REST Resource: forms.watches

リソース: Watch

フォームのイベントを監視します。指定されたイベントが発生すると、通知が指定されたターゲットに公開されます。通知の属性には、監視対象フォームの 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)

出力専用。作成されたときのタイムスタンプ。

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 呼び出しで、この値は 7 日後にリセットされます。

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 トピック。通知を受け取るには、トピックが Forms サービス アカウント 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 日間更新する。