این راهنما نحوه استفاده از متد create()
در منبع Membership
API Google Chat برای دعوت یا افزودن یک کاربر، Google Group یا برنامه Chat به فضایی که به عنوان ایجاد عضویت نیز شناخته میشود، توضیح میدهد. هنگام ایجاد عضویت، اگر خطمشی پذیرش خودکار عضو مشخصشده خاموش باشد، دعوت میشود و باید قبل از پیوستن، دعوت فضایی را بپذیرد. در غیر این صورت، ایجاد عضویت، عضو را مستقیماً به فضای مشخص شده اضافه می کند.
اگر یک سرپرست Google Workspace هستید، میتوانید کاربران، Google Groups یا برنامههای Chat را به هر فضایی در سازمان Google Workspace خود اضافه کنید.
منبع Membership
نشان میدهد که آیا کاربر انسانی یا برنامه چت Google به یک فضا دعوت شده، بخشی از آن یا غایب است.
- یک حساب 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 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 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 Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- یک پروژه Apps Script مستقل ایجاد کنید و سرویس گفتگوی پیشرفته را روشن کنید.
- در این راهنما، باید از احراز هویت کاربر یا برنامه استفاده کنید. برای احراز هویت به عنوان برنامه چت، اعتبارنامه حساب سرویس ایجاد کنید. برای مراحل، به تأیید اعتبار و مجوز به عنوان یک برنامه گپ Google مراجعه کنید.
- بر اساس اینکه میخواهید بهعنوان کاربر یا برنامه چت احراز هویت کنید ، محدوده مجوز را انتخاب کنید .
برای دعوت یا افزودن کاربر به فضایی با احراز هویت کاربر ، موارد زیر را در درخواست خود ارسال کنید:
- محدوده مجوز
chat.memberships
را مشخص کنید. - متد
CreateMembership()
را فراخوانی کنید. -
parent
به عنوان نام منبع فضایی که در آن عضویت ایجاد می شود، ارسال کنید. - تصویب
membership
به عنوان نمونه ای ازMembership
باmember
فیلد آن با موارد زیر:- فیلد
type
رویHUMAN
تنظیم شده است. - فیلد
name
رویusers/{user}
تنظیم شده است که در آن{user}
شخصی است که میخواهید به فضا اضافه کنید. برای تعیین کاربر چت ،{user}
را با یکی از موارد زیر جایگزین کنید:- شناسه شخص در People API. برای مثال، اگر People API person
resourceName
people/123456789
باشد، از مقدارusers/123456789
استفاده کنید. - شناسه کاربر در Directory API.
- آدرس ایمیل کاربر. به عنوان مثال،
users/222larabrown@gmail.com
یاusers/larabrown@cymbalgroup.com
. اگر کاربر از یک حساب Google استفاده می کند یا متعلق به یک سازمان Google Workspace دیگر است، باید از آدرس ایمیل او استفاده کنید.
- شناسه شخص در People API. برای مثال، اگر People API person
- فیلد
مثال زیر یک کاربر را به فضایی با احراز هویت کاربر اضافه می کند:
برای اجرای نمونه، موارد زیر را جایگزین کنید:
-
SPACE_NAME
: شناسه ازname
فضا. شما می توانید شناسه را با فراخوانی متدListSpaces()
یا از URL فضا بدست آورید. -
USER_NAME
: شناسه کاربری.
Chat API نمونه ای از Membership
را برمی گرداند که عضویت کاربر ایجاد شده را جزئیات می دهد.
برای دعوت یا افزودن یک گروه Google به فضایی با احراز هویت کاربر ( احراز هویت برنامه از دعوت یا افزودن یک گروه Google به فضا پشتیبانی نمیکند)، موارد زیر را در درخواست خود ارسال کنید:
- محدوده مجوز
chat.memberships
را مشخص کنید. - متد
CreateMembership()
را فراخوانی کنید. -
parent
به عنوان نام منبع فضایی که در آن عضویت ایجاد می شود، ارسال کنید. -
membership
به عنوان نمونه ای ازMembership
باname
فیلدgroupMember
رویgroups/{group}
که{group}
شناسه گروهی است که می خواهید برای آن عضویت ایجاد کنید، تنظیم کنید. شناسه گروه را می توان با استفاده از Cloud Identity API بازیابی کرد.
Google Groups را نمی توان به یک چت گروهی یا پیام مستقیم اضافه کرد، بلکه فقط به یک فضای نامگذاری شده اضافه می شود.
مثال زیر گروهی را با احراز هویت کاربر به فضای نامگذاری شده اضافه می کند:
برای اجرای نمونه، موارد زیر را جایگزین کنید:
-
SPACE_NAME
: شناسه ازname
فضا. شما می توانید شناسه را با فراخوانی متدListSpaces()
یا از URL فضا بدست آورید. -
GROUP_NAME
: شناسه گروه.
Chat API نمونه ای از Membership
را برمی گرداند که عضویت کاربر ایجاد شده را جزئیات می دهد.
برنامه چت نمیتواند برنامه دیگری را به عنوان عضو به فضا اضافه کند. برای افزودن یک برنامه چت به یک فضا یا یک پیام مستقیم بین دو کاربر انسانی، موارد زیر را در درخواست خود با احراز هویت کاربر ارسال کنید ( احراز هویت برنامه از دعوت یا افزودن یک برنامه گپ به فضا پشتیبانی نمیکند):
- محدوده مجوز
chat.memberships.app
را مشخص کنید. - متد
CreateMembership()
را فراخوانی کنید. -
parent
به عنوان نام منبع فضایی که در آن عضویت ایجاد می شود، ارسال کنید. - تصویب
membership
به عنوان نمونه ای ازMembership
باmember
فیلد آن با موارد زیر:- فیلد
type
رویBOT
تنظیم شده است. - فیلد
name
برایusers/app
تنظیم شده است. نام مستعاری که نشان دهنده برنامه فراخوانی Chat API است.
- فیلد
مثال زیر یک برنامه چت را به یک فضا اضافه می کند:
برای اجرای نمونه، SPACE_NAME
با شناسه name
فضا جایگزین کنید. شما می توانید شناسه را با فراخوانی متد ListSpaces()
یا از URL فضا بدست آورید.
Chat API نمونه ای از Membership
را برمی گرداند که عضویت کاربر ایجاد شده را جزئیات می دهد.
احراز هویت برنامه نیاز به تأیید یکباره سرپرست دارد.
برای دعوت یا افزودن کاربر به فضایی با احراز هویت برنامه ، موارد زیر را در درخواست خود ارسال کنید:
- محدوده مجوز
chat.app.memberships
را مشخص کنید. - متد
create
را در منبعmembership
فراخوانی کنید. -
parent
به نام منبع فضایی که در آن عضویت ایجاد می شود، تنظیم کنید. -
member
رویusers/{user}
تنظیم کنید که در آن{user}
شخصی است که میخواهید برای او عضویت ایجاد کنید، و یکی از این موارد است:- شناسه شخص در People API. به عنوان مثال، اگر People API person
resourceName
people/123456789
باشد، عضویت.membership.member.name
رویusers/123456789
تنظیم کنید. - شناسه کاربر در Directory API.
- آدرس ایمیل کاربر. به عنوان مثال،
users/222larabrown@gmail.com
یاusers/larabrown@cymbalgroup.com
. اگر کاربر از یک حساب Google استفاده می کند یا متعلق به یک سازمان Google Workspace دیگر است، باید از آدرس ایمیل او استفاده کنید.
- شناسه شخص در People API. به عنوان مثال، اگر People API person
برای فراخوانی یک روش API پیشنمایش برنامهنویس، باید از یک نسخه پیشنمایش برنامهنویس غیرعمومی سند کشف API استفاده کنید. برای احراز هویت درخواست، باید یک کلید API ارسال کنید.
برای ایجاد کلید API، پروژه Google Cloud برنامه خود را باز کنید و کارهای زیر را انجام دهید:
- در کنسول Google Cloud، به > APIs & Services > Credentials بروید. منو
- روی ایجاد اعتبارنامه > کلید API کلیک کنید.
- کلید API جدید شما نمایش داده می شود.
- روی Copy کلیک کنید تا کلید API خود را برای استفاده در کد برنامه خود کپی کنید. کلید API را میتوانید در بخش «کلیدهای API» اعتبار پروژهتان پیدا کنید.
- برای بهروزرسانی تنظیمات پیشرفته و محدود کردن استفاده از کلید API، روی Restrict key کلیک کنید. برای جزئیات بیشتر، به اعمال محدودیتهای کلید API مراجعه کنید.
مثال زیر یک کاربر را به فضایی با احراز هویت برنامه اضافه می کند:
- در فهرست کاری خود، یک فایل با نام
chat_membership_app_create.py
ایجاد کنید. کد زیر را در
chat_membership_app_create.py
قرار دهید:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships"] def main(): ''' Authenticates with Chat API using app authentication, then adds a user to a Chat space by creating a membership. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().members().create( # The space in which to create a membership. parent = 'spaces/SPACE', # Specify which user the membership is for. body = { 'member': { 'name':'users/USER', 'type': 'HUMAN' } } ).execute() # Prints details about the created membership. print(result) if __name__ == '__main__': main()
در کد زیر را جایگزین کنید:
API_KEY
: کلید API که برای ساختن نقطه پایانی سرویس برای Chat API ایجاد کردید.SPACE
: نام فضایی است که می توانید از روشspaces.list
در Chat API یا از URL یک فضا دریافت کنید.USER
: شناسه کاربری.
در پوشه کاری خود، نمونه را بسازید و اجرا کنید:
python3 chat_membership_app_create.py
اگر یک سرپرست Google Workspace هستید، میتوانید برای افزودن کاربران، Google Groups یا برنامههای Chat به هر فضایی در سازمان Google Workspace، متد create()
را فراخوانی کنید.
برای فراخوانی این روش به عنوان سرپرست Google Workspace، موارد زیر را انجام دهید:
- روش را با استفاده از احراز هویت کاربر فراخوانی کنید و محدوده مجوزی را مشخص کنید که از فراخوانی روش با استفاده از امتیازات سرپرست پشتیبانی می کند.
- در درخواست خود، پارامتر query
useAdminAccess
را بهtrue
مشخص کنید.
برای اطلاعات بیشتر و مثالها، به مدیریت فضاهای گپ Google به عنوان سرپرست Google Workspace مراجعه کنید.
- با احراز هویت برنامه ، یک برنامه گپ میتواند کاربران را دعوت یا اضافه کند، اما نه Google Groups یا برنامههای Chat. برای افزودن خود، یک برنامه Chat باید از احراز هویت کاربر با محدوده مجوز
chat.memberships
استفاده کند.
- جزئیات عضویت کاربر یا برنامه چت را دریافت کنید .
- اعضا را در یک فضا فهرست کنید .
- عضویت کاربر را در فضای چت Google به روز کنید .
- یک کاربر یا برنامه چت را از یک فضا حذف کنید .