WebhookNotification

Định cấu hình tài nguyên hoạt động chạy trong thời gian dài để gửi thông báo webhook từ API Dữ liệu Google Analytics đến máy chủ webhook của bạn khi tài nguyên cập nhật.

Cấu hình thông báo chứa các giá trị riêng tư và chỉ dự án GCP của bạn mới thấy được. Các dự án GCP khác nhau có thể đính kèm các thông báo webhook khác nhau vào cùng một tài nguyên hoạt động chạy trong thời gian dài.

Biểu diễn dưới dạng JSON 
{
  "uri": string,
  "channelToken": string
}
Trường
uri

string

Không bắt buộc. Địa chỉ web sẽ nhận được thông báo webhook. Địa chỉ này sẽ nhận được các yêu cầu POST khi trạng thái của tài nguyên hoạt động chạy trong thời gian dài thay đổi. Yêu cầu POST sẽ chứa cả phiên bản JSON của tài nguyên thao tác chạy trong thời gian dài trong phần nội dung và trường sentTimestamp. Dấu thời gian đã gửi sẽ chỉ định số micro giây unix kể từ thời gian bắt đầu của đồng hồ mà yêu cầu được gửi; điều này cho phép bạn xác định thông báo phát lại.

Ví dụ về URI là https://us-central1-example-project-id.cloudfunctions.net/example-function-1.

URI phải sử dụng HTTPS và trỏ đến một trang web có chứng chỉ SSL hợp lệ trên máy chủ web. URI phải có độ dài chuỗi tối đa là 128 ký tự và chỉ sử dụng các ký tự có trong danh sách cho phép theo RFC 1738.

Khi nhận được thông báo, máy chủ webhook của bạn sẽ phản hồi bằng mã trạng thái phản hồi HTTP là 200 trong vòng 5 giây.

Bạn phải có URI để sử dụng thông báo webhook.

Các yêu cầu gửi đến máy chủ webhook này sẽ chứa mã thông báo nhận dạng xác thực tài khoản dịch vụ google-analytics-audience-export@system.gserviceaccount.com. Để tìm hiểu thêm về mã thông báo nhận dạng, hãy xem https://cloud.google.com/docs/authentication/token-types#id. Đối với Google Cloud Functions, việc này cho phép bạn định cấu hình hàm để yêu cầu xác thực. Trong Cloud IAM, bạn cần cấp quyền cho tài khoản dịch vụ cho vai trò Trình gọi Cloud Run (roles/run.invoker) và Trình gọi Cloud Functions (roles/cloudfunctions.invoker) để yêu cầu đăng webhook có thể vượt qua quy trình xác thực Google Cloud Functions. API này có thể gửi thông báo webhook đến các URI tuỳ ý; đối với các máy chủ webhook không phải là Google Cloud Functions, bạn nên bỏ qua mã nhận dạng này trong tiêu đề người mang mã uỷ quyền nếu không cần thiết.
channelToken

string

Không bắt buộc. Mã thông báo kênh là một giá trị chuỗi tuỳ ý và phải có độ dài chuỗi tối đa là 64 ký tự. Mã thông báo kênh cho phép bạn xác minh nguồn của thông báo webhook. Điều này giúp ngăn chặn việc thư bị giả mạo. Mã thông báo kênh sẽ được chỉ định trong tiêu đề HTTP X-Goog-Channel-Token của yêu cầu POST webhook.

Bạn không cần mã thông báo kênh để sử dụng thông báo webhook.