Skip to content

Commit 78ccb6a

Browse files
coreychingcoreyching
committed
subbmiting first commit / draft to the tiktok conversions documentation
1 parent 8d3e0dd commit 78ccb6a

File tree

1 file changed

+106
-0
lines changed
  • src/connections/destinations/catalog/tiktok-conversions

1 file changed

+106
-0
lines changed

‎src/connections/destinations/catalog/tiktok-conversions/index.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: TikTok Conversions
3+
hide-boilerplate: true
4+
hide-dossier: true
5+
---
6+
7+
<!-- In the section above, edit the `title` field. For example, Slack (Actions) Destination -->
8+
9+
{% include content/plan-grid.md name="actions" %}
10+
11+
<!-- Include a brief description of the destination here, along with a link to your website. -->
12+
13+
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+
15+
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+
17+
> info ""
18+
> 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+
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+
> success ""
23+
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) TikTok Conversions Segment destination.
24+
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. -->
26+
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. -->
28+
29+
## Getting started
30+
31+
### TikTok Requirements
32+
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.
37+
38+
### Configuring TikTok Conversions in Segment
39+
40+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
41+
2. Find the Destinations Actions item in the left navigation, and click it.
42+
3. Click **Configure TikTok Conversions**.
43+
4. Select an existing Source to connect to TikTok Conversions (Actions).
44+
5. On the next page enter your TikTok API key and Secret key and click Verify credentials.
45+
46+
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. -->
52+
53+
## Pre-built subscriptions
54+
55+
By default a new TikTok (Actions) destination comes with the following subscriptions.
56+
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.
58+
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.
60+
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:
62+
63+
| Segment Event Name | TikTok Semantic Conversion Event Name
64+
| ------------------ | -----------------------------------------
65+
| Checkout Started | InitiateCheckout |
66+
| Products Searched | Search |
67+
| Payment Info Entered | AddPaymentInfo |
68+
| Order Completed | PlaceOrder |
69+
70+
| Segment Event Type| TikTok Semantic Conversion Event Name
71+
| ------------------ | -----------------------------------------
72+
|All **Segment Page Calls** | ViewContent |
73+
74+
<!-- 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+
76+
## Available TikTok Converstion actions
77+
78+
Combine the supported [triggers](/docs/connections/destinations/actions/#components-of-a-destination-action) with the following TikTok-supported actions:
79+
80+
- [Report Web Event](#report-web-event)
81+
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).
87+
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).
89+
90+
## **Notes**
91+
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.
94+
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.
96+
97+
## Benefits
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+
103+
{% include components/actions-fields.html name="TikTok Conversions" %}
104+
105+
<!-- 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.-->
106+

0 commit comments

Comments
 (0)