REST Resource: forms.watches

Recurso: Watch

Uma observação de eventos para um formulário. Quando o evento designado acontecer, uma notificação será publicada para o destino especificado. Os atributos da notificação incluirão uma chave formId que tem o ID do formulário assistido e uma chave eventType que tem a string do tipo.

As mensagens são enviadas pelo menos uma vez e são descartadas apenas em circunstâncias incomuns. Normalmente, todas as notificações devem ser entregues com segurança em alguns segundos. No entanto, em algumas situações as notificações podem ser entregues com atraso.

Um relógio expira sete dias após ser criado, a menos que seja renovado com watches.renew

Representação JSON 
{
  "id": string,
  "target": {
    object (WatchTarget)
  },
  "eventType": enum (EventType),
  "createTime": string,
  "expireTime": string,
  "errorType": enum (ErrorType),
  "state": enum (State)
}
Campos
id

string

Apenas saída. O ID deste relógio. Veja as notas em CreateWatchRequest.watch_id.
target

object (WatchTarget)

Obrigatório. Para onde enviar a notificação.
eventType

enum (EventType)

Obrigatório. Que tipo de evento é preciso observar.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de quando ele foi criado.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de quando isso vai expirar. Cada chamada watches.renew é redefinida para sete dias no futuro.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
errorType

enum (ErrorType)

Apenas saída. O tipo de erro mais recente de uma tentativa de entrega. Para começar a assistir ao formulário novamente, é possível fazer uma chamada para watches.renew, que também limpa essas informações de erro.
state

enum (State)

Apenas saída. O estado atual do relógio. Veja mais detalhes sobre relógios suspensos em errorType.

Destino de observação

O destino da entrega de notificações.

Representação JSON 
{

  // Union field target can be only one of the following:
  "topic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field target.
}
Campos
Campo de união target. Obrigatório. O destino da entrega de notificações. target pode ser apenas de um dos tipos a seguir:
topic

object (CloudPubsubTopic)

Um tópico do Pub/Sub. Para receber notificações, o tópico precisa conceder privilégios de publicação à conta de serviço do Formulários serviceAccount:forms-notifications@system.gserviceaccount.com. Somente o projeto proprietário de um tópico pode criar um relógio com ele.

As garantias de entrega do Pub/Sub precisam ser consideradas.

CloudPubsubTopic

Um tópico do Pub/Sub.

Representação JSON 
{
  "topicName": string
}
Campos
topicName

string

Obrigatório. Um nome de tópico do Pub/Sub totalmente qualificado para publicar os eventos. Esse tópico precisa pertencer ao projeto de chamada e já existe no Pub/Sub.

EventType

Tipos de eventos que podem ser assistidos.

Enums
EVENT_TYPE_UNSPECIFIED Tipo de evento não especificado. Esse valor não deve ser usado.
SCHEMA O tipo de evento do esquema. Um relógio com este tipo de evento será notificado sobre alterações no conteúdo e nas configurações do formulário.
RESPONSES O tipo de evento de respostas. Um relógio com este tipo de evento será notificado quando as respostas ao formulário forem enviadas.

ErrorType

Tipos de erros possíveis.

Enums
ERROR_TYPE_UNSPECIFIED Tipo de erro não especificado.
PROJECT_NOT_AUTHORIZED O projeto em nuvem não tem acesso ao formulário que está sendo monitorado. Isso ocorre quando o usuário revogou a autorização do projeto para acessar os formulários. Visualizações com esse erro não serão repetidas. Para tentar começar a assistir ao formulário novamente, ligue para watches.renew
NO_USER_ACCESS O usuário que concedeu o acesso não tem mais acesso ao formulário que está sendo monitorado. Visualizações com esse erro não serão repetidas. Para tentar começar a assistir ao formulário novamente, ligue para watches.renew
OTHER_ERRORS Ocorreu outro tipo de erro. A exibição de notificações depende do relógio state.

Estado

Possíveis estados de exibição.

Enums
STATE_UNSPECIFIED Estado não especificado.
ACTIVE O relógio está ativo.
SUSPENDED O relógio foi suspenso devido a um erro que pode ser resolvido. O relógio continuará existindo até expirar. Para tentar reativar o relógio, faça uma chamada para watches.renew

Métodos

create

 Crie um novo relógio.

delete

 Excluir um relógio.

list

 Retorne uma lista dos relógios que pertencem ao projeto que invocou.

renew

 Renovar um relógio existente por sete dias.