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 |
إجمالي عدد المساحات التي تطابق طلب البحث في كل الصفحات. إذا كانت النتيجة أكثر من 10000 مسافة، تكون هذه القيمة تقديرية. |
نطاقات التفويض
يتطلب استخدام أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly
لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.