How to set up a TikTok conversions destination with Adobe

This article describes how to setup a secure data connection through Adobe. Adobe supports TikTok Events API.

TikTok Web Events API extension overview

TikTok’s Events API is a secure server-to-server interface that allows advertisers to share the actions customers take on their websites directly with TikTok. Using the TikTok Web Events API extension, you can leverage the event forwarding rules to relay data to TikTok from the Adobe Experience Platform Edge Network.

For more information on these connection tools, please review About TikTok Events API.

Prerequisites

The Tiktok Web Events API extension is configured to use the TikTok Events API. To generate a TikTok Pixel Code and Access Token:

1. Create a TikTok For Business account (Learn more about TikTok for Business accounts here)

2. Create a TikTok Pixel using the Partner setup

3. Generate the Access Token from the settings page from the created Pixel

For the additional documentation for obtaining the Pixel code and the access token, please see TikTok API for Business

Install TikTok Web Events API extension

Navigate to the Data Collection UI or Experience Platform UI and select Event Forwarding from the left navigation to install the TikTok Web Events API extension. From here, select a property to add the extension to, or create a new property.

Select Extensions in the left navigation, then select the Catalog tab. Search for the TikTok Web Events API card, then select Install.

In the configuration view, you must provide the Pixel Code and the Access Token from TikTok Ads Manager. Please refer here for the additional documentation for obtaining the Pixel Code and the Access Token.

Configure Event Forwarding rule

Create a new event forwarding rule and configure its conditions. When selecting the actions, select TikTok Web Events API Extension, then. Select Send TikTok Web Events API Event for the action type.

Please refer to the TikTok Marketing API documentation for more information regarding supported events and parameters.

TikTok Supported Events & Recommended Properties

Configure Event Deduplication (Optional)

Deduplication is required for advertisers who are sending both client-side and server-side events to TikTok. With the Adobe TikTok Web Events API extension, advertisers who have been utilizing TikTok Pixel separately will need to configure deduplication for web events when enabling the extension to send server-side events to TikTok via Adobe.

Example: if the CompletePayment event is sent from TikTok Pixel and Adobe TikTok Web Events API extension, deduplication will be required unless the two channels are sending non-overlapping events.

Example: if the ViewContent event is sent from TikTok Pixel and CompletePayment event from Adobe extension, deduplication will not be required.

Please note: event deduplication will rely on these values from both TikTok Pixel and Adobe TikTok Web Events API extension:

• Pixel Code

• Event name

• Event ID

You must ensure both (TikTok Pixel & Adobe TikTok Web Events API extension) use the same values for all three parameters.

Duplicated events arriving within 5 minutes of each other will be merged - the latter event will be merged into the first event if the data field was not in the first event. Duplicated events within 48 hours, the latter event will be dropped.

For more information regarding event deduplication, please refer to Event Deduplication.

TikTok Pixel Configuration

In order to enable deduplication, the TikTok Pixel events need to include the event_id parameter in all overlapping events that are sent to TikTok. In order to do so, please include the event_id parameter in the TikTok Pixel payload.

The event_id is a unique string chosen by the advertiser. Advertisers may already have order numbers or transaction IDs that are suited well for use in deduplication. For advertisers without ready-made IDs, a random number can be used. However, this number must be consistent across the Pixel Events and Adobe TikTok Web Events API events for deduplication to work.

TikTok Pixel code sample to include event_id parameter

ttq.track('AddToCart', {

contents: [

{

content_id: '301',

content_name: 'running shoes',

content_category: 'Shoes > Sneakers > running shoes',

brand: 'your brand name',

quantity: 1,

price: 8,

}],

content_type: 'product',

value: 9.2,

currency: 'USD',

},

{event_id:'1239485'});

Please store the event_id variable used to send the TikTok Pixel event and include it in the Adobe data layer.

Adobe TikTok Web Events API Extension Configuration

The event_id value included in the TikTok Pixel event needs to be included in the Adobe extension event as well. In order to do so, the variable can be included in the Adobe data layer, which can be mapped to an XDM object used for event forwarding:

1. Map website variables to data elements, and

2. Map those data elements to an XDM object

Once the data element is created to capture the data layer, it can be mapped to the XDM object. Once completed, please map the new XDM field to the Event ID parameter from the extension configuration page.