TikTok información general sobre la extensión API web events

Última actualización: 2023-11-29
  • Temas:
  • Tags
    Ver más sobre este tema
  • Creado para:
  • Developer
    User
    Admin
    Leader

El TikTok La API de eventos es un API del servidor de red perimetral que le permite compartir información con TikTok directamente sobre las acciones de los usuarios en sus sitios web. Puede aprovechar las reglas del reenvío de eventos para enviar datos desde Adobe Experience Platform Edge Network hasta TikTok mediante el uso de TikTok Extensión de la API de eventos web.

TikTok requisitos previos

Para configurar la variable TikTok API de eventos web para utilizar TikTok API de eventos, debe generar un TikTok código de píxel y token de acceso.

Debe tener un válido TikTok para una cuenta empresarial con el fin de crear una TikTok píxel con la configuración de socio. Vaya a la TikTok para la página de registro empresarial para registrarse y crear una cuenta si aún no la tiene.

Debe haber iniciado sesión en su cuenta empresarial para configurar TikTok Píxel con configuración de socio. Para realizar esto, siga los pasos a continuación:

  1. Vaya a Assets y seleccione Evento.
  2. En Eventos web, seleccione Administrar.
  3. Seleccionar Configuración de eventos web.
  4. Seleccionar Configuración de socio como método de conexión.

Consulte la Introducción a Pixel para obtener más información sobre cómo configurar el TikTok píxel.

Puede generar un token de acceso una vez que el píxel se haya creado correctamente. Para ello, vaya al píxel y seleccione la opción Configuración pestaña. En la API de eventos, seleccione Generar token de acceso.

Consulte la TikTok guía de introducción para obtener más información sobre cómo configurar el código de píxel y el token de acceso.

Instalación y configuración de TikTok extensión de API de eventos web

Para instalar la extensión, seleccione Extensiones en el panel de navegación izquierdo. En el Catálogo , seleccione la pestaña Extensión de API de eventos web de TikTok y luego seleccione Instalar.

El catálogo de extensiones que muestra TikTok instalación de resalte de tarjeta de extensión.

En la pantalla siguiente, introduzca los siguientes valores de configuración que generó anteriormente desde TikTok Administrador de anuncios:

  • Código de píxel
  • Token de acceso

Cuando termine, seleccione Guardar.

TikTok pantalla de configuración para TikTok extensión de API de eventos web.

Configuración de una regla de reenvío de eventos

Una vez configurados todos los elementos de datos, puede empezar a crear reglas de reenvío de eventos que determinen cuándo y cómo se enviarán los eventos a TikTok.

Crear un nuevo regla en la propiedad de reenvío de eventos. En Acciones, añada una nueva acción y establezca la extensión en Extensión de API de eventos web de TikTok. Para enviar eventos de Edge Network a TikTok, configure el Tipo de acción hasta Enviar evento de API de eventos web de TikTok.

El Enviar evento de API de eventos web de TikTok tipo de acción que se está seleccionando para una TikTok en la IU de recopilación de datos.

Después de la selección, aparecen controles adicionales para configurar aún más el evento, como se describe a continuación. Una vez finalizado, seleccione Conservar cambios para guardar la regla.

Eventos y parámetros web

Los eventos y parámetros web contienen información general sobre el evento. Los eventos estándar son compatibles en TikTok Las herramientas de integración de y se pueden utilizar para la creación de informes de, la optimización para conversiones y la creación de audiencias.

Entrada Descripción
Nombre del evento El nombre del evento. Son acciones con nombres predefinidos creados por TikTok y es un campo obligatorio. Consulte la TikTok API de marketing para obtener más información sobre los eventos admitidos.
Hora del evento Fecha-hora como cadena en ISO 8601 o en aaaa-MM-dd'T'HH:mm:formato ss:SSSZ. Este campo es obligatorio.
ID de evento ID único generado por los anunciantes para indicar cada evento. Este es un campo opcional y se utiliza para la deduplicación.

El Web Events and Parameters sección que muestra la entrada de datos de ejemplo en los campos.

Parámetros de contexto de usuario

Los parámetros de contexto del usuario contienen información del cliente que se utiliza para hacer coincidir los eventos de visitantes web con TikTok usuarios. La inclusión de varios tipos de datos coincidentes permite aumentar la precisión de los modelos de segmentación y optimización.

Entrada Descripción
Dirección IP Dirección IP pública del explorador sin hash. Se admite direcciones IPv4 e IPv6. Se reconocen tanto las formas completas como las comprimidas de las direcciones IPv6.
Agente de usuario El agente de usuario sin hash del dispositivo del usuario.
Correo electrónico Dirección de correo electrónico del contacto asociado con el evento de conversión.
Phone El número de teléfono debe estar en formato E164 [+][código de país][código de área][local phone number] antes del hash.
ID de cookie Si utiliza el SDK de píxeles, guardará automáticamente un identificador único en la _ttp si las cookies están habilitadas. El _ttp Este valor se puede extraer y utilizar para este campo.
ID externo Cualquier identificador único, como ID de usuario, ID de cookie externas, etc., debe tener un cifrado hash con SHA256.
ID de clic TikTok El ttclid que se añade a la dirección URL de la página de aterrizaje cada vez que se selecciona un anuncio en TikTok.
URL de página La dirección URL de la página en el momento del evento.
URL de referente de página La URL del referente de la página.

El User Context Parameters sección que muestra la entrada de datos de ejemplo en los campos.

Parámetros de propiedades

Utilice los parámetros de propiedades para configurar propiedades compatibles adicionales.

Entrada Descripción
Precio Coste de un solo artículo.
Cantidad El número de artículos que se compran en el evento. Debe ser un número positivo mayor que 0.
Tipo de contenido Un valor de product o product_group debe asignarse a la propiedad de objeto content_type, según cómo configure la fuente de datos al configurar el catálogo de productos.
ID de contenido Un identificador único del elemento de producto.
Categoría de contenido Categoría de la página o producto.
Nombre del contenido Nombre de la página o producto.
Moneda La moneda de los artículos que se compran en el evento. Esto se expresa en ISO-4217.
Valor El precio total del pedido. Este valor es igual al precio * cantidad.
Descripción Una descripción del elemento o la página.
Consulta Cadena de texto que se utilizó para buscar un producto.
Estado El estado de un pedido, artículo o servicio. Por ejemplo, "enviado".

El Properties Parameters sección que muestra la entrada de datos de ejemplo en los campos.

Deduplicación de eventos

TikTok píxel deberá configurarse para la anulación de duplicación si utiliza ambos TikTok el SDK de píxeles y TikTok extensión de API de eventos web para enviar los mismos eventos a TikTok.

La deduplicación no es necesaria si se envían distintos tipos de eventos desde el cliente y el servidor sin ninguna superposición. Para garantizar que los informes no se vean afectados negativamente, debe asegurarse de que cualquier evento individual que comparta la variable TikTok el SDK de píxeles y TikTok La extensión de la API de eventos web está deduplicada.

Al enviar eventos compartidos, asegúrese de que cada evento incluya un ID de píxel, un ID de evento y un nombre. Se combinarán los eventos duplicados que llegan en un plazo de cinco minutos uno del otro. Si el campo de datos estaba ausente del primer evento, se combina con el evento posterior. Se eliminará cualquier evento duplicado recibido en un plazo de 48 horas.

Consulte la TikTok documentación sobre Deduplicación de eventos para obtener más información sobre este proceso.

Pasos siguientes

En esta guía se explica cómo enviar datos de eventos del lado del servidor a TikTok uso del TikTok extensión de API de eventos web. Para obtener más información sobre las funcionalidades de reenvío de eventos en Adobe Experience Platform, consulte la resumen del reenvío de eventos.

En esta página