يوضّح هذا الدليل كيفية استخدام الأسلوب
list()
في مورد Membership
من Google Chat API لإدراج الأعضاء في
مساحة كقائمة مُقسّمة إلى صفحات وقابلة للفلترة للاشتراكات في مساحة.
- عند إدراج الاشتراكات باستخدام مصادقة التطبيق، يتم إدراج الاشتراكات في المساحات التي يمكن لتطبيق Chat الوصول إليها، ولكن يتم استبعاد اشتراكات تطبيق Chat، بما في ذلك اشتراكه الخاص.
- عند إدراج العضويات باستخدام مصادقة المستخدم، يتم إدراج العضويات في المساحات التي يمكن للمستخدم المُعتمَد الوصول إليها.
- عند إدراج العضويات بصفتك مشرفًا في Google Workspace مع مصادقة مستخدم باستخدام امتيازات المشرف، يتم إدراج العضويات في جميع المساحات في مؤسستك على 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.
- مساحة Google Chat يكون فيها المستخدم الذي تمّت المصادقة عليه أو تطبيق Chat الذي يجري المكالمة عضوًا لتسجيل الدخول بصفتك تطبيق Chat، أضِف تطبيق Chat إلى المساحة.
Python
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى 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.
- مساحة Google Chat يكون فيها المستخدم الذي تمّت المصادقة عليه أو تطبيق Chat الذي يجري المكالمة عضوًا لتسجيل الدخول بصفتك تطبيق Chat، أضِف تطبيق 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 Chat يكون فيها المستخدم الذي تمّت المصادقة عليه أو تطبيق Chat الذي يجري المكالمة عضوًا لتسجيل الدخول بصفتك تطبيق Chat، أضِف تطبيق Chat إلى المساحة.
برمجة تطبيقات
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم ورمز ووصف لتطبيق Chat.
- أنشئ مشروعًا مستقلاً في Apps Script، وفعِّل خدمة Chat المتقدّمة.
- في هذا الدليل، يجب استخدام مصادقة المستخدم أو مصادقة التطبيق. للمصادقة بصفتك تطبيق Chat، أنشئ بيانات اعتماد حساب الخدمة. لمعرفة الخطوات، يُرجى الاطّلاع على مقالة المصادقة والتفويض بصفتك تطبيق Google Chat.
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
- مساحة Google Chat يكون فيها المستخدم الذي تمّت المصادقة عليه أو تطبيق Chat الذي يجري المكالمة عضوًا لتسجيل الدخول بصفتك تطبيق Chat، أضِف تطبيق Chat إلى المساحة.
إدراج الأعضاء في مساحة مع مصادقة المستخدم
لإدراج المستخدمين و"مجموعات Google" وتطبيق Chat في مساحة يمكن للمستخدم الذي تم مصادقة هويته الوصول إليها، عليك إدخال ما يلي في طلبك:
- باستخدام
مصادقة المستخدم،
حدِّد نطاق التفويض
chat.memberships.readonly
أوchat.memberships
. - استخدِم الطريقة
ListMemberships()
. - لعرض "مجموعات Google"، اضبط مَعلمة الطلب
showGroups
علىtrue
.
يسرد المثال التالي أعضاء "مجموعة Google" والمستخدمين والتطبيقات الظاهرة للمستخدم الذي تم مصادقة هويته.
Node.js
Python
Java
برمجة تطبيقات
لتنفيذ هذا المثال، استبدِل SPACE_NAME
برقم التعريف من حقل
name
المجموعة. يمكنك الحصول على المعرّف من خلال استدعاء الوسيطة
ListSpaces()
أو من عنوان URL للمساحة.
تعرِض Google Chat API قائمة بأعضاء "مجموعة Google" والمستخدمين والتطبيقات من المساحة المحدّدة.
إدراج الأعضاء في مساحة باستخدام مصادقة التطبيق
لإدراج المستخدمين وتطبيق Chat في مساحة يمكن للتطبيق الذي تمّت مصادقته الوصول إليها، يجب إدخال ما يلي في طلبك:
- باستخدام
مصادقة التطبيق،
حدِّد نطاق تفويض
chat.bot
. - استخدِم الطريقة
ListMemberships()
. - لعرض "مجموعات Google"، اضبط مَعلمة الطلب
showGroups
علىtrue
.
يسرد المثال التالي أعضاء المساحة (وليس مدراء المساحة) الذين يمكنهم الاطّلاع على تطبيق Chat:
Node.js
Python
Java
برمجة تطبيقات
لتنفيذ هذا المثال، استبدِل SPACE_NAME
برقم التعريف من حقل
name
المجموعة. يمكنك الحصول على المعرّف من خلال استدعاء الوسيطة
ListSpaces()
أو من عنوان URL للمساحة.
تعرض Google Chat API قائمة بأعضاء المساحة (باستثناء مدراء المساحة) من المساحة المحدّدة.
إدراج الأعضاء كمشرفين في Google Workspace
إذا كنت مشرفًا في Google Workspace، يمكنك استدعاء الأسلوب
ListMemberships()
لعرض العضويات لأي مساحة في
مؤسّسة Google Workspace. لا تعرض واجهة برمجة التطبيقات Chat API سوى عضويات المستخدمين، سواء الداخليين أو الخارجيين، أو مجموعات Google من مؤسستك، وبالتالي تحذف العضويات في أي تطبيقات Chat.
لاستدعاء هذه الطريقة بصفتك مشرفًا في Google Workspace، اتّبِع الخطوات التالية:
- استخدِم طريقة المصادقة للمستخدم، وحدِّد نطاق التفويض الذي يتيح استدعاء الطريقة باستخدام امتيازات المشرف.
- في طلبك، حدِّد مَعلمات طلب البحث التالية:
- اضبط
useAdminAccess
علىtrue
. - لعرض المستخدِمين فقط، اضبط
filter
لـmember.type
علىHUMAN
. - لعرض المستخدمين والمجموعات، اضبط
filter
لـmember.type
ليس يساويBOT
AND
showGroups
يساويtrue
.
- اضبط
لمزيد من المعلومات والأمثلة، يُرجى الاطّلاع على مقالة إدارة مساحات Google Chat بصفتك مشرفًا في Google Workspace.
تخصيص تقسيم الصفحات أو فلترة القائمة
لعرض العضويات، نقْل مَعلمات طلب البحث التالية لأجل تخصيص تقسيم الصفحات للعضويات المُدرَجة أو فلترتها:
pageSize
: الحد الأقصى لعدد الاشتراكات المطلوب عرضها قد تعرِض الخدمة عددًا أقل من هذه القيمة. في حال عدم تحديد عدد، يتم عرض 100 مساحة كحد أقصى. الحد الأقصى للقيمة هو 1,000، ويتم تلقائيًا تغيير القيم التي تزيد عن 1,000 إلى 1,000.pageToken
: رمز مميّز للصفحة، تم تلقّيه من مكالمة سابقة في مساحات القائمة قدِّم هذا الرمز المميّز لاسترداد الصفحة اللاحقة. عند تقسيم الصفحات، يجب أن تتطابق قيمة الفلترة مع الطلب الذي قدّم الرمز المميّز للصفحة. قد يؤدي إدخال قيمة مختلفة إلى نتائج غير متوقّعة.-
filter
: فلتر طلب بحث تتطلّب مصادقة المستخدم. لمعرفة تفاصيل طلبات البحث المتوافقة، يُرجى الاطّلاع على مرجعListMembershipsRequest
.
مواضيع ذات صلة
- الحصول على تفاصيل حول اشتراك مستخدم أو تطبيق Chat
- دعوة مستخدم أو تطبيق Chat أو إضافتهما إلى مساحة
- تعديل عضوية مستخدم في مساحة على Google Chat
- إزالة مستخدم أو تطبيق Chat من مساحة