REST Resource: subscriptions

{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}

string

Facultatif. Immuable. Identifiant. Nom de ressource de l'abonnement.

Format : subscriptions/{subscription}

string

Uniquement en sortie. Identifiant unique attribué par le système pour l'abonnement.

string

Obligatoire. Immuable. Ressource Google Workspace surveillée pour les événements, au format nom complet de la ressource. Pour en savoir plus sur les ressources cibles et les événements qu'elles prennent en charge, consultez Événements Google Workspace compatibles.

Un utilisateur ne peut autoriser votre application qu'à créer un seul abonnement pour une ressource cible donnée. Si votre application tente de créer un autre abonnement avec les mêmes identifiants utilisateur, la requête renvoie une erreur ALREADY_EXISTS.

string

Obligatoire. Immuable. Liste à puces. Entrée pour la création d'un abonnement. Sinon, il ne s'agit que de la sortie. Un ou plusieurs types d'événements à recevoir concernant la ressource cible. Mise en forme conforme à la spécification CloudEvents.

Les types d'événements compatibles dépendent de la ressource cible de votre abonnement. Pour en savoir plus, consultez Événements Google Workspace compatibles.

Par défaut, vous recevez également les événements concernant le cycle de vie de votre abonnement. Vous n'avez pas besoin de spécifier d'événements de cycle de vie pour ce champ.

Si vous spécifiez un type d'événement qui n'existe pas pour la ressource cible, la requête renvoie un code d'état HTTP 400 Bad Request.

object (PayloadOptions)

Facultatif. Options concernant les données à inclure dans la charge utile de l'événement. Disponible uniquement pour les événements Google Chat.

object (NotificationEndpoint)

Obligatoire. Immuable. Point de terminaison sur lequel l'abonnement envoie des événements, par exemple un sujet Pub/Sub.

enum (State)

Uniquement en sortie. État de l'abonnement. Détermine si l'abonnement peut recevoir des événements et les transmettre au point de terminaison des notifications.

enum (ErrorType)

Uniquement en sortie. Erreur qui a suspendu l'abonnement.

Pour réactiver l'abonnement, corrigez l'erreur et appelez la méthode subscriptions.reactivate.

string

Uniquement en sortie. Utilisateur qui a autorisé la création de l'abonnement.

Format : users/{user}

Pour les utilisateurs de Google Workspace, la valeur {user} correspond au champ user.id de l'API Directory.

string (Timestamp format)

Uniquement en sortie. Date et heure de création de l'abonnement.

string (Timestamp format)

Uniquement en sortie. Dernière mise à jour de l'abonnement.

boolean

Uniquement en sortie. Si la valeur est true, l'abonnement est en cours de mise à jour.

string

Facultatif. Cette somme de contrôle est calculée par le serveur en fonction de la valeur d'autres champs et peut être envoyée lors des demandes de mise à jour afin de s'assurer que le client dispose d'une valeur à jour avant de continuer.

string (Timestamp format)

La valeur par défaut n'est pas vide. Code temporel en UTC de l'expiration de l'abonnement. Toujours affiché en sortie, quelle que soit la fonction utilisée en entrée.

string (Duration format)

Uniquement en entrée. Valeur TTL (Time To Live) ou durée de l'abonnement. Si aucune valeur n'est spécifiée ou si elle est définie sur 0, utilise la durée maximale possible.

{
  "includeResource": boolean,
  "fieldMask": string
}

boolean

Facultatif. Indique si la charge utile de l'événement inclut des données sur la ressource qui a été modifiée. Par exemple, pour un événement où un message Google Chat a été créé, la charge utile contient-elle des données sur la ressource Message ? Si la valeur est "false", la charge utile de l'événement n'inclut que le nom de la ressource modifiée.

string (FieldMask format)

Facultatif. Si includeResource est défini sur true, la liste des champs à inclure dans la charge utile de l'événement. Séparez les champs par une virgule. Par exemple, pour inclure l'expéditeur d'un message Google Chat et l'heure de création, saisissez message.sender,message.createTime. Si cette valeur est omise, la charge utile inclut tous les champs de la ressource.

Si vous spécifiez un champ qui n'existe pas pour la ressource, le système l'ignore.

{

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}

string

Immuable. Sujet Cloud Pub/Sub qui reçoit les événements pour l'abonnement

Format : projects/{project}/topics/{topic}

Vous devez créer le sujet dans le projet Google Cloud où vous créez cet abonnement.

Lorsque le sujet reçoit des événements, ceux-ci sont encodés en tant que messages Cloud Pub/Sub. Pour en savoir plus, consultez la section Liaison de protocole Google Cloud Pub/Sub pour CloudEvents.