Method: subscriptions.list
درخواست 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
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2024-11-12 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2024-11-12 بهوقت ساعت هماهنگ جهانی."],[[["Lists existing Google Workspace subscriptions, allowing retrieval of details like event types and target resources."],["Enables filtering of subscriptions by event types and target resource using query parameters, requiring at least one event type for filtering."],["Uses pagination to retrieve large lists of subscriptions, providing a `nextPageToken` for accessing subsequent pages."],["Requires specific OAuth scopes for authorization, such as `https://www.googleapis.com/auth/chat.bot` or `https://www.googleapis.com/auth/chat.spaces`, to access and manage subscriptions."],["Returns a response body containing a list of subscriptions and a token for pagination if further pages exist."]]],["This document outlines how to list Google Workspace subscriptions using a `GET` request to `https://workspaceevents.googleapis.com/v1/subscriptions`. Key parameters include `pageSize` (max 100) to limit results, `pageToken` for pagination, and a mandatory `filter` to specify event types and/or target resources using `OR` and `AND` operators. The request body is empty. The response body contains a list of `subscriptions` and an optional `nextPageToken` for subsequent pages. Specific OAuth scopes are required for authorization.\n"]]
