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