TikTok Events API

TikTok for Business est une plateforme mondiale conçue pour donner aux marques et aux spécialistes du marketing les solutions nécessaires pour être des conteurs créatifs et interagir de manière pertinente avec la communauté TikTok. L'Events API TikTok est une intégration server-side qui vous permet de partager directement avec TikTok les événements des visiteurs du site web et de l'application à l'aide de leur Events API pour Web et Events API pour App version 2.0.

Le Events API pour APP le support est actuellement en phase de test bêta.

Fonctionnalités clés

La destination TikTok Events API offre les fonctionnalités clés suivantes :

• Structure des événements: notre Référence des événements correspond Le one de TikTok, ce qui signifie que vos données sont correctement reliées aux champs attendus de manière optimisée.

• Mappages prédéfinis: le mappage des données pour les destinations basées sur des événements s'effectue automatiquement, ce qui simplifie la saisie utilisateur.

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

• Smart mapping: le mapping des données peut être réajusté à l'aide des champs définis dans votre datalayer.

• Prise en charge des données multi-items: les informations incluses dans le item le tableau est envoyé à TikTok.

• Prise en charge du code d'événement de test: 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 de pouvoir accéder à TikTok Ads Manager.

Les événements personnalisés TikTok sont disponibles à des fins de reporting et de création d'audience. L'optimisation n'est actuellement PAS prise en charge.

Configuration

Paramètres	Description
jeton d’accès	Obligatoire pour événements Web. Votre jeton d'accès API tel que fourni par TikTok. Plus de détails sont disponibles en suivant ce LINK.
Pixel ID	Obligatoire pour événements Web. Votre identifiant 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.
Code d'événement de test	Pour événements Web uniquement. Ceci est utilisé pour tester le suivi des événements avant le déploiement en production. Ce code se trouve dans les TikTok Ads Manager suivant Assets ➜ Événements ➜ Gérer (Web Events) ➜ Sélectionnez votre pixel ➜ Test Events (onglet) [1]
Correspondance des événements	Modifiez le mappage standard entre les événements TikTok et les vôtres ou ajoutez de nouveaux mappages : les événements personnalisés sont également pris en charge. Plus de détails sur la configuration des événements Web TikTok personnalisés sont disponibles en suivant ce LINK.
Propriétés d'événement personnalisées	Envoyez des propriétés d'événement personnalisées.
Propriétés utilisateur personnalisées	Envoyez des propriétés utilisateur personnalisées.
Mappage d'événement TikTok "ViewContent"	Sélectionnez page_view, view_item ou les deux pour envoyer à TikTok ViewContent correspondra à l'événement. Voir Référence rapide pour plus de détails sur le mappage d'événements.
Source d'événement Autodiscovery	Activez cette option pour définir TikTok event_source en fonction de 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 priorité sur cette option.
Ne pas mettre l'ID utilisateur en minuscules	Lorsque cette option est activée et que le ID utilisateur (voir Mappage intelligent section) est fournie en texte clair, l'identifiant utilisateur n'est pas converti en minuscules avant d'appliquer l'algorithme de hachage SHA256.

1. Le Code d'événement de test ne peut être défini que dans les environnements de test, car TikTok n'enregistrera pas les données provenant d'événements en production lorsque ce code est inclus. 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 page_view [3] view_item [3]	ViewContent [3]
complete_tutorial	CompleteTutorial [2]
create_group	CreateGroup [2]
create_role	CreateRole [2]
customize_product	CustomizeProduct [1]
purchase complete_payment	Purchase
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]
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, hors ligne et CRM uniquement. Voir Source d'événement Autodiscovery dans Configuration pour plus de détails. 2. Pour les événements App uniquement. Voir Source d'événement Autodiscovery dans Configuration pour plus de détails. 3. Voir Mappage d'événement TikTok "ViewContent" dans Configuration pour plus de détails.

Correspondances des champs

Les propriétés peuvent être remappées à l'aide de notre Mappage intelligent fonctionnalité. 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 web avec les publicités TikTok. Cette destination commence par récupérer cet identifiant depuis partners.tiktok.ttp . S'il n'est pas présent, elle recherche le cookie mentionné précédemment _ttp et définit TikTok data.0.user.ttp avec la valeur obtenue. Le TikTok Click ID est un paramètre de suivi qui est ajouté aux URL de page de destination de votre annonce. Cette destination vérifie si partners.tiktok.ttclid est défini avec la valeur ttclid. S'il n'est pas présent, elle recherche le cookie ttclid. Si aucun n'est trouvé, elle tente d'analyser la valeur à partir de context.page.url .

Champs Smart Mapping	Propriétés par défaut de Commanders Act	Propriétés TikTok
Event Source	partners.tiktok.event_source	event_source [*][1]
-	Pixel ID App ID	event_source_id [*]
-	event_name	data.0.event [*][2]
Horodatage de l’événement	context.event_timestamp	data.0.event_time [*][3]
ID de l'événement	id	data.0.event_id [4]
Click ID	partners.tiktok.ttclid	data.0.user.ttclid [5]
ID utilisateur	user.id	data.0.user.external_id [6]
Cookie ID	partners.tiktok.ttp	data.0.user.ttp [7]
URL de la page	context.page.url	data.0.page.url
Référent de la page	context.page.referrer	data.0.page.referrer
IDFV de l'appareil	context.device.idfv	data.0.user.idfv [8]
Statut ATT de l'appareil	context.device.att_status	data.0.user.att_status [8][9]
IDFA de l'appareil GAID de l'appareil	context.device.advertising_id	data.0.user.idfa [8] data.0.user.gaid [10]
App ID	context.app.namespace	data.0.app.app_id [11]
Nom de l'app	context.app.name	data.0.app.app_name
Version de l’application	context.app.version	data.0.app.app_version
e-mail utilisateur	user.email	data.0.user.email [6]
Téléphone de l'utilisateur	user.phone	data.0.user.phone [6][12]
IP de l'appareil	context.device.ip	data.0.user.ip
Agent utilisateur de l'appareil	context.device.user_agent	data.0.user.user_agent
Langue de l'appareil	context.device.language	data.0.user.locale [13]
Utilisation limitée des données	partners.tiktok.ldu	data.0.limited_data_use [14]
Type de contenu de l'élément	items.X.content_type	data.0.properties.contents.X.content_type [15]
ID de l'item	items.X.id	data.0.properties.contents.X.content_id data.0.properties.content_ids [16]
Prix de l'article	items.X.product.price	data.0.properties.contents.X.price
Quantité de l'élément	items.X.quantity	data.0.properties.contents.X.quantity
Nom de l'item	items.X.product.name	data.0.properties.contents.X.content_name
Catégorie de l'item	items.X.product.category_1	data.0.properties.contents.X.content_category
Marque de l'item	items.X.product.brand	data.0.properties.contents.X.brand
Terme de recherche	search_term	data.0.properties.search_string [17]
ID de transaction	id	data.0.properties.order_id [17]
Identifiant de boutique	partners.tiktok.shop_id	data.0.properties.shop_id [17]
Statut de la transaction	status	data.0.properties.status [17]
Type de contenu	content_type	data.0.properties.content_type [17]
Devise	currency	data.0.properties.currency
Description	event_name	data.0.properties.description
Valeur de la transaction	valeur	data.0.properties.value
Liste des éléments	items.length	data.0.properties.num_items
-	Code d'événement de test	test_event_code
-	Propriétés d'événement personnalisées	[Any property] [18]
-	Propriétés utilisateur personnalisées	[Any property] [19]

* Propriété obligatoire. 1. Valeurs prises en charge : web , app , offline , et CRM . Lorsque Source d'événement Autodiscovery est activé, si le champ "Smart Mapping" Type d'expérience est défini avec une propriété contenant la valeur application native ou que l'objet context.app possède au moins une propriété, alors celui-ci est défini avec app . Le "Smart Mapping" Event Source a priorité sur la fonctionnalité de découverte automatique. Valeur par défaut : web . 2. Voir Référence rapide pour plus de détails sur le mappage d'événements. 3. S'il n'est pas fourni, l'horodatage actuel est utilisé. 4. Requis si vous envoyez des événements Web à la fois depuis le pixel navigateur TikTok et depuis 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. S'il n'est pas fourni, le cookie ttclid ou context.page.url est utilisé. 6. S'il est fourni en texte clair, il est automatiquement haché avec SHA-256. 7. S'il n'est pas 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. 13. Voir Identifiant de langue BCP 47. 14. Voir Events API 2.0 - Utilisation limitée des données pour plus de détails. 15. Valeurs prises en charge : product et product_group . Par défaut : product . 16. Requis pour Video Shopping Ads (VSA). 17. Défini pour les événements Web. 18. Défini dans le data.0.properties propriété. Voir Propriétés d'événement personnalisées dans Configuration. 19. Défini dans le data.0.user propriété. Voir Propriétés utilisateur personnalisées dans Configuration.