Method: subscriptions.list

اشتراک‌های Google Workspace را فهرست می‌کند. برای یادگیری نحوه استفاده از این روش، به فهرست اشتراک‌های Google Workspace مراجعه کنید.

درخواست HTTP

GET https://workspaceevents.googleapis.com/v1/subscriptions

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

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

پارامترها
pageSize

integer

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

اگر مشخص نشده باشد یا روی 0 تنظیم شود، حداکثر 50 اشتراک برگردانده می شود.

حداکثر مقدار 100 است. اگر مقداری بیش از 100 را مشخص کنید، سیستم فقط 100 اشتراک را برمی گرداند.

pageToken

string

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

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

filter

string

مورد نیاز. یک فیلتر پرس و جو

می‌توانید اشتراک‌ها را بر اساس نوع رویداد ( event_types ) و منبع هدف ( target_resource ) فیلتر کنید.

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

برای فیلتر کردن بر اساس نوع رویداد و منبع هدف، از عملگر AND استفاده کنید و نام کامل منبع را مشخص کنید، مانند //chat.googleapis.com/spaces/{space} .

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

event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//chat.googleapis.com/spaces/{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created" ) AND
  target_resource="//chat.googleapis.com/spaces/{space}"

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

درخواست بدن

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

بدن پاسخگو

پیام پاسخ برای SubscriptionsService.ListSubscriptions .

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

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

object ( Subscription )

لیست اشتراک ها

nextPageToken

string

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

محدوده مجوز

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

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly

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