Method: spaces.list

فضاهایی را که تماس گیرنده عضوی از آنها است را فهرست می کند. تا زمانی که اولین پیام ارسال نشود، چت‌های گروهی و پیام‌های پیامکی فهرست نمی‌شوند. برای مثال، لیست فاصله ها را ببینید.

از انواع احراز هویت زیر پشتیبانی می کند:

برای فهرست کردن همه فضاهای نامگذاری شده توسط سازمان Google Workspace، به جای آن از روش spaces.search() با استفاده از امتیازات سرپرست Workspace استفاده کنید.

درخواست HTTP

GET https://chat.googleapis.com/v1/spaces

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
page Size

integer

اختیاری. حداکثر تعداد فاصله برای بازگشت. ممکن است این سرویس کمتر از این مقدار را برگرداند.

اگر نامشخص باشد، حداکثر 100 فاصله برگردانده می شود.

حداکثر مقدار 1000 است. اگر از مقداری بیش از 1000 استفاده می کنید، به طور خودکار به 1000 تغییر می کند.

مقادیر منفی یک خطای INVALID_ARGUMENT را برمی‌گرداند.

page Token

string

اختیاری. یک نشانه صفحه، دریافت شده از یک تماس قبلی در لیست. این پارامتر را برای بازیابی صفحه بعدی ارائه کنید.

هنگام صفحه‌بندی، مقدار فیلتر باید با تماسی که توکن صفحه را ارائه می‌کند، مطابقت داشته باشد. عبور یک مقدار متفاوت ممکن است منجر به نتایج غیرمنتظره شود.

filter

string

اختیاری. یک فیلتر پرس و جو

می توانید فضاها را بر اساس نوع فاصله ( spaceType ) فیلتر کنید.

برای فیلتر بر اساس نوع فاصله، باید مقدار enum معتبر، مانند SPACE یا GROUP_CHAT را مشخص کنید ( spaceType نمی تواند SPACE_TYPE_UNSPECIFIED باشد). برای پرس و جو برای انواع فضای چندگانه، از عملگر OR استفاده کنید.

به عنوان مثال، پرس و جوهای زیر معتبر هستند:

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

درخواست‌های نامعتبر توسط سرور با خطای INVALID_ARGUMENT رد می‌شوند.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پاسخ برای یک لیست درخواست فاصله.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
فیلدها
spaces[]

object ( Space )

فهرست فضاهای موجود در صفحه درخواستی (یا اول). توجه: فیلد permissionSettings در شی Space برای درخواست‌های فهرست برگردانده نمی‌شود.

next Page Token

string

برای بازیابی صفحه بعدی نتایج، می توانید یک نشانه به عنوان pageToken ارسال کنید. اگر خالی باشد، هیچ صفحه بعدی وجود ندارد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.