Esta documentação é sobre o Universal Analytics. Consulte Measurement Protocol (Google Analytics 4) se você estiver usando o Google Analytics 4.

Uso do Protocolo de avaliação

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Este documento descreve como enviar hits comuns ao Protocolo de avaliação.

Visão geral

Este documento demonstra como formatar solicitações HTTP para enviar tipos de hit comuns ao Protocolo de avaliação do Google Analytics. Leia:

Envio de valores obrigatórios

Para enviar dados de interação dos usuários, faça uma solicitação HTTP POST a este ponto de extremidade.

POST /collect HTTP/1.1
Host: www.google-analytics.com

payload_data

Os parâmetros a seguir são obrigatórios para cada payload:

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.
&t=              // Hit Type.

Cada payload precisa conter um tipo de hit válido, e cada tipo de hit tem um conjunto próprio de campos obrigatórios. Assim, para enviar uma exibição da página /home, você usaria este payload:

v=1&tid=UA-XXXXX-Y&cid=555&t=pageview&dp=%2Fhome

As seções abaixo contêm exemplos de tipos de hit comuns.

Envio de vários hits em lote em uma única solicitação

Para enviar vários hits em uma única solicitação, use a extremidade /batch em vez de /collect e especifique cada carga na sua própria linha.

Por exemplo, para enviar hits de exibição de página para as páginas "Início", "Sobre" e "Contato" de um site, você pode enviar a solicitação em lote abaixo.

POST /batch HTTP/1.1
Host: www.google-analytics.com

v=1&tid=UA-XXXXX-Y&cid=555&t=pageview&dp=%2Fhome
v=1&tid=UA-XXXXX-Y&cid=555&t=pageview&dp=%2Fabout
v=1&tid=UA-XXXXX-Y&cid=555&t=pageview&dp=%2Fcontact

Limitações de lotes

Além dos limites padrão dos hits do Protocolo de avaliação, as solicitações em lote têm as limitações a seguir:

  • Um máximo de 20 hits pode ser especificado por pedido.
  • O tamanho total das cargas de todos os hits não pode ser superior a 16 mil bytes.
  • As cargas úteis dos hits não podem ser maiores que 8 mil bytes.

Envio de tipos de hit comuns

Veja abaixo exemplos de como enviar tipos de hit comuns ao Google Analytics. Além desses exemplos, você pode misturar e combinar vários parâmetros para conseguir novas relações de dados. Por exemplo, para entender em qual página um evento ocorreu, envie o parâmetro pagePath, p, junto com parâmetros de acompanhamento de eventos, conforme descrito abaixo.

Leia a referência de parâmetro para ver uma lista completa de todos os parâmetros que você pode enviar ao Google Analytics.

Acompanhamento de páginas

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=pageview      // Pageview hit type.
&dh=mydemo.com   // Document hostname.
&dp=/home        // Page.
&dt=homepage     // Title.

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Acompanhamento de eventos

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=event         // Event hit type
&ec=video        // Event Category. Required.
&ea=play         // Event Action. Required.
&el=holiday      // Event label.
&ev=300          // Event value.

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Acompanhamento de comércio eletrônico avançado

Os hits de comércio eletrônico avançado devem ser usados no lugar dos hits de comércio eletrônico. Se você já tiver implementado o acompanhamento de comércio eletrônico e quiser começar a usar o acompanhamento do comércio eletrônico avançado, há duas opções:

Usar uma nova propriedade

Você pode criar uma nova propriedade e enviar hits de comércio eletrônico avançado à nova propriedade.

Migrar uma propriedade existente

Migre todos os hits de comércio eletrônico para os hits de comércio eletrônico avançado seguindo os exemplos abaixo. Os dados de transações e itens coletados anteriormente com hits de comércio eletrônico não serão afetados e permanecerão disponíveis nas propriedades e vistas da propriedade às quais foram enviados originalmente.

Avaliação de impressões

v=1                                      // Version.
&tid=UA-XXXXX-Y                          // Tracking ID / Property ID.
&cid=555                                 // Anonymous Client ID.
&t=pageview                              // Pageview hit type.
&dh=mydemo.com                           // Document hostname.
&dp=/home                                // Page.
&dt=homepage                             // Title.

&il1nm=Search%20Results                  // Impression list 1. Required.
&il1pi1id=P12345                         // Product Impression 1 ID. Either ID or name must be set.
&il1pi1nm=Android%20Warhol%20T-Shirt     // Product Impression 1 name. Either ID or name must be set.
&il1pi1ca=Apparel%2FT-Shirts             // Product Impression 1 category.
&il1pi1br=Google                         // Product Impression 1 brand.
&il1pi1va=Black                          // Product Impression 1 variant.
&il1pi1ps=1                              // Product Impression 1 position.
&il1pi1cd1=Member                        // Custom dimension.

&il2nm=Recommended%20Products            // Impression list 2.
&il2pi1nm=Yellow%20T-Shirt               // Product Impression 1 name.
&il2pi2nm=Red%20T-Shirt                  // Product Impression 2 name.

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Avaliação de ações

v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type.
&ec=UX                                // Event Category. Required.
&ea=click                             // Event Action. Required.
&el=Results                           // Event label.

&pa=click                             // Product action (click). Required.
&pal=Search%20Results                 // Product Action List.
&pr1id=P12345                         // Product 1 ID. Either ID or name must be set.
&pr1nm=Android%20Warhol%20T-Shirt     // Product 1 name. Either ID or name must be set.
&pr1ca=Apparel                        // Product 1 category.
&pr1br=Google                         // Product 1 brand.
&pr1va=Black                          // Product 1 variant.
&pr1ps=1                              // Product 1 position.
    

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Combinação de impressões e ações

v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID /  Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type.
&ec=UX                                // Event Category. Required.
&ea=click                             // Event Action. Required.
&el=Results                           // Event label.

&pa=detail                            // Product action (detail). Required.
&pr1id=P12345                         // Product 1 ID. Either ID or name must be set.
&pr1nm=Android%20Warhol%20T-Shirt     // Product 1 name. Either ID or name must be set.
&pr1ca=Apparel                        // Product 1 category.
&pr1br=Google                         // Product 1 brand.
&pr1va=Black                          // Product 1 variant.
&pr1ps=1                              // Product 1 position.

&il1nm=Related%20Products             // Impression list.
&il1pi1id=P12345                      // Product Impression 1 ID.
&il1pi1nm=Android%20Warhol%20T-Shirt  // Product Impression 1 name.
&il1pi1ca=Apparel%2FT-Shirts          // Product Impression 1 category.
&il1pi1br=Google                      // Product Impression 1 brand.
&il1pi1va=Black                       // Product Impression 1 variant.
&il1pi1ps=1                           // Product Impression 1 position.
   

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Avaliação de compras

v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=pageview                           // Pageview hit type.
&dh=mydemo.com                        // Document hostname.
&dp=/receipt                          // Page.
&dt=Receipt%20Page                    // Title.

&ti=T12345                            // Transaction ID. Required.
&ta=Google%20Store%20-%20Online       // Affiliation.
&tr=37.39                             // Revenue.
&tt=2.85                              // Tax.
&ts=5.34                              // Shipping.
&tcc=SUMMER2013                       // Transaction coupon.

&pa=purchase                          // Product action (purchase). Required.
&pr1id=P12345                         // Product 1 ID. Either ID or name must be set.
&pr1nm=Android%20Warhol%20T-Shirt     // Product 1 name. Either ID or name must be set.
&pr1ca=Apparel                        // Product 1 category.
&pr1br=Google                         // Product 1 brand.
&pr1va=Black                          // Product 1 variant.
&pr1ps=1                              // Product 1 position.
    

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Avaliação de reembolsos

Se você precisar enviar dados de reembolso por meio de um evento e ele não fizer parte do comportamento normalmente avaliado no site (por exemplo, não iniciado pelo usuário), convém enviar um evento sem interação. Isso evita que métricas como taxa de rejeição, duração da sessão etc. sejam afetadas pelo evento.

 // Refund an entire transaction and send with a non-interaction event.
v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type.
&ec=Ecommerce                         // Event Category. Required.
&ea=Refund                            // Event Action. Required.
&ni=1                                 // Non-interaction parameter.

&ti=T12345                            // Transaction ID. Required.
&pa=refund                            // Product action (refund). Required.
    

Visualize esse hit no Criador de hit do Protocolo de avaliação.

 // Refund a single product.
v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type.
&ec=Ecommerce                         // Event Category. Required.
&ea=Refund                            // Event Action. Required.
&ni=1                                 // Non-interaction parameter.

&ti=T12345                            // Transaction ID. Required.
&pa=refund                            // Product action (refund). Required.
&pr1id=P12345                         // Product 1 ID. Required.
&pr1qt=1                              // Product 1 quantity. Required.
    

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Avaliação do processo de checkout

1. Avaliação das etapas de checkout
v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=pageview                           // Pageview hit type.
&dh=mydemo.com                        // Document hostname.
&dp=/checkout                         // Page.
&dt=Checkout                          // Title.

&pa=checkout                          // Product action (checkout).
&pr1id=P12345                         // Product 1 ID. Either ID or name must be set.
&pr1nm=Android%20Warhol%20T-Shirt     // Product 1 name. Either ID or name must be set.
&pr1ca=Apparel                        // Product 1 category.
&pr1br=Google                         // Product 1 brand.
&pr1va=Black                          // Product 1 variant.
&pr1pr=29.20                          // Product 1 Price.
&pr1qt=1                              // Product 1 quantity.
&cos=1                                // Checkout step #1.
&col=Visa                             // Checkout step option.
    

Visualize esse hit no Criador de hit do Protocolo de avaliação.

2. Avaliação das opções de checkout
v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type
&ec=Checkout                          // Event Category. Required.
&ea=Option                            // Event Action. Required.

&pa=checkout_option                   // Product action (checkout_option).
&cos=2                                // Checkout step.
&col=FedEx                            // Checkout step option.
    

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Avaliação das promoções internas

Impressões de promoções
v=1                                      // Version.
&tid=UA-XXXXX-Y                          // Tracking ID / Property ID.
&cid=555                                 // Anonymous Client ID.
&t=pageview                              // Pageview hit type.
&dh=mydemo.com                           // Document hostname.
&dp=/home                                // Page.
&dt=homepage                             // Title.

&promo1id=PROMO_1234                     // Promotion 1 ID. Either ID or name must be set.
&promo1nm=Summer%20Sale                  // Promotion 1 name. Either ID or name must be set.
&promo1cr=summer_banner2                 // Promotion Creative.
&promo1ps=banner_slot1                   // Promotion Position.
    

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Cliques em promoções
v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type
&ec=Internal%20Promotions             // Event Category. Required.
&ea=click                             // Event Action. Required.
&el=Summer%20Sale                     // Event label.

&promoa=click                         // Promotion action (click). Required.
&promo1id=PROMO_1234                  // Promotion 1 ID. Either ID or name must be set.
&promo1nm=Summer%20Sale               // Promotion 1 name. Either ID or name must be set.
&promo1cr=summer_banner2              // Promotion Creative.
&promo1ps=banner_slot1                // Promotion Position.
    

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Acompanhamento de comércio eletrônico

Para enviar dados de comércio eletrônico, envie um hit transaction para representar uma transação inteira. Em seguida, envie um hit item para cada item da transação. O ID da transação ti vincula todos os hits para representar a compra inteira.

Hit da transação

v=1               // Version.
&tid=UA-XXXXX-Y   // Tracking ID / Property ID.
&cid=555          // Anonymous Client ID.

&t=transaction    // Transaction hit type.
&ti=12345         // transaction ID. Required.
&ta=westernWear   // Transaction affiliation.
&tr=50.00         // Transaction revenue.
&ts=32.00         // Transaction shipping.
&tt=12.00         // Transaction tax.
&cu=EUR           // Currency code.

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Hit de item

v=1               // Version.
&tid=UA-XXXXX-Y   // Tracking ID / Property ID.
&cid=555          // Anonymous Client ID.

&t=item           // Item hit type.
&ti=12345         // Transaction ID. Required.
&in=sofa          // Item name. Required.
&ip=300           // Item price.
&iq=2             // Item quantity.
&ic=u3eqds43      // Item code / SKU.
&iv=furniture     // Item variation / category.
&cu=EUR           // Currency code.

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Interações em redes sociais

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=social        // Social hit type.
&sa=like         // Social Action. Required.
&sn=facebook     // Social Network. Required.
&st=/home        // Social Target. Required.

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Acompanhamento de exceções

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=exception       // Exception hit type.
&exd=IOException   // Exception description.
&exf=1             // Exception is fatal?

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Acompanhamento da velocidade do usuário

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=timing        // Timing hit type.
&utc=jsonLoader  // Timing category.
&utv=load        // Timing variable.
&utt=5000        // Timing time.
&utl=jQuery      // Timing label.

 // These values are part of browser load times

&dns=100         // DNS load time.
&pdt=20          // Page download time.
&rrt=32          // Redirect time.
&tcp=56          // TCP connect time.
&srt=12          // Server response time.

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Acompanhamento de aplicativos / telas

v=1                         // Version.
&tid=UA-XXXXX-Y             // Tracking ID / Property ID.
&cid=555                    // Anonymous Client ID.

&t=screenview               // Screenview hit type.
&an=funTimes                // App name.
&av=1.5.0                   // App version.
&aid=com.foo.App            // App Id.
&aiid=com.android.vending   // App Installer Id.

&cd=Home                    // Screen name / content description.

Visualize esse hit no Criador de hit do Protocolo de avaliação.

Uso de um servidor Proxy

Alguns ambientes não podem enviar hits diretamente ao Google Analytics. Alguns exemplos disso são celulares antigos que não executam JavaScript ou intranets corporativas protegidas por firewall. Nesses casos, é comum enviar solicitações a um servidor proxy que, depois, usa o Protocolo de avaliação para encaminhar os hits ao Google Analytics.

Para coletar o IP e o user agent do dispositivo do cliente, e não do servidor proxy, você pode especificar os dois valores no Protocolo de avaliação. Eles substituirão os valores que o Google Analytics normalmente coleta dos cabeçalhos das solicitações.

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=pageview      // Pageview hit type.
&uip=1.2.3.4     // IP address override.
&ua=Opera/9.80   // User agent override.

Visualize esse hit no Criador de hit do Protocolo de avaliação.