Method: subscriptions.list
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
HTTP-Anfrage
GET https://workspaceevents.googleapis.com/v1beta/subscriptions
Die URL verwendet die Syntax der gRPC-Transcodierung.
Abfrageparameter
| Parameter |
pageSize |
integer
Optional. Die maximale Anzahl von Abos, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben oder auf 0 gesetzt, werden bis zu 50 Abos zurückgegeben. Der Höchstwert ist 100. Wenn Sie einen Wert über 100 angeben, werden nur 100 Abos zurückgegeben.
|
pageToken |
string
Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Abos empfangen wurde. Geben Sie diesen Parameter an, um die nächste Seite abzurufen. Beim Paginieren muss der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe eines anderen Werts kann zu unerwarteten Ergebnissen führen.
|
filter |
string
Erforderlich. Ein Abfragefilter. Sie können Abos nach Ereignistyp (event_types) und Zielressource (target_resource) filtern. Sie müssen in Ihrer Abfrage mindestens einen Ereignistyp angeben. Wenn Sie nach mehreren Ereignistypen filtern möchten, verwenden Sie den Operator OR. Wenn Sie nach Ereignistyp und Zielressource filtern möchten, verwenden Sie den Operator AND und geben Sie den vollständigen Ressourcennamen an, z. B. //chat.googleapis.com/spaces/{space}. Die folgenden Abfragen sind beispielsweise gültig:
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}"
Der Server lehnt ungültige Anfragen mit dem Fehler INVALID_ARGUMENT ab.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Die Antwortnachricht für SubscriptionsService.ListSubscriptions.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
| JSON-Darstellung |
{
"subscriptions": [
{
object (Subscription)
}
],
"nextPageToken": string
} |
| Felder |
subscriptions[] |
object (Subscription)
Liste der Abos.
|
nextPageToken |
string
Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.
|
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
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
Weitere Informationen finden Sie im Autorisierungsleitfaden.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[[["\u003cp\u003eLists existing Google Workspace subscriptions, allowing developers to manage event delivery configurations.\u003c/p\u003e\n"],["\u003cp\u003eProvides filtering options by event types and target resources for refined subscription retrieval.\u003c/p\u003e\n"],["\u003cp\u003eUses pagination to handle large result sets, enabling retrieval of subscriptions in manageable chunks.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access, ensuring secure management of sensitive data.\u003c/p\u003e\n"],["\u003cp\u003eAvailable within the Google Workspace Developer Preview Program, offering early access to this functionality.\u003c/p\u003e\n"]]],["This describes how to list Google Workspace subscriptions using a `GET` request to `https://workspaceevents.googleapis.com/v1beta/subscriptions`. You can filter subscriptions by event type and target resource using the `filter` query parameter. Optional parameters include `pageSize` (max 100) and `pageToken` for pagination. The request body must be empty. The response contains a list of subscriptions and a `nextPageToken` for subsequent pages. Access requires specified OAuth scopes.\n"],null,["# Method: subscriptions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListSubscriptionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](/workspace/preview), which grants early access to certain features.\n\nLists Google Workspace subscriptions. To learn how to use this method, see [List Google Workspace subscriptions](https://developers.google.com/workspace/events/guides/list-subscriptions).\n\n### HTTP request\n\n`GET https://workspaceevents.googleapis.com/v1beta/subscriptions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of subscriptions to return. The service might return fewer than this value. If unspecified or set to `0`, up to 50 subscriptions are returned. The maximum value is 100. If you specify a value more than 100, the system only returns 100 subscriptions. |\n| `pageToken` | `string` Optional. A page token, received from a previous list subscriptions call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results. |\n| `filter` | `string` Required. A query filter. You can filter subscriptions by event type (`event_types`) and target resource (`target_resource`). You must specify at least one event type in your query. To filter for multiple event types, use the `OR` operator. To filter by both event type and target resource, use the `AND` operator and specify the full resource name, such as `//chat.googleapis.com/spaces/{space}`. For example, the following queries are valid: 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}\" The server rejects invalid queries with an `INVALID_ARGUMENT` error. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response message for [SubscriptionsService.ListSubscriptions](/workspace/events/reference/rest/v1beta/subscriptions/list#google.apps.events.subscriptions.v1beta.SubscriptionsService.ListSubscriptions).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"subscriptions\": [ { object (/workspace/events/reference/rest/v1beta/subscriptions#Subscription) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `subscriptions[]` | `object (`[Subscription](/workspace/events/reference/rest/v1beta/subscriptions#Subscription)`)` List of subscriptions. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chat.bot`\n- `\n https://www.googleapis.com/auth/chat.spaces`\n- `\n https://www.googleapis.com/auth/chat.spaces.readonly`\n- `\n https://www.googleapis.com/auth/chat.messages`\n- `\n https://www.googleapis.com/auth/chat.messages.readonly`\n- `\n https://www.googleapis.com/auth/chat.messages.reactions`\n- `\n https://www.googleapis.com/auth/chat.messages.reactions.readonly`\n- `\n https://www.googleapis.com/auth/chat.memberships`\n- `\n https://www.googleapis.com/auth/chat.memberships.readonly`\n- `\n https://www.googleapis.com/auth/meetings.space.created`\n- `\n https://www.googleapis.com/auth/meetings.space.readonly`\n- `\n https://www.googleapis.com/auth/drive`\n- `\n https://www.googleapis.com/auth/drive.file`\n- `\n https://www.googleapis.com/auth/drive.metadata`\n- `\n https://www.googleapis.com/auth/drive.metadata.readonly`\n- `\n https://www.googleapis.com/auth/drive.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
