WebhookNotification

Configura una risorsa operativa 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. Progetti Google Cloud diversi possono collegare notifiche webhook diverse alla stessa risorsa per le operazioni a lunga esecuzione.

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

string

(Facoltativo) L'indirizzo web che riceverà la notifica 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 per le operazioni a lunga esecuzione nel corpo sia un campo sentTimestamp. Il timestamp inviato specificherà i microsecondi unix dall'epoca in cui è stata inviata la richiesta. Ciò ti consente di 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 della stringa di 128 caratteri & Utilizza solo i caratteri inclusi nella lista consentita da RFC 1738.

Quando il server webhook riceve una notifica, dovrebbe rispondere con un codice di stato della 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 saperne di più sui token ID, consulta https://cloud.google.com/docs/authentication/token-types#id. Per Google Cloud Functions, questo ti consente di configurare la funzione in modo che richieda l'autenticazione. In Cloud IAM, devi concedere le autorizzazioni dell'account di servizio a Invoker di Cloud Run (roles/run.invoker) e Ruoli Invoker di Cloud Functions (roles/cloudfunctions.invoker) per la richiesta di pubblicazione del webhook al fine di 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 di connessione dell'autorizzazione deve essere ignorato, se non è necessario.

channelToken

string

(Facoltativo) Il token del canale è un valore stringa arbitrario e deve avere una lunghezza massima di 64 caratteri. I token del canale ti consentono di verificare l'origine di una notifica webhook. Questa protezione impedisce che il messaggio venga falsificato. Il token del canale verrà specificato nell'intestazione HTTP X-Goog-Channel-Token della richiesta POST webhook.

Non è necessario un token del canale per utilizzare le notifiche webhook.