REST Resource: forms.watches

Ressource: Regarder

Montre connectée aux événements d'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 incluent une clé formId contenant l'ID du formulaire surveillé et une clé eventType contenant 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 sont envoyées de manière fiable en quelques secondes. Toutefois, dans certains cas, elles peuvent être retardées.

Une montre expire sept jours après sa création, sauf si elle est renouvelée auprès de 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. Identifiant de cette montre. Voir les notes 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 de l'élément.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

expireTime

string (Timestamp format)

Uniquement en sortie. Horodatage. Chaque appel watches.renew est réinitialisé sur sept jours à compter de la date du jour.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. 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 de diffusion. Pour recommencer à regarder le formulaire, vous pouvez appeler watches.renew, ce qui efface é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 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 qui possède un sujet peut créer une montre avec ce sujet.

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 complet de 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 pouvant être surveillé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 "Réponses". Une montre avec ce type d'événement sera avertie lors de l'envoi de réponses aux formulaires.

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 accordée à votre projet pour accéder à ses formulaires. Les montres présentant cette erreur ne seront pas relancées. Pour réessayer de 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 présentant cette erreur ne seront pas relancées. Pour réessayer de 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 qui peut être résolue. La montre continuera d'exister jusqu'à son expiration. Pour essayer de réactiver la montre, vous pouvez appeler le watches.renew

Méthodes

create

Créer une montre.

delete

supprimer une montre ;

list

Renvoyez la liste des montres appartenant au projet appelant.

renew

Renouvelez une montre existante pour sept jours.