Method: subscriptions.list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Richiesta HTTP
GET https://workspaceevents.googleapis.com/v1/subscriptions
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri di query
| Parametri |
pageSize |
integer
(Facoltativo) Il numero massimo di abbonamenti da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore. Se non specificato o impostato su 0, vengono restituite fino a 50 iscrizioni. Il valore massimo è 100. Se specifichi un valore superiore a 100, il sistema restituisce solo 100 iscrizioni.
|
pageToken |
string
(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata dell'elenco degli abbonamenti. Fornisci questo parametro per recuperare la pagina successiva. Durante la paginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token di pagina. Il passaggio di un valore diverso potrebbe portare a risultati imprevisti.
|
filter |
string
Obbligatorio. Un filtro query. Puoi filtrare gli abbonamenti in base al tipo di evento (event_types) e alla risorsa di destinazione (target_resource). Devi specificare almeno un tipo di evento nella query. Per filtrare in base a più tipi di eventi, utilizza l'operatore OR. Per filtrare in base al tipo di evento e alla risorsa di destinazione, utilizza l'operatore AND e specifica il nome completo della risorsa, ad esempio //chat.googleapis.com/spaces/{space}. Ad esempio, le seguenti query sono valide:
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}"
Il server rifiuta le query non valide con un errore INVALID_ARGUMENT.
|
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
Il messaggio di risposta per SubscriptionsService.ListSubscriptions.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
| Rappresentazione JSON |
{
"subscriptions": [
{
object (Subscription)
}
],
"nextPageToken": string
} |
| Campi |
subscriptions[] |
object (Subscription)
Elenco degli abbonamenti.
|
nextPageToken |
string
Un token, che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.
|
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti 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
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 2025-07-25 UTC."],[[["\u003cp\u003eLists existing Google Workspace subscriptions, allowing retrieval of details like event types and target resources.\u003c/p\u003e\n"],["\u003cp\u003eEnables filtering of subscriptions by event types and target resource using query parameters, requiring at least one event type for filtering.\u003c/p\u003e\n"],["\u003cp\u003eUses pagination to retrieve large lists of subscriptions, providing a \u003ccode\u003enextPageToken\u003c/code\u003e for accessing subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific OAuth scopes for authorization, such as \u003ccode\u003ehttps://www.googleapis.com/auth/chat.bot\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/chat.spaces\u003c/code\u003e, to access and manage subscriptions.\u003c/p\u003e\n"],["\u003cp\u003eReturns a response body containing a list of subscriptions and a token for pagination if further pages exist.\u003c/p\u003e\n"]]],["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"],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\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/v1/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/v1/subscriptions/list#google.apps.events.subscriptions.v1.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/v1/subscriptions#Subscription) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `subscriptions[]` | `object (`[Subscription](/workspace/events/reference/rest/v1/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\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
