WebhookNotification
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 2024-11-20 UTC.
[null,null,["Ultimo aggiornamento 2024-11-20 UTC."],[[["Webhook notifications can be configured for long-running operations in the Google Analytics Data API to send updates to your server."],["These notifications are project-specific and include a JSON payload with operation details and a timestamp."],["The webhook configuration requires a URI using HTTPS with a valid SSL certificate, and optionally, a channel token for verification."],["When receiving a notification, your server should respond with an HTTP 200 status code within 5 seconds."],["Authentication for Google Cloud Functions is provided through an ID token representing the service account `google-analytics-audience-export@system.gserviceaccount.com`, while other webhook servers can ignore this token."]]],[]]
