- Ressource: Montre
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- WatchTarget
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CloudPubsubTopic
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- EventType
- ErrorType
- État
- Méthodes
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 ( |
Champs | |
---|---|
id |
Uniquement en sortie. L'ID de cette montre. Voir les remarques sur |
target |
Obligatoire. Où envoyer la notification. |
eventType |
Obligatoire. Type d'événement à surveiller. |
createTime |
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 : |
expireTime |
Uniquement en sortie. Horodatage de la date d'expiration. Chaque appel Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
errorType |
Uniquement en sortie. Type d'erreur le plus récent pour une tentative d'envoi. Pour recommencer à regarder le formulaire, vous pouvez appeler |
state |
Uniquement en sortie. État actuel de la montre. Pour en savoir plus sur les montres suspendues, consultez le |
WatchTarget
Cible de diffusion des notifications.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union target . Obligatoire. Cible de diffusion des notifications. target ne peut être qu'un des éléments suivants : |
|
topic |
Un sujet Pub/Sub. Pour recevoir des notifications, le sujet doit accorder des droits de publication au compte de service Forms Les garanties de livraison Pub/Sub doivent être prises en compte. |
CloudPubsubTopic
Un sujet Pub/Sub.
Représentation JSON |
---|
{ "topicName": string } |
Champs | |
---|---|
topicName |
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 |
|
---|---|
|
Créez une montre. |
|
Supprimer une montre |
|
Renvoie une liste des montres appartenant au projet à l'origine de l'appel. |
|
Renouvelez une montre existante pendant sept jours. |