Trang này được dịch bởi Cloud Translation API.

WebhookNotification

Biểu diễn dưới dạng JSON

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

Các cấu hình thông báo chứa các giá trị riêng tư & chỉ hiển thị với dự án GCP của bạn. Các dự án GCP 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 hoạt động trong thời gian dài.

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

Trường

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 tài nguyên hoạt động 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 hoạt động chạy lâu dài trong phần nội dung và trường `sentTimestamp`. Dấu thời gian được gửi sẽ chỉ định micrô giây unix kể từ thời gian bắt đầu của hệ thống mà 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 đã 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 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ự & chỉ sử dụng các ký tự trong danh sách cho phép từ RFC 1738. Khi nhận được thông báo, máy chủ webhook của bạn dự kiến sẽ trả lời kèm theo mã trạng thái phản hồi HTTP 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 tới máy chủ webhook này sẽ chứa một mã thông báo mã 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 mã 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, tuỳ chọn 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 sẽ cần cấp quyền tài khoản dịch vụ cho Cloud Run Invoker (`roles/run.invoker`) và Vai trò Trình gọi hàm đám mây (`roles/cloudfunctions.invoker`) đối với yêu cầu bài đăng webhook để 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 máy chủ webhook không phải là Google Cloud Functions, nếu không cần thiết, thì bạn nên bỏ qua mã thông báo mã nhận dạng này trong tiêu đề của phương thức mang uỷ quyền.
`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 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.

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 tài nguyên hoạt động 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 hoạt động chạy lâu dài trong phần nội dung và trường sentTimestamp. Dấu thời gian được gửi sẽ chỉ định micrô giây unix kể từ thời gian bắt đầu của hệ thống mà 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 đã 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 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ự & chỉ sử dụng các ký tự trong danh sách cho phép từ RFC 1738.

Khi nhận được thông báo, máy chủ webhook của bạn dự kiến sẽ trả lời kèm theo mã trạng thái phản hồi HTTP 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 tới máy chủ webhook này sẽ chứa một mã thông báo mã 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 mã 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, tuỳ chọn 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 sẽ cần cấp quyền tài khoản dịch vụ cho Cloud Run Invoker (roles/run.invoker) và Vai trò Trình gọi hàm đám mây (roles/cloudfunctions.invoker) đối với yêu cầu bài đăng webhook để 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 máy chủ webhook không phải là Google Cloud Functions, nếu không cần thiết, thì bạn nên bỏ qua mã thông báo mã nhận dạng này trong tiêu đề của phương thức mang uỷ quyền.

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 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.