يوضّح هذا الدليل كيفية استخدام الأسلوب
list()
في مورد Space
من Google Chat API لعرض المساحات. البيانات
تعرض المسافات قائمة مسافات مقسّمة إلى صفحات قابلة للفلترة.
تشير رسالة الأشكال البيانية
مرجع Space
يمثّل مكانًا يمكن فيه للمستخدمين والتطبيقات في Chat إرسال رسائل
ومشاركتها والتعاون. هناك عدة أنواع من المساحات:
- الرسائل المباشرة هي محادثات بين مستخدمين أو مستخدم تطبيق Chat.
- الدردشات الجماعية هي محادثات بين ثلاثة مستخدمين أو أكثر تطبيقات Chat
- المساحات المُسمّاة هي أماكن دائمة يرسل فيها المستخدمون الرسائل ويشاركون الملفات ويتعاونون معًا.
يؤدي إدراج المساحات باستخدام مصادقة التطبيق إلى إدراج المساحات التي يمكن لتطبيق Chat الوصول إليها. يؤدي إدراج المساحات باستخدام مصادقة المستخدم إلى إدراج المساحات التي يمكن للمستخدم الذي تمّت المصادقة عليه الوصول إليها.
المتطلبات الأساسية
Node.js
- نشاط تجاري أو مؤسسة حساب Google Workspace لديه إذن بالوصول إلى 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
- حساب على 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
- نشاط تجاري أو مؤسسة حساب 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 لديه إذن بالوصول إلى Google Chat
- إعداد بيئتك:
- أنشِئ مشروعًا على Google Cloud.
- إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
- إنشاء مشروع "برمجة تطبيقات Google" مستقل وفعِّل خدمة المحادثة المتقدّمة.
- في هذا الدليل، يجب استخدام مصادقة المستخدم أو مصادقة التطبيق. للمصادقة بصفتك تطبيق Chat، أنشئ بيانات اعتماد حساب الخدمة. لمعرفة الخطوات، يُرجى الاطّلاع على المصادقة والتفويض تطبيق Google Chat
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
إدراج المساحات التي تتضمّن مصادقة المستخدم
لإدراج المساحات في Google Chat، عليك إدخال ما يلي في طلبك:
- باستخدام
مصادقة المستخدم،
حدِّد نطاق التفويض
chat.spaces.readonly
أوchat.spaces
. - عليك استدعاء
ListSpaces()
.
يسرد المثال التالي المساحات المُسمّاة (ولكن ليس المحادثات الجماعية والمحادثات المباشرة الرسائل، التي تتم تصفيتها) مرئية للمستخدم الذي تمت مصادقته:
Node.js
Python
Java
برمجة تطبيقات
تعرض واجهة برمجة تطبيقات Chat قائمة مرقّمة للمساحات.
إدراج المساحات التي تستخدم مصادقة التطبيقات
لإدراج المساحات في 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
المرجع.
مواضيع ذات صلة
- أنشئ مساحة.
- إعداد مساحة
- الحصول على تفاصيل عن مساحة
- تعديل مساحة
- حذف المساحة
- العثور على مساحة رسائل مباشرة