WebhookNotification

Configura um recurso de operação de longa duração para enviar uma notificação de webhook da API Data do Google Analytics ao seu servidor de webhook quando o recurso é atualizado.

As configurações de notificação contêm valores particulares e só são visíveis para o projeto do GCP. Projetos do GCP diferentes podem anexar diferentes notificações de webhook ao mesmo recurso de operação de longa duração.

Representação JSON 
{
  "uri": string,
  "channelToken": string
}
Campos
uri

string

Opcional. O endereço da Web que receberá a notificação do webhook. Esse endereço receberá solicitações POST como o estado das alterações do recurso de operação de longa duração. A solicitação POST vai conter uma versão JSON do recurso de operação de longa duração no corpo e um campo sentTimestamp. O carimbo de data/hora enviado especifica o número de microssegundos do Unix desde a época em que a solicitação foi enviada. Isso permite identificar as notificações repetidas.

Um URI de exemplo é https://us-central1-example-project-id.cloudfunctions.net/example-function-1.

O URI precisa usar HTTPS e apontar para um site com um certificado SSL válido no servidor da Web. O URI precisa ter uma string máxima de 128 caracteres e usar apenas os caracteres da lista de permissões da RFC 1738 (link em inglês).

Quando o servidor de webhook recebe uma notificação, ele deve responder com um código de status de resposta HTTP 200 em até cinco segundos.

É necessário um URI para usar as notificações de webhook.

As solicitações para este servidor de webhook conterão um token de ID que autentica a conta de serviço google-analytics-audience-export@system.gserviceaccount.com. Para saber mais sobre tokens de ID, consulte https://cloud.google.com/docs/authentication/token-types#id. Para o Google Cloud Functions, isso permite que você configure a função para exigir autenticação. No Cloud IAM, você precisará conceder as permissões da conta de serviço aos papéis Invocador do Cloud Run (roles/run.invoker) e Invocador do Cloud Functions (roles/cloudfunctions.invoker) para que a solicitação de postagem do webhook passe a autenticação do Google Cloud Functions. Essa API pode enviar notificações de webhook para URIs arbitrários. Para servidores de webhook que não sejam o Google Cloud Functions, esse token de ID no cabeçalho do portador da autorização deverá ser ignorado se não for necessário.
channelToken

string

Opcional. O token de canal é um valor de string arbitrário e precisa ter no máximo 64 caracteres. Os tokens de canal permitem verificar a origem de uma notificação de webhook. Isso protege contra o spoofing da mensagem. O token do canal será especificado no cabeçalho HTTP X-Goog-Channel-Token da solicitação POST do webhook.

Um token de canal não é necessário para usar notificações de webhook.