WebhookNotification

Thiết lập tài nguyên hoạt động lâu dài để gửi thông báo webhook từ Google Analytics Data API đến máy chủ webhook 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ỉ hiển thị với dự án GCP của bạn. 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 diễn ra 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 thông báo webhook. Địa chỉ này sẽ nhận các yêu cầu POST khi trạng thái của các thay đổi về tài nguyên hoạt động trong thời gian dài. Yêu cầu POST sẽ chứa cả phiên bản JSON của tài nguyên hoạt động 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 thời gian bắt đầu của hệ thống (unix micro giây) kể từ thời gian bắt đầu của yêu cầu được gửi; điều này cho phép bạn xác định các thông báo được phát lại.

URI mẫu là https://us-central1-example-project-id.cloudfunctions.net/example-function-1.

URI phải sử dụng HTTPS và trỏ đến 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ỉ được dùng các ký tự được cho phép theo RFC 1738.

Khi nhận được thông báo, máy chủ webhook sẽ phản hồi kèm theo 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 qua webhook.

Các yêu cầu gửi đến máy chủ webhook này sẽ chứa một mã thông báo mã 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 truy cập vào https://cloud.google.com/docs/authentication/token-types#id. Đối với Google Cloud Functions, thao tác này cho phép bạn định cấu hình hàm của mình để yêu cầu xác thực. Trong Cloud IAM, bạn cần cấp quyền tài khoản dịch vụ cho các vai trò Cloud Run Invoker (roles/run.invoker) và Cloud Functions Invoker (roles/cloudfunctions.invoker) để yêu cầu đăng qua webhook để vượt qua quy trình xác thực của Google Cloud Functions. API này có thể gửi thông báo webhook đến các URI tùy ý; đối với các máy chủ webhook không phải là Google Cloud Functions, bạn nên bỏ qua mã thông báo mã nhận dạng này trong tiêu đề của mục lưu trữ 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 của kênh giúp bạn xác minh nguồn của thông báo webhook. Điều này giúp bảo vệ 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 qua webhook.

Bạn không bắt buộc phải có mã thông báo kênh để sử dụng thông báo webhook.