Gemini 4 Argon hiện đã ra mắt. Hãy dùng thử.

Google sử dụng công nghệ AI để dịch nội dung sang ngôn ngữ bạn ưu tiên. Bản dịch bằng AI có thể có lỗi.

Gemini Webhooks API

Webhook cho phép Gemini API gửi thông báo theo thời gian thực đến máy chủ của bạn khi các Thao tác không đồng bộ hoặc Thao tác kéo dài (LRO) hoàn tất. Điều này giúp bạn không cần phải thăm dò API để biết thông tin cập nhật về trạng thái, giảm độ trễ và mức hao tổn.

Xem dưới dạng markdown Xem đặc tả OpenAPI

CreateWebhook

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

Tạo một Webhook mới.

Nội dung yêu cầu
Đáp

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

name string (không bắt buộc)

Không bắt buộc. Tên do người dùng cung cấp của webhook.

subscribed_events mảng (enum (string)) (bắt buộc)

Bắt buộc. Các sự kiện mà webhook đăng ký nhận. Các sự kiện có sẵn: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Các giá trị có thể có:

batch.succeeded
Đã hoàn tất quá trình xử lý hàng loạt.
batch.expired
Lô chưa được xử lý trong khung thời gian 48 giờ.
batch.failed
Không thực hiện được công việc hàng loạt.
interaction.requires_action
Hoạt động tương tác yêu cầu hành động (ví dụ: gọi hàm).
interaction.completed
Đã hoàn tất tương tác thành công.
interaction.failed
Không tương tác được.
video.generated
Đã tạo xong video.

uri string (bắt buộc)

Bắt buộc. URI mà các sự kiện webhook sẽ được gửi đến.

Phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

create_time string (không bắt buộc)

Chỉ có đầu ra. Dấu thời gian cho biết thời điểm tạo webhook.

id string (không bắt buộc)

Chỉ có đầu ra. Mã nhận dạng của webhook.

name string (không bắt buộc)

Không bắt buộc. Tên do người dùng cung cấp của webhook.

new_signing_secret string (không bắt buộc)

Chỉ có đầu ra. Khoá bí mật ký mới cho webhook. Chỉ được điền sẵn khi tạo.

signing_secrets array (SigningSecret) (không bắt buộc)

Chỉ có đầu ra. Khoá bí mật ký liên kết với webhook này.

Trường

expire_time string (không bắt buộc)

Chỉ có đầu ra. Ngày hết hạn của khoá bí mật ký.

truncated_secret string (không bắt buộc)

Chỉ có đầu ra. Phiên bản rút gọn của khoá bí mật ký.

state enum (string) (không bắt buộc)

Chỉ có đầu ra. Trạng thái của webhook.

Các giá trị có thể có:

enabled
Webhook đang bật.
disabled
Người dùng đã tắt webhook.
disabled_due_to_failed_deliveries
Webhook bị vô hiệu hoá do không gửi được.

subscribed_events array (enum (string)) (không bắt buộc)

Các giá trị có thể có:

batch.succeeded
Đã hoàn tất quá trình xử lý hàng loạt.
batch.expired
Lô chưa được xử lý trong khung thời gian 48 giờ.
batch.failed
Không thực hiện được công việc hàng loạt.
interaction.requires_action
Hoạt động tương tác yêu cầu hành động (ví dụ: gọi hàm).
interaction.completed
Đã hoàn tất tương tác thành công.
interaction.failed
Không tương tác được.
video.generated
Đã tạo xong video.

update_time string (không bắt buộc)

Chỉ có đầu ra. Dấu thời gian khi webhook được cập nhật lần gần đây nhất.

uri string (không bắt buộc)

Bắt buộc. URI mà các sự kiện webhook sẽ được gửi đến.

Ví dụ

Ví dụ về phản hồi

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

Gửi một sự kiện ping đến Webhook.

Tham số đường dẫn / truy vấn
Nội dung yêu cầu
Đáp

Tham số đường dẫn / truy vấn

id string (bắt buộc)

Bắt buộc. Mã nhận dạng của webhook cần ping. Định dạng: `{webhook_id}`

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

Phản hồi

Nếu thành công, phản hồi sẽ trống.

Ví dụ

RotateSigningSecret

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

Tạo một khoá bí mật ký mới cho Webhook.

Tham số đường dẫn / truy vấn
Nội dung yêu cầu
Đáp

Tham số đường dẫn / truy vấn

id string (bắt buộc)

Bắt buộc. Mã nhận dạng của webhook mà bạn muốn tạo khoá bí mật ký. Định dạng: `{webhook_id}`

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

revocation_behavior enum (string) (không bắt buộc)

Không bắt buộc. Hành vi thu hồi đối với các khoá bí mật dùng để ký trước đây.

Các giá trị có thể có:

revoke_previous_secrets_after_h24
Tạo một khoá bí mật ký mới và thu hồi tất cả các khoá bí mật trước đó sau 24 giờ. Lựa chọn mặc định và an toàn nhất cho việc di chuyển.
revoke_previous_secrets_immediately
Thu hồi tất cả các khoá bí mật trước đó ngay lập tức. Hãy thận trọng khi sử dụng vì việc này có thể làm gián đoạn các thông báo đang diễn ra.

Phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

secret string (không bắt buộc)

Chỉ có đầu ra. Khoá bí mật ký mới tạo.

Ví dụ

Ví dụ về phản hồi

{
  "secret": "string"
}

ListWebhooks

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

Liệt kê tất cả Webhook.

Tham số đường dẫn / truy vấn
Đáp

Tham số đường dẫn / truy vấn

page_size số nguyên (không bắt buộc)

Không bắt buộc. Số lượng webhook tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu không chỉ định, tối đa 50 webhook sẽ được trả về. Giá trị tối đa là 1.000.

page_token string (không bắt buộc)

Không bắt buộc. Mã thông báo trang nhận được từ lệnh gọi `ListWebhooks` trước đó. Cung cấp thông tin này để truy xuất trang tiếp theo.

Phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

next_page_token string (không bắt buộc)

Một mã thông báo có thể được gửi dưới dạng "page_token" để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có các trang tiếp theo.

webhooks array (Webhook) (không bắt buộc)

Webhook.

Ví dụ

Ví dụ về phản hồi

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

Lấy một Webhook cụ thể.

Tham số đường dẫn / truy vấn
Đáp

Tham số đường dẫn / truy vấn

id string (bắt buộc)

Bắt buộc. Mã nhận dạng của webhook cần truy xuất.

Phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

create_time string (không bắt buộc)

Chỉ có đầu ra. Dấu thời gian cho biết thời điểm tạo webhook.

id string (không bắt buộc)

Chỉ có đầu ra. Mã nhận dạng của webhook.

name string (không bắt buộc)

Không bắt buộc. Tên do người dùng cung cấp của webhook.

new_signing_secret string (không bắt buộc)

Chỉ có đầu ra. Khoá bí mật ký mới cho webhook. Chỉ được điền sẵn khi tạo.

signing_secrets array (SigningSecret) (không bắt buộc)

Chỉ có đầu ra. Khoá bí mật ký liên kết với webhook này.

Trường

expire_time string (không bắt buộc)

Chỉ có đầu ra. Ngày hết hạn của khoá bí mật ký.

truncated_secret string (không bắt buộc)

Chỉ có đầu ra. Phiên bản rút gọn của khoá bí mật ký.

state enum (string) (không bắt buộc)

Chỉ có đầu ra. Trạng thái của webhook.

Các giá trị có thể có:

enabled
Webhook đang bật.
disabled
Người dùng đã tắt webhook.
disabled_due_to_failed_deliveries
Webhook bị vô hiệu hoá do không gửi được.

subscribed_events array (enum (string)) (không bắt buộc)

Các giá trị có thể có:

batch.succeeded
Đã hoàn tất quá trình xử lý hàng loạt.
batch.expired
Lô chưa được xử lý trong khung thời gian 48 giờ.
batch.failed
Không thực hiện được công việc hàng loạt.
interaction.requires_action
Hoạt động tương tác yêu cầu hành động (ví dụ: gọi hàm).
interaction.completed
Đã hoàn tất tương tác thành công.
interaction.failed
Không tương tác được.
video.generated
Đã tạo xong video.

update_time string (không bắt buộc)

Chỉ có đầu ra. Dấu thời gian khi webhook được cập nhật lần gần đây nhất.

uri string (không bắt buộc)

Bắt buộc. URI mà các sự kiện webhook sẽ được gửi đến.

Ví dụ

Ví dụ về phản hồi

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

Cập nhật một Webhook hiện có.

Tham số đường dẫn / truy vấn
Nội dung yêu cầu
Đáp

Tham số đường dẫn / truy vấn

id string (bắt buộc)

Bắt buộc. Mã nhận dạng của webhook cần cập nhật.

update_mask string (không bắt buộc)

Không bắt buộc. Danh sách các trường cần cập nhật.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

name string (không bắt buộc)

Không bắt buộc. Tên do người dùng cung cấp của webhook.

state enum (string) (không bắt buộc)

Không bắt buộc. Trạng thái của webhook.

Các giá trị có thể có:

enabled
Webhook đang bật.
disabled
Người dùng đã tắt webhook.
disabled_due_to_failed_deliveries
Webhook bị vô hiệu hoá do không gửi được.

subscribed_events array (enum (string)) (không bắt buộc)

Không bắt buộc. Các sự kiện mà webhook đăng ký nhận. Các sự kiện có sẵn: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Các giá trị có thể có:

batch.succeeded
Đã hoàn tất quá trình xử lý hàng loạt.
batch.expired
Lô chưa được xử lý trong khung thời gian 48 giờ.
batch.failed
Không thực hiện được công việc hàng loạt.
interaction.requires_action
Hoạt động tương tác yêu cầu hành động (ví dụ: gọi hàm).
interaction.completed
Đã hoàn tất tương tác thành công.
interaction.failed
Không tương tác được.
video.generated
Đã tạo xong video.

uri string (không bắt buộc)

Không bắt buộc. URI mà các sự kiện webhook sẽ được gửi đến.

Phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

create_time string (không bắt buộc)

Chỉ có đầu ra. Dấu thời gian cho biết thời điểm tạo webhook.

id string (không bắt buộc)

Chỉ có đầu ra. Mã nhận dạng của webhook.

name string (không bắt buộc)

Không bắt buộc. Tên do người dùng cung cấp của webhook.

new_signing_secret string (không bắt buộc)

Chỉ có đầu ra. Khoá bí mật ký mới cho webhook. Chỉ được điền sẵn khi tạo.

signing_secrets array (SigningSecret) (không bắt buộc)

Chỉ có đầu ra. Khoá bí mật ký liên kết với webhook này.

Trường

expire_time string (không bắt buộc)

Chỉ có đầu ra. Ngày hết hạn của khoá bí mật ký.

truncated_secret string (không bắt buộc)

Chỉ có đầu ra. Phiên bản rút gọn của khoá bí mật ký.

state enum (string) (không bắt buộc)

Chỉ có đầu ra. Trạng thái của webhook.

Các giá trị có thể có:

enabled
Webhook đang bật.
disabled
Người dùng đã tắt webhook.
disabled_due_to_failed_deliveries
Webhook bị vô hiệu hoá do không gửi được.

subscribed_events array (enum (string)) (không bắt buộc)

Các giá trị có thể có:

batch.succeeded
Đã hoàn tất quá trình xử lý hàng loạt.
batch.expired
Lô chưa được xử lý trong khung thời gian 48 giờ.
batch.failed
Không thực hiện được công việc hàng loạt.
interaction.requires_action
Hoạt động tương tác yêu cầu hành động (ví dụ: gọi hàm).
interaction.completed
Đã hoàn tất tương tác thành công.
interaction.failed
Không tương tác được.
video.generated
Đã tạo xong video.

update_time string (không bắt buộc)

Chỉ có đầu ra. Dấu thời gian khi webhook được cập nhật lần gần đây nhất.

uri string (không bắt buộc)

Bắt buộc. URI mà các sự kiện webhook sẽ được gửi đến.

Ví dụ

Ví dụ về phản hồi

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

Xoá một Webhook.

Tham số đường dẫn / truy vấn
Đáp

Tham số đường dẫn / truy vấn

id string (bắt buộc)

Bắt buộc. Mã của webhook cần xoá. Định dạng: `{webhook_id}`

Phản hồi

Nếu thành công, phản hồi sẽ trống.

Ví dụ

Tài nguyên

Webhook

Tài nguyên Webhook.

Trường

create_time string (không bắt buộc)

Chỉ có đầu ra. Dấu thời gian cho biết thời điểm tạo webhook.

id string (không bắt buộc)

Chỉ có đầu ra. Mã nhận dạng của webhook.

name string (không bắt buộc)

Không bắt buộc. Tên do người dùng cung cấp của webhook.

new_signing_secret string (không bắt buộc)

Chỉ có đầu ra. Khoá bí mật ký mới cho webhook. Chỉ được điền sẵn khi tạo.

signing_secrets array (SigningSecret) (không bắt buộc)

Chỉ có đầu ra. Khoá bí mật ký liên kết với webhook này.

Trường

expire_time string (không bắt buộc)

Chỉ có đầu ra. Ngày hết hạn của khoá bí mật ký.

truncated_secret string (không bắt buộc)

Chỉ có đầu ra. Phiên bản rút gọn của khoá bí mật ký.

state enum (string) (không bắt buộc)

Chỉ có đầu ra. Trạng thái của webhook.

Các giá trị có thể có:

enabled
Webhook đang bật.
disabled
Người dùng đã tắt webhook.
disabled_due_to_failed_deliveries
Webhook bị vô hiệu hoá do không gửi được.

subscribed_events array (enum (string)) (không bắt buộc)

Các giá trị có thể có:

batch.succeeded
Đã hoàn tất quá trình xử lý hàng loạt.
batch.expired
Lô chưa được xử lý trong khung thời gian 48 giờ.
batch.failed
Không thực hiện được công việc hàng loạt.
interaction.requires_action
Hoạt động tương tác yêu cầu hành động (ví dụ: gọi hàm).
interaction.completed
Đã hoàn tất tương tác thành công.
interaction.failed
Không tương tác được.
video.generated
Đã tạo xong video.

update_time string (không bắt buộc)

Chỉ có đầu ra. Dấu thời gian khi webhook được cập nhật lần gần đây nhất.

uri string (không bắt buộc)

Bắt buộc. URI mà các sự kiện webhook sẽ được gửi đến.