يوضّح هذا الدليل كيفية استخدام الأسلوب
list()
في مورد Space
من Google Chat API لعرض المساحات. تُعرِض دالة Listing
spaces قائمة بالمساحات مُقسّمة إلى صفحات وقابلة للفلترة.
يمثّل
مورد Space
مكانًا يمكن فيه للمستخدمين وتطبيقات Chat إرسال الرسائل
ومشاركة الملفات والتعاون. هناك عدة أنواع من المساحات:
- الرسائل المباشرة هي محادثات بين مستخدمَين أو مستخدم وأحد تطبيقات Chat.
- المحادثات الجماعية هي محادثات بين ثلاثة مستخدمين أو أكثر وتطبيقات Chat.
- المساحات المُسمّاة هي أماكن دائمة يرسل من خلالها المستخدمون الرسائل ويشاركون الملفات ويتعاونون في ما بينها.
يؤدي إدراج المساحات باستخدام مصادقة التطبيق إلى إدراج المساحات التي يمكن لتطبيق Chat الوصول إليها. يؤدي إدراج المساحات باستخدام مصادقة المستخدم إلى إدراج المساحات التي يمكن للمستخدم الذي تمّت المصادقة عليه الوصول إليها.
المتطلبات الأساسية
Node.js
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد البيئة:
- أنشِئ مشروعًا على Google Cloud.
- ضبط شاشة موافقة OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
- ثبِّت Node.js مكتبة عميل Cloud.
- أنشئ بيانات اعتماد الوصول استنادًا إلى طريقة المصادقة التي تريد استخدامها في طلب Google Chat API:
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي. - لمصادقة تطبيق Chat،
أنشئ بيانات اعتماد
حساب الخدمة واحفظ بيانات الاعتماد كملف JSON باسم
credentials.json
.
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق 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.
Java
- حساب Business أو Enterprise Google Workspace لديه إذن بالوصول إلى 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.
- أنشِئ مشروعًا مستقلاً لبرمجة التطبيقات، وفعِّل خدمة Chat المتقدّمة.
- في هذا الدليل، يجب استخدام مصادقة المستخدم أو مصادقة التطبيق. للمصادقة بصفتك تطبيق Chat، أنشئ بيانات اعتماد حساب الخدمة. لمعرفة الخطوات، يُرجى الاطّلاع على مقالة المصادقة والتفويض بصفتك تطبيق Google Chat.
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
إدراج المساحات التي تتضمّن مصادقة المستخدم
لإدراج المساحات في Google Chat، أرسِل ما يلي في طلبك:
- باستخدام
مصادقة المستخدم،
حدِّد نطاق التفويض
chat.spaces.readonly
أوchat.spaces
. - استخدِم الطريقة
ListSpaces()
.
يسرد المثال التالي المساحات المُسمّاة (ولكن ليس المحادثات الجماعية والرسائل المباشرة التي يتم استبعادها) التي تظهر للمستخدم الذي تم مصادقة هويته:
Node.js
Python
Java
برمجة تطبيقات
تعرض واجهة Chat API قائمة مساحات مقسّمة على صفحات.
إدراج المساحات التي تستخدم مصادقة التطبيقات
لإدراج المساحات في Google Chat، عليك تضمين ما يلي في طلبك:
- باستخدام
مصادقة التطبيق،
حدِّد نطاق تفويض
chat.bot
. - استخدِم الطريقة
ListSpaces()
.
يسرد المثال التالي المساحات المُسمّاة (وليس المحادثات الجماعية والرسائل المباشرة) الظاهرة لتطبيق Chat:
Node.js
Python
Java
برمجة تطبيقات
تعرض واجهة Chat API قائمة مساحات مقسّمة على صفحات.
تخصيص تقسيم الصفحات أو فلترة القائمة
لعرض المساحات في Google Chat، نقْل مَعلمات طلب البحث التالية الاختيارية لتخصيص تقسيم الصفحات للمساحات المدرَجة أو فلترتها:
pageSize
: الحد الأقصى لعدد المسافات المطلوب عرضها. قد تعرِض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديد عدد، يتم عرض 100 مسافة كحد أقصى. الحد الأقصى للقيمة هي 1,000، ويتم تغيير القيم الأعلى من 1,000 تلقائيًا إلى 1,000.pageToken
: رمز مميّز للصفحة، تم تلقّيه من مكالمة سابقة في مساحات القوائم قدِّم هذا الرمز المميّز لاسترداد الصفحة اللاحقة. عند تقسيم الصفحات، يجب أن تتطابق قيمة الفلترة مع الطلب الذي قدّم الرمز المميّز للصفحة. قد يؤدي إدخال قيمة مختلفة إلى نتائج غير متوقّعة.filter
: فلتر طلب بحث للاطّلاع على تفاصيل طلبات البحث المتوافقة، يُرجى الاطّلاع على مرجعListSpacesRequest
.
مواضيع ذات صلة
- أنشئ مساحة.
- إعداد مساحة
- الحصول على تفاصيل عن مساحة
- تعديل مساحة
- حذف مساحة
- العثور على مساحة رسائل مباشرة