REST Resource: subscriptions

{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}

string

省略可。変更不可。ID。サブスクリプションのリソース名。

形式: subscriptions/{subscription}

string

出力専用。システムによってサブスクリプションに割り当てられた一意の識別子。

string

必須。変更不可。イベントについてモニタリングされる Google Workspace リソース（完全なリソース名の形式）。ターゲット リソースとそれらがサポートするイベントについては、サポートされている Google Workspace イベントをご覧ください。

ユーザーは、特定のターゲット リソースに対して 1 つのサブスクリプションのみを作成することをアプリに許可できます。アプリが同じユーザー認証情報で別のサブスクリプションを作成しようとすると、そのリクエストは ALREADY_EXISTS エラーを返します。

string

必須。変更不可。順序なしリスト。サブスクリプションを作成するための入力。それ以外の場合は、出力のみ。ターゲット リソースについて受信するイベントのタイプ（複数可）。CloudEvents 仕様に沿った形式。

サポートされるイベントタイプは、サブスクリプションの対象リソースによって異なります。詳しくは、サポートされる Google Workspace イベントをご覧ください。

デフォルトでは、定期購入のライフサイクルに関するイベントも受け取ります。このフィールドにライフサイクル イベントを指定する必要はありません。

ターゲット リソースに存在しないイベントタイプを指定すると、リクエストは HTTP 400 Bad Request ステータス コードを返します。

object (PayloadOptions)

省略可。イベント ペイロードに含めるデータに関するオプション。Google Chat のイベントでのみサポートされています。

object (NotificationEndpoint)

必須。変更不可。サブスクリプションがイベントを配信するエンドポイント（Pub/Sub トピックなど）。

enum (State)

出力専用。サブスクリプションの状態。サブスクリプションがイベントを受信して通知エンドポイントに配信できるかどうかを決定します。

enum (ErrorType)

出力専用。サブスクリプションを一時停止したエラー。

定期購入を再度有効にするには、エラーを解決して subscriptions.reactivate メソッドを呼び出します。

string

出力専用。サブスクリプションの作成を承認したユーザー。

形式: users/{user}

Google Workspace ユーザーの場合、{user} の値は Directory API の user.id フィールドです。

string (Timestamp format)

出力専用。サブスクリプションが作成された時刻。

string (Timestamp format)

出力専用。定期購入が最後に更新された時刻。

boolean

出力専用。true の場合、サブスクリプションは更新中です。

string

省略可。このチェックサムは、他のフィールドの値に基づいてサーバーによって計算され、続行する前にクライアントが最新の値を持っていることを確認するために、更新リクエスト時に送信されることもあります。

string (Timestamp format)

空でないデフォルト。サブスクリプションが期限切れになるときのタイムスタンプ（UTC）。入力に使用された内容に関係なく、常に出力に表示されます。

string (Duration format)

入力のみのサブスクリプションの有効期間（TTL）または期間。指定しないか 0 に設定した場合、指定可能な最長時間が使用されます。

{
  "includeResource": boolean,
  "fieldMask": string
}

boolean

省略可。変更されたリソースに関するデータがイベント ペイロードに含まれているかどうか。たとえば、Google Chat メッセージが作成されたイベントの場合、ペイロードに Message リソースに関するデータが含まれているかどうかがわかります。false の場合、イベント ペイロードには変更されたリソースの名前のみが含まれます。

string (FieldMask format)

省略可。includeResource が true に設定されている場合、イベント ペイロードに含めるフィールドのリスト。フィールドはカンマで区切ってください。たとえば、Google Chat メッセージの送信者と作成時刻を含めるには「message.sender,message.createTime」と入力します。省略した場合、ペイロードにはリソースのすべてのフィールドが含まれます。

存在しないフィールドを指定した場合、そのフィールドは無視されます。

{

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}

string

変更不可。サブスクリプションのイベントを受け取る Cloud Pub/Sub トピック。

形式: projects/{project}/topics/{topic}

トピックは、このサブスクリプションを作成する Google Cloud プロジェクトに作成する必要があります。

トピックがイベントを受信すると、イベントは Cloud Pub/Sub メッセージとしてエンコードされます。詳しくは、CloudEvents の Google Cloud Pub/Sub プロトコル バインディングをご覧ください。