Teste o servidor MCP do Google Analytics. Instale no
GitHub e confira o
anúncio para mais detalhes.
WebhookNotification
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003eWebhook notifications can be configured for long-running operations in the Google Analytics Data API to send updates to your server.\u003c/p\u003e\n"],["\u003cp\u003eThese notifications are project-specific and include a JSON payload with operation details and a timestamp.\u003c/p\u003e\n"],["\u003cp\u003eThe webhook configuration requires a URI using HTTPS with a valid SSL certificate, and optionally, a channel token for verification.\u003c/p\u003e\n"],["\u003cp\u003eWhen receiving a notification, your server should respond with an HTTP 200 status code within 5 seconds.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication for Google Cloud Functions is provided through an ID token representing the service account \u003ccode\u003egoogle-analytics-audience-export@system.gserviceaccount.com\u003c/code\u003e, while other webhook servers can ignore this token.\u003c/p\u003e\n"]]],["This document outlines the configuration for webhook notifications from the Google Analytics Data API. You can set up a webhook server (`uri`) to receive POST requests containing long-running operation resource updates in JSON format, along with a `sentTimestamp`. The `uri` must be HTTPS with a valid SSL certificate and is required for webhook notifications. Optionally, use a `channelToken` for source verification, which is included in the `X-Goog-Channel-Token` header. Notifications will include an ID token for authentication.\n"],null,["# WebhookNotification\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nConfigures a long-running operation resource to send a webhook notification from the Google Analytics Data API to your webhook server when the resource updates.\n\nNotification configurations contain private values \\& are only visible to your GCP project. Different GCP projects may attach different webhook notifications to the same long-running operation resource.\n\n| JSON representation |\n|---------------------------------------------------|\n| ``` { \"uri\": string, \"channelToken\": string } ``` |\n\n| Fields ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `uri` | `string` Optional. The web address that will receive the webhook notification. This address will receive POST requests as the state of the long running operation resource changes. The POST request will contain both a JSON version of the long running operation resource in the body and a `sentTimestamp` field. The sent timestamp will specify the unix microseconds since the epoch that the request was sent; this lets you identify replayed notifications. An example URI is `https://us-central1-example-project-id.cloudfunctions.net/example-function-1`. The URI must use HTTPS and point to a site with a valid SSL certificate on the web server. The URI must have a maximum string length of 128 characters \\& use only the allowlisted characters from [RFC 1738](https://www.rfc-editor.org/rfc/rfc1738). When your webhook server receives a notification, it is expected to reply with an HTTP response status code of 200 within 5 seconds. A URI is required to use webhook notifications. Requests to this webhook server will contain an ID token authenticating the service account `google-analytics-audience-export@system.gserviceaccount.com`. To learn more about ID tokens, see \u003chttps://cloud.google.com/docs/authentication/token-types#id\u003e. For Google Cloud Functions, this lets you configure your function to require authentication. In Cloud IAM, you will need to grant the service account permissions to the Cloud Run Invoker (`roles/run.invoker`) \\& Cloud Functions Invoker (`roles/cloudfunctions.invoker`) roles for the webhook post request to pass Google Cloud Functions authentication. This API can send webhook notifications to arbitrary URIs; for webhook servers other than Google Cloud Functions, this ID token in the authorization bearer header should be ignored if it is not needed. |\n| `channel``Token` | `string` Optional. The channel token is an arbitrary string value and must have a maximum string length of 64 characters. Channel tokens allow you to verify the source of a webhook notification. This guards against the message being spoofed. The channel token will be specified in the `X-Goog-Channel-Token` HTTP header of the webhook POST request. A channel token is not required to use webhook notifications. |"]]
