Gemini Webhooks API

Webhook ช่วยให้ Gemini API สามารถพุชการแจ้งเตือนแบบเรียลไทม์ไปยังเซิร์ฟเวอร์ของคุณเมื่อการดำเนินการแบบไม่พร้อมกันหรือการดำเนินการที่ใช้เวลานาน (LRO) เสร็จสมบูรณ์ ซึ่งจะช่วยลดความจำเป็นในการสำรวจ API เพื่อดูการอัปเดตสถานะ ทำให้ลดเวลาในการตอบสนองและค่าใช้จ่ายได้

ดูเป็นมาร์กดาวน์ ดูข้อกำหนด OpenAPI

CreateWebhook

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

สร้างเว็บฮุกใหม่

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

name string  (ไม่บังคับ)

ไม่บังคับ ชื่อของ Webhook ที่ผู้ใช้ระบุ

subscribed_events array (enum (string))  (ต้องระบุ)

ต้องระบุ เหตุการณ์ที่เว็บฮุกติดตาม เหตุการณ์ที่ใช้ได้ - 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  (ต้องระบุ)

ต้องระบุ URI ที่จะส่งเหตุการณ์เว็บฮุคไป

คำตอบ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

create_time string  (ไม่บังคับ)

เอาต์พุตเท่านั้น การประทับเวลาเมื่อสร้าง Webhook

id string  (ไม่บังคับ)

เอาต์พุตเท่านั้น รหัสของเว็บฮุก

name string  (ไม่บังคับ)

ไม่บังคับ ชื่อของ Webhook ที่ผู้ใช้ระบุ

new_signing_secret string  (ไม่บังคับ)

เอาต์พุตเท่านั้น ข้อมูลลับในการลงนามใหม่สำหรับ Webhook จะป้อนข้อมูลเมื่อสร้างเท่านั้น

signing_secrets array (SigningSecret)  (ไม่บังคับ)

เอาต์พุตเท่านั้น ข้อมูลลับในการลงนามที่เชื่อมโยงกับ Webhook นี้

แสดงข้อมูลลับในการลงนามที่ใช้เพื่อยืนยันเพย์โหลดของเว็บฮุค

ช่อง

expire_time string  (ไม่บังคับ)

เอาต์พุตเท่านั้น วันที่หมดอายุของข้อมูลลับในการลงนาม

truncated_secret string  (ไม่บังคับ)

เอาต์พุตเท่านั้น เวอร์ชันที่ตัดทอนของข้อมูลลับในการลงนาม

state enum (string)  (ไม่บังคับ)

เอาต์พุตเท่านั้น สถานะของเว็บฮุค

ค่าที่เป็นไปได้ มีดังนี้

  • enabled

    เปิดใช้เว็บฮุกแล้ว

  • disabled

    ผู้ใช้ปิดใช้เว็บฮุก

  • disabled_due_to_failed_deliveries

    ระบบปิดใช้เว็บฮุกเนื่องจากนำส่งไม่สำเร็จ

subscribed_events array (enum (string))  (ไม่บังคับ)

ต้องระบุ เหตุการณ์ที่เว็บฮุกติดตาม เหตุการณ์ที่ใช้ได้ - 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 string  (ไม่บังคับ)

เอาต์พุตเท่านั้น การประทับเวลาเมื่ออัปเดตเว็บฮุคครั้งล่าสุด

uri สตริง  (ไม่บังคับ)

ต้องระบุ 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

ส่งเหตุการณ์ ping ไปยัง Webhook

พารามิเตอร์เส้นทาง / การค้นหา

id string  (ต้องระบุ)

ต้องระบุ รหัสของเว็บบุ๊กที่จะปิง รูปแบบ: `{webhook_id}`

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

คำตอบ

หากทำสำเร็จ การตอบกลับจะว่างเปล่า

ตัวอย่าง

RotateSigningSecret

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

สร้างข้อมูลลับในการลงนามใหม่สำหรับ Webhook

พารามิเตอร์เส้นทาง / การค้นหา

id string  (ต้องระบุ)

ต้องระบุ รหัสของเว็บฮุคที่จะสร้างข้อมูลลับในการลงนาม รูปแบบ: `{webhook_id}`

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

revocation_behavior enum (string)  (ไม่บังคับ)

ไม่บังคับ ลักษณะการเพิกถอนสำหรับข้อมูลลับในการลงนามก่อนหน้านี้

ค่าที่เป็นไปได้ มีดังนี้

  • revoke_previous_secrets_after_h24

    สร้างข้อมูลลับในการลงนามใหม่และเพิกถอนข้อมูลลับก่อนหน้าทั้งหมดหลังจากผ่านไป 24 ชั่วโมง ตัวเลือกเริ่มต้นและปลอดภัยที่สุดสำหรับการย้ายข้อมูล

  • revoke_previous_secrets_immediately

    เพิกถอนข้อมูลลับก่อนหน้าทั้งหมดทันที โปรดใช้ด้วยความระมัดระวังเนื่องจากอาจขัดจังหวะการแจ้งเตือนที่กำลังแสดงอยู่

คำตอบ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

secret string  (ไม่บังคับ)

เอาต์พุตเท่านั้น ข้อมูลลับในการลงนามที่สร้างขึ้นใหม่

ตัวอย่าง

ตัวอย่างการตอบกลับ

{
  "secret": "string"
}

ListWebhooks

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

แสดงรายการเว็บฮุกทั้งหมด

พารามิเตอร์เส้นทาง / การค้นหา

page_size integer  (ไม่บังคับ)

ไม่บังคับ จำนวนสูงสุดของ Webhook ที่จะแสดงผล บริการอาจแสดงผลน้อยกว่า ค่านี้ หากไม่ระบุ ระบบจะแสดงผล Webhook อย่างมาก 50 รายการ ค่าสูงสุดคือ 1,000

page_token string  (ไม่บังคับ)

ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้ `ListWebhooks` ก่อนหน้า ระบุค่านี้เพื่อดึงข้อมูลหน้าถัดไป

คำตอบ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

next_page_token string  (ไม่บังคับ)

โทเค็นที่ส่งเป็น `page_token` เพื่อดึงข้อมูลหน้าถัดไปได้ หากละเว้นฟิลด์นี้ จะไม่มีหน้าถัดไป

เว็บบุ๊ก อาร์เรย์ (เว็บบุ๊ก)  (ไม่บังคับ)

เว็บฮุค

ตัวอย่าง

ตัวอย่างการตอบกลับ

{
  "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}

รับเว็บฮุคที่เฉพาะเจาะจง

พารามิเตอร์เส้นทาง / การค้นหา

id string  (ต้องระบุ)

ต้องระบุ รหัสของ Webhook ที่จะดึงข้อมูล

คำตอบ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

create_time string  (ไม่บังคับ)

เอาต์พุตเท่านั้น การประทับเวลาเมื่อสร้าง Webhook

id string  (ไม่บังคับ)

เอาต์พุตเท่านั้น รหัสของเว็บฮุก

name string  (ไม่บังคับ)

ไม่บังคับ ชื่อของ Webhook ที่ผู้ใช้ระบุ

new_signing_secret string  (ไม่บังคับ)

เอาต์พุตเท่านั้น ข้อมูลลับในการลงนามใหม่สำหรับ Webhook จะป้อนข้อมูลเมื่อสร้างเท่านั้น

signing_secrets array (SigningSecret)  (ไม่บังคับ)

เอาต์พุตเท่านั้น ข้อมูลลับในการลงนามที่เชื่อมโยงกับ Webhook นี้

แสดงข้อมูลลับในการลงนามที่ใช้เพื่อยืนยันเพย์โหลดของเว็บฮุค

ช่อง

expire_time string  (ไม่บังคับ)

เอาต์พุตเท่านั้น วันที่หมดอายุของข้อมูลลับในการลงนาม

truncated_secret string  (ไม่บังคับ)

เอาต์พุตเท่านั้น เวอร์ชันที่ตัดทอนของข้อมูลลับในการลงนาม

state enum (string)  (ไม่บังคับ)

เอาต์พุตเท่านั้น สถานะของเว็บฮุค

ค่าที่เป็นไปได้ มีดังนี้

  • enabled

    เปิดใช้เว็บฮุกแล้ว

  • disabled

    ผู้ใช้ปิดใช้เว็บฮุก

  • disabled_due_to_failed_deliveries

    ระบบปิดใช้เว็บฮุกเนื่องจากนำส่งไม่สำเร็จ

subscribed_events array (enum (string))  (ไม่บังคับ)

ต้องระบุ เหตุการณ์ที่เว็บฮุกติดตาม เหตุการณ์ที่ใช้ได้ - 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 string  (ไม่บังคับ)

เอาต์พุตเท่านั้น การประทับเวลาเมื่ออัปเดตเว็บฮุคครั้งล่าสุด

uri สตริง  (ไม่บังคับ)

ต้องระบุ 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}

อัปเดตเว็บฮุคที่มีอยู่

พารามิเตอร์เส้นทาง / การค้นหา

id string  (ต้องระบุ)

ต้องระบุ รหัสของเว็บฮุคที่จะอัปเดต

update_mask string  (ไม่บังคับ)

ไม่บังคับ รายการฟิลด์ที่จะอัปเดต

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

name string  (ไม่บังคับ)

ไม่บังคับ ชื่อของ Webhook ที่ผู้ใช้ระบุ

state enum (string)  (ไม่บังคับ)

ไม่บังคับ สถานะของเว็บฮุค

ค่าที่เป็นไปได้ มีดังนี้

  • enabled

    เปิดใช้เว็บฮุกแล้ว

  • disabled

    ผู้ใช้ปิดใช้เว็บฮุก

  • disabled_due_to_failed_deliveries

    ระบบปิดใช้เว็บฮุกเนื่องจากนำส่งไม่สำเร็จ

subscribed_events array (enum (string))  (ไม่บังคับ)

ไม่บังคับ เหตุการณ์ที่เว็บฮุกติดตาม เหตุการณ์ที่ใช้ได้ - 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 สตริง  (ไม่บังคับ)

ไม่บังคับ URI ที่จะส่งเหตุการณ์เว็บฮุคไป

คำตอบ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

create_time string  (ไม่บังคับ)

เอาต์พุตเท่านั้น การประทับเวลาเมื่อสร้าง Webhook

id string  (ไม่บังคับ)

เอาต์พุตเท่านั้น รหัสของเว็บฮุก

name string  (ไม่บังคับ)

ไม่บังคับ ชื่อของ Webhook ที่ผู้ใช้ระบุ

new_signing_secret string  (ไม่บังคับ)

เอาต์พุตเท่านั้น ข้อมูลลับในการลงนามใหม่สำหรับ Webhook จะป้อนข้อมูลเมื่อสร้างเท่านั้น

signing_secrets array (SigningSecret)  (ไม่บังคับ)

เอาต์พุตเท่านั้น ข้อมูลลับในการลงนามที่เชื่อมโยงกับ Webhook นี้

แสดงข้อมูลลับในการลงนามที่ใช้เพื่อยืนยันเพย์โหลดของเว็บฮุค

ช่อง

expire_time string  (ไม่บังคับ)

เอาต์พุตเท่านั้น วันที่หมดอายุของข้อมูลลับในการลงนาม

truncated_secret string  (ไม่บังคับ)

เอาต์พุตเท่านั้น เวอร์ชันที่ตัดทอนของข้อมูลลับในการลงนาม

state enum (string)  (ไม่บังคับ)

เอาต์พุตเท่านั้น สถานะของเว็บฮุค

ค่าที่เป็นไปได้ มีดังนี้

  • enabled

    เปิดใช้เว็บฮุกแล้ว

  • disabled

    ผู้ใช้ปิดใช้เว็บฮุก

  • disabled_due_to_failed_deliveries

    ระบบปิดใช้เว็บฮุกเนื่องจากนำส่งไม่สำเร็จ

subscribed_events array (enum (string))  (ไม่บังคับ)

ต้องระบุ เหตุการณ์ที่เว็บฮุกติดตาม เหตุการณ์ที่ใช้ได้ - 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 string  (ไม่บังคับ)

เอาต์พุตเท่านั้น การประทับเวลาเมื่ออัปเดตเว็บฮุคครั้งล่าสุด

uri สตริง  (ไม่บังคับ)

ต้องระบุ 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}

ลบเว็บฮุค

พารามิเตอร์เส้นทาง / การค้นหา

id string  (ต้องระบุ)

ต้องระบุ รหัสของเว็บฮุคที่จะลบ รูปแบบ: `{webhook_id}`

คำตอบ

หากทำสำเร็จ การตอบกลับจะว่างเปล่า

ตัวอย่าง

แหล่งข้อมูล

เว็บฮุค

ทรัพยากรเว็บฮุค

ช่อง

create_time string  (ไม่บังคับ)

เอาต์พุตเท่านั้น การประทับเวลาเมื่อสร้าง Webhook

id string  (ไม่บังคับ)

เอาต์พุตเท่านั้น รหัสของเว็บฮุก

name string  (ไม่บังคับ)

ไม่บังคับ ชื่อของ Webhook ที่ผู้ใช้ระบุ

new_signing_secret string  (ไม่บังคับ)

เอาต์พุตเท่านั้น ข้อมูลลับในการลงนามใหม่สำหรับ Webhook จะป้อนข้อมูลเมื่อสร้างเท่านั้น

signing_secrets array (SigningSecret)  (ไม่บังคับ)

เอาต์พุตเท่านั้น ข้อมูลลับในการลงนามที่เชื่อมโยงกับ Webhook นี้

แสดงข้อมูลลับในการลงนามที่ใช้เพื่อยืนยันเพย์โหลดของเว็บฮุค

ช่อง

expire_time string  (ไม่บังคับ)

เอาต์พุตเท่านั้น วันที่หมดอายุของข้อมูลลับในการลงนาม

truncated_secret string  (ไม่บังคับ)

เอาต์พุตเท่านั้น เวอร์ชันที่ตัดทอนของข้อมูลลับในการลงนาม

state enum (string)  (ไม่บังคับ)

เอาต์พุตเท่านั้น สถานะของเว็บฮุค

ค่าที่เป็นไปได้ มีดังนี้

  • enabled

    เปิดใช้เว็บฮุกแล้ว

  • disabled

    ผู้ใช้ปิดใช้เว็บฮุก

  • disabled_due_to_failed_deliveries

    ระบบปิดใช้เว็บฮุกเนื่องจากนำส่งไม่สำเร็จ

subscribed_events array (enum (string))  (ไม่บังคับ)

ต้องระบุ เหตุการณ์ที่เว็บฮุกติดตาม เหตุการณ์ที่ใช้ได้ - 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 string  (ไม่บังคับ)

เอาต์พุตเท่านั้น การประทับเวลาเมื่ออัปเดตเว็บฮุคครั้งล่าสุด

uri สตริง  (ไม่บังคับ)

ต้องระบุ URI ที่จะส่งเหตุการณ์เว็บฮุคไป