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