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 servidor de webhook quando o recurso for atualizado.
As configurações de notificação contêm valores particulares e só ficam visíveis para seu projeto do GCP. Diferentes projetos do GCP 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 vai receber a notificação do webhook. Esse endereço vai receber solicitações POST à medida que o estado do recurso da operação de longa duração mudar. A solicitação POST vai conter uma versão JSON do recurso de operação de longa execução no corpo e um campo sentTimestamp. O carimbo de data/hora enviado vai especificar os microssegundos do Unix desde a época em que a solicitação foi enviada. Isso permite identificar notificações repetidas. Um exemplo de URI é 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 um comprimento máximo de 128 caracteres e usar apenas os caracteres listados no RFC 1738. Quando o servidor do webhook recebe uma notificação, ele precisa responder com um código de status de resposta HTTP 200 em até 5 segundos. É necessário um URI para usar notificações de webhook. As solicitações para esse servidor de webhook vão conter um token de ID que autentica a conta de serviço google-analytics-audience-export@system.gserviceaccount.com. Para saber mais sobre os tokens de ID, consulte https://cloud.google.com/docs/authentication/token-types#id. No Google Cloud Functions, isso permite que você configure a função para exigir autenticação. No IAM do Cloud, você precisa conceder as permissões da conta de serviço aos papéis de Invocador do Cloud Run (roles/run.invoker) e Invocador do Cloud Functions (roles/cloudfunctions.invoker) para que a solicitação de postagem do webhook seja aprovada na autenticação do Google Cloud Functions. Essa API pode enviar notificações de webhook para URIs arbitrários. Para servidores de webhook diferentes do Cloud Functions, esse token de ID no cabeçalho de portador de autorização precisa ser ignorado se não for necessário.
|
channelToken |
string
Opcional. O token do canal é um valor de string arbitrário e precisa ter um comprimento máximo de 64 caracteres. Os tokens de canal permitem verificar a origem de uma notificação de webhook. Isso protege contra a falsificação de mensagens. O token do canal será especificado no cabeçalho HTTP X-Goog-Channel-Token da solicitação POST do webhook. Não é necessário um token de canal para usar notificações de webhook.
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-11-20 UTC.
[null,null,["Última atualização 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."]]],[]]
