Method: subscriptions.list

Liste les abonnements Google Workspace. Pour savoir comment utiliser cette méthode, consultez Lister les abonnements Google Workspace.

Requête HTTP

GET https://workspaceevents.googleapis.com/v1beta/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 un nombre inférieur à cette valeur.

Si aucune valeur n'est spécifiée ou si la valeur est définie sur 0, un maximum de 50 abonnements sont renvoyés.

La valeur maximale est de 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 appel de liste des abonnements précédent. Fournissez ce paramètre pour récupérer la page suivante.

Lors de la pagination, la valeur du filtre doit correspondre à l'appel ayant fourni le jeton de page. Si vous transmettez une autre valeur, vous risquez d'obtenir des résultats inattendus.
filter

string

Obligatoire. 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 à la fois 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
  • 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

Pour en savoir plus, consultez le guide d'autorisation.