REST Resource: forms.watches

リソース: 視聴

フォームのイベントのウォッチ。指定されたイベントが発生すると、指定されたターゲットに通知が公開されます。通知の属性には、監視対象のフォームの ID を含む formId キーと、型の文字列を含む eventType キーが含まれます。

メッセージは at-least-once 配信で送信され、異常な状況でのみ破棄されます。通常、すべての通知は数秒以内に確実に配信されますが、通知が遅れる場合もあります。

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

ErrorType

発生する可能性があるエラーのタイプ。

列挙型
ERROR_TYPE_UNSPECIFIED エラーの種類が指定されていません。
PROJECT_NOT_AUTHORIZED クラウド プロジェクトには監視対象のフォームへのアクセス権がありません。これは、プロジェクトのフォームへのアクセス許可をユーザーが取り消した場合に発生します。このエラーが発生したウォッチは再試行されません。フォームの表示をもう一度開始するには、watches.renew を呼び出します。
NO_USER_ACCESS アクセス権を付与したユーザーは、監視対象のフォームにアクセスできなくなりました。このエラーが発生したウォッチは再試行されません。フォームの表示をもう一度開始するには、watches.renew を呼び出します。
OTHER_ERRORS 別のタイプのエラーが発生しました。通知を継続するかどうかは、スマートウォッチの state によって異なります。

状態

考えられるウォッチの状態。

列挙型
STATE_UNSPECIFIED 未指定の状態
ACTIVE ウォッチはアクティブです。
SUSPENDED 解決可能なエラーのため、スマートウォッチは停止されています。スマートウォッチは有効期限が切れるまで存続します。スマートウォッチを再度有効にするには、watches.renew に発信します

Methods

create

 新しいウォッチを作成する。

delete

 スマートウォッチを削除する。

list

 呼び出し元のプロジェクトが所有するウォッチのリストを返します。

renew

 既存のスマートウォッチを 7 日間更新します。