Method: spaces.findGroupChats

تمام فاصله‌های دارای spaceType == GROUP_CHAT را برمی‌گرداند، که عضویت‌های انسانی آنها دقیقاً شامل کاربر فراخواننده و کاربران مشخص شده در FindGroupChatsRequest.memberships است.

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

مجموعه مشخص‌شده از کاربران باید فقط شامل عضویت‌های انسانی (غیربرنامه‌ای) باشد. درخواستی که شامل کاربران غیرانسانی باشد، هیچ فاصله‌ای را برنمی‌گرداند.

نیاز به احراز هویت کاربر با یکی از حوزه‌های مجوز زیر دارد:

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
user[]

string

نام منابع همه کاربران انسانی در چت گروهی با کاربر تماس گیرنده. برنامه‌های چت نمی‌توانند در درخواست گنجانده شوند.

قالب: users/{user} ، که در آن {user} یا id شخص از People API است، یا id کاربر در Directory API. به عنوان مثال، برای یافتن همه چت‌های گروهی با کاربر تماس‌گیرنده و دو کاربر دیگر، با شناسه‌های پروفایل People API 123456789 و 987654321 ، می‌توانید users/123456789 و users/987654321 استفاده کنید. همچنین می‌توانید از ایمیل به عنوان نام مستعار برای {user} استفاده کنید. به عنوان مثال، users/example@gmail.com که در آن example@gmail.com ایمیل کاربر Google Chat است.

وقتی کاربر تماس‌گیرنده، کاربر Google Workspace باشد، همه کاربران درخواست‌شده باید عضو همان سازمان Google Workspace باشند که کاربر تماس‌گیرنده عضو آن است.

pageSize

integer

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

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

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

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

pageToken

string

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

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

spaceView

enum ( SpaceView )

نوع نمای فضای درخواستی. در صورت عدم تنظیم، پیش‌فرض روی SPACE_VIEW_RESOURCE_NAME_ONLY است. درخواست‌هایی که SPACE_VIEW_EXPANDED را مشخص می‌کنند باید شامل محدوده‌هایی باشند که امکان خواندن داده‌های فضا را فراهم می‌کنند، برای مثال، https://www.googleapis.com/auth/chat.spaces یا https://www.googleapis.com/auth/chat.spaces.readonly .

درخواست بدنه

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

بدنه پاسخ

پاسخی حاوی فضاهای گفتگوی گروهی دقیقاً با نام کاربر فراخواننده و کاربران درخواست‌شده.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

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

object ( Space )

فهرست فضاهای موجود در صفحه درخواستی (یا صفحه اول).

nextPageToken

string

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

دامنه‌های مجوز

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

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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

اسپیس ویو

نمایی که مشخص می‌کند کدام فیلدها باید در منبع Space پر شوند. برای اطمینان از سازگاری با نسخه‌های آینده، توصیه می‌کنیم کد شما مقادیر اضافی را در نظر بگیرد.

انوم‌ها
SPACE_VIEW_UNSPECIFIED مقدار پیش‌فرض/تنظیم نشده.
SPACE_VIEW_RESOURCE_NAME_ONLY فقط نام منبع Space را پر می‌کند.
SPACE_VIEW_EXPANDED فیلدهای منبع فضا را پر می‌کند. توجه: فیلد permissionSettings پر نمی‌شود. درخواست‌هایی که SPACE_VIEW_EXPANDED را مشخص می‌کنند باید شامل محدوده‌هایی باشند که امکان خواندن داده‌های فضا را فراهم می‌کنند، برای مثال، https://www.googleapis.com/auth/chat.spaces یا https://www.googleapis.com/auth/chat.spaces.readonly .