Visão geral da extensão de API de eventos da Web do TikTok

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

TikTok pré-requisitos prerequisites

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

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

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

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

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

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

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

Instalar e configurar a extensão de API de eventos Web do TikTok install

Para instalar a extensão, selecione Extensões na navegação à esquerda. Na guia Catálogo, selecione a Extensão de API de Eventos da Web do TikTok e selecione Instalar.

O catálogo de extensões que mostra a instalação do destaque do cartão de extensão TikTok.

Na próxima tela, insira os seguintes valores de configuração que você gerou anteriormente do TikTok Ads Manager:

  • Código de pixel
  • Token de acesso

Quando terminar, selecione Salvar.

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

Configurar uma regra de encaminhamento de eventos config-rule

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

Crie uma nova regra na propriedade de encaminhamento de eventos. Em Ações, adicione uma nova ação e defina a extensão como Extensão da API de Eventos da Web do TikTok. Para enviar eventos Edge Network para TikTok, defina o Tipo de Ação como Enviar Evento de API de Eventos da Web do TikTok.

O tipo de ação Enviar Evento de API de Eventos da Web do TikTok está sendo selecionado para uma regra 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. Depois de concluído, selecione Manter alterações para salvar a regra.

Parâmetros e Eventos da Web

Os eventos e parâmetros da Web contêm informações gerais sobre o evento. Os eventos padrão têm suporte nas ferramentas de integração do TikTok e podem ser usados para relatórios, otimização de conversões e criação de públicos.

Entrada
Descrição
Nome do evento
O nome do evento. Estas são ações com nomes predefinidos criados por TikTok e é um campo obrigatório. Consulte a documentação da TikTok API de marketing para obter mais informações sobre eventos com suporte.
Hora do Evento
Data e hora como cadeia de caracteres no formato ISO 8601 ou yyyy-MM-dd'T'HH:mm:ss:SSSZ. 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 seção Web Events and Parameters que mostra exemplos de entrada de dados nos campos.

Parâmetros de Contexto do Usuário

Os parâmetros de contexto de usuário contêm informações de cliente que são usadas para corresponder eventos de visitante 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 do cookie
Se você estiver usando o Pixel, o SDK salvará automaticamente um identificador exclusivo no cookie _ttp, se os cookies estiverem habilitados. O valor _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
O ttclid que é adicionado à URL da página de aterrissagem 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 seção User Context Parameters 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á seu feed de dados ao configurar seu 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.
Currency
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 seção Properties Parameters que mostra exemplos de entrada de dados nos campos.

Desduplicação de eventos deduplication

O pixel TikTok precisará ser configurado para desduplicação se você usar o SDK de TikTok pixels e a extensão de API de eventos da Web TikTok para enviar os mesmos eventos para 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 compartilhado pelo SDK de TikTok pixels e pela extensão de API de eventos da Web do TikTok foi desduplicado.

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 documentação TikTok em Eliminação de Duplicação de Eventos para obter mais detalhes sobre esse processo.

Próximas etapas

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

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743