این راهنما نحوه استفاده از روش patch
در منبع membership
Google Chat API را برای تغییر ویژگیهای عضویت، مانند تغییر عضو فضایی به مدیر فضایی یا تغییر مدیر فضایی به عضو فضایی، توضیح میدهد.
منبع Membership
نشان میدهد که آیا کاربر انسانی یا برنامه چت Google به یک فضا دعوت شده، بخشی از آن یا غایب است.
پیش نیازها
پایتون
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- کتابخانه Google API Client Python را نصب کنید.
- شناسه مشتری OAuth را برای یک برنامه دسکتاپ ایجاد کنید . برای اجرای نمونه در این راهنما، اعتبارنامه ها را به عنوان یک فایل JSON با نام
client_secrets.json
در فهرست محلی خود ذخیره کنید.
- محدوده مجوزی را انتخاب کنید که از احراز هویت کاربر پشتیبانی می کند.
Node.js
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- Node.js Google API Client Library را نصب کنید.
- شناسه مشتری OAuth را برای یک برنامه دسکتاپ ایجاد کنید . برای اجرای نمونه در این راهنما، اعتبارنامه ها را به عنوان یک فایل JSON با نام
client_secrets.json
در فهرست محلی خود ذخیره کنید.
- محدوده مجوزی را انتخاب کنید که از احراز هویت کاربر پشتیبانی می کند.
اسکریپت برنامه ها
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- یک پروژه Apps Script مستقل ایجاد کنید و سرویس گفتگوی پیشرفته را روشن کنید.
- محدوده مجوزی را انتخاب کنید که از احراز هویت کاربر پشتیبانی می کند.
یک عضویت را به روز کنید
برای بهروزرسانی عضویت فضایی، موارد زیر را در درخواست خود بنویسید:
- محدوده مجوز
chat.memberships
را مشخص کنید. - متد
patch
در منبعMembership
فراخوانی کنید وname
عضویت را برای بهروزرسانی، و همچنین یکupdateMask
وbody
که ویژگیهای عضویت بهروز شده را مشخص میکند، ارسال کنید. -
updateMask
جنبه های عضویت برای به روز رسانی را مشخص می کند و شامل موارد زیر است:-
role
: نقش کاربر در فضای چت، که اقدامات مجاز آنها را در فضا تعیین می کند. مقادیر ممکن عبارتند از:-
ROLE_MEMBER
: عضوی از فضا. کاربر دارای مجوزهای اولیه مانند ارسال پیام به فضا است. در مکالمات گروهی 1:1 و بدون نام، همه این نقش را دارند. -
ROLE_MANAGER
: یک مدیر فضا. کاربر تمام مجوزهای اولیه به اضافه مجوزهای مدیریتی را دارد که به او اجازه می دهد فضا را مدیریت کند، مانند افزودن یا حذف اعضا. فقط در فضاهایی کهspaceType
SPACE
است (فضاهای نامگذاری شده) پشتیبانی می شود.
-
-
یک عضو معمولی فضایی را مدیر فضایی کنید
مثال زیر با تعیین role
به عنوان ROLE_MANAGER
در body
که ویژگی های عضویت به روز شده را مشخص می کند، یک عضو فضای معمولی را به یک مدیر فضا تبدیل می کند:
پایتون
- در پوشه کاری خود، یک فایل با نام
chat_membership_update.py
ایجاد کنید. کد زیر را در
chat_membership_update.py
قرار دهید:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.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.memberships"] def main(): ''' Authenticates with Chat API via user credentials, then updates a specified space member to change it from a regular member to a space manager. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().members().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', body={'role': 'ROLE_MANAGER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()
در کد زیر را جایگزین کنید:
SPACE
: نام فضایی است که می توانید از روشspaces.list
در Chat API یا از URL یک فضا دریافت کنید.MEMBERSHIP
: یک نام عضویت که می توانید از روشspaces.members.list
در Chat API بدست آورید.
در پوشه کاری خود، نمونه را بسازید و اجرا کنید:
python3 chat_membership_update.py
Node.js
- در پوشه کاری خود، یک فایل با نام
chat_membership_update.js
ایجاد کنید. کد زیر را در
chat_membership_update.js
قرار دهید:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Updates a membership in a Chat space to change it from * a space member to a space manager. * @return {!Promise<!Object>} */ async function updateSpace() { /** * Authenticate with Google Workspace * and get user authorization. */ const scopes = [ 'https://www.googleapis.com/auth/chat.memberships', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); /** * Build a service endpoint for Chat API. */ const chatClient = await chat.chat({version: 'v1', auth: authClient}); /** * Use the service endpoint to call Chat API. */ return await chatClient.spaces.patch({ /** * The membership to update, and the updated role. * * Replace SPACE with a space name. * Obtain the space name from the spaces resource of Chat API, * or from a space's URL. * * Replace MEMBERSHIP with a membership name. * Obtain the membership name from the membership of Chat API. */ name: 'spaces/SPACE/members/MEMBERSHIP', updateMask: 'role', requestBody: { role: 'ROLE_MANAGER' } }); } /** * Use the service endpoint to call Chat API. */ updateSpace().then(console.log);
در کد زیر را جایگزین کنید:
SPACE
: نام فضایی است که می توانید از روشspaces.list
در Chat API یا از URL یک فضا دریافت کنید.MEMBERSHIP
: یک نام عضویت که می توانید از روشspaces.members.list
در Chat API بدست آورید.
در پوشه کاری خود، نمونه را بسازید و اجرا کنید:
python3 chat_membership_update.js
اسکریپت برنامه ها
این مثال Chat API را با استفاده از Advanced Chat Service فراخوانی میکند.
محدوده مجوز
chat.memberships
را به فایلappsscript.json
پروژه Apps Script اضافه کنید:"oauthScopes": [ "https://www.googleapis.com/auth/chat.memberships" ]
تابعی مانند این را به کد پروژه Apps Script اضافه کنید:
/** * Updates a membership from space member to space manager. * @param {string} memberName The resource name of the membership. */ function updateMembershipToSpaceManager(memberName) { try { const body = {'role': 'ROLE_MANAGER'}; Chat.Spaces.Members.patch(memberName, body); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to create message with error %s', err.message); } }
Google Chat API عضویت مشخص شده را به یک مدیر فضا تغییر میدهد و نمونهای از Membership
که جزئیات این تغییر را توضیح میدهد برمیگرداند.
یک مدیر فضایی را به عضویت دائمی خود درآورید
مثال زیر با تعیین role
به عنوان ROLE_MEMBER
در body
که ویژگی های عضویت به روز شده را مشخص می کند، یک مدیر فضا را به یک عضو فضای معمولی تبدیل می کند:
پایتون
- در پوشه کاری خود، یک فایل با نام
chat_membership_update.py
ایجاد کنید. کد زیر را در
chat_membership_update.py
قرار دهید:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.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.memberships"] def main(): ''' Authenticates with Chat API via user credentials, then updates a specified space member to change it from a regular member to a space manager. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().members().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', body={'role': 'ROLE_MEMBER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()
در کد زیر را جایگزین کنید:
SPACE
: نام فضایی است که می توانید از روشspaces.list
در Chat API یا از URL یک فضا دریافت کنید.MEMBERSHIP
: یک نام عضویت که می توانید از روشspaces.members.list
در Chat API بدست آورید.
در پوشه کاری خود، نمونه را بسازید و اجرا کنید:
python3 chat_membership_update.py
Node.js
- در پوشه کاری خود، یک فایل با نام
chat_membership_update.js
ایجاد کنید. کد زیر را در
chat_membership_update.js
قرار دهید:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Updates a membership in a Chat space to change it from * a space manager to a space member. * @return {!Promise<!Object>} */ async function updateSpace() { /** * Authenticate with Google Workspace * and get user authorization. */ const scopes = [ 'https://www.googleapis.com/auth/chat.memberships', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); /** * Build a service endpoint for Chat API. */ const chatClient = await chat.chat({version: 'v1', auth: authClient}); /** * Use the service endpoint to call Chat API. */ return await chatClient.spaces.patch({ /** * The membership to update, and the updated role. * * Replace SPACE with a space name. * Obtain the space name from the spaces resource of Chat API, * or from a space's URL. * * Replace MEMBERSHIP with a membership name. * Obtain the membership name from the membership of Chat API. */ name: 'spaces/SPACE/members/MEMBERSHIP', updateMask: 'role', requestBody: { role: 'ROLE_MEMBER' } }); } /** * Use the service endpoint to call Chat API. */ updateSpace().then(console.log);
در کد زیر را جایگزین کنید:
SPACE
: نام فضایی است که می توانید از روشspaces.list
در Chat API یا از URL یک فضا دریافت کنید.MEMBERSHIP
: یک نام عضویت که می توانید از روشspaces.members.list
در Chat API بدست آورید.
در پوشه کاری خود، نمونه را بسازید و اجرا کنید:
python3 chat_membership_update.js
اسکریپت برنامه ها
این مثال Chat API را با استفاده از Advanced Chat Service فراخوانی میکند.
محدوده مجوز
chat.memberships
را به فایلappsscript.json
پروژه Apps Script اضافه کنید:"oauthScopes": [ "https://www.googleapis.com/auth/chat.memberships" ]
تابعی مانند این را به کد پروژه Apps Script اضافه کنید:
/** * Updates a membership from space manager to space member. * @param {string} memberName The resource name of the membership. */ function updateMembershipToSpaceMember(memberName) { try { const body = {'role': 'ROLE_MEMBER'}; Chat.Spaces.Members.patch(memberName, body); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to create message with error %s', err.message); } }
Google Chat API عضویت مشخص شده را به یک مدیر فضا تغییر میدهد و نمونهای از Membership
که جزئیات این تغییر را توضیح میدهد برمیگرداند.
موضوعات مرتبط
- یک کاربر یا یک برنامه چت Google را به یک فضا دعوت یا اضافه کنید .
- جزئیات عضویت کاربر یا برنامه چت را دریافت کنید .
- اعضا را در یک فضا فهرست کنید .
- یک کاربر یا برنامه چت را از یک فضا حذف کنید .