Esta página foi traduzida pela API Cloud Translation.

WebhookNotification

Representação JSON

Configura um recurso de operação de longa duração para enviar uma notificação do 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 ficam visíveis apenas 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

Campos
`uri`	`string` Opcional. O endereço da Web que receberá a notificação de webhook. Esse endereço receberá solicitações POST à medida que o estado do recurso de operação de longa duração for alterado. A solicitação POST 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 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 string de 128 caracteres. Use somente os caracteres permitidos da RFC 1738 (link em inglês). Quando o servidor de webhook recebe uma notificação, espera-se que ele responda 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 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 permissões da conta de serviço ao Invocador do Cloud Run (`roles/run.invoker`) e Papéis de invocador do Cloud Functions (`roles/cloudfunctions.invoker`) para a solicitação de postagem do webhook para transmitir 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 são do Google Cloud Functions, esse token de ID no cabeçalho do portador de 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 deve ter um comprimento máximo de string de 64 caracteres. Os tokens de canal permitem verificar a origem de uma notificação de webhook. Isso protege contra spoofing de mensagens. O token de 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 webhook.

uri

string

Opcional. O endereço da Web que receberá a notificação de webhook. Esse endereço receberá solicitações POST à medida que o estado do recurso de operação de longa duração for alterado. A solicitação POST 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 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 string de 128 caracteres. Use somente os caracteres permitidos da RFC 1738 (link em inglês).

Quando o servidor de webhook recebe uma notificação, espera-se que ele responda 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 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 permissões da conta de serviço ao Invocador do Cloud Run (roles/run.invoker) e Papéis de invocador do Cloud Functions (roles/cloudfunctions.invoker) para a solicitação de postagem do webhook para transmitir 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 são do Google Cloud Functions, esse token de ID no cabeçalho do portador de 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 deve ter um comprimento máximo de string de 64 caracteres. Os tokens de canal permitem verificar a origem de uma notificação de webhook. Isso protege contra spoofing de mensagens. O token de 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 webhook.