Hits de validação – Protocolo de avaliação

Neste documento, você aprende a validar hits do Protocolo de avaliação do Google Analytics.

Visão geral

O Protocolo de avaliação do Google Analytics não retorna códigos de erro HTTP, mesmo que um hit do Protocolo de avaliação esteja incorreto ou sem parâmetros obrigatórios. Para garantir que seus hits estejam formatados corretamente e contenham todos os parâmetros obrigatórios, você pode testá-los com o servidor de validação antes de inseri-los na produção.

Este guia descreve o processo de envio de hits ao servidor de validação do Protocolo de avaliação e explica como interpretar a resposta.

O Criador de hit do Protocolo de avaliação, uma ferramenta que permite criar e validar hits do Protocolo de avaliação de maneira interativa, usa esse servidor de validação.

Envio de hits para validação

Hits podem ser enviados para o servidor de validação do Protocolo de avaliação por qualquer método compatível com o Protocolo de avaliação. A única diferença é o URL. Para enviar hits ao servidor de validação do Measurement Protocol, use o endpoint /debug/collect em vez de /collect. O exemplo a seguir mostra um hit inválido enviado para o servidor de validação do Protocolo de avaliação:

https://www.google-analytics.com/debug/collect?tid=fake&v=1

Para mais detalhes sobre como criar um hit do Protocolo de avaliação, consulte a referência do protocolo.

Importante:os hits enviados para o servidor de validação do Measurement Protocol não são exibidos nos relatórios. Eles são usados apenas para depuração.

Como interpretar a resposta

Respostas do servidor de validação do Protocolo de avaliação são exibidas no formato JSON. O exemplo a seguir mostra a resposta do hit exibido acima:

{
  "hitParsingResult": [
    {
      "valid": false,
      "hit": "GET /debug/collect?tid=fake\u0026v=1 HTTP/1.1",
      "parserMessage": [
        {
          "messageType": "ERROR",
          "description": "The value provided for parameter 'tid' is invalid. Please see http://goo.gl/a8d4RP#tid for details.",
          "parameter": "tid"
        },
        {
          "messageType": "ERROR",
          "description": "Tracking Id is a required field for this hit. Please see http://goo.gl/a8d4RP#tid for details.",
          "parameter": "tid"
        }
      ]
    }
  ]
}

A raiz da resposta, hitParsingResult, é uma matriz cujo tamanho corresponde ao número de hits enviados na solicitação original. Cada objeto na matriz conterá as chaves valid, hit e parserMessage. Se um hit for inválido, parserMessage vai conter uma matriz de objetos com a descrição dos problemas de validação. Se um hit for válido, parserMessage será uma matriz vazia.

A tabela a seguir descreve as propriedades de cada item na matriz hitParsingResult:

Chave	Tipo	Descrição
valid	Boolean	true para hits válidos, false para hits inválidos.
hit	string	Uma string com o caminho da solicitação, assim como o método e o protocolo dela.
parserMessage	Array	Uma lista de mensagens do analisador. Se o hit for válido, esse conjunto ficará vazio.
parserMessage.messageType	string	Os valores possíveis são "INFO", "WARN" e "ERROR".
parserMessage.description	string	Detalhes ou etapas adicionais para corrigir o problema de validação.
parserMessage.parameter	string|undefined	O parâmetro (se aplicável) que causa o problema de validação.