REST Resource: forms.watches

リソース: Watch

フォームのイベントを監視する。指定したイベントが発生すると、指定したターゲットに通知がパブリッシュされます。通知の属性には、監視対象のフォームの ID を持つ formId キーと、そのタイプの文字列を持つ eventType キーが含まれます。

メッセージは at-least-once（少なくとも 1 回）で送信され、異常な状況でのみドロップされます。通常、すべての通知が数秒以内に確実に配信される必要があります。状況によっては通知が遅れることもあります。

watches.renew で更新しない限り、スマートウォッチは作成から 7 日後に期限切れになります

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 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
expireTime

string (Timestamp format)

出力専用。有効期限のタイムスタンプ。watches.renew を呼び出すたびに、この値は 7 日後にリセットされます。

RFC3339 UTC「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 response イベントタイプ。フォームの回答が送信されると、このイベントタイプのスマートウォッチに通知されます。

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 日間更新します。