Method: subscriptions.list

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

درخواست HTTP

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

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

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

پارامترها
pageSize

integer

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

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

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

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
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.readonly

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