این راهنما نحوه استفاده از متد list()
را در منبع Membership
API Google Chat برای فهرست کردن اعضا در یک فضا بهعنوان فهرست صفحهبندیشده و قابل فیلتر از عضویتها در یک فضا توضیح میدهد.
- فهرست کردن عضویتها با احراز هویت برنامه ، عضویتها را در فضاهایی فهرست میکند که برنامه Chat به آنها دسترسی دارد، اما عضویتهای برنامه Chat، از جمله عضویت خود را استثنا نمیکند.
- فهرست کردن عضویتها با احراز هویت کاربر ، عضویتها را در فضاهایی فهرست میکند که کاربر احراز هویت شده به آنها دسترسی دارد.
- فهرست کردن عضویتها بهعنوان سرپرست Google Workspace با احراز هویت کاربر با استفاده از امتیازات سرپرست، عضویتها را در همه فضاهای سازمان Google Workspace شما فهرست میکند.
منبع Membership
نشان میدهد که آیا کاربر انسانی یا برنامه چت Google به یک فضا دعوت شده، بخشی از آن یا غایب است.
پیش نیازها
Node.js
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- Node.js Cloud Client Library را نصب کنید.
- اعتبارنامه دسترسی را بر اساس نحوه احراز هویت در درخواست Google Chat API خود ایجاد کنید:
- برای احراز هویت به عنوان کاربر چت، اعتبارنامه های شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
client_secrets.json
در فهرست محلی خود ذخیره کنید. - برای احراز هویت بهعنوان برنامه چت، اعتبار حساب سرویس ایجاد کنید و اعتبارنامهها را بهعنوان فایل JSON با نام
credentials.json
ذخیره کنید.
- برای احراز هویت به عنوان کاربر چت، اعتبارنامه های شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
- بر اساس اینکه میخواهید بهعنوان کاربر یا برنامه چت احراز هویت کنید ، محدوده مجوز را انتخاب کنید .
- یک فضای گپ Google که کاربر احراز هویت شده یا برنامه چت تماس گیرنده عضو آن است. برای احراز هویت به عنوان برنامه Chat، برنامه Chat را به فضا اضافه کنید .
پایتون
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- کتابخانه Client Python Cloud را نصب کنید.
- اعتبارنامه دسترسی را بر اساس نحوه احراز هویت در درخواست Google Chat API خود ایجاد کنید:
- برای احراز هویت به عنوان کاربر چت، اعتبارنامه های شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
client_secrets.json
در فهرست محلی خود ذخیره کنید. - برای احراز هویت بهعنوان برنامه چت، اعتبار حساب سرویس ایجاد کنید و اعتبارنامهها را بهعنوان فایل JSON با نام
credentials.json
ذخیره کنید.
- برای احراز هویت به عنوان کاربر چت، اعتبارنامه های شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
- بر اساس اینکه میخواهید بهعنوان کاربر یا برنامه چت احراز هویت کنید ، محدوده مجوز را انتخاب کنید .
- یک فضای گپ Google که کاربر احراز هویت شده یا برنامه چت تماس گیرنده عضو آن است. برای احراز هویت به عنوان برنامه Chat، برنامه Chat را به فضا اضافه کنید .
جاوا
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- کتابخانه Java Cloud Client را نصب کنید.
- اعتبارنامه دسترسی را بر اساس نحوه احراز هویت در درخواست Google Chat API خود ایجاد کنید:
- برای احراز هویت به عنوان کاربر چت، اعتبارنامه های شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
client_secrets.json
در فهرست محلی خود ذخیره کنید. - برای احراز هویت بهعنوان برنامه چت، اعتبار حساب سرویس ایجاد کنید و اعتبارنامهها را بهعنوان فایل JSON با نام
credentials.json
ذخیره کنید.
- برای احراز هویت به عنوان کاربر چت، اعتبارنامه های شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
- بر اساس اینکه میخواهید بهعنوان کاربر یا برنامه چت احراز هویت کنید ، محدوده مجوز را انتخاب کنید .
- یک فضای گپ Google که کاربر احراز هویت شده یا برنامه چت تماس گیرنده عضو آن است. برای احراز هویت به عنوان برنامه Chat، برنامه Chat را به فضا اضافه کنید .
اسکریپت برنامه ها
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- یک پروژه Apps Script مستقل ایجاد کنید و سرویس گفتگوی پیشرفته را روشن کنید.
- در این راهنما، باید از احراز هویت کاربر یا برنامه استفاده کنید. برای احراز هویت به عنوان برنامه چت، اعتبارنامه حساب سرویس ایجاد کنید. برای مراحل، به تأیید اعتبار و مجوز به عنوان یک برنامه گپ Google مراجعه کنید.
- بر اساس اینکه میخواهید بهعنوان کاربر یا برنامه چت احراز هویت کنید ، محدوده مجوز را انتخاب کنید .
- یک فضای گپ Google که کاربر احراز هویت شده یا برنامه چت تماس گیرنده عضو آن است. برای احراز هویت به عنوان برنامه Chat، برنامه Chat را به فضا اضافه کنید .
فهرست اعضا در یک فضا با احراز هویت کاربر
برای فهرست کردن کاربران، گروههای Google و برنامه چت در فضایی که کاربر احراز هویت شده به آن دسترسی دارد، موارد زیر را در درخواست خود ارسال کنید:
- با احراز هویت کاربر ، محدوده مجوز
chat.memberships.readonly
یاchat.memberships
را مشخص کنید. - متد
ListMemberships()
را فراخوانی کنید. - برای فهرست کردن Google Groups، پارامتر query
showGroups
را رویtrue
تنظیم کنید.
مثال زیر اعضای گروه Google، انسان و برنامه را فهرست می کند که برای کاربر تأیید شده قابل مشاهده است.
Node.js
پایتون
جاوا
اسکریپت برنامه ها
برای اجرای این نمونه، SPACE_NAME
با شناسه فیلد name
فضا جایگزین کنید. شما می توانید شناسه را با فراخوانی متد ListSpaces()
یا از URL فضا بدست آورید.
Google Chat API فهرستی از اعضای Google Group، انسان و برنامه را از فضای مشخص شده برمی گرداند.
فهرست اعضا در یک فضا با احراز هویت برنامه
برای فهرست کردن کاربران و برنامه چت در فضایی که برنامه احراز هویت شده به آن دسترسی دارد، موارد زیر را در درخواست خود ارسال کنید:
- با احراز هویت برنامه ، محدوده مجوز
chat.bot
را مشخص کنید. - متد
ListMemberships()
را فراخوانی کنید. - برای فهرست کردن Google Groups، پارامتر query
showGroups
را رویtrue
تنظیم کنید.
مثال زیر اعضای فضای انسانی (نه مدیران فضا) قابل مشاهده در برنامه چت را فهرست می کند:
Node.js
پایتون
جاوا
اسکریپت برنامه ها
برای اجرای این نمونه، SPACE_NAME
با شناسه فیلد name
فضا جایگزین کنید. شما می توانید شناسه را با فراخوانی متد ListSpaces()
یا از URL فضا بدست آورید.
Google Chat API فهرستی از اعضای فضای انسانی (به استثنای مدیران فضا) را از فضای مشخص شده برمی گرداند.
اعضا را به عنوان سرپرست Google Workspace فهرست کنید
اگر یک سرپرست Google Workspace هستید، میتوانید برای فهرست کردن عضویتها برای هر فضایی در سازمان Google Workspace خود، با روش ListMemberships()
تماس بگیرید. Chat API فقط عضویتهای مربوط به کاربران - اعم از داخلی و خارجی - یا Google Groups را از سازمان شما برمیگرداند، و بنابراین عضویتها را برای هر برنامه چت حذف نمیکند.
برای فراخوانی این روش به عنوان سرپرست Google Workspace، موارد زیر را انجام دهید:
- روش را با استفاده از احراز هویت کاربر فراخوانی کنید و محدوده مجوزی را مشخص کنید که از فراخوانی روش با استفاده از امتیازات سرپرست پشتیبانی می کند.
- در درخواست خود، پارامترهای پرس و جو زیر را مشخص کنید:
-
useAdminAccess
را رویtrue
تنظیم کنید. - برای بازگشت فقط کاربران،
filter
member.type
.type را برابر باHUMAN
تنظیم کنید. - برای بازگرداندن کاربران و گروهها،
filter
member.type
.type را باBOT
AND
showGroups
برابر باtrue
تنظیم کنید.
-
برای اطلاعات بیشتر و مثالها، به مدیریت فضاهای گپ Google به عنوان سرپرست Google Workspace مراجعه کنید.
صفحه بندی را سفارشی کنید یا لیست را فیلتر کنید
برای فهرست کردن عضویت ها، پارامترهای پرس و جوی زیر را برای سفارشی کردن صفحه بندی یا فیلتر کردن عضویت های فهرست شده ارسال کنید:
-
pageSize
: حداکثر تعداد عضویت برای بازگشت. ممکن است این سرویس کمتر از این مقدار را برگرداند. اگر نامشخص باشد، حداکثر 100 فاصله برگردانده می شود. حداکثر مقدار 1000 است. مقادیر بیش از 1000 به طور خودکار به 1000 تغییر می کنند. -
pageToken
: یک نشانه صفحه، دریافت شده از یک تماس قبلی با فاصله لیست. این نشانه را برای بازیابی صفحه بعدی ارائه دهید. هنگام صفحهبندی، مقدار فیلتر باید با تماسی که توکن صفحه را ارائه میکند، مطابقت داشته باشد. عبور یک مقدار متفاوت ممکن است منجر به نتایج غیرمنتظره شود. -
filter
: یک فیلتر پرس و جو. نیاز به احراز هویت کاربر دارد. برای جزئیات درخواست پشتیبانی شده، به مرجعListMembershipsRequest
مراجعه کنید.
موضوعات مرتبط
- جزئیات عضویت کاربر یا برنامه چت را دریافت کنید .
- یک کاربر یا برنامه چت را به یک فضا دعوت یا اضافه کنید .
- عضویت کاربر را در فضای چت Google به روز کنید .
- یک کاربر یا برنامه چت را از یک فضا حذف کنید .