يوضّح هذا الدليل كيفية استخدام طريقة
create()
في المورد Membership
لواجهة Google Chat API من أجل دعوة مستخدم أو مجموعة Google أو تطبيق Chat إلى مساحة، ويُعرف ذلك أيضًا باسم إنشاء اشتراك. عند إنشاء عضوية، إذا كان العضو المحدّد قد أوقف سياسة القبول التلقائي، ستتم دعوته وعليه قبول دعوة الفضاء قبل الانضمام إليه. بخلاف ذلك، تؤدي عملية إنشاء اشتراك إلى إضافة العضو مباشرةً إلى المساحة المحدّدة.
إذا كنت مشرفًا في Google Workspace، يمكنك إضافة مستخدمين أو مجموعات Google أو تطبيقات Chat إلى أي مساحة في مؤسستك على Google Workspace.
يمثّل مصدر
Membership
ما إذا تمت دعوة مستخدم بشري أو تطبيق Google Chat إلى مساحة أو كان جزءًا منها أو غير متوفّر فيها.
المتطلبات الأساسية
Node.js
- حساب Google Workspace من إصدار Business أو Enterprise مع إذن الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل واجهة Google Chat API وأعِدّها باستخدام اسم ورمز ووصف لتطبيق Chat.
- ثبِّت مكتبة برامج Cloud الخاصة بنظام Node.js.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
credentials.json
في الدليل المحلي. - لإجراء المصادقة بصفتك تطبيق Chat،
أنشئ بيانات اعتماد
لحساب الخدمة واحفظها كملف JSON باسم
credentials.json
.
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
- اختَر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق Chat.
Python
- حساب Google Workspace من إصدار Business أو Enterprise مع إذن الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل واجهة Google Chat API وأعِدّها باستخدام اسم ورمز ووصف لتطبيق Chat.
- ثبِّت مكتبة برامج Cloud للغة Python.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
credentials.json
في الدليل المحلي. - لإجراء المصادقة بصفتك تطبيق Chat،
أنشئ بيانات اعتماد
لحساب الخدمة واحفظها كملف JSON باسم
credentials.json
.
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
- اختَر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق Chat.
Java
- حساب Google Workspace من إصدار Business أو Enterprise مع إذن الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل واجهة Google Chat API وأعِدّها باستخدام اسم ورمز ووصف لتطبيق Chat.
- ثبِّت مكتبة برامج Cloud للغة Java.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
credentials.json
في الدليل المحلي. - لإجراء المصادقة بصفتك تطبيق Chat،
أنشئ بيانات اعتماد
لحساب الخدمة واحفظها كملف JSON باسم
credentials.json
.
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
- اختَر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق Chat.
برمجة تطبيقات
- حساب Google Workspace من إصدار Business أو Enterprise مع إذن الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل واجهة Google Chat API وأعِدّها باستخدام اسم ورمز ووصف لتطبيق Chat.
- أنشئ مشروعًا مستقلاً في "برمجة تطبيقات Google"، وفعِّل خدمة Chat المتقدّمة.
- في هذا الدليل، يجب استخدام مصادقة المستخدم أو التطبيق. للمصادقة كتطبيق Chat، أنشئ بيانات اعتماد حساب خدمة. للاطّلاع على الخطوات، يُرجى الرجوع إلى مقالة المصادقة والتفويض كتطبيق Google Chat.
- اختَر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق Chat.
دعوة مستخدم أو إضافته إلى مساحة كمستخدم
لدعوة مستخدم أو إضافته إلى مساحة تتطلّب مصادقة المستخدم، عليك تضمين ما يلي في طلبك:
- حدِّد
chat.memberships
نطاق التفويض. - استدعِ طريقة
CreateMembership()
. - مرِّر
parent
كاسم المورد للمساحة التي تريد إنشاء العضوية فيها. - مرِّر
membership
كمثيل منMembership
مع ضبط الحقلmember
على ما يلي:- تم ضبط الحقل
type
علىHUMAN
. - يجب ضبط الحقل
name
علىusers/{user}
، حيث يمثّل{user}
الشخص الذي تريد إضافته إلى المساحة. لتحديد مستخدم Chat، استبدِل{user}
بأي مما يلي:- تمثّل هذه السمة رقم تعريف
الشخص
في People API. على سبيل المثال، إذا كانت السمة person في People API
resourceName
هيpeople/123456789
، استخدِم القيمةusers/123456789
. - معرّف المستخدم في Directory API.
- عنوان البريد الإلكتروني للمستخدم على سبيل المثال،
users/222larabrown@gmail.com
أوusers/larabrown@cymbalgroup.com
. إذا كان المستخدم يستعمل حساب Google أو ينتمي إلى مؤسسة مختلفة على Google Workspace، عليك استخدام عنوان بريده الإلكتروني.
- تمثّل هذه السمة رقم تعريف
الشخص
في People API. على سبيل المثال، إذا كانت السمة person في People API
- تم ضبط الحقل
يضيف المثال التالي مستخدمًا إلى مساحة تتضمّن مصادقة المستخدم:
Node.js
Python
Java
برمجة تطبيقات
لتشغيل العيّنة، استبدِل ما يلي:
SPACE_NAME
: رقم التعريف منname
الخاص بالمساحة يمكنك الحصول على المعرّف من خلال استدعاء الطريقةListSpaces()
أو من عنوان URL الخاص بالمساحة.USER_NAME
: رقم تعريف المستخدم
تعرض Chat API مثيلاً من
Membership
يقدّم تفاصيل حول عضوية المستخدم التي تم إنشاؤها.
دعوة "مجموعة Google" أو إضافتها إلى مساحة
لدعوة مجموعة Google أو إضافتها إلى مساحة تتضمّن مصادقة المستخدم (لا تتيح مصادقة التطبيق دعوة مجموعة Google أو إضافتها إلى مساحة)، عليك تضمين ما يلي في طلبك:
- حدِّد
chat.memberships
نطاق التفويض. - استدعِ طريقة
CreateMembership()
. - مرِّر
parent
كاسم المورد للمساحة التي تريد إنشاء العضوية فيها. - مرِّر
membership
كنموذج منMembership
مع ضبط الحقلname
منgroupMember
علىgroups/{group}
حيث{group}
هو رقم تعريف المجموعة التي تريد إنشاء عضوية لها. يمكن استرداد رقم تعريف المجموعة باستخدام Cloud Identity API.
لا يمكن إضافة "مجموعات Google" إلى محادثة جماعية أو رسالة مباشرة، بل إلى مساحة تحمل اسمًا فقط.
يضيف المثال التالي مجموعة إلى مساحة مسماة مع مصادقة المستخدم:
Node.js
Python
Java
برمجة تطبيقات
لتشغيل العيّنة، استبدِل ما يلي:
SPACE_NAME
: رقم التعريف منname
الخاص بالمساحة يمكنك الحصول على المعرّف من خلال استدعاء الطريقةListSpaces()
أو من عنوان URL الخاص بالمساحة.GROUP_NAME
: معرّف مجموعة
تعرض Chat API مثيلاً من
Membership
يقدّم تفاصيل حول عضوية المستخدم التي تم إنشاؤها.
إضافة تطبيق Chat إلى مساحة
لا يمكن لتطبيق Chat إضافة تطبيق آخر كعضو في مساحة. لإضافة تطبيق Chat إلى مساحة أو رسالة مباشرة بين مستخدمَين بشريَين، عليك تضمين ما يلي في طلبك مع مصادقة المستخدم (لا تتيح مصادقة التطبيق دعوة تطبيق Chat أو إضافته إلى مساحة):
- حدِّد
chat.memberships.app
نطاق التفويض. - استدعِ طريقة
CreateMembership()
. - مرِّر
parent
كاسم المورد للمساحة التي تريد إنشاء العضوية فيها. - مرِّر
membership
كمثيل منMembership
مع ضبط الحقلmember
على ما يلي:- تم ضبط الحقل
type
علىBOT
. - الحقل
name
مضبوط علىusers/app
، وهو اسم مستعار يمثّل التطبيق الذي يستدعي Chat API.
- تم ضبط الحقل
يضيف المثال التالي تطبيق Chat إلى مساحة:
Node.js
Python
Java
برمجة تطبيقات
لتشغيل النموذج، استبدِل SPACE_NAME
برقم التعريف من name
الخاص بالمساحة.
يمكنك الحصول على المعرّف من خلال استدعاء الطريقة
ListSpaces()
أو من عنوان URL الخاص بالمساحة.
تعرض Chat API مثيلاً من
Membership
يقدّم تفاصيل حول عضوية المستخدم التي تم إنشاؤها.
دعوة مستخدم أو إضافته إلى مساحة كتطبيق Chat
تتطلّب مصادقة التطبيق الحصول على موافقة المشرف لمرة واحدة.
لدعوة مستخدم أو إضافته إلى مساحة تتضمّن مصادقة التطبيق، عليك تضمين ما يلي في طلبك:
- حدِّد
chat.app.memberships
نطاق التفويض. - استدعِ الطريقة
create
على الموردmembership
. - اضبط
parent
على اسم المورد للمساحة التي تريد إنشاء العضوية فيها. - اضبط
member
علىusers/{user}
، حيث يمثّل{user}
الشخص الذي تريد إنشاء عضوية له، ويكون إما:- تمثّل هذه السمة رقم تعريف
الشخص
في People API. على سبيل المثال، إذا كانت قيمة person
resourceName
في People API هيpeople/123456789
، اضبط قيمةmembership.member.name
علىusers/123456789
. - معرّف المستخدم في Directory API.
- عنوان البريد الإلكتروني للمستخدم على سبيل المثال،
users/222larabrown@gmail.com
أوusers/larabrown@cymbalgroup.com
. إذا كان المستخدم يستعمل حسابًا على Google أو ينتمي إلى مؤسسة مختلفة على Google Workspace، عليك استخدام عنوان بريده الإلكتروني.
- تمثّل هذه السمة رقم تعريف
الشخص
في People API. على سبيل المثال، إذا كانت قيمة person
إنشاء مفتاح واجهة برمجة تطبيقات
لاستدعاء إحدى طرق واجهة برمجة التطبيقات في "معاينة المطوّر"، يجب استخدام إصدار غير علني من مستند اكتشاف واجهة برمجة التطبيقات. للمصادقة على الطلب، يجب إدخال مفتاح واجهة برمجة التطبيقات.
لإنشاء مفتاح واجهة برمجة التطبيقات، افتح مشروع Google Cloud الخاص بتطبيقك واتّبِع الخطوات التالية:
- في Google Cloud Console، انتقِل إلى "القائمة" > واجهات برمجة التطبيقات والخدمات > بيانات الاعتماد.
- انقر على إنشاء بيانات اعتماد > مفتاح واجهة برمجة التطبيقات.
- يظهر مفتاح واجهة برمجة التطبيقات الجديد.
- انقر على "نسخ" لنسخ مفتاح واجهة برمجة التطبيقات لاستخدامه في رمز تطبيقك. يمكنك أيضًا العثور على مفتاح واجهة برمجة التطبيقات في قسم "مفاتيح واجهة برمجة التطبيقات" ضمن بيانات اعتماد مشروعك.
- انقر على تقييد المفتاح لتعديل الإعدادات المتقدّمة والحدّ من استخدام مفتاح واجهة برمجة التطبيقات. لمزيد من التفاصيل، يُرجى الاطّلاع على تطبيق قيود على مفتاح واجهة برمجة التطبيقات.
كتابة نص برمجي يستدعي Chat API
يضيف المثال التالي مستخدمًا إلى مساحة تتضمّن مصادقة التطبيق:
Python
- في دليل العمل، أنشئ ملفًا باسم
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
: مفتاح واجهة برمجة التطبيقات الذي أنشأته لإنشاء نقطة نهاية الخدمة لواجهة Chat API.SPACE
: اسم مساحة، ويمكنك الحصول عليه من خلال طريقةspaces.list
في Chat API، أو من عنوان URL الخاص بمساحة.USER
: رقم تعريف المستخدم
في دليل العمل، أنشئ النموذج وشغِّله:
python3 chat_membership_app_create.py
إضافة مستخدمين أو مجموعات Google إلى مساحة بصفتك مشرف Google Workspace
إذا كنت مشرفًا في Google Workspace، يمكنك استدعاء طريقة create()
لإضافة مستخدمين أو مجموعات Google أو تطبيقات Chat إلى أي مساحة في مؤسسة Google Workspace.
لاستدعاء هذه الطريقة بصفتك مشرفًا في Google Workspace، اتّبِع الخطوات التالية:
- استدعِ الطريقة باستخدام مصادقة المستخدم، وحدِّد نطاق تفويض يتيح استدعاء الطريقة باستخدام امتيازات المشرف.
- في طلبك، حدِّد مَعلمة طلب البحث
useAdminAccess
بالقيمةtrue
.
لمزيد من المعلومات والأمثلة، يُرجى الاطّلاع على مقالة إدارة مساحات Google Chat بصفتك مشرف Google Workspace.
القيود والاعتبارات
- باستخدام مصادقة التطبيق، يمكن لتطبيق Chat دعوة المستخدمين أو إضافتهم، ولكن ليس إلى مجموعات Google أو تطبيقات Chat. لإضافة نفسه، يجب أن يستخدم تطبيق الدردشة مصادقة المستخدم مع نطاق التفويض
chat.memberships
.
مواضيع ذات صلة
- الاطّلاع على تفاصيل حول عضوية مستخدم أو تطبيق Chat
- إدراج الأعضاء في مساحة
- تعديل عضوية مستخدم في مساحة Google Chat
- إزالة مستخدم أو تطبيق Chat من مساحة