REST Resource: forms.watches

Ressource: Watch

Surveillance des événements pour un formulaire. Lorsque l'événement désigné se produit, une notification est publiée sur la cible spécifiée. Les attributs de la notification incluront une clé formId contenant l'ID du formulaire surveillé et une clé eventType contenant la chaîne du type.

Les messages sont envoyés avec une distribution au moins une fois et ne sont supprimés que dans des circonstances exceptionnelles. En règle générale, toutes les notifications doivent être distribuées de manière fiable en quelques secondes. Toutefois, dans certains cas, elles peuvent être retardées.

Une surveillance expire sept jours après sa création, sauf si elle est renouvelée avec watches.renew.

Représentation JSON 
{
  "id": string,
  "target": {
    object (WatchTarget)
  },
  "eventType": enum (EventType),
  "createTime": string,
  "expireTime": string,
  "errorType": enum (ErrorType),
  "state": enum (State)
}
Champs
id

string

Uniquement en sortie. ID de cette montre. Voir les remarques sur CreateWatchRequest.watch_id.
target

object (WatchTarget)

Obligatoire. À qui envoyer la notification.
eventType

enum (EventType)

Obligatoire. Type d'événement à surveiller.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
expireTime

string (Timestamp format)

Uniquement en sortie. Code temporel d'expiration. Chaque appel watches.renew réinitialise cette valeur sur sept jours plus tard.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
errorType

enum (ErrorType)

Uniquement en sortie. Type d'erreur le plus récent pour une tentative de diffusion. Pour recommencer à surveiller le formulaire, vous pouvez appeler watches.renew, ce qui effacera également ces informations d'erreur.
state

enum (State)

Uniquement en sortie. État actuel de la montre. Pour en savoir plus sur les montres suspendues, consultez errorType.

WatchTarget

Cible de diffusion de la notification.

Représentation JSON 
{

  // Union field target can be only one of the following:
  "topic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field target.
}
Champs
Champ d'union target. Obligatoire. Cible de diffusion de la notification. target ne peut être qu'un des éléments suivants :
topic

object (CloudPubsubTopic)

Un sujet Pub/Sub Pour recevoir des notifications, le sujet doit accorder des droits de publication au compte de service Forms serviceAccount:forms-notifications@system.gserviceaccount.com. Seul le projet propriétaire d'un sujet peut créer une surveillance avec celui-ci.

Les garanties de diffusion Pub/Sub doivent être prises en compte.

CloudPubsubTopic

Un sujet Pub/Sub

Représentation JSON 
{
  "topicName": string
}
Champs
topicName

string

Obligatoire. Nom de sujet Pub/Sub complet dans lequel publier les événements. Ce sujet doit appartenir au projet appelant et déjà exister dans Pub/Sub.

EventType

Types d'événements pouvant être regardés.

Enums
EVENT_TYPE_UNSPECIFIED Type d'événement non spécifié. Cette valeur ne doit pas être utilisée.
SCHEMA Type d'événement du schéma. Une montre avec ce type d'événement sera avertie des modifications apportées au contenu et aux paramètres du formulaire.
RESPONSES Type d'événement de réponse. Une surveillance avec ce type d'événement recevra une notification lorsque des réponses aux formulaires seront envoyées.

ErrorType

Types d'erreurs possibles.

Enums
ERROR_TYPE_UNSPECIFIED Type d'erreur non spécifié.
PROJECT_NOT_AUTHORIZED Le projet Cloud n'a pas accès au formulaire surveillé. Cela se produit si l'utilisateur a révoqué l'autorisation permettant à votre projet d'accéder à ses formulaires. Les montres associées à cette erreur ne seront pas réessayées. Pour tenter de recommencer à regarder le formulaire, vous pouvez appeler watches.renew.
NO_USER_ACCESS L'utilisateur qui a accordé l'accès n'a plus accès au formulaire surveillé. Les montres associées à cette erreur ne seront pas réessayées. Pour tenter de recommencer à regarder le formulaire, vous pouvez appeler watches.renew.
OTHER_ERRORS Un autre type d'erreur s'est produit. La poursuite des notifications dépend de la state de la montre.

État

États possibles de la montre.

Enums
STATE_UNSPECIFIED État non spécifié.
ACTIVE La montre est active.
SUSPENDED La montre est suspendue en raison d'une erreur pouvant être résolue. La montre continuera d'exister jusqu'à son expiration. Pour tenter de réactiver la montre, vous pouvez appeler watches.renew.

Méthodes

create

 Créez une montre.

delete

 Supprimer une montre

list

 Renvoie la liste des montres appartenant au projet appelant.

renew

 Renouveler une surveillance existante pendant sept jours.