تعرض قائمة المساحات في مؤسسة Google Workspace استنادًا إلى بحث المشرف.
تتطلب مصادقة المستخدمين الذين لديهم امتيازات المشرف. في الطلب، اضبط السمة useAdminAccess
على true
.
طلب HTTP
GET https://chat.googleapis.com/v1/spaces:search
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات طلب البحث
المعلمات | |
---|---|
use |
عند يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب هذا الحقل إما لا تتيح هذه الطريقة حاليًا سوى إذن وصول المشرف، وبالتالي لا يتم قبول سوى |
page |
الحد الأقصى لعدد المسافات المعروضة قد تعرض الخدمة عددًا أقل من هذه القيمة. وفي حال عدم تحديد قيمة هذه السمة، يتم عرض 100 مسافة كحدّ أقصى. الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000. |
page |
رمز مميّز تم تلقّيه من المكالمة السابقة لمساحات البحث قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند تقسيم الصفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم رمز تعريف الصفحة. قد يؤدي تمرير قيم مختلفة إلى المعلَمات الأخرى إلى نتائج غير متوقعة. |
query |
مطلوب. طلب بحث يمكنك البحث باستخدام المعلمات التالية:
يقبل كل من تكون لا يقبل يقبل العمود لا يقبل المتغيّر في الحقول المختلفة، يمكن استخدام ضمن الحقل نفسه، لا يتوافق طلبات البحث التالية صالحة:
|
order |
اختياريّ. كيفية ترتيب قائمة المساحات السمات المتوافقة مع الطلب هي:
في ما يلي القيم الصالحة لعملية الترتيب:
في ما يلي بنية الجملة المتوافقة:
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
ردّ يتضمّن قائمة بالمساحات المتوافقة مع طلب مساحات البحث.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"spaces": [
{
object ( |
الحقول | |
---|---|
spaces[] |
صفحة من المساحات المطلوبة. |
next |
هو رمز مميّز يمكن استخدامه لاسترداد الصفحة التالية. إذا كان هذا الحقل فارغًا، يعني ذلك أنّه ما مِن صفحات لاحقة. |
total |
إجمالي عدد المساحات التي تتطابق مع طلب البحث في جميع الصفحات إذا كانت النتيجة أكثر من 10,000 مساحة، تكون هذه القيمة تقديرية. |
نطاقات الأذونات
يتطلب هذا الإعداد أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.