TikTok

Channel ID: tiktok

Overview:

Onboarding

Tiktok has seven fields:

Pixel ID (required) - ID of the Pixel that you would like to attribute to
Advertiser ID (required) - ID of the Advertiser that is needed for audience synchronization
oAuth (required) - a token that authorizes EdgeTag for TikTok API access
Browser pixel (optional) - If you enable it, we will automatically inject the TikTok browser pixel and send the same events from the browser and server. Adding the same event ID to both events is essential, allowing TikTok to de-duplicate them. If you don't enable this, you may be sending duplicated events from your existing pixels, which will inflate your Purchase events.
Offline Event Set ID (optional) - ID of the set that will be used for offline conversions
Purchase Event (optional) - you can select how purchase event will be reported in TikTok. As CompletePayment or PlaceAnOrder
Event test code (optional) - Enter your test code from Event Manager for your pixel to test events if everything is collected correctly. You must remove this test code when you go live with EdgeTag, as otherwise, events will not be recorded.
LDU (optional) - If you enable it, you may notice an impact on audience sizes in California, Virginia, Colorado, Connecticut, and Utah and on their campaign effectiveness (as LDU data is not used for optimization purposes). LDU is a feature to give businesses more control over how their event data is used in TikTok's systems. More info in here

Pixel ID

You must go to your Ads Manager and select the pixel you want to use. Click on Events section inside Tools tab in the header.

Click on Web Events tab and copy the pixel ID value that you want to use.

Advertiser ID

In the Ads manager, click on the Account tab in the top right of header. Copy the ID of the correct ad account that you want to use with Blotout.

Offline Event Set ID

Similar to Pixel ID, you need to go to events section. Instead of Web Events, select Offline Events. Copy the correct Offline Event Set that you want to use.

Browser Setup

When you are using our SDK via npm package you will need to add additional package for this channel to work correctly. You will need to install @blotoutio/providers-tiktok-sdk.

After you install it you will need to add it to your init call.

Code Snippet

Copy

import { init } from '@blotoutio/edgetag-sdk-js'
import tiktok from '@blotoutio/providers-tiktok-sdk'

init({
  edgeURL: 'https://d.mysite.com',
  disableConsentCheck: true,
  providers: [tiktok]
})

Events

These are standard events that Tiktok is recommending.

You can find our standard events in our guide.

Below you will see the example payload you need to use for the specific event to be processed correctly by the provider and is not defined in our standard events.

Example

Copy

edgetag('tag', 'AddToCart', { value: 10.0, currency: 'USD' })

ClickButton

When a button is clicked.

AddToWishlist

When an item is added to a wishlist.

Contact

When contact or consultation occurs.

Download

When a button to open an external browser download page is clicked.

SubmitForm

When a form is submitted.

CompleteRegistration

When registration is completed.

For all the above events, there are optional fields that you could send as listed below.

Name	Type	Required	Description
currency	string	No	ISO 4217 code
value	number	No	Value of the order or items sold, which is total price of the order
search	string	No	The text string that was searched for
contents	Contents[]	No	Related items in a web event

Type Definitions

Name	Type	Required	Description
id	string	Yes	ID of the product item
quantity	number	No	Number of item.
item_price	number	No	The price of the single item.
title	string	No	Name of the page/product.
category	string	No	Category of the page/product.
type	string	Yes	The content_type object property's value must be set to either product or product_group. If you will be tracking events associated with individual products, set the value to product. If you are tracking events associated with product groups, set it to product_group instead.