Prova il server MCP per Google Analytics. Installa da
GitHub e consulta l'
annuncio per maggiori dettagli.
WebhookNotification
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Configura una risorsa di operazioni di lunga durata per inviare una notifica webhook dall'API di dati di Google Analytics al tuo server webhook quando la risorsa viene aggiornata.
Le configurazioni delle notifiche contengono valori privati e sono visibili solo al tuo progetto Google Cloud. Progetti Google Cloud diversi possono associare notifiche webhook diverse alla stessa risorsa di operazioni a lungo termine.
| Rappresentazione JSON |
{
"uri": string,
"channelToken": string
} |
| Campi |
uri |
string
Facoltativo. L'indirizzo web che riceverà la notifica webhook. Questo indirizzo riceverà le richieste POST man mano che cambia lo stato della risorsa dell'operazione a lungo termine. La richiesta POST conterrà sia una versione JSON della risorsa dell'operazione a lungo termine nel corpo sia un campo sentTimestamp. Il timestamp inviato specifica i microsecondi Unix dall'epoca in cui è stata inviata la richiesta; in questo modo puoi identificare le notifiche riprodotte. Un esempio di URI è https://us-central1-example-project-id.cloudfunctions.net/example-function-1. L'URI deve utilizzare HTTPS e puntare a un sito con un certificato SSL valido sul server web. L'URI deve avere una lunghezza massima della stringa di 128 caratteri e utilizzare solo i caratteri inclusi nella lista consentita dell'RFC 1738. Quando il server webhook riceve una notifica, deve rispondere con un codice di stato di risposta HTTP 200 entro 5 secondi. Per utilizzare le notifiche webhook è necessario un URI. Le richieste a questo server webhook conterranno un token ID che autentica l'account di servizio google-analytics-audience-export@system.gserviceaccount.com. Per scoprire di più sugli ID token, consulta https://cloud.google.com/docs/authentication/token-types#id. Per Google Cloud Functions, ti consente di configurare la funzione in modo che richieda l'autenticazione. In Cloud IAM, dovrai concedere le autorizzazioni dell'account di servizio ai ruoli Invoker di Cloud Run (roles/run.invoker) e Invoker di Cloud Functions (roles/cloudfunctions.invoker) affinché la richiesta di post webhook possa superare l'autenticazione di Google Cloud Functions. Questa API può inviare notifiche webhook a URI arbitrari; per i server webhook diversi da Google Cloud Functions, questo token ID nell'intestazione dell'autenticazione con token deve essere ignorato se non è necessario.
|
channelToken |
string
Facoltativo. Il token del canale è un valore di stringa arbitrario e deve avere una lunghezza massima di 64 caratteri. I token canale ti consentono di verificare l'origine di una notifica webhook. In questo modo, il messaggio viene protetto dallo spoofing. Il token del canale verrà specificato nell'intestazione HTTP X-Goog-Channel-Token della richiesta POST webhook. Non è necessario un token canale per utilizzare le notifiche webhook.
|
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-26 UTC.
[null,null,["Ultimo aggiornamento 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. |"]]
