Method: subscriptions.list

Elenca gli abbonamenti a Google Workspace. Per informazioni su come utilizzare questo metodo, consulta Elencare gli abbonamenti a Google Workspace.

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 valore inferiore a questo valore.

Se il criterio non viene specificato o se viene impostato su 0, vengono restituite fino a 50 sottoscrizioni.

Il valore massimo è 100. Se specifichi un valore superiore a 100, il sistema restituisce solo 100 sottoscrizioni.
pageToken

string

(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata di iscrizioni all'elenco. Fornisci questo parametro per recuperare la pagina successiva.

Durante l'impaginazione, il valore del filtro deve corrispondere alla chiamata che ha fornito il token della pagina. Il passaggio di un valore diverso potrebbe portare a risultati imprevisti.
filter

string

Obbligatorio. Un filtro di query.

Puoi filtrare le iscrizioni per tipo di evento (event_types) e 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 sia per tipo di evento che per 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.