Eventos recomendados do Google Analytics

Confira a seguir uma lista de eventos recomendados. Você também pode criar e enviar seus próprios eventos personalizados.

Ao criar nomes de eventos personalizados, você precisa:

  1. Siga as regras de nomenclatura de eventos.
  2. Evite nomes e prefixos reservados.
  3. Respeite os limites de coleta de eventos, como o limite de 40 caracteres para nomes de eventos e parâmetros.

Confira Começar para mais detalhes.

Se você estiver fazendo upgrade do Measurement Protocol, confira Fazer upgrade do Measurement Protocol para instruções.

Para todas as propriedades

ad_impression

Esse evento está disponível apenas para fluxos de apps.

Use esse evento quando um usuário vê uma impressão de anúncio.

  • Um ad_impression enviado usando o Measurement Protocol não será incluído em exportações para outras plataformas de publicidade, como o Google Ads.
  • O envio de eventos ad_impression usando o Measurement Protocol pode causar impressões duplicadas se você tiver configurado a inclusão de tags ou o SDK para seus produtos de publicidade do Google vinculados. Envie um evento ad_impression usando o Measurement Protocol apenas se ele não tiver sido capturado pela inclusão de tag ou pelo SDK.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Não USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Não 3,99
O valor da impressão de anúncio.
* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes.
* O parâmetro currency é obrigatório quando você define conversion_value.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
ad_platform string Não MoPub A plataforma de publicidade.
ad_source string Não AdColony A origem de anúncios.
ad_format string Não Banner O formato do anúncio.
ad_unit_name string Não Banner_03 O nome do bloco de anúncios.

Exemplo

O exemplo a seguir mostra como enviar um evento ad_impression usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "FIREBASE_APP_ID"
    }
  ],
  "events": [
    {
      "eventName": "ad_impression",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "APP",
      "appInstanceId": "APP_INSTANCE_ID",
      "currency": "USD",
      "conversionValue": 3.99,
      "additionalEventParameters": [
        {
          "parameterName": "ad_platform",
          "value": "MoPub"
        },
        {
          "parameterName": "ad_source",
          "value": "AdColony"
        },
        {
          "parameterName": "ad_format",
          "value": "Banner"
        },
        {
          "parameterName": "ad_unit_name",
          "value": "Banner_03"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "app_instance_id": "app_instance_id",
    "events": [{
      "name": "ad_impression",
      "params": {
        "ad_platform": "MoPub",
        "ad_source": "AdColony",
        "ad_format": "Banner",
        "ad_unit_name": "Banner_03",
        "currency": "USD",
        "value": 3.99
      }
    }]
  })
});

earn_virtual_currency

Este evento mensura quando um usuário recebe moeda virtual em um jogo. Registre-o com spend_virtual_currency para entender melhor sua economia virtual.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
conversion_value number Não 5 Valor da moeda virtual.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
virtual_currency_name string Não Pedras preciosas Nome da moeda virtual.

Exemplo

O exemplo a seguir mostra como enviar um evento earn_virtual_currency usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "earn_virtual_currency",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "conversionValue": 5,
      "additionalEventParameters": [
        {
          "parameterName": "virtual_currency_name",
          "value": "Gems"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "earn_virtual_currency",
      "params": {
        "virtual_currency_name": "Gems",
        "value": 5
      }
    }]
  })
});

join_group

Registre esse evento quando um usuário entrar em um grupo, como uma associação, equipe ou família. Use esse evento para analisar a popularidade de determinados grupos ou recursos sociais.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
group_id string Não G_12345 ID do grupo.

Exemplo

O exemplo a seguir mostra como enviar um evento join_group usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "join_group",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "group_id",
          "value": "G_12345"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events":[{
      "name":"join_group",
      "params":{
        "group_id":"G_12345"
      }
    }]
  })
});

login

Envie esse evento para indicar que um usuário fez login no seu site ou app.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
method string Não Google Método usado para fazer login.

Exemplo

O exemplo a seguir mostra como enviar um evento login usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "login",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "method",
          "value": "Google"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "login",
      "params": {
        "method": "Google"
      }
    }]
  })
});

screen_view

Esse evento está disponível apenas para fluxos de apps.

Use esse evento para indicar que ocorreu uma transição de tela.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
screen_class string Não MainActivity A classe da tela.
screen_name string Não Sobre Nome da tela.

Exemplo

O exemplo a seguir mostra como enviar um evento screen_view usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "FIREBASE_APP_ID"
    }
  ],
  "events": [
    {
      "eventName": "screen_view",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "APP",
      "appInstanceId": "APP_INSTANCE_ID",
      "additionalEventParameters": [
        {
          "parameterName": "screen_class",
          "value": "MainActivity"
        },
        {
          "parameterName": "screen_name",
          "value": "About"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "app_instance_id": "app_instance_id",
    "events": [{
      "name": "screen_view",
      "params": {
        "screen_class": "MainActivity",
        "screen_name": "About"
      }
    }]
  })
});

Registre este evento para indicar quando o usuário realizou a pesquisa. Você pode usar esse evento para identificar o conteúdo que os usuários estão pesquisando no seu site ou app. Por exemplo, você pode enviar esse evento quando um usuário acessar uma página de resultados de pesquisa depois de realizar uma pesquisa.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
search_term string Sim camisetas Termo que foi pesquisado.

Exemplo

O exemplo a seguir mostra como enviar um evento search usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "search",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "search_term",
          "value": "t-shirts"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "search",
      "params": {
        "search_term": "t-shirts"
      }
    }]
  })
});

select_content

Esse evento indica que um usuário selecionou conteúdo de um determinado tipo. além de ajudar você a identificar conteúdo e categorias em alta relacionados ao seu site ou app.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
content_type string Não produto Tipo de conteúdo selecionado.
content_id string Não C_12345 Um identificador para o item selecionado. O valor precisa incluir pelo menos um caractere não numérico.

Exemplo

O exemplo a seguir mostra como enviar um evento select_content usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "select_content",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "content_type",
          "value": "product"
        },
        {
          "parameterName": "content_id",
          "value": "C_12345"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "select_content",
      "params": {
        "content_type": "product",
        "content_id": "C_12345"
      }
    }]
  })
});

share

Use esse evento quando um usuário compartilhar conteúdo.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
cart_data.items Item[] Não Itens do evento.

Defina o campo cart_data.items no objeto Event.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
method string Não Twitter Método de compartilhamento do conteúdo.
content_type string Não imagem Tipo de conteúdo compartilhado.

Exemplo

O exemplo a seguir mostra como enviar um evento share usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "share",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "cartData": {
        "items": [
          {
            "itemId": "C_12345",
            "quantity": 1,
            "unitPrice": 27.67
          }
        ]
      },
      "additionalEventParameters": [
        {
          "parameterName": "method",
          "value": "Twitter"
        },
        {
          "parameterName": "content_type",
          "value": "image"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "share",
      "params": {
        "method": "Twitter",
        "content_type": "image",
        "item_id": "C_12345"
      }
    }]
  })
});

sign_up

Esse evento indica que um usuário se inscreveu em uma conta. Use o evento para entender os diferentes comportamentos de usuários conectados e desconectados.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
method string Não Google Método usado para inscrição.

Exemplo

O exemplo a seguir mostra como enviar um evento sign_up usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "sign_up",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "method",
          "value": "Google"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "sign_up",
      "params": {
        "method": "Google"
      }
    }]
  })
});

spend_virtual_currency

Esse evento mede a venda de produtos virtuais no seu app e ajuda você a identificar os itens mais procurados.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
conversion_value number Sim 5 Valor da moeda virtual.
cart_data.items Item[] Não Itens do evento.

Defina o campo cart_data.items no objeto Event.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Não Incentivo para iniciantes Nome do item em que a moeda virtual está sendo usada.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
virtual_currency_name string Sim Pedras preciosas Nome da moeda virtual.

Exemplo

O exemplo a seguir mostra como enviar um evento spend_virtual_currency usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "spend_virtual_currency",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "cartData": {
        "items": [
          {
            "itemId": "I_12345",
            "quantity": 1,
            "unitPrice": 27.67,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Starter Boost"
              }
            ]
          }
        ]
      },
      "conversionValue": 5,
      "additionalEventParameters": [
        {
          "parameterName": "virtual_currency_name",
          "value": "Gems"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "spend_virtual_currency",
      "params": {
        "value": 5,
        "virtual_currency_name": "Gems",
        "item_name": "Starter Boost"
      }
    }]
  })
});

tutorial_begin

Esse evento indica o início do processo de integração. Use-o em um funil com tutorial_complete para entender quantos usuários concluem o tutorial.

Parâmetros

Não há parâmetros sugeridos para esse evento.

Exemplo

O exemplo a seguir mostra como enviar um evento tutorial_begin usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "tutorial_begin",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID"
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "tutorial_begin"
    }]
  })
});

tutorial_complete

Esse evento indica a conclusão do processo de integração do usuário. Utilize-o em um funil com tutorial_begin para entender quantos usuários concluem o tutorial.

Parâmetros

Não há parâmetros sugeridos para esse evento.

Exemplo

O exemplo a seguir mostra como enviar um evento tutorial_complete usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "tutorial_complete",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID"
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "tutorial_complete"
    }]
  })
});

view_search_results

Registre esse evento quando os resultados de uma pesquisa forem exibidos para o usuário. Você pode ativar o evento "view_search_results" para a coleta automática com a Medição otimizada de eventos no Google Analytics.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
search_term string Não Roupas Termo usado na pesquisa.

Exemplo

O exemplo a seguir mostra como enviar um evento view_search_results usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "view_search_results",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "search_term",
          "value": "Clothing"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "view_search_results",
      "params": {
        "search_term": "Clothing"
      }
    }]
  })
});

campaign_details

Use esse evento para enviar detalhes da campanha que serão aplicados a eventos com um carimbo de data/hora maior ou igual ao do evento campaign_details.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
campaign_id string Não google_1234 O ID da campanha.
campaign string Não Summer_fun O nome usado para identificar uma promoção ou campanha estratégica específica.
source string Não google A origem do tráfego da campanha (por exemplo, Google, e-mail etc.).
medium string Não cpc A mídia da campanha (por exemplo, e-mail, custo por clique etc.).
term string Não summer+travel O termo da campanha usado com a pesquisa paga para fornecer as palavras-chave dos anúncios.
content string Não logolink Conteúdo da campanha usado para testes A/B e anúncios com segmentação por conteúdo para diferenciar anúncios ou links que direcionam ao mesmo URL.

Exemplo

O exemplo a seguir mostra como enviar um evento campaign_details usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "campaign_details",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "campaign_id",
          "value": "google_1234"
        },
        {
          "parameterName": "campaign",
          "value": "Summer_fun"
        },
        {
          "parameterName": "source",
          "value": "google"
        },
        {
          "parameterName": "medium",
          "value": "cpc"
        },
        {
          "parameterName": "term",
          "value": "summer+travel"
        },
        {
          "parameterName": "content",
          "value": "logolink"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "campaign_details",
      "params": {
        "campaign_id": "google_1234",
        "campaign": "Summer_fun",
        "source": "google",
        "medium": "cpc",
        "term": "summer+travel",
        "content": "logolink"
      }
    }]
  })
});

Vendas on-line

add_payment_info

Esse evento significa que um usuário enviou as informações de pagamento em um processo de finalização de compra de e-commerce.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Métricas de valor no evento view_item para não contribuir com a receita

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* Defina conversion_value como a soma de (price * quantity) para todos os itens em items. Não inclua shipping ou tax.
* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.
cart_data.items Item[] Sim Itens do evento.

Defina o campo cart_data.items no objeto Event.
cart_data.coupon_codes string[] Não SUMMER_FUN O código do cupom associado ao evento.


Defina o campo coupon_codes no objeto CartData.
* Forneça apenas um código de cupom nesta lista.
* Isso é independente dos códigos de cupom no nível do item.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
payment_type string Não Cartão de crédito Forma de pagamento escolhida.

Exemplo

O exemplo a seguir mostra como enviar um evento add_payment_info usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "add_payment_info",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "payment_type",
          "value": "Credit Card"
        }
      ],
      "cartData": {
        "couponCodes": [
          "SUMMER_FUN"
        ],
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "add_payment_info",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "coupon": "SUMMER_FUN",
        "payment_type": "Credit Card",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

add_shipping_info

Esse evento significa que um usuário enviou as informações de frete em um processo de finalização de compra de e-commerce.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Métricas de valor no evento view_item para não contribuir com a receita

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* Defina conversion_value como a soma de (price * quantity) para todos os itens em items. Não inclua shipping ou tax.
* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.
cart_data.items Item[] Sim Itens do evento.

Defina o campo cart_data.items no objeto Event.
cart_data.coupon_codes string[] Não SUMMER_FUN O código do cupom associado ao evento.


Defina o campo coupon_codes no objeto CartData.
* Forneça apenas um código de cupom nesta lista.
* Isso é independente dos códigos de cupom no nível do item.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
shipping_tier string Não Terrestre Tipo de frete (por exemplo, Ground, Air, Next-day) selecionado para a entrega do item comprado.

Exemplo

O exemplo a seguir mostra como enviar um evento add_shipping_info usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "add_shipping_info",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "shipping_tier",
          "value": "Ground"
        }
      ],
      "cartData": {
        "couponCodes": [
          "SUMMER_FUN"
        ],
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "add_shipping_info",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "coupon": "SUMMER_FUN",
        "shipping_tier": "Ground",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

add_to_cart

Esse evento indica que um item foi adicionado a um carrinho de compras.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Métricas de valor no evento view_item para não contribuir com a receita

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* Defina conversion_value como a soma de (price * quantity) para todos os itens em items. Não inclua shipping ou tax.
* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.
cart_data.items Item[] Sim Itens do evento.

Defina o campo cart_data.items no objeto Event.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento add_to_cart usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "add_to_cart",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "add_to_cart",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

add_to_wishlist

O evento indica que um item foi adicionado à lista de desejos. Use esse evento para identificar os presentes mais procurados no seu app.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Métricas de valor no evento view_item para não contribuir com a receita

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* Defina conversion_value como a soma de (price * quantity) para todos os itens em items. Não inclua shipping ou tax.
* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.
cart_data.items Item[] Sim Itens do evento.

Defina o campo cart_data.items no objeto Event.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento add_to_wishlist usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "add_to_wishlist",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "add_to_wishlist",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

begin_checkout

Esse evento indica que um usuário iniciou o processo de finalização da compra.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Métricas de valor no evento view_item para não contribuir com a receita

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* Defina conversion_value como a soma de (price * quantity) para todos os itens em items. Não inclua shipping ou tax.
* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.
cart_data.items Item[] Sim Itens do evento.

Defina o campo cart_data.items no objeto Event.
cart_data.coupon_codes string[] Não SUMMER_FUN O código do cupom associado ao evento.


Defina o campo coupon_codes no objeto CartData.
* Forneça apenas um código de cupom nesta lista.
* Isso é independente dos códigos de cupom no nível do item.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento begin_checkout usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "begin_checkout",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "couponCodes": [
          "SUMMER_FUN"
        ],
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "begin_checkout",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "coupon": "SUMMER_FUN",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

in_app_purchase

Esse evento está disponível apenas para fluxos de apps.

Use esse evento quando um usuário fizer uma compra no app.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda do conversion_value do evento, no formato ISO 4217 de três letras.

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.
cart_data.items Item[] Não Itens do evento.

Defina o campo cart_data.items no objeto Event.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
product_id string Não ABC123456789 O ID do produto.
subscription boolean Não verdadeiro

Indica se a compra é uma assinatura.
Se não for definido, o padrão será false.
free_trial boolean Não verdadeiro

Indica se o evento é para um teste sem custo financeiro de uma assinatura.
Se não for definido, o padrão será false.
price_is_discounted boolean Não falso

Indica se o price tem desconto.
Se não for definido, o padrão será false.

Exemplo

O exemplo a seguir mostra como enviar um evento in_app_purchase usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "FIREBASE_APP_ID"
    }
  ],
  "events": [
    {
      "eventName": "in_app_purchase",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "APP",
      "appInstanceId": "APP_INSTANCE_ID",
      "currency": "USD",
      "conversionValue": 30.03,
      "cartData": {
        "items": [
          {
            "itemId": "ABC123456789",
            "quantity": 3,
            "unitPrice": 10.01
          }
        ]
      },
      "additionalEventParameters": [
        {
          "parameterName": "subscription",
          "value": true
        },
        {
          "parameterName": "free_trial",
          "value": false
        },
        {
          "parameterName": "price_is_discounted",
          "value": false
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "app_instance_id": "app_instance_id",
    "events":[{
      "name":"in_app_purchase",
      "params":{
        "currency": "USD",
        "value": 30.03,
        "quantity": 3,
        "product_id": "ABC123456789",
        "subscription": true,
        "free_trial": false,
        "price_is_discounted": false
      }
    }]
  })
});

purchase

Esse evento indica quando um ou mais itens são comprados por um usuário.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Métricas de valor no evento view_item para não contribuir com a receita

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* Defina conversion_value como a soma de (price * quantity) para todos os itens em items. Não inclua shipping ou tax.
* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.
transaction_id string Sim T_12345 Identificador exclusivo de uma transação.

O parâmetro transaction_id evita duplicar eventos de uma compra. Defina o campo transaction_id no objeto Event.
user_properties.customer_type CustomerType Não NEW Se a conversão é de um cliente NEW ou RETURNING.
cart_data.items Item[] Sim Itens do evento.

Defina o campo cart_data.items no objeto Event.
cart_data.coupon_codes string[] Não SUMMER_FUN O código do cupom associado ao evento.


Defina o campo coupon_codes no objeto CartData.
* Forneça apenas um código de cupom nesta lista.
* Isso é independente dos códigos de cupom no nível do item.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
shipping number Não 3,33 Custo de frete associado a uma transação.
tax number Não 1,11 Custo dos tributos associados a uma transação.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento purchase usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "purchase",
      "transactionId": "TRANSACTION_ID",
      "conversionValue": 83.99,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "userProperties": {
        "customerType": "RETURNING"
      },
      "cartData": {
        "couponCodes": [
          "SUMMER_FUN"
        ],
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 3,
            "unitPrice": 10.01,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Stan and Friends Tee"
              },
              {
                "parameterName": "affiliation",
                "value": "Google Merchandise Store"
              },
              {
                "parameterName": "discount",
                "value": "2.22"
              },
              {
                "parameterName": "index",
                "value": "0"
              },
              {
                "parameterName": "item_brand",
                "value": "Google"
              },
              {
                "parameterName": "item_category",
                "value": "Apparel"
              },
              {
                "parameterName": "item_category2",
                "value": "Adult"
              },
              {
                "parameterName": "item_category3",
                "value": "Shirts"
              },
              {
                "parameterName": "item_category4",
                "value": "Crew"
              },
              {
                "parameterName": "item_category5",
                "value": "Short sleeve"
              },
              {
                "parameterName": "item_list_id",
                "value": "related_products"
              },
              {
                "parameterName": "item_list_name",
                "value": "Related Products"
              },
              {
                "parameterName": "item_variant",
                "value": "green"
              },
              {
                "parameterName": "location_id",
                "value": "ChIJIQBpAG2ahYAR_6128GcTUEo"
              },
              {
                "parameterName": "google_business_vertical",
                "value": "retail"
              }
            ]
          }
        ]
      },
      "additionalEventParameters": [
        {
          "parameterName": "shipping",
          "value": "3.33"
        },
        {
          "parameterName": "tax",
          "value": "1.11"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
    method: "POST",
    body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "purchase",
      "params": {
        "currency": "USD",
        "transaction_id": "T_12345",
        "value": 30.03,
        "coupon": "SUMMER_FUN",
        "shipping": 3.33,
        "tax": 1.11,
        "items": [
            {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

refund

Esse evento indica quando um ou mais itens são reembolsados a um usuário.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Métricas de valor no evento view_item para não contribuir com a receita

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* Defina conversion_value como a soma de (price * quantity) para todos os itens em items. Não inclua shipping ou tax.
* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.
transaction_id string Sim T_12345 Identificador exclusivo de uma transação.
cart_data.items Item[] Não Itens do evento.

Defina o campo cart_data.items no objeto Event.
cart_data.coupon_codes string[] Não SUMMER_FUN O código do cupom associado ao evento.


Defina o campo coupon_codes no objeto CartData.
* Forneça apenas um código de cupom nesta lista.
* Isso é independente dos códigos de cupom no nível do item.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
shipping number Não 3,33 Custo de frete associado a uma transação.
tax number Não 1,11 Custo dos tributos associados a uma transação.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento refund usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "refund",
      "conversionValue": 30.03,
      "currency": "USD",
      "transactionId": "T_12345",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "shipping",
          "value": 3.33
        },
        {
          "parameterName": "tax",
          "value": 1.11
        }
      ],
      "cartData": {
        "couponCodes": [
          "SUMMER_FUN"
        ],
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "refund",
      "params": {
        "currency": "USD",
        "transaction_id": "T_12345",
        "value": 30.03,
        "coupon": "SUMMER_FUN",
        "shipping": 3.33,
        "tax": 1.11,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

remove_from_cart

Esse evento indica que um item foi removido do carrinho.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Métricas de valor no evento view_item para não contribuir com a receita

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* Defina conversion_value como a soma de (price * quantity) para todos os itens em items. Não inclua shipping ou tax.
* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.
cart_data.items Item[] Sim Itens do evento.

Defina o campo cart_data.items no objeto Event.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento remove_from_cart usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "remove_from_cart",
      "conversionValue": 30.03,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "remove_from_cart",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

select_item

Esse evento indica que um item foi selecionado em uma lista.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
cart_data.items Item[] Sim* Itens do evento.

* A matriz do parâmetro items precisa ter um único elemento que representa o item selecionado. Quando há vários elementos definidos, só o primeiro em items é usado.

Defina o campo cart_data.items no objeto Event.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Ignorado quando o parâmetro é definido no nível do item.
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Ignorado quando o parâmetro é definido no nível do item.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento select_item usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "select_item",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "item_list_id",
          "value": "related_products"
        },
        {
          "parameterName": "item_list_name",
          "value": "Related products"
        }
      ],
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "select_item",
      "params": {
        "item_list_id": "related_products",
        "item_list_name": "Related products",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

select_promotion

Esse evento indica que uma promoção foi selecionada em uma lista.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
cart_data.items Item[] Não Itens do evento.

Defina o campo cart_data.items no objeto Event.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
creative_name string Não summer_banner2 Nome do criativo promocional.
creative_slot string Não featured_app_1 Nome do slot do criativo promocional associado ao evento.
promotion_id string Não P_12345 ID da promoção associada ao evento.
promotion_name string Não Promoção de verão Nome da promoção associada ao evento.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
creative_name string Não summer_banner2 Nome do criativo promocional.

Se não for definido, o padrão será creative_name no nível do evento.
creative_slot string Não featured_app_1 Nome do slot do criativo promocional associado ao item.

Se não for definido, o padrão será creative_slot no nível do evento.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
promotion_id string Não P_12345 ID da promoção associada ao item.

Se não for definido, o padrão será promotion_id no nível do evento.
promotion_name string Não Promoção de verão Nome da promoção associada ao item.

Se não for definido, o padrão será promotion_name no nível do evento.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento select_promotion usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "select_promotion",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "creative_name",
          "value": "Summer Banner"
        },
        {
          "parameterName": "creative_slot",
          "value": "featured_app_1"
        },
        {
          "parameterName": "promotion_id",
          "value": "P_12345"
        },
        {
          "parameterName": "promotion_name",
          "value": "Summer Sale"
        }
      ],
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "select_promotion",
      "params": {
        "creative_name": "Summer Banner",
        "creative_slot": "featured_app_1",
        "promotion_id": "P_12345",
        "promotion_name": "Summer Sale",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "creative_name": "summer_banner2",
            "creative_slot": "featured_app_1",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "promotion_id": "P_12345",
            "promotion_name": "Summer Sale",
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

view_cart

Esse evento indica que um usuário viu o carrinho.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Métricas de valor no evento view_item para não contribuir com a receita

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* Defina conversion_value como a soma de (price * quantity) para todos os itens em items. Não inclua shipping ou tax.
* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.
cart_data.items Item[] Sim Itens do evento.

Defina o campo cart_data.items no objeto Event.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento view_cart usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "view_cart",
      "conversionValue": 7.77,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          },
          {
            "itemId": "SKU_67890",
            "quantity": 2,
            "unitPrice": 24.00,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Google Red Team Hat"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "view_cart",
      "params": {
        "currency": "USD",
        "value": 7.77,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

view_item

Esse evento indica que parte do conteúdo foi exibido ao usuário. Use o evento para descobrir os itens mais procurados que foram visualizados.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Métricas de valor no evento view_item para não contribuir com a receita

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* Defina conversion_value como a soma de (price * quantity) para todos os itens em items. Não inclua shipping ou tax.
* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.
cart_data.items Item[] Sim Itens do evento.

Defina o campo cart_data.items no objeto Event.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento view_item usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "view_item",
      "conversionValue": 7.77,
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          },
          {
            "itemId": "SKU_67890",
            "quantity": 2,
            "unitPrice": 24.00,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Google Red Team Hat"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "view_item",
      "params": {
        "currency": "USD",
        "value": 7.77,
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ],
      }
    }]
  })
});

view_item_list

Registre esse evento quando uma lista de itens de uma determinada categoria for exibida para o usuário.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda dos itens associados ao evento, no formato ISO 4217 de três letras.

* Métricas de valor no evento view_item para não contribuir com a receita

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
cart_data.items Item[] Sim Itens do evento.

Defina o campo cart_data.items no objeto Event.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento view_item_list usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "view_item_list",
      "currency": "USD",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "item_list_id",
          "value": "related_products"
        },
        {
          "parameterName": "item_list_name",
          "value": "Related products"
        }
      ],
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "view_item_list",
      "params": {
        "item_list_id": "related_products",
        "item_list_name": "Related products",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

view_promotion

Esse evento indica que uma promoção foi acessada em uma lista.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
cart_data.items Item[] Sim* Itens do evento.

* A matriz do parâmetro items precisa ter um único elemento que representa o item associado à promoção. Quando há vários elementos definidos, só o primeiro em items é usado.

Defina o campo cart_data.items no objeto Event.

Campos do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_id string Sim I_12345 Um identificador exclusivo do item. Defina o campo item_id no objeto Item.
unit_price number Sim 27,67 O preço unitário excluindo tributos, frete e descontos no nível da transação e do evento para este item.

Se o item tiver um desconto no escopo do item, use o preço unitário com desconto. Por exemplo, se um item tiver um preço unitário de 27,67 e um desconto unitário de 6,66, defina unitPrice como 21,01.
quantity number Sim 1 A quantidade de unidades compradas para este item específico.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
creative_name string Não summer_banner2 Nome do criativo promocional.
creative_slot string Não featured_app_1 Nome do slot do criativo promocional associado ao evento.
promotion_id string Não P_12345 ID da promoção associada ao evento.
promotion_name string Não Promoção de verão Nome da promoção associada ao evento.

Parâmetros do item

Nome Tipo Obrigatório Valor de exemplo Descrição
item_name string Sim* Camiseta Stan and Friends

Nome do item.

*É preciso especificar item_id ou item_name.

affiliation string Não Google Store Uma afiliação de produto para indicar uma empresa fornecedora ou loja física.
Observação: affiliation está disponível apenas no escopo do item.
coupon string Não SUMMER_FUN Nome/código do cupom associado ao item.

Os parâmetros coupon no nível do evento e do item são independentes.
creative_name string Não summer_banner2 Nome do criativo promocional.

Se não for definido, o padrão será creative_name no nível do evento.
creative_slot string Não featured_app_1 Nome do slot do criativo promocional associado ao item.

Se não for definido, o padrão será creative_slot no nível do evento.
discount number Não 2,22 Valor do desconto monetário unitário associado ao item.
index number Não 5 Índice/posição do item em uma lista.
item_brand string Não Google Marca do item.
item_category string Não Vestuário Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2 string Não Adulto Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3 string Não Camisas Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4 string Não Gola redonda Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5 string Não Manga curta Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id string Não related_products ID da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_id no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name string Não Produtos relacionados Nome da lista em que o item foi apresentado ao usuário.

Se definido, o parâmetro item_list_name no nível do evento é ignorado.
Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant string Não verde Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id string Não ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco) O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado.
Observação: location_id está disponível apenas no escopo do item.
promotion_id string Não P_12345 ID da promoção associada ao item.

Se não for definido, o padrão será promotion_id no nível do evento.
promotion_name string Não Promoção de verão Nome da promoção associada ao item.

Se não for definido, o padrão será promotion_name no nível do evento.
Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

O exemplo a seguir mostra como enviar um evento view_promotion usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "view_promotion",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "userId": "USER_ID",
      "additionalEventParameters": [
        {
          "parameterName": "creative_name",
          "value": "Summer Banner"
        },
        {
          "parameterName": "creative_slot",
          "value": "featured_app_1"
        },
        {
          "parameterName": "promotion_id",
          "value": "P_12345"
        },
        {
          "parameterName": "promotion_name",
          "value": "Summer Sale"
        }
      ],
      "cartData": {
        "items": [
          {
            "itemId": "SKU_12345",
            "quantity": 1,
            "unitPrice": 29.99,
            "additionalItemParameters": [
              {
                "parameterName": "item_name",
                "value": "Triblend Android T-Shirt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "view_promotion",
      "params": {
        "creative_name": "Summer Banner",
        "creative_slot": "featured_app_1",
        "promotion_id": "P_12345",
        "promotion_name": "Summer Sale",
        "items": [
          {
            "item_id": "SKU_12345",
            "item_name": "Stan and Friends Tee",
            "affiliation": "Google Merchandise Store",
            "coupon": "SUMMER_FUN",
            "creative_name": "summer_banner2",
            "creative_slot": "featured_app_1",
            "currency": "USD",
            "discount": 2.22,
            "index": 0,
            "item_brand": "Google",
            "item_category": "Apparel",
            "item_category2": "Adult",
            "item_category3": "Shirts",
            "item_category4": "Crew",
            "item_category5": "Short sleeve",
            "item_list_id": "related_products",
            "item_list_name": "Related Products",
            "item_variant": "green",
            "location_id": "ChIJIQBpAG2ahYAR_6128GcTUEo",
            "price": 10.01,
            "promotion_id": "P_12345",
            "promotion_name": "Summer Sale",
            "google_business_vertical": "retail",
            "quantity": 3
          }
        ]
      }
    }]
  })
});

Jogos

level_up

Esse evento indica que um jogador subiu de nível em um jogo. Use para avaliar a distribuição de níveis da sua base de usuários e identificar fases difíceis de concluir.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
level number Não 5 Nível do personagem.
character string Não Jogador 1 Personagem que subiu de nível.

Exemplo

O exemplo a seguir mostra como enviar um evento level_up usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "level_up",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "level",
          "value": 5
        },
        {
          "parameterName": "character",
          "value": "Player 1"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "level_up",
      "params": {
        "level": 5,
        "character": "Player 1"
      }
    }]
  })
});

post_score

Envie esse evento quando o usuário registrar uma pontuação. Use esse evento para entender o desempenho dos usuários no seu jogo e correlacionar as maiores pontuações com os públicos-alvo ou comportamentos.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
score number Sim 10.000 Pontuação que será registrada.
level number Não 5 Nível da pontuação.
character string Não Jogador 1 Personagem que conseguiu a pontuação.

Exemplo

O exemplo a seguir mostra como enviar um evento post_score usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "post_score",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "score",
          "value": 10000
        },
        {
          "parameterName": "level",
          "value": 5
        },
        {
          "parameterName": "character",
          "value": "Player 1"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "post_score",
      "params": {
        "score": 10000,
        "level": 5,
        "character": "Player 1"
      }
    }]
  })
});

unlock_achievement

Registre esse evento quando o usuário desbloquear uma conquista. O evento ajuda você a entender como os usuários estão explorando seu jogo.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
achievement_id string Sim A_12345 ID da conquista que foi desbloqueada.

Exemplo

O exemplo a seguir mostra como enviar um evento unlock_achievement usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "unlock_achievement",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "additionalEventParameters": [
        {
          "parameterName": "achievement_id",
          "value": "A_12345"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "unlock_achievement",
      "params": {
        "achievement_id": "A_12345"
      }
    }]
  })
});

Geração de leads

close_convert_lead

Registre esse evento quando um lead qualificado for convertido em cliente. Isso geralmente significa o fim do processo de nutrição de leads, como quando um contrato é assinado, uma assinatura paga é iniciada ou uma venda final é concluída.

  • Observação:para acompanhar a aquisição inicial de leads, como envios de formulários, inscrições em newsletters ou solicitações de demonstração, use o evento generate_lead.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda do conversion_value do evento, no formato ISO 4217 de três letras.

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.

Exemplo

O exemplo a seguir mostra como enviar um evento close_convert_lead usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "close_convert_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "close_convert_lead",
      "params": {
        "currency": "USD",
        "value": 30.03
      }
    }]
  })
});

close_unconvert_lead

Esse evento mede quando um usuário é marcado como não sendo um lead convertido, além do motivo.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda do conversion_value do evento, no formato ISO 4217 de três letras.

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
unconvert_lead_reason string Não Nunca respondeu O motivo de o lead não ter gerado uma conversão.

Exemplo

O exemplo a seguir mostra como enviar um evento close_unconvert_lead usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "close_unconvert_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03,
      "additionalEventParameters": [
        {
          "parameterName": "unconvert_lead_reason",
          "value": "Never responded"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "close_unconvert_lead",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "unconvert_lead_reason": "Never responded"
      }
    }]
  })
});

disqualify_lead

Esse evento mede quando um usuário é marcado como desqualificado para se tornar um lead, além do motivo da desqualificação.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda do conversion_value do evento, no formato ISO 4217 de três letras.

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
disqualified_lead_reason string Não Não quero comprar O motivo de um lead ter sido marcado como desqualificado.

Exemplo

O exemplo a seguir mostra como enviar um evento disqualify_lead usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "disqualify_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03,
      "additionalEventParameters": [
        {
          "parameterName": "disqualified_lead_reason",
          "value": "Not looking to buy"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "disqualify_lead",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "disqualified_lead_reason": "Not looking to buy"
      }
    }]
  })
});

generate_lead

Este evento determina quando um lead é gerado (por exemplo, por meio de um formulário). Registre isso para entender a eficácia das campanhas de marketing e como muitos clientes interagem novamente com sua empresa após o remarketing para os clientes.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda do conversion_value do evento, no formato ISO 4217 de três letras.

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
lead_source string Não Feira comercial A origem do lead.

Exemplo

O exemplo a seguir mostra como enviar um evento generate_lead usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "generate_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03,
      "additionalEventParameters": [
        {
          "parameterName": "lead_source",
          "value": "Trade show"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "generate_lead",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "lead_source": "Trade show"
      }
    }]
  })
});

qualify_lead

Esse evento mede quando um usuário é marcado como atendendo aos critérios para se tornar um lead qualificado.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda do conversion_value do evento, no formato ISO 4217 de três letras.

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.

Exemplo

O exemplo a seguir mostra como enviar um evento qualify_lead usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "qualify_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "qualify_lead",
      "params": {
        "currency": "USD",
        "value": 30.03
      }
    }]
  })
});

working_lead

Esse evento mede quando um usuário entra em contato ou é contatado por um representante.

Campos de evento

Nome Tipo Obrigatório Valor de exemplo Descrição
currency string Sim* USD Moeda do conversion_value do evento, no formato ISO 4217 de três letras.

* Se você definir conversion_value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
conversion_value number Sim* 30,03 Valor monetário do evento.

* O parâmetro conversion_value costuma ser necessário para gerar relatórios importantes. Se você marcar o evento como um evento principal, é recomendável definir conversion_value.
* O parâmetro currency é obrigatório quando você define conversion_value.

Parâmetros

Nome Tipo Obrigatório Valor de exemplo Descrição
lead_status string Não Conversas iniciadas O status do lead.

Exemplo

O exemplo a seguir mostra como enviar um evento working_lead usando a API Data Manager. Se você estiver fazendo upgrade do Measurement Protocol, use as guias para migrar suas solicitações para a API Data Manager.

API Data Manager


{
  "destinations": [
    {
      "operatingAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "loginAccount": {
        "accountType": "GOOGLE_ANALYTICS_PROPERTY",
        "accountId": "GOOGLE_ANALYTICS_PROPERTY_ID"
      },
      "productDestinationId": "MEASUREMENT_ID"
    }
  ],
  "events": [
    {
      "eventName": "working_lead",
      "eventTimestamp": "2025-06-10T23:42:33-05:00",
      "eventSource": "WEB",
      "clientId": "CLIENT_ID",
      "currency": "USD",
      "conversionValue": 30.03,
      "additionalEventParameters": [
        {
          "parameterName": "lead_status",
          "value": "Started conversations"
        }
      ]
    }
  ]
}

Measurement Protocol

const measurementId = 'G-XXXXXXXXXX';
const apiSecret = '<secret_value>';
 
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    "client_id": "client_id",
    "events": [{
      "name": "working_lead",
      "params": {
        "currency": "USD",
        "value": 30.03,
        "lead_status": "Started conversations"
      }
    }]
  })
});