REST Resource: forms.watches

资源：Watch

监控表单事件。当指定的事件发生时，系统会向指定的目标发布通知。通知的属性将包括一个包含所监控表单 ID 的 formId 键，以及一个包含类型字符串的 eventType 键。

消息以“至少一次传送”方式发送，只有在极端情况下才会被丢弃。通常情况下，所有通知都应在几秒钟内可靠地传送；但在某些情况下，通知可能会延迟。

观看会在创建 7 天后过期，除非使用 watches.renew 续订

JSON 表示法 
{
  "id": string,
  "target": {
    object (WatchTarget)
  },
  "eventType": enum (EventType),
  "createTime": string,
  "expireTime": string,
  "errorType": enum (ErrorType),
  "state": enum (State)
}
字段
id

string

仅限输出。此手表的 ID。请参阅有关 CreateWatchRequest.watch_id 的备注。
target

object (WatchTarget)

必需。通知的发送位置。
eventType

enum (EventType)

必需。要监控的事件类型。
createTime

string (Timestamp format)

仅限输出。创建此内容时的时间戳。

使用 RFC 3339，其中生成的输出将始终采用 Z 归一化，并使用 0、3、6 或 9 个小数位。也接受除“Z”以外的偏移量。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
expireTime

string (Timestamp format)

仅限输出。此令牌的过期时间戳。每次 watches.renew 调用都会将其重置为未来 7 天。

使用 RFC 3339，其中生成的输出将始终采用 Z 归一化，并使用 0、3、6 或 9 个小数位。也接受除“Z”以外的偏移量。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
errorType

enum (ErrorType)

仅限输出。上次尝试提交时发生的错误类型。如需重新开始监控表单，可以调用 watches.renew，这也会清除此错误信息。
state

enum (State)

仅限输出。手表的当前状态。如需详细了解已暂停的手表，请查看 errorType。

WatchTarget

通知传送的目标。

JSON 表示法 
{

  // Union field target can be only one of the following:
  "topic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field target.
}
字段
联合字段 target。必需。通知传送的目标。target 只能是下列其中一项：
topic

object (CloudPubsubTopic)

Pub/Sub 主题。如需接收通知，该主题必须向 Google 表单服务账号 serviceAccount:forms-notifications@system.gserviceaccount.com 授予发布权限。只有拥有某个主题的项目才能使用该主题创建观测。

应考虑 Pub/Sub 传送保证。

CloudPubsubTopic

Pub/Sub 主题。

JSON 表示法 
{
  "topicName": string
}
字段
topicName

string

必需。要将事件发布到的完全限定 Pub/Sub 主题名称。此主题必须归调用项目所有，并且已在 Pub/Sub 中存在。

EventType

可监控的可能事件类型。

枚举
EVENT_TYPE_UNSPECIFIED 未指定事件类型。请勿使用此值。
SCHEMA 架构事件类型。具有此事件类型的手表会收到表单内容和设置更改的通知。
RESPONSES 响应事件类型。当有表单回复被提交时，监视器会收到此事件类型的通知。

ErrorType

可能的错误类型。

枚举
ERROR_TYPE_UNSPECIFIED 未指明的错误类型。
PROJECT_NOT_AUTHORIZED Cloud 项目无权访问要监控的表单。如果用户撤消了对您项目访问其表单的授权，就会出现这种情况。系统不会重试出现此错误的手表。如需尝试重新开始观看表单，可以调用 watches.renew
NO_USER_ACCESS 授予访问权限的用户将无法再访问被监控的表单。系统不会重试出现此错误的手表。如需尝试重新开始观看表单，可以调用 watches.renew
OTHER_ERRORS 发生了另一种类型的错误。通知是否会继续取决于手表 state。

州

可能的手表状态。

枚举
STATE_UNSPECIFIED 未指定状态。
ACTIVE 手表处于开启状态。
SUSPENDED 由于可能可以解决的错误，手表已被中止。此观看会一直保留，直至到期。如需尝试重新激活手表，可以拨打 watches.renew

方法

create

 创建新手表。

delete

 删除手表。

list

 返回调用方项目拥有的监视器列表。

renew

 续订现有手表 7 天。