فهرست فضاها (original) (raw)
این راهنما نحوه استفاده از متد list() در منبع Space از API چت گوگل برای فهرست کردن فضاها را توضیح میدهد. فهرست کردن فضاها، فهرستی صفحهبندیشده و قابل فیلتر از فضاها را برمیگرداند.
منبع Space مکانی را نشان میدهد که افراد و برنامههای چت میتوانند در آن پیام ارسال کنند، فایلها را به اشتراک بگذارند و با یکدیگر همکاری کنند. چندین نوع Space وجود دارد:
- پیامهای مستقیم (DM) مکالماتی بین دو کاربر یا یک کاربر و یک برنامه چت هستند.
- چتهای گروهی، مکالماتی بین سه یا چند کاربر و برنامههای چت هستند.
- فضاهای نامگذاری شده مکانهای پایداری هستند که افراد در آنها پیام میفرستند، فایلها را به اشتراک میگذارند و با یکدیگر همکاری میکنند.
فهرست کردن فضاها با احراز هویت برنامه، فضاهایی را که برنامه چت به آنها دسترسی دارد، فهرست میکند. فهرست کردن فضاها با احراز هویت کاربر، فضاهایی را که کاربر احراز هویت شده به آنها دسترسی دارد، فهرست میکند.
پیشنیازها
نود جی اس
- یک حساب کاربری تجاری یا سازمانی Google Workspace با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه گوگل کلود ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- API چت گوگل را با نام، آیکون و توضیحات برای برنامه چت خود فعال و پیکربندی کنید .
- کتابخانه کلاینت ابری Node.js را نصب کنید.
- بر اساس نحوهی احراز هویت در درخواست API چت گوگل خود، اعتبارنامههای دسترسی ایجاد کنید:
* برای احراز هویت به عنوان کاربر چت، اعتبارنامههای OAuth client ID را ایجاد کنید و اعتبارنامهها را به عنوان یک فایل JSON با نامcredentials.jsonدر دایرکتوری محلی خود ذخیره کنید.
* برای احراز هویت به عنوان برنامه چت، اعتبارنامههای حساب سرویس را ایجاد کنید و اعتبارنامهها را به عنوان یک فایل JSON با نامcredentials.jsonذخیره کنید.
- بر اساس اینکه میخواهید به عنوان کاربر یا برنامه چت احراز هویت کنید ، یک محدوده مجوز انتخاب کنید .
پایتون
- یک حساب کاربری تجاری یا سازمانی Google Workspace با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه گوگل کلود ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- API چت گوگل را با نام، آیکون و توضیحات برای برنامه چت خود فعال و پیکربندی کنید .
- کتابخانه کلاینت ابری پایتون را نصب کنید.
- بر اساس نحوهی احراز هویت در درخواست API چت گوگل خود، اعتبارنامههای دسترسی ایجاد کنید:
* برای احراز هویت به عنوان کاربر چت، اعتبارنامههای OAuth client ID را ایجاد کنید و اعتبارنامهها را به عنوان یک فایل JSON با نامcredentials.jsonدر دایرکتوری محلی خود ذخیره کنید.
* برای احراز هویت به عنوان برنامه چت، اعتبارنامههای حساب سرویس را ایجاد کنید و اعتبارنامهها را به عنوان یک فایل JSON با نامcredentials.jsonذخیره کنید.
- بر اساس اینکه میخواهید به عنوان کاربر یا برنامه چت احراز هویت کنید ، یک محدوده مجوز انتخاب کنید .
جاوا
- یک حساب کاربری تجاری یا سازمانی Google Workspace با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه گوگل کلود ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- API چت گوگل را با نام، آیکون و توضیحات برای برنامه چت خود فعال و پیکربندی کنید .
- کتابخانه کلاینت ابری جاوا را نصب کنید.
- بر اساس نحوهی احراز هویت در درخواست API چت گوگل خود، اعتبارنامههای دسترسی ایجاد کنید:
* برای احراز هویت به عنوان کاربر چت، اعتبارنامههای OAuth client ID را ایجاد کنید و اعتبارنامهها را به عنوان یک فایل JSON با نامcredentials.jsonدر دایرکتوری محلی خود ذخیره کنید.
* برای احراز هویت به عنوان برنامه چت، اعتبارنامههای حساب سرویس را ایجاد کنید و اعتبارنامهها را به عنوان یک فایل JSON با نامcredentials.jsonذخیره کنید.
- بر اساس اینکه میخواهید به عنوان کاربر یا برنامه چت احراز هویت کنید ، یک محدوده مجوز انتخاب کنید .
اسکریپت برنامهها
- یک حساب کاربری تجاری یا سازمانی Google Workspace با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه گوگل کلود ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- API چت گوگل را با نام، آیکون و توضیحات برای برنامه چت خود فعال و پیکربندی کنید .
- یک پروژه مستقل Apps Script ایجاد کنید و سرویس چت پیشرفته (Advanced Chat Service) را فعال کنید.
- در این راهنما، شما باید از احراز هویت کاربر یا برنامه استفاده کنید. برای احراز هویت به عنوان برنامه چت، اعتبارنامههای حساب سرویس ایجاد کنید. برای مراحل، به «احراز هویت و مجوز به عنوان یک برنامه چت گوگل» مراجعه کنید.
- بر اساس اینکه میخواهید به عنوان کاربر یا برنامه چت احراز هویت کنید ، یک محدوده مجوز انتخاب کنید .
لیست فضاها با احراز هویت کاربر
برای فهرست کردن فضاها در گوگل چت، موارد زیر را در درخواست خود وارد کنید:
- با احراز هویت کاربر ، دامنه مجوز
chat.spaces.readonlyیاchat.spacesرا مشخص کنید. - متد ListSpaces() را فراخوانی کنید.
مثال زیر فضاهای نامگذاری شده (اما نه چتهای گروهی و پیامهای مستقیم که فیلتر شدهاند) را که برای کاربر احراز هویت شده قابل مشاهده هستند، فهرست میکند:
نود جی اس
پایتون
جاوا
اسکریپت برنامهها
API چت، فهرستی صفحهبندیشده از فاصلهها را برمیگرداند.
لیست فضاها با احراز هویت برنامه
برای فهرست کردن فضاها در گوگل چت، موارد زیر را در درخواست خود وارد کنید:
- با احراز هویت برنامه ، دامنه مجوز
chat.botرا مشخص کنید. - متد ListSpaces() را فراخوانی کنید.
مثال زیر فضاهای نامگذاری شده (اما نه چتهای گروهی و پیامهای مستقیم) قابل مشاهده برای برنامه چت را فهرست میکند:
نود جی اس
پایتون
جاوا
اسکریپت برنامهها
API چت، فهرستی صفحهبندیشده از فاصلهها را برمیگرداند.
برای فهرست کردن فضاها در گوگل چت، پارامترهای پرس و جوی اختیاری زیر را برای سفارشیسازی صفحهبندی یا فیلتر کردن فضاهای فهرستشده ارسال کنید:
pageSize: حداکثر تعداد فاصله برای برگرداندن. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود، حداکثر ۱۰۰ فاصله برگردانده میشود. حداکثر مقدار ۱۰۰۰ است؛ مقادیر بالاتر از ۱۰۰۰ به طور خودکار به ۱۰۰۰ تغییر میکنند.pageToken: یک توکن صفحه که از فراخوانی قبلی فضاهای لیست دریافت شده است. این توکن را برای بازیابی صفحه بعدی ارائه دهید. هنگام صفحهبندی، مقدار فیلتر باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشد. ارسال مقدار متفاوت ممکن است منجر به نتایج غیرمنتظرهای شود.filter: یک فیلتر پرسوجو. برای جزئیات پرسوجوی پشتیبانیشده، به مرجع ListSpacesRequest مراجعه کنید.- فضایی ایجاد کنید .
- فضایی را تنظیم کنید .
- جزئیات مربوط به یک فضا را دریافت کنید .
- بهروزرسانی یک فضا .
- یک فاصله (space) را حذف کنید .
- یک فضای پیام مستقیم پیدا کنید .