REST Resource: forms.watches

資源：Watch

監控表單事件。指定事件發生時，系統會將通知發布至指定目標。通知的屬性會包含 formId 鍵，其中包含所監控表單的 ID，以及 eventType 鍵，其中包含類型的字串。

訊息會以「至少傳送一次」的傳遞模式傳送，只有在特殊情況下才會遭到捨棄。通常所有通知都應在幾秒內可靠地傳送；不過，在某些情況下，通知可能會延遲。

除非使用 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 呼叫都會將此值重設為未來七天。

使用 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。

州

可能的 Watch 狀態。

列舉
STATE_UNSPECIFIED 未指定狀態。
ACTIVE 智慧手錶已啟用。
SUSPENDED 手錶因可能可解決的錯誤而遭到停用。這項監控作業會持續進行，直到到期為止。如要嘗試重新啟動手錶，可以撥打電話給 watches.renew

方法

create

 建立新的手錶。

delete

 刪除手錶。

list

 傳回叫用專案擁有的監控清單。

renew

 續訂現有手錶的服務，期限為七天。