REST Resource: forms.watches

資源:監控

表單事件的智慧手錶。指定事件發生時,系統會向指定的目標發布通知。通知的屬性包括具有觀看表單 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 呼叫會將此來電重設為 7 天後。

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 雲端專案無法存取正在觀看的表單。當使用者撤銷專案存取表單的授權時,就會發生這類錯誤。系統不會重試含有這個錯誤的智慧手錶。如要再次嘗試觀看表單,請呼叫 watches.renew
NO_USER_ACCESS 獲得存取權的使用者將無法再存取正在觀看的表單。系統不會重試含有這個錯誤的智慧手錶。如要再次嘗試觀看表單,請呼叫 watches.renew
OTHER_ERRORS 發生其他類型的錯誤。通知是否會持續發生取決於手錶 state

可能的觀看狀態。

列舉
STATE_UNSPECIFIED 未指定狀態。
ACTIVE 智慧手錶已啟用。
SUSPENDED 發生錯誤,可能會暫停智慧手錶。手錶會繼續運作,直到過期為止。如要嘗試重新啟用智慧手錶,可以撥打 watches.renew

方法

create

建立新智慧手錶。

delete

刪除智慧手錶。

list

傳回叫用專案擁有的手錶清單。

renew

續訂現有智慧手錶 7 天。