WebhookNotification

Configura una risorsa operazione a lunga esecuzione per inviare una notifica webhook dall'API di dati di Google Analytics al server webhook quando la risorsa viene aggiornata.

Le configurazioni delle notifiche contengono valori privati e sono visibili solo al tuo progetto Google Cloud. Diversi progetti Google Cloud possono collegare notifiche webhook diverse alla stessa risorsa operazione a lunga esecuzione.

Rappresentazione JSON
{
  "uri": string,
  "channelToken": string
}
Campi
uri

string

Campo facoltativo. L'indirizzo web che riceverà la notifica del webhook. Questo indirizzo riceverà richieste POST quando cambia lo stato della risorsa dell'operazione a lunga esecuzione. La richiesta POST conterrà sia una versione JSON della risorsa dell'operazione a lunga esecuzione nel corpo sia un campo sentTimestamp. Il timestamp inviato specificherà i microsecondi Unix dall'epoca in cui è stata inviata la richiesta. In questo modo puoi identificare le notifiche riprodotte.

Un URI di esempio è 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 delle stringhe di 128 caratteri e utilizzare solo i caratteri inclusi nella lista consentita da RFC 1738.

Quando il server webhook riceve una notifica, dovrebbe 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ù sui token ID, consulta https://cloud.google.com/docs/authentication/token-types#id. Per Google Cloud Functions, consente di configurare la funzione in modo che richieda l'autenticazione. In Cloud IAM, devi 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 superi 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 di connessione di autorizzazione deve essere ignorato, se non è necessario.

channelToken

string

Campo facoltativo. Il token di canale è un valore stringa arbitrario e deve avere una stringa di massimo 64 caratteri. I token di canale ti consentono di verificare l'origine di una notifica webhook. Questa funzionalità evita che il messaggio venga falsificato. Il token del canale verrà specificato nell'intestazione HTTP X-Goog-Channel-Token della richiesta POST webhook.

Per utilizzare le notifiche webhook, non è necessario un token del canale.