يشرح هذا الدليل طريقة استخدام الطريقة
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 Client Library لنظام التشغيل Node.js.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد المصادقة بها في طلب Google Chat API:
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي. - للمصادقة على أنّه تطبيق Chat، أنشِئ بيانات اعتماد حساب الخدمة واحفظ بيانات الاعتماد كملف JSON باسم
credentials.json
.
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
Python
- حساب Business أو Enterprise Google Workspace لديه إذن بالوصول إلى Google Chat.
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
- ثبِّت مكتبة Cloud Client Library لـ Python.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد المصادقة بها في طلب Google Chat API:
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي. - لمصادقة تطبيق Chat،
أنشئ بيانات اعتماد
حساب الخدمة واحفظ بيانات الاعتماد كملف JSON باسم
credentials.json
.
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
Java
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة موافقة OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
- ثبِّت مكتبة Cloud Client Library لـ Java.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد المصادقة بها في طلب Google Chat API:
- للمصادقة بصفتك مستخدم Chat، أنشِئ بيانات اعتماد معرِّف عميل OAuth واحفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي. - لمصادقة تطبيق Chat،
أنشئ بيانات اعتماد
حساب الخدمة واحفظ بيانات الاعتماد كملف JSON باسم
credentials.json
.
- للمصادقة بصفتك مستخدم Chat، أنشِئ بيانات اعتماد معرِّف عميل OAuth واحفظ بيانات الاعتماد كملف JSON باسم
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
برمجة تطبيقات
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل Google Chat API واضبطها باستخدام اسم تطبيق Chat ورمزه ووصفه.
- أنشئ مشروعًا مستقلاً في Apps Script، وفعِّل خدمة Chat المتقدّمة.
- في هذا الدليل، يجب استخدام مصادقة المستخدم أو مصادقة التطبيق. للمصادقة كتطبيق Chat، أنشئ بيانات اعتماد حساب الخدمة. لمعرفة الخطوات، يُرجى الاطّلاع على مقالة المصادقة والتفويض بصفتك تطبيق Google Chat.
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
دعوة مستخدم أو إضافته إلى مساحة بصفته مستخدمًا
لدعوة مستخدم أو إضافته إلى مساحة باستخدام مصادقة المستخدم، عليك إرسال ما يلي في طلبك:
- حدِّد نطاق تفويض
chat.memberships
. - استخدِم الطريقة
CreateMembership()
. - نقْل
parent
كاسم المورد للمساحة التي تريد إنشاء اشتراك فيها. - نقْل
membership
كمثيل منMembership
مع ضبط حقلهmember
على ما يلي:- تم ضبط الحقل
type
علىHUMAN
. - الحقل
name
مضبوط علىusers/{user}
حيث يكون{user}
هو المستخدم الذي تريد إضافته إلى المساحة. لتحديد مستخدم Chat، استبدِل{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
- تم ضبط الحقل
يضيف المثال التالي مستخدمًا إلى مساحة باستخدام مصادقة المستخدم:
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
، وهو اسم بديل يمثّل التطبيق ويُستخدَم عند memanggil 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، انتقِل إلى رمز القائمة > واجهات برمجة التطبيقات والخدمات > بيانات الاعتماد.
- انقر على إنشاء بيانات اعتماد > مفتاح واجهة برمجة التطبيقات.
- يتم عرض مفتاح واجهة برمجة التطبيقات الجديد.
- انقر على رمز النسخ لنسخ مفتاح واجهة برمجة التطبيقات لاستخدامه في رمز تطبيقك. ويمكن أيضًا العثور على مفتاح واجهة برمجة التطبيقات في قسم "مفاتيح واجهة برمجة التطبيقات" في بيانات اعتماد مشروعك.
- انقر على تقييد المفتاح لتعديل الإعدادات المتقدّمة والحد من استخدام مفتاح واجهة برمجة التطبيقات. لمزيد من التفاصيل، يُرجى الاطّلاع على فرض قيود على مفاتيح واجهة برمجة التطبيقات.
كتابة نص برمجي يستدعي 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 مصادقة المستخدم من خلال نطاق تفويض
chat.memberships
.
مواضيع ذات صلة
- الحصول على تفاصيل حول اشتراك مستخدم أو تطبيق Chat
- قائمة الأعضاء في مساحة
- تعديل عضوية مستخدم في مساحة على Google Chat
- إزالة مستخدم أو تطبيق Chat من مساحة