REST Resource: forms.watches

Ресурс: Смотреть

След за событиями для формы. Когда произойдет назначенное событие, уведомление будет опубликовано в указанной цели. Атрибуты уведомления будут включать ключ formId , который содержит идентификатор просматриваемой формы, и ключ eventType , который имеет строку типа.

Сообщения отправляются с доставкой хотя бы один раз и удаляются только в чрезвычайных обстоятельствах. Обычно все уведомления должны быть надежно доставлены в течение нескольких секунд; однако в некоторых ситуациях уведомления могут задерживаться.

Срок действия часов истекает через семь дней после их создания, если они не продлены с помощью watches.renew

JSON-представление 
{
  "id": string,
  "target": {
    object (WatchTarget)
  },
  "eventType": enum (EventType),
  "createTime": string,
  "expireTime": string,
  "errorType": enum (ErrorType),
  "state": enum (State)
}
Поля
id

string

Только вывод. Идентификатор этих часов. См. примечания к CreateWatchRequest.watch_id .

target

object ( WatchTarget )

Необходимый. Куда отправить уведомление.

eventType

enum ( EventType )

Необходимый. Какой тип событий следует отслеживать.

createTime

string ( Timestamp format)

Только вывод. Временная метка, когда это было создано.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

expireTime

string ( Timestamp format)

Только вывод. Временная метка истечения срока действия. Каждый вызов watches.renew сбрасывает это значение на семь дней в будущем.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

errorType

enum ( ErrorType )

Только вывод. Самый последний тип ошибки при попытке доставки. Чтобы снова начать просмотр формы, можно выполнить вызов watches.renew , который также очистит эту информацию об ошибке.

state

enum ( State )

Только вывод. Текущее состояние часов. Дополнительную информацию о подвесных часах можно найти, проверив errorType .

WatchTarget

Цель доставки уведомлений.

JSON-представление 
{
  "topic": {
    object (CloudPubsubTopic)
  }
}
Поля
topic

object ( CloudPubsubTopic )

Тема Pub/Sub. Чтобы получать уведомления, тема должна предоставить права публикации учетной записи службы форм serviceAccount:forms-notifications@system.gserviceaccount.com . Только проект, владеющий темой, может создавать часы с ее использованием.

Следует учитывать гарантии доставки Pub/Sub.

ОблакоPubsubTopic

Тема Pub/Sub.

JSON-представление 
{
  "topicName": string
}
Поля
topicName

string

Необходимый. Полное имя темы Pub/Sub, в которой будут публиковаться события. Эта тема должна принадлежать вызывающему проекту и уже существовать в Pub/Sub.

тип события

Возможные типы событий, которые можно просмотреть.

Перечисления
EVENT_TYPE_UNSPECIFIED Неопределенный тип события. Это значение не следует использовать.
SCHEMA Тип события схемы. Часы с этим типом событий будут уведомлены об изменениях в содержимом формы и настройках.
RESPONSES Тип события ответов. Часы с этим типом события будут уведомлены при отправке ответов в форме.

Тип ошибки

Возможные типы ошибок.

Перечисления
ERROR_TYPE_UNSPECIFIED Неуказанный тип ошибки.
PROJECT_NOT_AUTHORIZED Облачный проект не имеет доступа к просматриваемой форме. Это происходит, если пользователь отозвал у вашего проекта разрешение на доступ к своим формам. Часы с этой ошибкой не будут повторно проверены. Чтобы попытаться снова начать просмотр формы, можно позвонить в watches.renew
NO_USER_ACCESS Пользователь, предоставивший доступ, больше не имеет доступа к просматриваемой форме. Часы с этой ошибкой не будут повторно проверены. Чтобы попытаться снова начать просмотр формы, можно позвонить в watches.renew
OTHER_ERRORS Произошла ошибка другого типа. Будут ли уведомления продолжаться, зависит от state просмотра.

Состояние

Возможные состояния наблюдения.

Перечисления
STATE_UNSPECIFIED Неустановленное состояние.
ACTIVE Часы активны.
SUSPENDED Часы приостановлены из-за ошибки, которую можно устранить. Часы будут продолжать существовать до истечения срока их действия. Чтобы попытаться повторно активировать часы, можно позвонить на watches.renew

Методы

create

 Создайте новые часы.

delete

 Удалить часы.

list

 Возвращает список часов, принадлежащих вызывающему проекту.

renew

 Продлите существующие часы на семь дней.