REST Resource: forms.watches

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Recurso: Watch

Un reloj para los eventos de un formulario Cuando ocurra el evento designado, se publicará una notificación en el destino especificado. Los atributos de la notificación incluirán una clave formId con el ID del formulario observado y una clave eventType con la string del tipo.

Los mensajes se envían con al menos una entrega y solo se descartan en circunstancias extraordinarias. Por lo general, todas las notificaciones se deben entregar de manera confiable en pocos segundos. Sin embargo, en algunos casos, se pueden retrasar.

Un reloj vence siete días después de su creación, a menos que se renueve con watches.renew

Representación JSON 
{
  "id": string,
  "target": {
    object (WatchTarget)
  },
  "eventType": enum (EventType),
  "createTime": string,
  "expireTime": string,
  "errorType": enum (ErrorType),
  "state": enum (State)
}
Campos
id

string

Solo salida. El ID de este reloj. Consulta las notas sobre CreateWatchRequest.watch_id.
target

object (WatchTarget)

Obligatorio. Dónde enviar la notificación.
eventType

enum (EventType)

Obligatorio. El tipo de evento que se debe supervisar.
createTime

string (Timestamp format)

Solo salida. Marca de tiempo de la fecha de creación.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Solo salida. Marca de tiempo del vencimiento del vencimiento. Cada llamada a watches.renew se restablece en siete días en el futuro.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
errorType

enum (ErrorType)

Solo salida. El tipo de error más reciente de un intento de entrega. Para volver a ver el formulario, puedes realizar una llamada al número watches.renew, lo que también borrará la información del error.
state

enum (State)

Solo salida. El estado actual del reloj. Para obtener más información sobre los relojes suspendidos, consulta errorType.

Objetivo de observación

Es el destino de la entrega de notificaciones.

Representación JSON 
{
  "topic": {
    object (CloudPubsubTopic)
  }
}
Campos
topic

object (CloudPubsubTopic)

Un tema de Pub/Sub. Para recibir notificaciones, el tema debe otorgar privilegios de publicación a la cuenta de servicio de Formularios serviceAccount:forms-notifications@system.gserviceaccount.com. Solo el proyecto que posee un tema puede crear un reloj.

Se deben considerar las garantías de entrega de Pub/Sub.

Subtema de Cloud Pub/Sub

Un tema de Pub/Sub.

Representación JSON 
{
  "topicName": string
}
Campos
topicName

string

Obligatorio. Un nombre de tema de Pub/Sub completamente calificado para publicar los eventos. Este tema debe ser propiedad del proyecto que realiza la llamada y ya debe existir en Pub/Sub.

EventType

Posibles tipos de eventos que se pueden mirar.

Enumeradores
EVENT_TYPE_UNSPECIFIED Tipo de evento no especificado. No se debe usar este valor.
SCHEMA El tipo de evento del esquema. Un reloj con este tipo de evento recibirá una notificación sobre los cambios en el contenido y la configuración del formulario.
RESPONSES El tipo de evento de respuestas. Se enviará una notificación a un reloj con este tipo de evento cuando se envíen las respuestas del formulario.

ErrorType

Tipos de errores posibles.

Enumeradores
ERROR_TYPE_UNSPECIFIED Tipo de error no especificado.
PROJECT_NOT_AUTHORIZED El proyecto de Cloud no tiene acceso al formulario que se está viendo. Esto ocurre si el usuario revocó la autorización para que el proyecto acceda a los formularios. No se reintentará mirar los videos que tengan este error. Para intentar ver el formulario de nuevo, puedes realizar una llamada al watches.renew
NO_USER_ACCESS El usuario que otorgó el acceso ya no tiene acceso al formulario que se está viendo. No se reintentará mirar los videos que tengan este error. Para intentar ver el formulario de nuevo, puedes realizar una llamada al watches.renew
OTHER_ERRORS Se produjo otro tipo de error. La continuidad de las notificaciones depende del state del reloj.

Estado

Estados posibles de visualización.

Enumeradores
STATE_UNSPECIFIED Estado sin especificar.
ACTIVE El reloj está activo.
SUSPENDED El reloj está suspendido debido a un error que puede resolverse. El reloj seguirá existiendo hasta que venza. Para intentar reactivar el reloj, puedes llamar a watches.renew

Métodos

create

 Crear un reloj nuevo

delete

 Borrar un reloj

list

 Muestra una lista de los relojes que pertenecen al proyecto que se invoca.

renew

 Renovar un reloj existente por siete días