REST Resource: forms.watches

Ressource: Watch

Une montre qui surveille les événements d'un formulaire. Lorsque l'événement spécifié se produit, une notification est publiée à la cible spécifiée. Les attributs de la notification incluent une clé formId qui contient l'ID du formulaire surveillé et une clé eventType qui contient la chaîne du type.

Les messages sont distribués 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 envoyées de manière fiable en quelques secondes. Cependant, dans certains cas, les notifications peuvent être retardées.

Une montre 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. L'ID de cette montre. Voir les remarques sur CreateWatchRequest.watch_id.
target

object (WatchTarget)

Obligatoire. Où envoyer la notification.
eventType

enum (EventType)

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

string (Timestamp format)

Uniquement en sortie. Horodatage de la création.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la date d'expiration. Chaque appel watches.renew redéfinit les paramètres sur sept jours plus tard.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
errorType

enum (ErrorType)

Uniquement en sortie. Type d'erreur le plus récent pour une tentative d'envoi. Pour recommencer à regarder le formulaire, vous pouvez appeler watches.renew, ce qui efface également les informations sur l'erreur.
state

enum (State)

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

WatchTarget

Cible de diffusion des notifications.

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 des notifications. 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 auquel appartient un sujet peut l'utiliser pour créer une montre.

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

CloudPubsubTopic

Un sujet Pub/Sub.

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

string

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

EventType

Types d'événements possibles 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 associée à ce type d'événement sera informée des modifications apportées au contenu et aux paramètres du formulaire.
RESPONSES Type d'événement des réponses. Une montre associée à ce type d'événement recevra une notification lorsque des réponses 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 d'accès de votre projet à son ou ses formulaires. Les montres associées à cette erreur ne feront pas l'objet d'une nouvelle tentative. Pour réessayer de regarder le formulaire, vous pouvez passer un appel au 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 feront pas l'objet d'une nouvelle tentative. Pour réessayer de regarder le formulaire, vous pouvez passer un appel au watches.renew
OTHER_ERRORS Un autre type d'erreur s'est produit. La poursuite ou non des notifications dépend de l'state de la montre.

État

États de la page de lecture possibles.

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

Méthodes

create

 Créez une montre.

delete

 Supprimer une montre

list

 Renvoie une liste des montres appartenant au projet à l'origine de l'appel.

renew

 Renouvelez une montre existante pendant sept jours.