TikTok visão geral da extensão de API de eventos na web

Última atualização em 2023-11-29
  • Tópicos
  • Tags
    Exibir mais informações sobre este tópico
  • Criado para:
  • Developer
    User
    Admin
    Leader

A variável TikTok A API de eventos é uma API do servidor de rede de borda que permite compartilhar informações com a TikTok diretamente sobre as ações do usuário em seus sites. Você pode aproveitar as regras de encaminhamento de eventos para enviar dados do Adobe Experience Platform Edge Network para TikTok usando o TikTok Extensão da API de eventos da Web.

TikTok pré-requisitos

Para configurar o TikTok API de eventos da Web para usar o TikTok de eventos, é necessário gerar uma TikTok código de pixel e token de acesso.

Você deve ter um válido TikTok para uma conta comercial para criar um TikTok pixel usando a configuração do parceiro. Vá para a TikTok para página de registro comercial para registrar e criar uma conta se ainda não tiver uma.

Você precisa estar conectado à sua conta comercial para configurar TikTok Pixel usando configuração de parceiro. Para fazer isso, siga as etapas abaixo:

  1. Navegue até a Assets e selecione Evento.
  2. Em Eventos da Web, selecione Gerenciar.
  3. Selecionar Configurar eventos da Web.
  4. Selecionar Configuração do Parceiro como seu método de conexão.

Consulte a Introdução ao Pixel guia para obter mais informações sobre como configurar o TikTok pixel.

Você pode gerar um token de acesso depois que o pixel for criado com êxito. Para fazer isso, navegue até o Pixel e selecione a variável Configurações guia. Em API de eventos, selecione Gerar token de acesso.

Consulte a TikTok guia de introdução para obter mais informações sobre como configurar o código de pixel e o token de acesso.

Instale e configure o TikTok extensão da API de eventos da web

Para instalar a extensão, selecione Extensões no painel de navegação esquerdo. No Catálogo , selecione a Extensão da API de eventos da Web do TikTok e selecione Instalar.

O catálogo de extensões que mostra o TikTok placa de extensão destacando instalar.

Na próxima tela, insira os seguintes valores de configuração gerados anteriormente TikTok Gerenciador de anúncios:

  • Código de pixel
  • Token de acesso

Quando terminar, selecione Salvar.

TikTok tela de configuração para o TikTok extensão da API de eventos da Web.

Configurar uma regra de encaminhamento de eventos

Depois que todos os elementos de dados forem configurados, você poderá começar a criar regras de encaminhamento de eventos que determinam quando e como seus eventos serão enviados para o TikTok.

Criar um novo regra na propriedade de encaminhamento de eventos. Em Ações, adicione uma nova ação e defina a extensão para Extensão da API de eventos da Web do TikTok. Para enviar eventos da Rede de borda para o TikTok, defina o Tipo de ação para Enviar evento de API de eventos da Web do TikTok.

A variável Enviar evento de API de eventos da Web do TikTok tipo de ação que está sendo selecionado para um TikTok na interface da Coleção de dados.

Após a seleção, controles adicionais aparecem para configurar ainda mais o evento, conforme descrito abaixo. Após a conclusão, selecione Manter alterações para salvar a regra.

Eventos e parâmetros da Web

Os eventos e parâmetros da Web contêm informações gerais sobre o evento. Eventos padrão são compatíveis com o TikTok ferramentas de integração e podem ser usadas para relatórios, otimização para conversões e criação de públicos-alvo.

Entrada Descrição
Nome do evento O nome do evento. Essas são ações com nomes predefinidos criadas por TikTok e é um campo obrigatório. Consulte a TikTok API de marketing para obter mais informações sobre eventos compatíveis.
Hora do Evento Data e hora como string em ISO 8601 ou em aaaa-MM-dd'T'HH:mm:formato ss:SSZ. Este campo é obrigatório.
ID de evento A ID exclusiva gerada pelos anunciantes para indicar cada evento. Este campo é opcional e é usado para desduplicação.

A variável Web Events and Parameters seção que mostra exemplos de entrada de dados nos campos.

Parâmetros de Contexto do Usuário

Os parâmetros de contexto do usuário contêm informações do cliente usadas para corresponder eventos de visitantes da Web com TikTok usuários. A inclusão de vários tipos de dados correspondentes permite aumentar a precisão dos modelos de direcionamento e otimização.

Entrada Descrição
Endereço IP Endereço IP público sem hash do navegador. O suporte é fornecido para endereços IPv4 e IPv6. As formas completa e compactada de endereços IPv6 são reconhecidas.
Agente do usuário O agente de usuário sem hash do dispositivo do usuário.
Email Endereço de email do contato associado ao evento de conversão.
Telefone O número de telefone deve estar no formato E164 [+][código do país][código de área][local phone number] antes do hash.
ID de cookies Se estiver usando o Pixel, o SDK salvará automaticamente um identificador exclusivo na _ttp cookie, se os cookies estiverem ativados. A variável _ttp pode ser extraído e usado para este campo.
ID externa Qualquer identificador exclusivo, como IDs de usuário, IDs de cookie externo e assim por diante, deve ter hash com SHA256.
ID de cliques do TikTok A variável ttclid que é adicionado ao URL da landing page sempre que um anúncio é selecionado em TikTok.
URL da página O URL da página no momento do evento.
URL do referenciador de página O URL do referenciador de página.

A variável User Context Parameters seção que mostra exemplos de entrada de dados nos campos.

Parâmetros de propriedades

Use os parâmetros de propriedades para configurar outras propriedades compatíveis.

Entrada Descrição
Preço O custo de um único item.
Quantidade O número de itens sendo comprados no evento. Deve ser um número positivo maior que 0.
Tipo de conteúdo Um valor de product ou product_group deve ser atribuído à propriedade de objeto content_type, dependendo de como você configurará o feed de dados ao configurar o catálogo de produtos.
ID de conteúdo Um identificador exclusivo do item de produto.
Categoria de conteúdo Categoria da página/produto.
Nome do conteúdo Nome da página/produto.
Moeda A moeda dos itens que estão sendo comprados no evento. Isso é expresso em ISO-4217.
Valor O preço total do pedido. Esse valor será igual ao preço * quantidade.
Descrição Uma descrição do item ou da página.
Consulta A sequência de caracteres de texto que foi usada para pesquisar um produto.
Status O status de um pedido, item ou serviço. Por exemplo, "enviado".

A variável Properties Parameters seção que mostra exemplos de entrada de dados nos campos.

Desduplicação de eventos

TikTok pixel precisará ser configurado para desduplicação se você usar o TikTok pixel SDK e o TikTok extensão da API de eventos da Web para enviar os mesmos eventos para o TikTok.

A desduplicação não é necessária se tipos de evento distintos estiverem sendo enviados do cliente e do servidor sem qualquer sobreposição. Para garantir que seus relatórios não sejam afetados negativamente, verifique se qualquer evento único compartilhado pela TikTok pixel SDK e o TikTok a extensão da API de eventos da web está desduplicada.

Ao enviar eventos compartilhados, verifique se todos os eventos incluem uma ID de pixel, uma ID de evento e um nome. Os eventos duplicados que chegarem dentro de cinco minutos um do outro serão mesclados. Se o campo de dados estiver ausente do primeiro evento, ele será combinado com o evento subsequente. Qualquer evento duplicado recebido em 48 horas será removido.

Consulte a TikTok documentação sobre Desduplicação de eventos para obter mais detalhes sobre esse processo.

Próximas etapas

Este guia abordou como enviar dados do evento do lado do servidor para o TikTok usando o TikTok extensão da API de eventos da Web. Para obter mais informações sobre os recursos de encaminhamento de eventos do Adobe Experience Platform, consulte o visão geral do encaminhamento de eventos.

Nesta página