فهرستی از فضاهای یک سازمان Google Workspace را بر اساس جستجوی سرپرست برمیگرداند.
به احراز هویت کاربر با حقوق مدیر نیاز دارد. در درخواست، useAdminAccess
روی true
تنظیم کنید.
درخواست HTTP
GET https://chat.googleapis.com/v1/spaces:search
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
پارامترها | |
---|---|
use Admin Access | وقتی کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به این روش در حال حاضر فقط از دسترسی ادمین پشتیبانی می کند، بنابراین فقط |
page Size | حداکثر تعداد فاصله برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند. اگر نامشخص باشد، حداکثر 100 فاصله برگردانده می شود. حداکثر مقدار 1000 است. اگر از مقداری بیش از 1000 استفاده می کنید، به طور خودکار به 1000 تغییر می کند. |
page Token | یک نشانه دریافت شده از تماس قبلی با فضاهای جستجو. این پارامتر را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد. انتقال مقادیر مختلف به سایر پارامترها ممکن است منجر به نتایج غیرمنتظره شود. |
query | مورد نیاز. یک جست و جو می توانید با استفاده از پارامترهای زیر جستجو کنید:
در زمینه های مختلف، فقط اپراتورهای در میان همان فیلد، پرس و جوهای مثال زیر معتبر هستند:
|
order By | اختیاری. نحوه ترتیب لیست فضاها ویژگی های پشتیبانی شده برای سفارش عبارتند از:
مقادیر عملیات سفارش معتبر عبارتند از:
نحو پشتیبانی شده عبارتند از:
|
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
با لیستی از فضاهای مربوط به درخواست فضاهای جستجو پاسخ دهید.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"spaces": [
{
object ( |
فیلدها | |
---|---|
spaces[] | صفحه ای از فضاهای درخواستی |
next Page Token | نشانه ای که می توان از آن برای بازیابی صفحه بعدی استفاده کرد. اگر این فیلد خالی باشد، هیچ صفحه بعدی وجود ندارد. |
total Size | تعداد کل فضاهایی که با پرس و جو مطابقت دارند، در تمام صفحات. اگر نتیجه بیش از 10000 فاصله باشد، این مقدار تخمینی است. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/chat.admin.spaces
-
https://www.googleapis.com/auth/chat.admin.spaces.readonly
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.