Wypróbuj serwer MCP w Google Analytics. Zainstaluj go z
GitHub. Więcej informacji znajdziesz w
ogłoszeniu.
WebhookNotification
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Konfiguruje zasób długotrwałej operacji, aby wysyłać powiadomienie webhooka z interfejsu Google Analytics Data API do serwera webhooka, gdy zasób zostanie zaktualizowany.
Konfiguracje powiadomień zawierają wartości prywatne i są widoczne tylko dla Twojego projektu w Google Cloud Platform. Różne projekty GCP mogą dołączać różne powiadomienia webhooka do tego samego zasobu długotrwałej operacji.
| Zapis JSON |
{
"uri": string,
"channelToken": string
} |
| Pola |
uri |
string
Opcjonalnie: Adres internetowy, na który będzie wysyłane powiadomienie webhook. Ten adres będzie otrzymywać żądania POST, gdy zmienia się stan zasobu długotrwałej operacji. Żądanie POST zawiera w treści zarówno wersję zasobu operacji długotrwałej w formacie JSON, jak i pole sentTimestamp. Wysłana sygnatura czasowa będzie określać mikrosekundy w systemie Unix od początku epoki, w której wysłano żądanie. Pozwoli to zidentyfikować odtworzone powiadomienia. Przykładowy identyfikator URI to https://us-central1-example-project-id.cloudfunctions.net/example-function-1. Identyfikator URI musi używać protokołu HTTPS i wskazywać witrynę z prawidłowym certyfikatem SSL na serwerze WWW. Adres URI musi mieć maksymalnie 128 znaków i zawierać tylko znaki wymienione w specyfikacji RFC 1738. Gdy serwer webhooka otrzyma powiadomienie, powinien w ciągu 5 sekund odpowiedzieć kodem stanu odpowiedzi HTTP 200. Aby korzystać z powiadomień webhook, musisz podać identyfikator URI. Żądania wysyłane do tego serwera webhooka będą zawierać token identyfikacyjny uwierzytelniający konto usługi google-analytics-audience-export@system.gserviceaccount.com. Więcej informacji o tokenach tożsamości znajdziesz na stronie https://cloud.google.com/docs/authentication/token-types#id. W przypadku Google Cloud Functions możesz skonfigurować funkcję tak, aby wymagała uwierzytelniania. Aby przekazać żądanie przesłania webhooka do uwierzytelniania Google Cloud Functions, musisz w Cloud IAM przyznać uprawnienia do konta usługi do roli Wywołujący Cloud Run (roles/run.invoker) i Wywołujący Cloud Functions (roles/cloudfunctions.invoker). Ten interfejs API może wysyłać powiadomienia webhook do dowolnych adresów URI. W przypadku serwerów webhook innych niż Google Cloud Functions ten identyfikator tożsamości w nagłówku autoryzacji z uprawnieniami „Bearer” należy zignorować, jeśli nie jest potrzebny.
|
channelToken |
string
Opcjonalnie: Token kanału to dowolny ciąg znaków, który może mieć maksymalnie 64 znaki. Tokeny kanału umożliwiają weryfikację źródła powiadomienia webhook. Zapobiega to podszywania się pod inną osobę. Token kanału będzie określony w nagłówku HTTP X-Goog-Channel-Token żądania POST webhooka. Aby korzystać z powiadomień webhook, nie musisz mieć tokenu kanału.
|
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-26 UTC.
[null,null,["Ostatnia aktualizacja: 2025-07-26 UTC."],[[["\u003cp\u003eWebhook notifications can be configured for long-running operations in the Google Analytics Data API to send updates to your server.\u003c/p\u003e\n"],["\u003cp\u003eThese notifications are project-specific and include a JSON payload with operation details and a timestamp.\u003c/p\u003e\n"],["\u003cp\u003eThe webhook configuration requires a URI using HTTPS with a valid SSL certificate, and optionally, a channel token for verification.\u003c/p\u003e\n"],["\u003cp\u003eWhen receiving a notification, your server should respond with an HTTP 200 status code within 5 seconds.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication for Google Cloud Functions is provided through an ID token representing the service account \u003ccode\u003egoogle-analytics-audience-export@system.gserviceaccount.com\u003c/code\u003e, while other webhook servers can ignore this token.\u003c/p\u003e\n"]]],["This document outlines the configuration for webhook notifications from the Google Analytics Data API. You can set up a webhook server (`uri`) to receive POST requests containing long-running operation resource updates in JSON format, along with a `sentTimestamp`. The `uri` must be HTTPS with a valid SSL certificate and is required for webhook notifications. Optionally, use a `channelToken` for source verification, which is included in the `X-Goog-Channel-Token` header. Notifications will include an ID token for authentication.\n"],null,["# WebhookNotification\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nConfigures a long-running operation resource to send a webhook notification from the Google Analytics Data API to your webhook server when the resource updates.\n\nNotification configurations contain private values \\& are only visible to your GCP project. Different GCP projects may attach different webhook notifications to the same long-running operation resource.\n\n| JSON representation |\n|---------------------------------------------------|\n| ``` { \"uri\": string, \"channelToken\": string } ``` |\n\n| Fields ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `uri` | `string` Optional. The web address that will receive the webhook notification. This address will receive POST requests as the state of the long running operation resource changes. The POST request will contain both a JSON version of the long running operation resource in the body and a `sentTimestamp` field. The sent timestamp will specify the unix microseconds since the epoch that the request was sent; this lets you identify replayed notifications. An example URI is `https://us-central1-example-project-id.cloudfunctions.net/example-function-1`. The URI must use HTTPS and point to a site with a valid SSL certificate on the web server. The URI must have a maximum string length of 128 characters \\& use only the allowlisted characters from [RFC 1738](https://www.rfc-editor.org/rfc/rfc1738). When your webhook server receives a notification, it is expected to reply with an HTTP response status code of 200 within 5 seconds. A URI is required to use webhook notifications. Requests to this webhook server will contain an ID token authenticating the service account `google-analytics-audience-export@system.gserviceaccount.com`. To learn more about ID tokens, see \u003chttps://cloud.google.com/docs/authentication/token-types#id\u003e. For Google Cloud Functions, this lets you configure your function to require authentication. In Cloud IAM, you will need to grant the service account permissions to the Cloud Run Invoker (`roles/run.invoker`) \\& Cloud Functions Invoker (`roles/cloudfunctions.invoker`) roles for the webhook post request to pass Google Cloud Functions authentication. This API can send webhook notifications to arbitrary URIs; for webhook servers other than Google Cloud Functions, this ID token in the authorization bearer header should be ignored if it is not needed. |\n| `channel``Token` | `string` Optional. The channel token is an arbitrary string value and must have a maximum string length of 64 characters. Channel tokens allow you to verify the source of a webhook notification. This guards against the message being spoofed. The channel token will be specified in the `X-Goog-Channel-Token` HTTP header of the webhook POST request. A channel token is not required to use webhook notifications. |"]]
