Esta documentação do Recommendations AI faz referência ao console do Recommendations. Recomendamos migrar para o console de varejo e usar a documentação de varejo, que documenta o Recommendations AI, o console de varejo e a pesquisa de varejo.

Se você estiver usando a versão v1beta do Recommendations AI, migre para a versão da API Retail.

Como gravar eventos do usuário em tempo real

Nesta página, você verá como registrar eventos do usuário em tempo real. O Recommendations AI usa eventos do usuário em tempo real para gerar recomendações do próximo item. Registrar muitos tipos de eventos do usuário com informações válidas do produto aumenta a qualidade das recomendações.

Para detalhes sobre eventos do usuário, incluindo tipos de evento do usuário e JSON de amostra para todos os tipos, consulte Eventos do usuário.

Você pode registrar um evento de usuário de várias maneiras:

Veja abaixo exemplos de como registrar eventos do usuário do tipo detail-page-view para todos esses métodos. Para outros tipos de evento, consulte Eventos do usuário.

Também é possível importar eventos históricos do usuário. Pode levar um tempo considerável para registrar dados suficientes de eventos do usuário para treinar seus modelos. É possível acelerar o treinamento inicial do modelo importando dados de eventos do usuário de eventos anteriores em massa. Consulte Como importar eventos históricos do usuário.

Se o evento do usuário que você está registrando for a primeira vez que um usuário interage com um produto baseado em uma recomendação fornecida anteriormente, a inclusão de um token de atribuição permite que o Recommendations AI forneça métricas de desempenho de recomendação, mas o token de atribuição é opcional. Para informações sobre como trabalhar com tokens de atribuição, consulte Tokens de atribuição

Para mais informações sobre o campo "userInfo", consulte Sobre o objeto de informações do usuário.

Antes de começar

Antes de gravar eventos do usuário, faça o seguinte:

  • Um projeto do Google Cloud criado com autenticação configurada.

  • uma chave de API válida (para o Pixel ou JavaScript do Gerenciador de tags) ou uma conta de serviço válida com o papel de editor de varejo atribuído, caso seja usada para gravar diretamente.

    Para mais informações, consulte Antes de começar.

Práticas recomendadas para registrar eventos do usuário

O Recommendations AI requer dados de alta qualidade para fazer previsões de alta qualidade. Se os dados estiverem incompletos ou incorretos, a qualidade das previsões será prejudicada.

Ao registrar eventos do usuário, implemente as seguintes práticas recomendadas:

  • Se você gravar eventos do usuário antes ou durante a importação do seu catálogo, reconecte-se a qualquer evento registrado antes da conclusão da importação do catálogo.

    Você pode importar o catálogo para o Recommendations AI antes, depois ou ao mesmo tempo em que registra eventos do usuário. Essas tarefas em paralelo podem economizar tempo se o catálogo for grande e houver muitos eventos de usuários. Após a conclusão da importação do catálogo, use a API para voltar aos eventos que foram enviados antes da conclusão da importação.

    O Recommendations AI tenta mesclar eventos registrados do usuário com metadados do catálogo de produtos quando o evento do usuário é criado. Somente os eventos mesclados são usados para o treinamento. Portanto, reconecte os eventos gravados antes da importação completa do catálogo. Se um evento se referir a um item que não existe no catálogo, ele será descartado ou não associado aos produtos corretos. Da mesma forma, se você importar eventos de usuários no passado, o catálogo precisará incluir todos os produtos aos quais eles fazem referência. você pode marcar produtos mais antigos como OUT_OF_STOCK em vez de removê-los do catálogo.

  • Mantenha seu catálogo atualizado.

    Quando você registra eventos do usuário, o item do catálogo incluído no evento do usuário é conectado ao catálogo atual. Se você registrar um evento para um item de catálogo que não esteja no catálogo atual, ele não poderá ser usado pelo Recommendations AI para treinar seus modelos. Isso é chamado de evento "unjoined". Se você registrou eventos antes da importação completa do seu catálogo, será necessário reingressar nos eventos que foram gravados durante a importação. Espera-se que alguns eventos sejam cancelados. No entanto, se a porcentagem dos eventos não vinculados atingir 5% ou mais do total de eventos do usuário, verifique se o catálogo está atualizado, refaça os eventos que foram gravados antes da atualização completa do catálogo. investigar por que os eventos sem participação estão sendo criados.

    É possível ver os eventos não associados usando a filtragem de eventos. Saiba mais.

  • Forneça o máximo de informações possível com os eventos de usuário.

    Cada tipo de evento do usuário tem informações diferentes que são obrigatórias e aceitas. Para mais informações, consulte Eventos do usuário.

  • Configure alertas para saber se os processos de gravação de eventos do usuário sofreram interrupções.

  • Para uma importação de eventos em massa de usuários, limite o tamanho dos dados que você está importando.

    A importação de eventos em massa de usuários pode levar até 24 horas para ser concluída.

    O tamanho de cada arquivo deve ser de 2 GB ou menor. É possível incluir no máximo 100 arquivos em uma única solicitação de importação. Uma delas é importar somente os eventos de usuários um dia de cada vez.

  • Após uma importação em massa, revise seus relatórios de erros para garantir que seus dados foram importados corretamente.

  • Ao importar dados do evento do usuário, inclua um carimbo de data/hora preciso para cada evento e evite importar eventos sequenciais do usuário com carimbos de data/hora idênticos.

    Forneça o carimbo de data/hora no campo eventTime no formato especificado por RFC 3339.

  • Se você importou eventos de usuário incorretos, fale com seu contato do Recommendations AI sobre como corrigir o problema.

  • Quando possível, mantenha os dados do evento do usuário contínuos.

    Lacunas nos dados de eventos do usuário podem reduzir a qualidade do modelo.

  • Use uma forma segura de um identificador exclusivo para manter os usuários anônimos na Recommendations AI e proteger a privacidade deles. Você é responsável por editar PII (informações de identificação pessoal), como e-mails ou endereços residenciais, dos seus dados.

Como gravar eventos do usuário com um pixel JavaScript

O exemplo a seguir registra um UserEvent de detail-page-view usando um pixel JavaScript.

<script type="text/javascript">
var user_event = {
  "eventType" : "detail-page-view",
  "visitorId": "visitor-id",
  "userInfo": {
      "userId": "user-id"
  },
  "attributionToken": "attribution-token",
  "experimentIds": "experiment-id",
  "productDetails": [
      {
        "product": {"id": "123"}
      }
  ]
};

var _gre = _gre || [];
// Credentials for project.
_gre.push(['apiKey', 'api-key']);
_gre.push(['logEvent', user_event]);
_gre.push(['projectId', 'project-id']);
_gre.push(['locationId', 'global']);
_gre.push(['catalogId', 'default_catalog']);

(function() {
  var gre = document.createElement('script'); gre.type = 'text/javascript'; gre.async = true;
  gre.src = 'https://www.gstatic.com/retail/v2_event.js';
  var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(gre, s);
})();

</script>

Se você importou eventos do usuário com o Google Analytics 360, defina visitorID como o ID do cliente do Google Analytics. O ID do cliente do Google Analytics faz parte apenas do nome completo do cookie _ga. Por exemplo, o ID do cliente 123456789.123456789 faz parte do cookie _ga GA1.3.123456789.123456789.

Para mais informações sobre como conseguir o ID do cliente, consulte a documentação do Google Analytics.

Veja a seguir um exemplo abreviado que mostra o formato para definir o ID do cliente em um evento do usuário. Substitua "UA-XXXXXX-N" pelo seu ID de acompanhamento do Google Analytics.

<script type="text/javascript">
var tracker = ga.getByName('UA-XXXXXX-N');
var user_event = {
      "visitorId": tracker.get('clientId')
};
</script>

Como gravar eventos do usuário com o método userEvents.write

É possível usar o método userEvents.write para enviar eventos do usuário diretamente para a API do servidor de back-end.

Para registrar eventos do usuário, envie uma solicitação POST para o método userEvents.write e forneça o corpo da solicitação apropriado.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data "{
         'eventType': 'detail-page-view',
         'visitorId': 'visitor0',
         'eventTime': '2020-01-01T03:33:33.000001Z',
         'experimentIds': '['321'],
         'attributionToken': 'ABC',
         'attributes': {
            'example_text_attribute': {
              'text': ['text_1', 'text_2']
            },
            'example_number_attribute': {
               'numbers': [3.14, 42, 1.2345]
            }
         },
         'productDetails': [{
           'product': {
             'id': 'abc'
           }
          }],
         'userInfo': {
           'userId': 'abc@example.com',
           'ipAddress': '8.8.8.8',
           'userAgent': 'Mozilla/5.0',
           'directUserRequest': true
         },
         'uri': 'http://example',
         'referrerUri': 'http://example',
         'pageViewId': 'currentPageUri'
}"
"https://retail.googleapis.com/v2/projects/PROJECT_ID/locations/global/catalogs/default_catalog/userEvents:write"

Como registrar eventos do usuário com o Gerenciador de tags do Google

O Gerenciador de tags oferece uma maneira de gerenciar e testar várias tags sem muitas alterações de código no servidor para seu site.

Algumas das decisões tomadas durante a configuração dependem da escolha entre o uso do Google Analytics e do comércio eletrônico do Google Analytics. O comércio eletrônico do Google Analytics pode ser implementado usando o Google Analytics 4 ou o comércio eletrônico avançado. A tag do Cloud Retail é compatível com ambos.

Não é necessário usar o Google Analytics nem o comércio eletrônico do Google Analytics. Se você não os usar, poderá configurar Variável: comércio eletrônico ao criar a tag do Cloud Retail ou preencher manualmente o código da camada de dados do seu site depois de criar a tag.

O comércio eletrônico do Google Analytics é uma configuração adicional do Google Analytics que transmite títulos, IDs, preços, detalhes de transações e outros dados estruturados de comércio eletrônico para o Google Analytics. A API Retail pode usar automaticamente a camada de dados de comércio eletrônico do Google Analytics. Portanto, se você já fez isso, a configuração poderá ser mais fácil. Se você não tiver o comércio eletrônico do Google Analytics configurado, mas quiser usá-lo, consulte mais detalhes e instruções de configuração no guia do desenvolvedor do GA4 ou no guia do desenvolvedor sobre comércio eletrônico avançado.

Use este procedimento único para configurar uma tag do Cloud Retail no Gerenciador de tags e registrar eventos do usuário.

Como criar uma tag do Gerenciador de tags do Google

Configure uma tag no Gerenciador de tags para enviar informações do evento do usuário à API Retail.

  1. Faça login no Gerenciador de tags e selecione o contêiner do seu site.

  2. Acesse a guia Tags e clique em Nova para adicionar uma nova tag.

  3. Dê um nome à tag na parte superior do painel (o marcador é Variável sem título), como "Recommendations AI".

  4. Clique em Configuração da tag e escolha a tag Cloud Retail para abrir o painel de configuração de tags.

  5. Insira sua chave de API.

    Use a chave que você criou ao configurar a API Retail.

    As chaves de API estão disponíveis na página APIs & Services > Credentials no Console do Cloud.

  6. Insira o número do projeto do Google Cloud em que a API Retail está ativada.

    O número do projeto está disponível no painel do Console do Cloud.

  7. No campo Fonte de dados de eventos do usuário:

    • Camada de dados (recomendado): selecione se a implementação será uma das seguintes:

      • Você tem o comércio eletrônico do Google Analytics implementado pelo Gerenciador de tags. Reutilize a camada de dados como a fonte de dados de eventos em vez de preencher uma nova. O esquema do Google Analytics 4 será usado, se houver. Caso contrário, ele usará o comércio eletrônico avançado do UA. Com essa fonte de dados, só é possível registrar eventos add-to-cart, purchase-complete e detail-page-view.

      • Você está usando o comércio eletrônico do Google Analytics e pode preencher manualmente o código da camada de dados. Consulte o Guia do desenvolvedor do Gerenciador de tags.

    • Variável – Cloud Retail: selecione para preencher uma variável do Gerenciador de tags com os campos obrigatórios para a Recommendations AI. Será possível escolher essa opção se você não estiver usando o comércio eletrônico do Google Analytics ou se o comércio eletrônico do Google Analytics não tiver os dados necessários para o Recommendations AI. Se você estiver mudando para essa origem da opção legada da camada de dados – Cloud Retail, crie também uma variável da camada de dados com a chave cloud_retail e associe-a a esta opção Variável: Cloud Retail.

    • Variável: e-commerce: selecione se você não estiver usando o e-commerce do Google Analytics na sua camada de dados e não for possível preencher manualmente o código da camada de dados.

      No campo Ler dados de comércio eletrônico da variável de usuário exibido, escolha uma variável. Isso permite que a API Retail leia os dados de eventos dos usuários de comércio eletrônico do Google Analytics em uma variável personalizada criada por você.

      A variável precisa corresponder ao formato documentado no Guia do desenvolvedor do GA4 ou no Guia do desenvolvedor de comércio eletrônico avançado. Para criar uma variável no formato correto, use o Criador de objetos de comércio eletrônico avançado, um modelo de variável personalizada da galeria de modelos da comunidade do Gerenciador de tags. Os modelos da comunidade não são mantidos pelo Google. Para usar esse modelo, consulte a página da galeria "Criador de objetos de comércio eletrônico avançado" para ver a documentação e outros recursos.

  8. Clique em Save.

    Sua tag do Cloud Retail foi criada.

Opções de fonte de dados legadas

Antes, Camada de dados: e-commerce e Camada de dados: Cloud Retail estavam disponíveis como opções de fonte de dados. Essas opções legadas não estão disponíveis em novas tags. Se você trocar uma tag para uma nova origem de dados, visualize-a com o Gerenciador de tags para verificá-la antes da implantação. Ao fazer a mudança:

  • Se você usou Camada de dados: e-commerce, é possível alternar para a Camada de dados. O esquema do Google Analytics 4 será usado, se houver. Caso contrário, ele usará o comércio eletrônico avançado do UA.

  • Se você usou Camada de dados: Cloud Retail, mude para a opção Variável: Cloud Retail. Crie uma variável da camada de dados com a chave cloud_retail e associe-a à opção Variável: Cloud Retail.

Próximo:

Como criar acionadores de eventos para sua tag do Gerenciador de tags

Crie acionadores para todos os tipos de evento de usuário que seus modelos do Recommendations AI usarão.

As tags do Gerenciador de tags precisam ter acionadores que controlam quando a tag deve ser "disparada" no site. Os acionadores detectam quando os eventos ocorrem (como quando um usuário visualiza a página inicial ou adiciona um item ao carrinho) e solicita que a tag envie essas informações de evento do usuário para a API Retail.

O Gerenciador de tags fornece alguns acionadores padrão. Por exemplo, Window Loaded é um gatilho para eventos detail-page-view. Para ver detalhes sobre cada tipo, consulte Tipos de acionador na documentação do Gerenciador de tags.

Geralmente, a tag é acionada quando um usuário visualiza qualquer página que tenha os eventos necessários para o Recommendations AI, como a página inicial, as páginas de detalhes do produto, as páginas do carrinho ou a página de finalização da compra. Nesses casos, a tag precisa ser disparada após o carregamento da página. Assim, os cookies estarão disponíveis e todas as variáveis da camada de dados serão preenchidas. Para fazer isso, defina os acionadores que serão disparados em Window Loaded ou DOM Ready.

Talvez seja necessário disparar a tag quando uma ação for realizada, em vez de fazer isso no carregamento de página. Por exemplo, se um usuário que adiciona um item a um carrinho não forçar a atualização da página. Nesses casos, você pode configurar essa ação de clique no seu site para enviar atualizações simultaneamente para a camada de dados e associar o gatilho a essa ação.

Por exemplo, se você criou um gatilho para eventos add-to-cart, poderá escolher o tipo de gatilho para Clique - Apenas links e defini-lo para disparar no ID de clique (em neste exemplo, addtocart). Em seguida, você configuraria o link addtocart no seu site para também atualizar a camada de dados com novos valores quando clicado:

  <a id="addtocart" href="javascript:void(0);"
         onclick="dataLayer.push({
                  'cloud_retail': {
                  'eventType': 'add-to-cart',
                  'visitorId': '456',
                  'cartId': 'mobile',
                  'productDetails': [{
                  'product': {
                  'id': '54321'
                  },
                  'quantity': 1
                  }]}});">Add to Cart</a>

Para alguns eventos de usuário, você precisa criar um acionador personalizado. Geralmente, você cria um acionador personalizado no Gerenciador de tags usando o nome do evento. Se não for possível modificar o código do front-end, você poderá criar um gatilho personalizado usando macros JavaScript. Para mais informações sobre gatilhos personalizados, consulte Gatilho de evento personalizado.

Use os seguintes procedimentos para criar acionadores no Gerenciador de tags:

Como criar novos acionadores para sua tag do Gerenciador de tags

Se você não usa o comércio eletrônico do Google Analytics, crie novos acionadores de eventos para os eventos do usuário de que seus modelos do Recommendations AI precisam. Em seguida, associe os novos acionadores à tag do Cloud Retail criada no Gerenciador de tags.

Antes de iniciar as próximas etapas, verifique se você criou uma tag do Cloud Retail no Gerenciador de tags. Consulte Criar uma tag do Gerenciador de tags.

Primeiro, crie os acionadores. Repita este procedimento para todos os eventos de usuário que seus modelos do Recommendations AI exigem:

  1. Na página Gerenciador de tags, em Acionadores, clique em Novo > Configuração de acionador.

  2. Escolha o tipo de gatilho que se aplica ao evento de usuário para o qual você está criando um gatilho.

  3. Salve o gatilho.

Em seguida, associe os novos acionadores à sua tag do Cloud Retail. Esse é um procedimento único:

  1. Na página Tags, do Gerenciador de tags, clique na sua tag do Cloud Retail para editá-la.

  2. Clique em Acionamento, selecione os novos acionadores e clique em Adicionar.

  3. Salve sua tag.

Em seguida, visualize a tag e configure o monitoramento de erros de gravação de eventos e outros problemas para garantir que a API Retail continue recebendo dados com sucesso.

Se você estiver usando a camada de dados cloud_retail como fonte de evento do usuário, configure sua camada de dados.

Reutilizar acionadores de comércio eletrônico do Google Analytics

Se você implementou o comércio eletrônico do Google Analytics pelo Gerenciador de tags, reutilize acionadores de evento do comércio eletrônico do Google Analytics para recomendações de IA.

Com essa fonte de dados, só é possível registrar eventos add-to-cart, purchase-complete e detail-page-view.

A tabela a seguir mostra como os eventos de comércio eletrônico do Google Analytics e de comércio eletrônico avançado são mapeados para os eventos do Recommendations AI.

Google Analytics 4 Comércio eletrônico avançado Recommendations AI
add_to_cart add add-to-cart
purchase purchase purchase-complete
view_item detail detail-page-view

Antes de iniciar estas etapas, confirme se você:

Para reutilizar acionadores de comércio eletrônico do Google Analytics, faça o seguinte:

  1. Na página Tags do Gerenciador de tags, clique na sua tag de comércio eletrônico do Google Analytics (tipo de tag Google Analytics – Universal Analytics ou Google Analytics – evento do GA4) para editá-la.

  2. Em Configurações avançadas > Sequenciamento de tags, selecione Acionar uma tag após o nome da tag de e-commercee-commerce avançado ou do GA4> disparar.

  3. Selecione sua tag do Cloud Retail como Tag de limpeza.

    Selecione Don't fire <Cloud tag Retail name> if <Enhanced ecommerce or GA4 tag name> failed ou is paused.

  4. Salve sua tag.

Como criar uma variável de ID de visitante

A API Retail usa o valor visitorId para rastrear usuários. visitorId normalmente é um ID de sessão e é necessário para todos os eventos. Configure uma variável que defina códigos de sessão como visitorId.

Se você estiver usando o Google Analytics, poderá utilizar o ID de visitante da plataforma. Para configurar isso, use o procedimento a seguir para substituir o valor do ID de visitante da tag do Cloud Retail. Isso mapeia o cookie primário "_ga" para uma variável do Gerenciador de tags chamada "Visitas da conta do GA". É possível fazer o mesmo para qualquer cookie de ID de sessão. não precisa ser do Google Analytics.

Para este procedimento, pressupomos que você esteja usando o Google Analytics. Se não estiver, use outro cookie ou variável ou consiga o ID do visitante na camada de dados cloud_retail.

Antes de iniciar estas etapas, verifique se você já criou uma tag do Cloud Retail no Gerenciador de tags. Consulte Como criar uma tag do Gerenciador de tags do Google.

Para definir o valor visitorID como uma variável da tag do Cloud Retail:

  1. No Gerenciador de tags, acesse a guia Variáveis e clique em Nova para criar uma nova variável definida pelo usuário.

  2. Dê um nome à variável na parte superior da caixa de diálogo, como "ID do visitante do GA".

  3. Insira as configurações da variável:

    Google Analytics 360

    1. Defina o Tipo de variável como JavaScript personalizado.

    2. Digite o script a seguir no campo JavaScript personalizado.

      Substitua "UA-XXXXXX-N" pelo seu ID de acompanhamento do Google Analytics. Para encontrar seu ID de acompanhamento, consulte O que aconteceu com meu ID de acompanhamento?. Para mais informações sobre como conseguir o ID do cliente, consulte a documentação do Google Analytics.

      function() {
       var tracker = ga.getByName('UA-XXXXXX-N');
       return tracker.get('clientID');
      }
      
    3. Clique em Salvar para salvar a variável.

    Google Analytics

    1. Escolha Cookie primário como o tipo de variável.

    2. No campo Nome do cookie, digite _ga.

    3. Clique em Valor do formato, selecione Converter indefinido para.. e insira "" (uma string vazia).

    4. Clique em Salvar para salvar a variável.

      Isso mapeia o cookie primário "_ga" para uma variável do Gerenciador de tags chamada "visitante da conta do GA".

  4. Acesse a guia Tags e clique na tag do Cloud Retail para editá-la.

  5. Clique em Configuração da tag e, em "Campos para substituir", clique no botão + Substituir um valor na mensagem UserEvent.

  6. Selecione visitorId como o campo e a variável que você acabou de criar como o valor do campo.

  7. Salve sua tag do Cloud Retail.

Em seguida, visualize sua tag e configure o monitoramento de erros de gravação de eventos e outros problemas para garantir que o Recommendations AI continue recebendo dados com sucesso.

Se você estiver usando a camada de dados cloud_retail como fonte de evento do usuário, configure sua camada de dados.

Como usar a camada de dados cloud_retail com o Gerenciador de tags

Se você criou sua tag do Cloud Retail no Gerenciador de tags para usar a camada de dados cloud_retail como origem do evento do usuário, configure a variável dataLayer no HTML de origem, conforme descrito na Guia do desenvolvedor do Gerenciador de tags.

Sobre a camada de dados

A maioria das tags do Gerenciador de tags requer dados que mudam dependendo do usuário ou da página (como IDs de usuário ou de produto). No caso da tag do Cloud Retail, esses dados precisam ser expostos de maneira estruturada por meio de uma camada de dados para que o Gerenciador de tags possa usá-los.

A camada de dados é um objeto JavaScript que normalmente é adicionado a uma página com código do lado do servidor ou no front-end usando HTML ou um modelo. Se uma página for configurada com a camada de dados, ela conterá um código como este:

dataLayer = dataLayer || [];
dataLayer.push({
  'cloud_retail': {
    'eventType': 'home-page-view',
    'visitorId': 'visitor_a',

    'userInfo': {
      'userId': '789'
    },
  }
});

Esse código cria um objeto dataLayer e atribui a estrutura cloud_retail a ele como um elemento de matriz.

Campos obrigatórios na camada de dados cloud_retail

A seção Eventos do usuário lista todos os campos e exemplos obrigatórios de tipos de evento que precisam ser transmitidos à camada de dados cloud_retail.

Seu código ou modelos do servidor precisam ter as tags de script corretas em cada página de que você quer enviar eventos. Depois que o objeto dataLayer for preenchido corretamente em cada página, teste a tag do Cloud Retail.

Alguns campos, como visitorId, são obrigatórios para a mensagem UserEvent, mas podem não estar disponíveis ao preencher a camada de dados. Por exemplo, visitorId pode ser derivado do cookie do usuário ou experimentIds do framework de experimentação A/B. Nesse caso, use uma variável para substituir o campo na tag do Gerenciador de tags.

É possível substituir os seguintes campos:

  • visitorId
  • userInfo.userId
  • attributionToken
  • experimentIds

Para saber como substituir um campo UserEvent no Gerenciador de tags, consulte Como definir o campo visitorID no Gerenciador de tags, que explica a substituição do valor do campo visitorId. com uma variável definida pelo usuário.

O exemplo a seguir mostra a camada de dados que precisa ser incluída na página para um UserEvent de detail-page-view usando o Gerenciador de tags:

<script>
  dataLayer = dataLayer || [];
  dataLayer.push({
    'cloud_retail': {
      'eventType' : 'detail-page-view',
      'visitorId': 'visitor_a',
      'userInfo': {
          // The user and visitor ID fields can typically be
          // be populated from a client-side JavaScript
          // variable such as a cookie. If you set the user
          // and/or visitor ID values from the server,
          // populate the `userID`.
          'userId': 'user_a'
      },
      'attributionToken': 'attribution-token',
      // In most cases, the experiment ID field is populated from a
      // client side JavaScript variable as defined by the experiment
      // manager.
      // If you set the experiment ID value from the server,
      // populate the `experimentIds` field here.
      'productDetails': [
            {
              'product': {'id': '123'}
            }
      ],
    // You can use the 'cloud_retail' data layer element along with other
    // data layer elements.
    'ecommerce': {
      ...
    },
  }];
</script>

Como visualizar sua tag do Gerenciador de tags

Com o modo de visualização do Gerenciador de tags, você pode testar novas tags antes de publicá-las no seu site ativo.

Para mais detalhes sobre o modo de visualização, consulte a documentação do Gerenciador de tags do modo de visualização.

Use o procedimento a seguir para confirmar que a tag está sendo acionada corretamente.

  1. Na página de visão geral do Gerenciador de tags, clique em Visualizar.

    O modo de visualização do Gerenciador de tags é aberto em uma nova guia do navegador.

  2. Insira as informações do site e clique em Iniciar para iniciar o Assistente de tags.

    Na guia atual do navegador, o Assistente de tags é iniciado e seu site é aberto em uma nova guia.

  3. No seu site, acesse qualquer página em que a tag do Cloud Retail seja acionada.

  4. Confirme se o Assistente de tags lista a tag do Cloud Retail na guia Tags, na seção Tags disparadas.

  5. No Assistente de tags, acesse a guia Camada de dados e verifique se os valores corretos da camada de dados de comércio eletrônico ou cloud_retail são exibidos.

Como verificar erros de tag

Se alguns campos estiverem incorretos ou ausentes ao visualizar a tag, a tag também retornará um erro, a menos que não esteja sendo disparada.

Verifique se há erros na página Erros no Console do Google Cloud. Esta página registra a maioria dos erros, exceto os de sintaxe, que normalmente aparecem apenas nos resultados da solicitação.

Você pode seguir as etapas abaixo para verificar se há erros gerados pelo Chrome DevTools, incluindo erros de sintaxe.

  1. Ative o modo de visualização no Gerenciador de tags para seu site em um navegador Chrome e acesse qualquer página em que a tag do Cloud Retail seja acionada.

  2. Com o modo de visualização aberto, abra o DevTools e clique na guia Network.

  3. Atualize a página.

  4. No DevTools, pesquise por userEvent.

    A guia "Rede" exibe o evento userEvent:collect e o código de status dele.

    • Uma resposta 200 indica que a tag está em bom estado.
    • Outras respostas, como um erro 400 e o destaque do evento em vermelho, indicam que a depuração é necessária.
  5. Clique duas vezes no nome do evento para executar a solicitação e mostre uma resposta completa com mais informações de erro.

    Por exemplo, talvez você veja um erro 400 contendo a mensagem "visitorId" é obrigatória e não pode estar vazia", indicando que visitorId não foi definido corretamente.

  6. Se nenhum userEvent for disparado, verifique a guia Console do DevTools para ver erros de sintaxe na camada de dados.

Como definir alertas para monitorar a gravação de eventos

A tarefa final para registrar eventos do usuário é configurar alertas. Você quer saber se os eventos não estão sendo registrados para tomar providências, se necessário. Para mais informações, consulte Como configurar alertas.

A seguir