REST Resource: forms.watches

資源：Watch

監控表單的事件。當指定事件發生時，系統就會對指定目標發布通知。通知的屬性會包含具有已觀看形式 ID 的 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

僅供輸出。這支手錶的 ID。查看「CreateWatchRequest.watch_id」上的附註。
target

object (WatchTarget)

必要欄位。要傳送通知到哪裡。
eventType

enum (EventType)

必要欄位。要觀察的事件類型。
createTime

string (Timestamp format)

僅供輸出。建立時間的時間戳記。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
expireTime

string (Timestamp format)

僅供輸出。到期時間的時間戳記。每次 watches.renew 通話都會將此通話重設為未來七天。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
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 主題。如要接收通知，主題必須授予表單服務帳戶 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 天。