Method: subscriptions.patch

Met à jour ou renouvelle un abonnement Google Workspace. Pour savoir comment utiliser cette méthode, consultez Mettre à jour ou renouveler un abonnement Google Workspace.

Pour un abonnement à une ressource cible Chat, vous pouvez mettre à jour un abonnement comme suit :

Requête HTTP

PATCH https://workspaceevents.googleapis.com/v1/{subscription.name=subscriptions/*}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
subscription.name

string

Identifiant. Nom de ressource de l'abonnement.

Format: subscriptions/{subscription}

Paramètres de requête

Paramètres
updateMask

string (FieldMask format)

Facultatif. Champ à mettre à jour. Si ce champ est omis, tous les champs inclus dans la requête sont mis à jour.

Vous pouvez mettre à jour l'un des champs suivants dans un abonnement :

  • expireTime : code temporel d'expiration de l'abonnement.
  • ttl : durée de vie (TTL) ou durée de l'abonnement.
  • eventTypes : liste des types d'événements à recevoir concernant la ressource cible.

Lorsque vous utilisez le caractère générique * (équivalent à PUT), les champs omis sont définis sur des valeurs vides et rejetés s'ils ne sont pas valides.
validateOnly

boolean

Facultatif. Si la valeur est true, la requête est validée et prévisualisée, mais l'abonnement n'est pas mis à jour.

Corps de la requête

Le corps de la requête contient une instance de Subscription.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

  • Le champ metadata contient un tableau vide.
  • Le champ response contient une instance mise à jour de Subscription.

Niveaux d'accès des autorisations

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

  • 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/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.users.readstate.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.