Gemini Webhooks API

Webhook を使用すると、非同期オペレーションまたは長時間実行オペレーション（LRO）が完了したときに、Gemini API がリアルタイム通知をサーバーにプッシュできます。これにより、API のステータス更新をポーリングする必要がなくなり、レイテンシとオーバーヘッドが削減されます。

マークダウンとして表示 OpenAPI 仕様を表示

CreateWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks

新しい Webhook を作成します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

name 文字列  （省略可）

省略可。ユーザーが指定した Webhook の名前。

subscribed_events 配列（列挙型（文字列））  （必須）

必須。Webhook が登録されているイベント。使用可能なイベント: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

指定できる値は次のとおりです。

  • batch.succeeded

    バッチ処理が正常に完了しました。

  • batch.expired

    バッチが 48 時間以内に処理されなかった。

  • batch.failed

    バッチジョブが失敗しました。

  • interaction.requires_action

    操作にはアクション（関数呼び出しなど）が必要です。

  • interaction.completed

    操作が正常に完了しました。

  • interaction.failed

    操作に失敗しました。

  • video.generated

    動画の生成が完了しました。

uri 文字列  （必須）

必須。Webhook イベントの送信先 URI。

レスポンス

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

create_time 文字列  （省略可）

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

id string  （省略可）

出力専用。Webhook の ID。

name 文字列  （省略可）

省略可。ユーザーが指定した Webhook の名前。

new_signing_secret 文字列  （省略可）

出力専用。Webhook の新しい署名シークレット。作成時にのみ入力されます。

signing_secrets 配列（SigningSecret）  （省略可）

出力専用。この Webhook に関連付けられている署名シークレット。

Webhook ペイロードの検証に使用される署名シークレットを表します。

フィールド

expire_time 文字列  （省略可）

出力専用。署名シークレットの有効期限。

truncated_secret 文字列  （省略可）

出力専用。署名シークレットの切り捨てられたバージョン。

state enum（文字列）  （省略可）

出力専用。Webhook の状態。

指定できる値は次のとおりです。

  • enabled

    Webhook が有効になっている。

  • disabled

    ユーザーによって Webhook が無効になっています。

  • disabled_due_to_failed_deliveries

    配信に失敗したため、Webhook が無効になっています。

subscribed_events 配列（列挙型（文字列））  （省略可）

必須。Webhook が登録されているイベント。使用可能なイベント: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

指定できる値は次のとおりです。

  • batch.succeeded

    バッチ処理が正常に完了しました。

  • batch.expired

    バッチが 48 時間以内に処理されなかった。

  • batch.failed

    バッチジョブが失敗しました。

  • interaction.requires_action

    操作にはアクション（関数呼び出しなど）が必要です。

  • interaction.completed

    操作が正常に完了しました。

  • interaction.failed

    操作に失敗しました。

  • video.generated

    動画の生成が完了しました。

update_time 文字列  （省略可）

出力専用。Webhook が最後に更新されたときのタイムスタンプ。

uri string  （省略可）

必須。Webhook イベントの送信先 URI。

例

返信の例

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

PingWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:ping

Webhook に ping イベントを送信します。

パス / クエリ パラメータ

id 文字列  （必須）

必須。ping を送信する Webhook の ID。形式: `{webhook_id}`

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

レスポンス

成功すると、レスポンスは空になります。

例

RotateSigningSecret

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:rotateSigningSecret

Webhook の新しい署名シークレットを生成します。

パス / クエリ パラメータ

id 文字列  （必須）

必須。署名シークレットを生成する Webhook の ID。形式: `{webhook_id}`

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

revocation_behavior 列挙型（文字列）  （省略可）

省略可。以前の署名シークレットの取り消し動作。

指定できる値は次のとおりです。

  • revoke_previous_secrets_after_h24

    新しい署名シークレットを生成し、24 時間後に以前のすべてのシークレットを取り消します。移行のデフォルトで最も安全なオプション。

  • revoke_previous_secrets_immediately

    以前のシークレットはすべて直ちに取り消します。進行中の通知が中断される可能性があるため、注意して使用してください。

レスポンス

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

secret string  （省略可）

出力専用。新しく生成された署名シークレット。

例

返信の例

{
  "secret": "string"
}

ListWebhooks

get https://generativelanguage.googleapis.com/v1beta/webhooks

すべての Webhook を一覧表示します。

パス / クエリ パラメータ

page_size 整数  （省略可）

省略可。返す Webhook の最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個の Webhook が返されます。最大値は 1000 です。

page_token 文字列  （省略可）

省略可。前回の `ListWebhooks` 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

レスポンス

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

next_page_token string  （省略可）

次のページを取得するために `page_token` として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

webhooks array (Webhook)  （省略可）

Webhook。

例

返信の例

{
  "next_page_token": "string",
  "webhooks": [
    {
      "create_time": "string",
      "id": "string",
      "name": "string",
      "new_signing_secret": "string",
      "signing_secrets": [
        {
          "expire_time": "string",
          "truncated_secret": "string"
        }
      ],
      "state": "enabled",
      "subscribed_events": [
        "batch.succeeded"
      ],
      "update_time": "string",
      "uri": "string"
    }
  ]
}

GetWebhook

get https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

特定の Webhook を取得します。

パス / クエリ パラメータ

id 文字列  （必須）

必須。取得する Webhook の ID。

レスポンス

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

create_time 文字列  （省略可）

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

id string  （省略可）

出力専用。Webhook の ID。

name 文字列  （省略可）

省略可。ユーザーが指定した Webhook の名前。

new_signing_secret 文字列  （省略可）

出力専用。Webhook の新しい署名シークレット。作成時にのみ入力されます。

signing_secrets 配列（SigningSecret）  （省略可）

出力専用。この Webhook に関連付けられている署名シークレット。

Webhook ペイロードの検証に使用される署名シークレットを表します。

フィールド

expire_time 文字列  （省略可）

出力専用。署名シークレットの有効期限。

truncated_secret 文字列  （省略可）

出力専用。署名シークレットの切り捨てられたバージョン。

state enum（文字列）  （省略可）

出力専用。Webhook の状態。

指定できる値は次のとおりです。

  • enabled

    Webhook が有効になっている。

  • disabled

    ユーザーによって Webhook が無効になっています。

  • disabled_due_to_failed_deliveries

    配信に失敗したため、Webhook が無効になっています。

subscribed_events 配列（列挙型（文字列））  （省略可）

必須。Webhook が登録されているイベント。使用可能なイベント: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

指定できる値は次のとおりです。

  • batch.succeeded

    バッチ処理が正常に完了しました。

  • batch.expired

    バッチが 48 時間以内に処理されなかった。

  • batch.failed

    バッチジョブが失敗しました。

  • interaction.requires_action

    操作にはアクション（関数呼び出しなど）が必要です。

  • interaction.completed

    操作が正常に完了しました。

  • interaction.failed

    操作に失敗しました。

  • video.generated

    動画の生成が完了しました。

update_time 文字列  （省略可）

出力専用。Webhook が最後に更新されたときのタイムスタンプ。

uri string  （省略可）

必須。Webhook イベントの送信先 URI。

例

返信の例

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

UpdateWebhook

patch https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

既存の Webhook を更新します。

パス / クエリ パラメータ

id 文字列  （必須）

必須。更新する Webhook の ID。

update_mask 文字列  （省略可）

省略可。更新するフィールドのリスト。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

name 文字列  （省略可）

省略可。ユーザーが指定した Webhook の名前。

state enum（文字列）  （省略可）

省略可。Webhook の状態。

指定できる値は次のとおりです。

  • enabled

    Webhook が有効になっている。

  • disabled

    ユーザーによって Webhook が無効になっています。

  • disabled_due_to_failed_deliveries

    配信に失敗したため、Webhook が無効になっています。

subscribed_events 配列（列挙型（文字列））  （省略可）

省略可。Webhook が登録されているイベント。使用可能なイベント: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

指定できる値は次のとおりです。

  • batch.succeeded

    バッチ処理が正常に完了しました。

  • batch.expired

    バッチが 48 時間以内に処理されなかった。

  • batch.failed

    バッチジョブが失敗しました。

  • interaction.requires_action

    操作にはアクション（関数呼び出しなど）が必要です。

  • interaction.completed

    操作が正常に完了しました。

  • interaction.failed

    操作に失敗しました。

  • video.generated

    動画の生成が完了しました。

uri string  （省略可）

省略可。Webhook イベントの送信先 URI。

レスポンス

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

create_time 文字列  （省略可）

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

id string  （省略可）

出力専用。Webhook の ID。

name 文字列  （省略可）

省略可。ユーザーが指定した Webhook の名前。

new_signing_secret 文字列  （省略可）

出力専用。Webhook の新しい署名シークレット。作成時にのみ入力されます。

signing_secrets 配列（SigningSecret）  （省略可）

出力専用。この Webhook に関連付けられている署名シークレット。

Webhook ペイロードの検証に使用される署名シークレットを表します。

フィールド

expire_time 文字列  （省略可）

出力専用。署名シークレットの有効期限。

truncated_secret 文字列  （省略可）

出力専用。署名シークレットの切り捨てられたバージョン。

state enum（文字列）  （省略可）

出力専用。Webhook の状態。

指定できる値は次のとおりです。

  • enabled

    Webhook が有効になっている。

  • disabled

    ユーザーによって Webhook が無効になっています。

  • disabled_due_to_failed_deliveries

    配信に失敗したため、Webhook が無効になっています。

subscribed_events 配列（列挙型（文字列））  （省略可）

必須。Webhook が登録されているイベント。使用可能なイベント: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

指定できる値は次のとおりです。

  • batch.succeeded

    バッチ処理が正常に完了しました。

  • batch.expired

    バッチが 48 時間以内に処理されなかった。

  • batch.failed

    バッチジョブが失敗しました。

  • interaction.requires_action

    操作にはアクション（関数呼び出しなど）が必要です。

  • interaction.completed

    操作が正常に完了しました。

  • interaction.failed

    操作に失敗しました。

  • video.generated

    動画の生成が完了しました。

update_time 文字列  （省略可）

出力専用。Webhook が最後に更新されたときのタイムスタンプ。

uri string  （省略可）

必須。Webhook イベントの送信先 URI。

例

返信の例

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

DeleteWebhook

delete https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Webhook を削除します。

パス / クエリ パラメータ

id 文字列  （必須）

必須。削除する Webhook の ID。形式: `{webhook_id}`

レスポンス

成功すると、レスポンスは空になります。

例

リソース

Webhook

Webhook リソース。

フィールド

create_time 文字列  （省略可）

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

id string  （省略可）

出力専用。Webhook の ID。

name 文字列  （省略可）

省略可。ユーザーが指定した Webhook の名前。

new_signing_secret 文字列  （省略可）

出力専用。Webhook の新しい署名シークレット。作成時にのみ入力されます。

signing_secrets 配列（SigningSecret）  （省略可）

出力専用。この Webhook に関連付けられている署名シークレット。

Webhook ペイロードの検証に使用される署名シークレットを表します。

フィールド

expire_time 文字列  （省略可）

出力専用。署名シークレットの有効期限。

truncated_secret 文字列  （省略可）

出力専用。署名シークレットの切り捨てられたバージョン。

state enum（文字列）  （省略可）

出力専用。Webhook の状態。

指定できる値は次のとおりです。

  • enabled

    Webhook が有効になっている。

  • disabled

    ユーザーによって Webhook が無効になっています。

  • disabled_due_to_failed_deliveries

    配信に失敗したため、Webhook が無効になっています。

subscribed_events 配列（列挙型（文字列））  （省略可）

必須。Webhook が登録されているイベント。使用可能なイベント: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

指定できる値は次のとおりです。

  • batch.succeeded

    バッチ処理が正常に完了しました。

  • batch.expired

    バッチが 48 時間以内に処理されなかった。

  • batch.failed

    バッチジョブが失敗しました。

  • interaction.requires_action

    操作にはアクション（関数呼び出しなど）が必要です。

  • interaction.completed

    操作が正常に完了しました。

  • interaction.failed

    操作に失敗しました。

  • video.generated

    動画の生成が完了しました。

update_time 文字列  （省略可）

出力専用。Webhook が最後に更新されたときのタイムスタンプ。

uri string  （省略可）

必須。Webhook イベントの送信先 URI。