Method: subscriptions.list

Répertorie les abonnements Google Workspace. Pour savoir comment utiliser cette méthode, consultez Répertorier les abonnements Google Workspace.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal d'abonnements à afficher. Le service peut renvoyer moins que cette valeur.

Si aucune valeur n'est spécifiée ou si elle est définie sur 0, jusqu'à 50 abonnements sont renvoyés.

La valeur maximale est 100. Si vous spécifiez une valeur supérieure à 100, le système ne renvoie que 100 abonnements.
pageToken

string

Facultatif. Jeton de page reçu d'un précédent appel à la liste des abonnements. Indiquez ce paramètre pour récupérer la page suivante.

Lors de la pagination, la valeur du filtre doit correspondre à l'appel qui a fourni le jeton de page. La transmission d'une valeur différente peut entraîner des résultats inattendus.
filter

string

Obligatoire. Un filtre de requête.

Vous pouvez filtrer les abonnements par type d'événement (event_types) et par ressource cible (target_resource).

Vous devez spécifier au moins un type d'événement dans votre requête. Pour filtrer plusieurs types d'événements, utilisez l'opérateur OR.

Pour filtrer par type d'événement et par ressource cible, utilisez l'opérateur AND et spécifiez le nom complet de la ressource, par exemple //chat.googleapis.com/spaces/{space}.

Par exemple, les requêtes suivantes sont valides:

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}"

Le serveur rejette les requêtes non valides avec une erreur INVALID_ARGUMENT.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour SubscriptionsService.ListSubscriptions

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
Champs
subscriptions[]

object (Subscription)

Liste des abonnements.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • 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

Pour en savoir plus, consultez le Guide relatif aux autorisations.