يشرح هذا الدليل كيفية استخدام طريقة
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 الخاصة بنظام Node.js.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
credentials.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 للغة Python.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
credentials.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 للغة Java.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
credentials.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.
- أنشئ مشروعًا مستقلاً في "برمجة تطبيقات Google"، وفعِّل خدمة 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 قائمة بأعضاء المجموعات والأشخاص والتطبيقات من المساحة المحدّدة.
عرض قائمة بالأعضاء في مساحة تتطلّب مصادقة التطبيق
لإدراج المستخدمين وتطبيق 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 من مساحة