You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: TikTok Long Term Access Token. You can generate this from the TikTok Marketing API portal. Please follow TikTok's [Authorization guide](https://ads.tiktok.com/athena/docs/index.html?plat_id=-1&doc_id=100010&id=100681&key=e98b971a296ae45d8e35a22fba032d1c06f5973de9aab73ce07b82f230cf3afd){:target="_blank"} for more info.
6
+
default:
7
+
- name: Secret Key (required)
8
+
description: TikTok App Secret Key. You can find this key in the "Basic Information" tab of your TikTok app.
9
+
default:
10
+
- name: App Id (required)
11
+
description: TikTok App Id. You can find this key in the "Basic Information" tab of your TikTok app.
12
+
default:
13
+
- name: Pixel Code (required)
14
+
description: An ID for your pixel. Required to send events to the TikTok pixel.
15
+
default:
16
+
actions:
17
+
- action: Report Web Event
18
+
blurb: Report events directly to TikTok.
19
+
fields:
20
+
- name: Email
21
+
description: Email address of the user who triggered the conversion event.
22
+
default: coalesce(properties.email, traits.email)
23
+
- name: External ID
24
+
description: Uniquely identifies the user who triggered the conversion event.
25
+
default: coalesce(userId, anonymousId)
26
+
- name: Event Name
27
+
description: Conversion event name. Please refer to the "Supported Web Events" section on [this](https://ads.tiktok.com/marketing_api/docs?id=1701890979375106){:target="_blank"} page for accepted event names.
28
+
default:
29
+
- name: Event ID
30
+
description: Any hashed ID that can identify a unique user/session.
31
+
default: messageId
32
+
- name: Event Timestamp
33
+
description: Timestamp that the event took place, in ISO 8601 format.
34
+
default:
35
+
- name: Segment Event Type
36
+
description: The Segment Event type, for example, "page".
37
+
default: type
38
+
- name: Properties associated with the event
39
+
description: Additional properties such as content info, description, and currency.
40
+
default:
41
+
- name: Phone Number
42
+
description: Phone number of the user who triggered the conversion event, in E.164 standard format, e.g. +14150000000.
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/tiktok-conversions/index.md
+42-46Lines changed: 42 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,38 +2,37 @@
2
2
title: TikTok Conversions
3
3
hide-boilerplate: true
4
4
hide-dossier: true
5
+
hidden: true
5
6
---
6
7
7
-
<!-- In the section above, edit the `title` field. For example, Slack (Actions) Destination -->
8
-
9
8
{% include content/plan-grid.md name="actions" %}
10
9
11
-
<!-- Include a brief description of the destination here, along with a link to your website. -->
12
-
13
10
The TikTok Conversions Destination enables advertisers to send Segment events to report events directly to TikTok. Data shared can power TikTok solutions like dynamic product ads, custom targeting, campaign optimization and attribution.
14
11
15
12
Reporting web events allows advertisers to send user data directly to TikTok for downstream targeting and optimization. Advertisers will be able to see their event data in TikTok Events Manager.
16
13
17
14
> info ""
18
15
> This document is about a feature which is in beta. This means that the Destination Actions are in active development, and some functionality may change before it becomes generally available
19
16
20
-
<!-- In the section below, add your destination name where indicated. If you have a classic version of the destination, ensure that its documentation is linked as well. If you don't have a classic version of the destination, remove the second and third sentences. -->
21
-
22
17
> success ""
23
18
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) TikTok Conversions Segment destination.
24
19
25
-
<!-- In the section below, explain the value of this actions-based destination over the classic version, if applicable. If you don't have a classic version of the destination, remove this section. -->
20
+
## Benefits
26
21
27
-
<!-- The section below explains how to enable and configure the destination. Include any configuration steps not captured below. For example, obtaining an API key from your platform and any configuration steps required to connect to the destination. -->
22
+
1.**Streamlined stability and security**: Integrate and iterate without client-side limitations, like network connectivity or ad blocker issues.
23
+
2.**Configurable privacy controls**: Stay compliant with rapidly evolving requirements with flexible privacy controls that let you adapt what data you share and when you share it.
24
+
3.**Maximum event measurement**: Capture more events with improved accuracy across different browsers, apps and devices to get a unified view of your customer's journey from page view to purchase.
28
25
29
26
## Getting started
30
27
28
+
Follow the instructions below to enable your TikTok ads account, and add the TikTok Conversions destination to your Segment workspace.
29
+
31
30
### TikTok Requirements
32
31
33
-
1.[Create a TikTok For Business account](https://ads.tiktok.com/marketing_api/docs?id=1702715936951297).
34
-
2.[Register as a developer](https://ads.tiktok.com/marketing_api/docs?id=1702716323359809).
35
-
3.[Create a developer application](https://ads.tiktok.com/marketing_api/docs?id=1702716474845185).
36
-
4. Follow instructions for [Authorization](https://ads.tiktok.com/marketing_api/docs?id=1701890912382977) and generate a long term access token.
32
+
1.[Create a TikTok For Business account](https://ads.tiktok.com/marketing_api/docs?id=1702715936951297){target="_blank"}.
33
+
2.[Register as a developer](https://ads.tiktok.com/marketing_api/docs?id=1702716323359809{target="_blank"}).
34
+
3.[Create a developer application](https://ads.tiktok.com/marketing_api/docs?id=1702716474845185){target="_blank"}.
35
+
4. Follow instructions for [Authorization](https://ads.tiktok.com/marketing_api/docs?id=1701890912382977){target="_blank"} and generate a long term access token.
37
36
38
37
### Configuring TikTok Conversions in Segment
39
38
@@ -44,63 +43,60 @@ Reporting web events allows advertisers to send user data directly to TikTok for
44
43
5. On the next page enter your TikTok API key and Secret key and click Verify credentials.
45
44
46
45
47
-
<!-- The line below renders a table of connection settings (if applicable) from your destinations data file. The Segment Docs team will assist with this. -->
48
-
49
-
{% include components/actions-fields.html name="TikTok Conversions" connection="true" %}
50
-
51
-
<!-- The section below provides an overview of the prebuilt subscriptions that ship with your destination. If there are no prebuilt subscriptions, remove this section. -->
46
+
{% include components/actions-fields.html name="tiktok" connection="true" %}
52
47
53
48
## Pre-built subscriptions
54
49
55
-
By default a new TikTok (Actions) destination comes with the following subscriptions.
50
+
By default a new TikTok Conversions destination comes with the following subscriptions.
51
+
52
+
| Subscription Name | Trigger | TikTok Conversions Action |
| Products Searched | All events where the name is `Products Searched`| Report Web Event |
55
+
| Add Payment Info | All events where the name is `Payment Info Entered`| Report Web Event |
56
+
| Initiate Checkout | All events where the name is `Checkout Started`| Report Web Event |
57
+
| Order Completed | All events where the name is `Order Completed`| Report Web Event |
58
+
| View Content | All **Page** events | Report Web Event |
56
59
57
-
You can select these subscriptions by choosing "Quick Setup" when you first configure the destination. You can enable, edit, and disable them from the screen that appears.
60
+
Choose **Quick Setup** during configuration to can select these subscriptions. You can enable, edit, and disable them from the Actions tab of the destination.
58
61
59
-
All the pre-built TikTok Conversions Subscriptions trigger the same action, **Report Web Event**, however they are configured to map events that follow Segment's Spec to TikTok's spec. However, you are able to create new subscriptions and map events anyway you like.
62
+
The pre-built TikTok Conversions Subscriptions trigger the same action, **Report Web Event**. The default subscriptions map events that follow Segment's Spec to the TikTok spec. You can create new subscriptions and map events that best suit your configuration.
60
63
61
-
The following table shows how we map Segment’s semantic ecommerce or custom event names to TikTok’s semantic conversion event names in the pre-built subscriptions:
64
+
The table below shows the mapping of the Segment semantic ecommerce or custom event names to the TikTok semantic conversion event names in the prebuilt subscriptions.
62
65
63
-
| Segment Event Name | TikTok Semantic Conversion Event Name
<!-- The section below provides reference tables for the actions defined in your destination. Create the unordered list. The Segment Docs team will assist with populating the data file referenced by this include. -->
75
78
76
-
## Available TikTok Converstion actions
79
+
## Available TikTok Conversion actions
77
80
78
81
Combine the supported [triggers](/docs/connections/destinations/actions/#components-of-a-destination-action) with the following TikTok-supported actions:
79
82
80
83
-[Report Web Event](#report-web-event)
81
84
82
-
### Report Web Event
83
-
84
-
All the TikTok Conversions subscriptions trigger the Report Web Event action.
85
-
86
-
This action sends a request from Segment to the [TikTok Events Web API](https://ads.tiktok.com/marketing_api/docs?id=1701890979375106).
85
+
{% include components/actions-fields.html name="tiktok" %}
87
86
88
-
Ensure you've created your TikTok Pixel within Events Manager before sending events. Instructions to create a pixel can be found [here] (https://ads.tiktok.com/help/article?aid=10021).
87
+
All TikTok Conversions subscriptions trigger the Report Web Event action.
89
88
90
-
## **Notes**
89
+
This action sends a request from Segment to the [TikTok Events Web API](https://ads.tiktok.com/marketing_api/docs?id=1701890979375106){:target="_blank"}.
91
90
92
-
The TikTok Events API support QPS =< 1k per app（TikTok Marketing API app）per endpoint. If more is required, please contact your TikTok account representative.
93
-
A request only reports events to one pixel ID. This restriction is mostly because authorization will be done at user/pixel level. See the Authorization section for details.
91
+
Ensure you've created your TikTok Pixel within Events Manager before sending events. Instructions to create a pixel can be found [here](https://ads.tiktok.com/help/article?aid=10021){:target="_blank"}.
94
92
95
-
Data that is shared to the Events API is processed similar to information shared via other TikTok data integration business tools, like the TikTok pixel and TikTok SDK.
93
+
## Notes
96
94
97
-
## Benefits
95
+
- The TikTok Events API supports QPS =< 1k per app（TikTok Marketing API app）per endpoint. If more is required, please contact your TikTok account representative.
96
+
- Requests report events to one pixel ID. This restriction is because authorization is done at user/pixel level. See the Authorization section for details.
97
+
- Data that is shared to the Events API is processed similar to information shared through other TikTok data integration business tools, like the TikTok pixel and TikTok SDK.
98
98
99
-
1.**Streamlined stability and security**: Integrate and iterate without client-side limitations, like network connectivity or ad blocker issues.
100
-
2.**Configurable privacy controls**: Stay compliant with rapidly evolving requirements with flexible privacy controls that let you adapt what data you share and when you share it.
101
-
3.**Maximum event measurement**: Capture more events with improved accuracy across different browsers, apps and devices to get a unified view of your customer's journey from page view to purchase.
102
99
103
-
{% include components/actions-fields.html name="TikTok Conversions" %}
104
100
105
101
<!-- Add information about steps needed to migrate from a classic version of your destination here. The Segment Docs team will assist you with populating the data file referenced by this include. The table at the bottom maps classic settings to the new destination.-->
0 commit comments