TikTok Events API

TikTok for Business est une plateforme mondiale conçue pour donner aux marques et aux marketeurs les solutions pour être des conteurs créatifs et s'engager de manière significative avec la communauté TikTok. L'Events API de TikTok est une intégration server-side qui vous permet de partager les événements des visiteurs de votre site et de votre application directement avec TikTok en utilisant leur Events API for Web et Events API for App version 2.0.

Le Events API for APP le support est actuellement en test beta.

Principales fonctionnalités

La destination TikTok Events fournit les fonctionnalités clés suivantes :

• Structure des événements : notre Référence des événements correspondances un, ce qui signifie que vos données sont correctement mappées aux champs attendus de manière optimisée.

• Mappings préconstruits : le mapping des données pour les destinations basées sur des événements se fait automatiquement, ce qui simplifie les saisies utilisateur.

• Hachage automatique : les informations sont automatiquement hachées conformément aux spécifications du partenaire.

• Mapping intelligent : le mapping des données peut être réajusté en utilisant vos champs définis dans le datalayer.

• Prise en charge des données multi-éléments : les informations incluses dans le élément array sont envoyées à TikTok.

• Prise en charge du test_event_code : validation en temps réel dans vos environnements de test avec le champ test_event_code.

Configuration de la destination

Avant de commencer avec cette destination, assurez-vous d'avoir accès à TikTok Ads Manager.

Les événements personnalisés TikTok sont disponibles pour le reporting et la création d'audiences. L'optimisation n'est actuellement PAS prise en charge.

Configuration

Paramètres	Description
Access Token	Obligatoire pour événements Web. Votre API Access Token tel que fourni par TikTok. Plus de détails sont disponibles en suivant ce LINK.
Pixel Id	Obligatoire pour événements Web. Votre identifiant de pixel tel que fourni par TikTok. Plus de détails sont disponibles en suivant ce LINK.
App Id	Obligatoire pour événements App. Votre identifiant d'application tel que fourni par TikTok. Plus de détails sont disponibles en suivant ce LINK.
Test Event Code	Pour événements Web seulement. Ceci est utilisé pour tester le suivi des événements avant le déploiement en production. Ce code peut être trouvé dans le TikTok Ads Manager suivant Assets ➜ Events ➜ Manage (Web Events) ➜ Sélectionnez votre pixel ➜ Test Events (Onglet) [1]
Mapping des événements	Changez le mapping standard entre les événements de TikTok et les vôtres ou ajoutez de nouveaux mappings : les événements personnalisés sont également pris en charge. Plus de détails sur la façon de configurer des événements web TikTok personnalisés sont disponibles en suivant ce LINK.
Mapping de l'événement TikTok "ViewContent"	Sélectionnez page_view, view_item ou les deux pour envoyer à TikTok ViewContent événement. Voir Référence rapide pour plus de détails sur le mapping d'événements.
Source d'événement en autodécouverte	Cochez cette option pour définir TikTok event_source basé sur la valeur fournie dans le champ "Smart Mapping" Type d'expérience ou dans la propriété standard context.app . Le champ "Smart Mapping" Event Source a la priorité sur cette option.

[1] Le Test Event Code ne peut être défini que dans les environnements de test car TikTok ne sauvegardera pas les données provenant d'événements en direct contenant ce code. Plus de détails sont disponibles en suivant ce LINK.

Référence rapide

Les événements standards TikTok sont détaillés dans ce LINK.

Commanders Act Events	TikTok Events
achieve_level	AchieveLevel [2]
add_payment_info	AddPaymentInfo
add_to_cart	AddToCart
add_to_wishlist	AddToWishlist
application_approval	ApplicationApproval [1]
begin_checkout	InitiateCheckout [1]
click_button view_content	ViewContent
complete_tutorial	CompleteTutorial [2]
create_group	CreateGroup [2]
create_role	CreateRole [2]
customize_product	CustomizeProduct [1]
purchase	CompletePayment [1][4] Checkout [2]
complete_payment	CompletePayment [1][4] Purchase [2]
contact	Contact [1]
download	Download [1]
find_location	FindLocation [1]
submit_form generate_lead	Lead [1]
generate_lead	GenerateLead [2]
in_app_ad_click	InAppADClick [2]
in_app_ad_impr	InAppAdImpr [2]
install_app	InstallApp [2]
join_group	JoinGroup [2]
launch_app	LaunchAPP [2]
loan_application	LoanApplication [2]
loan_approval	LoanApproval [2]
loan_disbursal	LoanDisbursal [2]
login	Login [2]
view_content page_view[3] view_item[3]	ViewContent
rate	Rate [2]
schedule	Schedule [1]
search	Search
sign_up	CompleteRegistration [1] Registration [2]
spend_credits	SpendCredits [2]
start_trial	StartTrial
submit_application	SubmitApplication [1]
subscribe	Subscribe
unlock_achievement	UnlockAchievement [2]

[1] Pour les événements web uniquement. Voir event_source in Configuration pour plus de détails. [2] Pour les événements app uniquement. Voir event_source in Configuration pour plus de détails. [3] Selon votre sélection pour Mapping de l'événement TikTok "ViewContent" . Voir Configuration pour plus de détails. [4] Avec CompletePayment événements vous pouvez tirer parti de TikTok Value-Based Optimization for Web (VBO Web).

Mappings de champs

La plupart des propriétés peuvent être remappées en utilisant notre fonctionnalité "Smart Mapping". Le pixel client-side TikTok enregistre un identifiant unique dans le cookie _ttp, qui est utilisé pour faire correspondre les événements des visiteurs du site avec les publicités TikTok. Cette destination commence par obtenir cet identifiant depuis partners.tiktok.ttp . S'il n'est pas présent, il recherche le cookie précédemment mentionné _ttp et définit TikTok data.0.user.ttp avec la valeur résultante. Le Tiktok Click ID est un paramètre de tracking qui est attaché aux URL de landing page de vos annonces. Cette destination vérifie si partners.tiktok.ttclid est défini avec la valeur ttclid. S'il n'est pas présent, il recherche le cookie ttclid. Si aucun n'est trouvé, il tente de parser la valeur depuis context.page.url .

Commanders Act Properties	TikTok Properties
partners.tiktok.event_source	event_source [*][1]
Pixel Id App Id	event_source_id [*]
event_name	data.0.event [*][2]
context.event_timestamp	data.0.event_time [*][3]
id	data.0.event_id [4]
partners.tiktok.ttclid	data.0.user.ttclid [5]
user.id	data.0.user.external_id [6]
partners.tiktok.ttp	data.0.user.ttp [7]
context.page.url	data.0.page.url
context.page.referrer	data.0.page.referrer
context.device.advertising_id	data.0.user.idfa [8]
context.device.idfv	data.0.user.idfv [8]
context.device.att_status	data.0.user.att_status [8][9]
context.device.advertising_id	data.0.user.gaid [10]
context.app.namespace	data.0.app.app_id [11]
context.app.name	data.0.app.app_name
context.app.version	data.0.app.app_version
user.email	data.0.user.email [6]
user.phone	data.0.user.phone [6][12]
context.device.ip	data.0.user.ip
context.device.user_agent	data.0.user.user_agent
context.device.language	data.0.user.locale [13]
partners.tiktok.ldu	data.0.limited_data_use [14]
items.X.content_type	data.0.properties.contents.X.content_type [15]
items.X.id	data.0.properties.contents.X.content_id data.0.properties.content_ids [16]
items.X.product.price	data.0.properties.contents.X.price
items.X.quantity	data.0.properties.contents.X.quantity
items.X.product.name	data.0.properties.contents.X.content_name
items.X.product.category_1	data.0.properties.contents.X.content_category
items.X.product.brand	data.0.properties.contents.X.brand
search_term	data.0.properties.search_string [17]
id	data.0.properties.order_id [17]
partners.tiktok.shop_id	data.0.properties.shop_id [17]
status	data.0.properties.status [17]
content_type	data.0.properties.content_type [17]
currency	data.0.properties.currency
event_name	data.0.properties.description
value	data.0.properties.value
items.length	data.0.properties.num_items
Test Event Code	test_event_code

[*] Propriété obligatoire. [1] Valeurs prises en charge : web , app , offline , et crm . Lorsque Source d'événement en autodécouverte est cochée, si le champ "Smart Mapping" Type d'expérience est défini avec une propriété contenant la valeur native app ou l'objet context.app a au moins une propriété alors ceci est défini avec app . Le "Smart Mapping" Event Source a la priorité sur la fonctionnalité d'autodécouverte. Valeur par défaut : web . [2] Voir Référence rapide pour plus de détails sur le mapping d'événements. [3] Si non fourni, le timestamp courant est utilisé. [4] Requis si vous envoyez des événements web à la fois depuis le pixel navigateur TikTok et cette destination. Utilisé pour la déduplication avec event_source_id et data[0].event . Plus de détails sont disponibles en suivant ce LINK. [5] Si non fourni, le cookie ttclid ou context.page.url est utilisé. [6] S'il est fourni en clair, il est automatiquement haché avec SHA-256. [7] Si non fourni, le cookie _ttp est utilisé. [8] Défini lorsque la propriété "Smart Mapping" Plateforme de l'appareil ou context.device.type est défini avec iOS (insensible à la casse). [9] Valeurs prises en charge : AUTHORIZED , DENIED , NOT_DETERMINED , RESTRICTED et NOT_APPLICABLE. Plus de détails sont disponibles en suivant ce LINK. [10] Défini lorsque la propriété "Smart Mapping" Plateforme de l'appareil ou context.device.type est défini avec Android (insensible à la casse). [11] Requis pour les événements app. [12] Numéro de téléphone au format E.164 format. [13] Voir Identifiant de langue BCP 47. [14] Voir Events API 2.0 - Limited Data Use pour plus de détails. [15] Valeurs prises en charge : product et product_group . Par défaut : product . [16] Requis pour les Video Shopping Ads (VSA). [17] Défini pour les événements web.