TikTok is a social platform short-form video hosting service.
TikTok is a social platform short-form video hosting service. This destination leverages TikTok Events API to report offline events.
The TikTok Offline Events destination provides the following key features:
Events structure: our covers , meaning that your data is properly bridged to the expected fields in an optimized way.
Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.
Automatic hashing: information is automatically hashed matching partner specifications.
Support for multi-item data: information included in the item array is dispatched to TikTok.
id
properties.order_id
shop_id
properties.shop_id
items.X.id
properties.contents.X.content_id
items.X.product.name
properties.contents.X.content_name
items.X.product.price
properties.contents.X.price
items.X.quantity
properties.contents.X.quantity
items.X.type
properties.contents.X.content_type
items.X.product.category_1>
items.X.product.category_2>
items.X.product.category_3>
items.X.product.category_4>
items.X.product.category_5
properties.contents.X.content_category
currency
properties.currency
value
properties.value
type
properties.event_channel
Event Set Id
Required
Your event set identifier value. More details are available following this LINK. This setting supports dynamic values [1].
Mapping
Required
Map "TikTok Event Types" with your "Commanders Act events" by setting at least a TikTok Event Type and a Commanders Act Event Name . One entry is required.
[All events]
CompletePayment , Contact , Subscribe and SubmitForm [1]
Event Set Id
event_set_id
TikTok Event Type
event [1]
id
event_id
context.event_timestamp
timestamp[2]
user.phone
context.user.phone_numbers.0 [3]
user.email
context.user.emails.0 [3]
is a global platform designed to give brands and marketers the solutions to be creative storytellers and meaningfully engage with the TikTok community. The TikTok Events API is a server-side integration that allows you to share website and app visitor events directly with TikTok using their and version 2.0.
The support is currently under beta testing.
The TikTok Events API destination provides the following key features:
Events structure: our Events reference matches TikTok's one, meaning that your data is properly bridged to the expected fields in an optimized way.
Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.
Automatic hashing: information is automatically hashed matching partner specifications.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Support for multi-item data: information included in the array is dispatched to TikTok.
Support for test event code: real-time validation in your test environments with field test_event_code.
Before you get started with this destination, make sure you can access TikTok Ads Manager.
TikTok custom events are available for reporting and audience creation purposes. Optimization is currently NOT supported.
Access Token
Required for .
Your as provided by TikTok. More details are available by following this .
Pixel Id
Required for .
Your pixel identifier as provided by TikTok. More details are available by following this .
App Id
Required for .
Your app identifier as provided by TikTok. More details are available by following this .
Test Event Code
For only. This is used to test event tracking before deploying in production. This code can be found in the following Assets ➜ Events ➜ Manage (Web Events) ➜ Select your pixel ➜ Test Events (Tab) [1]
Event Mapping
Change the standard mapping between TikTok's events and yours or add new mappings: custom events are also supported. More details on how you can set up custom TikTok web events are available following this .
TikTok "ViewContent" Event Mapping
Select page_view, view_item or both to send TikTok ViewContent event. See for more details on event mapping.
achieve_level
AchieveLevel [2]
add_payment_info
AddPaymentInfo
add_to_cart
AddToCart
add_to_wishlist
AddToWishlist
application_approval
ApplicationApproval [1]
begin_checkout
InitiateCheckout [1]
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
Events structure: our Events reference supports TikTok order status, meaning that your data is properly bridged to the expected fields in an optimized way.
Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.
Smart mapping: data mapping can be readjusted using your datalayer defined fields.
Support for item data: information included in the array is dispatched to TikTok.
Credentials
Required
Your credentials with TikTok as set directly in your destination or, in the left menu, following: Administration ➜ Connector Credentials ➜ Add connector credentials ➜ TikTok .
TikTok Organic Tracking Id
Required
The TikTok Organic Tracking Id (ttoclid) is a tracking parameter that is appended to your page URL when a user clicks on your product page (E.g. https://www.url.com/product?ttoclid=opfed89ds90132344n2dkkl12321s321va).
Third Merchant Id
Required
Must match the third_merchant_id you used to create the merchant within TikTok.
Third Shop Id
Required
The identifier of the hotel as in your system.
Third Shop Name
Required
The name of the hotel as in your system.
Payment Value
Required
The total amount the customer is expected to pay on the panel site. This includes all fees and taxes, but excludes any discounts applied. Calculated as: payment_value = total_value - discounts. This value reflects the full price of the order, even if the customer completes payment at a later stage (E.g. during checkout).
[Any Event]
[Any Order Status] [1]
id
order_id [*]
Third Merchant Id
third_merchant_id [*]
Third Shop Id
third_shop_id [*]
Third Shop Name
third_shop_name [*]
event_name
order_status [*][1]
Order Country
order_country [*]
Total Value
Required
Total order value before discounts, including taxes and service fees. Calculated as: total_value = total_room_fee + total_tax + total_service_fee. This value is related to the price of the order.
Order Country
Required
The country where the hotel is located.
Create Time
Required
The time of order created in your system (timestamp in seconds).
Length Of Stay
Required
Length of stay.
Amount Of Room
Required
Amount of room stayed.
Check-In Date
Required
Check-In date.
Check-Out Date
Required
Check-Out date.
Event Mapping
Required
Map TikTok order status with Your event name . More details are available following this LINK. At least one entry is required.
Create Time
create_time [*]
context.event_timestamp
update_time [*]
partners.tiktok.initiator
initiator [2]
currency
value.currency [*]
Payment Value
value.payment_value [*]
Total Value
value.total_value [*]
Length Of Stay
extra.length_of_stay [*]
Amount Of Room
extra.amount_of_room [*]
Check-In Date
extra.check_in_date [*]
Check-Out Date
extra.check_out_date [*]
items.X.id
third_sku_id [*][3]
items.X.product.name
third_sku_name [*][3]
items.X.third_spu_id
spu_list.0.third_spu_id
items.X.third_spu_name
spu_list.0.third_spu_name
partners.tiktok.actual_occupancy
extra.actual_occupancy
partners.tiktok.no_show
extra.no_show
partners.tiktok.cancel_reason
extra.cancel_reason
partners.tiktok.fulfillment_value
value.fulfillment_value [4]
partners.tiktok.fulfillment_tax
value.fulfillment_tax [4]
partners.tiktok.fulfillment_service_fee
value.fulfillment_service_fee [4]
partners.tiktok.commission_currency
currency [4][5]
partners.tiktok.commission_base_amount
commission_base_amount [4][5]
partners.tiktok.total_room_fee
value.total_room_fee
tax_amount
value.total_tax
partners.tiktok.total_service_fee
value.total_service_fee
partners.tiktok.discounts
value.discounts
context.page.url
order_url
partners.tiktok.promotion_id
promotion_info.promotion_id
partners.tiktok.promotion_description
promotion_info.description
partners.tiktok.promotion_saved_amount
promotion_info.saved_amount
RESTRICTEDNOT_APPLICABLEAutodiscovery Event Source
Flag this option to set TikTok event_source based on the value provided in the "Smart Mapping" field Experience Type or in the standard property context.app . The "Smart Mapping" field Event Source has priority over this option.
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]
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