Skip to content

Commit 36eae48

Browse files
maryamsharifkdaswanimarkzegarelli
authored
Scaffold TikTok Audiences Docs (#4466)
* Scaffold TikTok Audiences docs * Fix step numbers * remove mention of Segment Audience Key * updates to TikTok Audiences docs * Add private metadata --------- Co-authored-by: kdaswani <[email protected]> Co-authored-by: markzegarelli <[email protected]>
1 parent f5c1ecf commit 36eae48

File tree

2 files changed

+333
-0
lines changed

2 files changed

+333
-0
lines changed

‎src/_data/catalog/destinations_private.yml

Lines changed: 279 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1799,6 +1799,285 @@ items:
17991799
values:
18001800
'@path': $.properties
18011801
trigger: type = "track"
1802+
- id: 63d2e550fb90f1632ed8820a
1803+
display_name: TikTok Audiences
1804+
name: TikTok Audiences
1805+
slug: actions-tiktok-audiences
1806+
previous_names:
1807+
- TikTok Audiences
1808+
website: https://ads.tiktok.com/help/article/custom-audiences
1809+
status: PRIVATE_BUILDING
1810+
logo:
1811+
url: https://cdn.filepicker.io/api/file/SgbtLlB1TUeT3UXbSQhZ
1812+
mark:
1813+
url: https://cdn.filepicker.io/api/file/YlhZoZEBTaqQfp4cVC85
1814+
methods:
1815+
track: true
1816+
identify: true
1817+
group: true
1818+
alias: true
1819+
screen: false
1820+
page: true
1821+
platforms:
1822+
browser: true
1823+
mobile: false
1824+
server: true
1825+
warehouse: false
1826+
components: []
1827+
browserUnbundlingSupported: false
1828+
browserUnbundlingPublic: false
1829+
replay: false
1830+
settings:
1831+
- name: advertiser_ids
1832+
type: array
1833+
defaultValue: ''
1834+
description: >-
1835+
The Advertiser IDs where audiences should be synced. Hidden in
1836+
production and should not be altered by users.
1837+
required: true
1838+
label: TikTok Advertiser IDs
1839+
actions:
1840+
- id: hHwktvrTqqBDpD7pCfcB1L
1841+
name: Add Users
1842+
slug: addUser
1843+
description: Add contacts from an Engage Audience to a TikTok Audience Segment.
1844+
platform: CLOUD
1845+
hidden: false
1846+
defaultTrigger: event = "Audience Entered"
1847+
fields:
1848+
- id: aL8dVRk4mtbdeaR6s5t3sD
1849+
sortOrder: 0
1850+
fieldKey: selected_advertiser_id
1851+
label: Advertiser ID
1852+
type: STRING
1853+
description: The advertiser ID to use when syncing audiences.
1854+
placeholder: ''
1855+
required: true
1856+
multiple: false
1857+
choices: null
1858+
dynamic: true
1859+
allowNull: false
1860+
- id: ggWwAULwgBnjsgsNTr6gTt
1861+
sortOrder: 1
1862+
fieldKey: audience_id
1863+
label: Audience ID
1864+
type: STRING
1865+
description: >-
1866+
Audience ID for the TikTok Audience you want to sync your Engage
1867+
audience to. This is returned after you create an audience and can
1868+
also be found in the TikTok Audiences dashboard.
1869+
placeholder: ''
1870+
required: true
1871+
multiple: false
1872+
choices: null
1873+
dynamic: false
1874+
allowNull: false
1875+
- id: s2zGhXVDynJiojb3HEcUMo
1876+
sortOrder: 2
1877+
fieldKey: email
1878+
label: User Email
1879+
type: HIDDEN
1880+
description: The user's email address to send to TikTok.
1881+
placeholder: ''
1882+
defaultValue:
1883+
'@path': $.context.traits.email
1884+
required: false
1885+
multiple: false
1886+
choices: null
1887+
dynamic: false
1888+
allowNull: false
1889+
- id: tyqqypiyfMhkgo7gnp7eDm
1890+
sortOrder: 3
1891+
fieldKey: advertising_id
1892+
label: User Advertising ID
1893+
type: HIDDEN
1894+
description: >-
1895+
The user's mobile advertising ID to send to TikTok. This could be
1896+
a GAID, IDFA, or AAID
1897+
placeholder: ''
1898+
defaultValue:
1899+
'@path': $.context.device.advertisingId
1900+
required: false
1901+
multiple: false
1902+
choices: null
1903+
dynamic: false
1904+
allowNull: false
1905+
- id: n852LKKzfhEM5zV6Ncudcr
1906+
sortOrder: 4
1907+
fieldKey: send_email
1908+
label: Send Email
1909+
type: BOOLEAN
1910+
description: Send email to TikTok. Segment will hash this value before sending
1911+
placeholder: ''
1912+
defaultValue: true
1913+
required: false
1914+
multiple: false
1915+
choices: null
1916+
dynamic: false
1917+
allowNull: false
1918+
- id: mS6qSTtmsyjq18KBvB2rcd
1919+
sortOrder: 5
1920+
fieldKey: send_advertising_id
1921+
label: Send Mobile Advertising ID
1922+
type: BOOLEAN
1923+
description: >-
1924+
Send mobile advertising ID (IDFA, AAID or GAID) to TikTok. Segment
1925+
will hash this value before sending.
1926+
placeholder: ''
1927+
defaultValue: true
1928+
required: false
1929+
multiple: false
1930+
choices: null
1931+
dynamic: false
1932+
allowNull: false
1933+
- id: hDRxQkNsgCUs9h9kp6su69
1934+
sortOrder: 6
1935+
fieldKey: event_name
1936+
label: Event Name
1937+
type: HIDDEN
1938+
description: The name of the current Segment event.
1939+
placeholder: ''
1940+
defaultValue:
1941+
'@path': $.event
1942+
required: false
1943+
multiple: false
1944+
choices: null
1945+
dynamic: false
1946+
allowNull: false
1947+
- id: vP7W7BzVBFYQxE4FRLkHn
1948+
sortOrder: 7
1949+
fieldKey: enable_batching
1950+
label: Enable Batching
1951+
type: BOOLEAN
1952+
description: Enable batching of requests to the TikTok Audiences.
1953+
placeholder: ''
1954+
defaultValue: true
1955+
required: false
1956+
multiple: false
1957+
choices: null
1958+
dynamic: false
1959+
allowNull: false
1960+
- id: qaHW7xW6EGyUaaDrstiPjL
1961+
name: Remove Users
1962+
slug: removeUser
1963+
description: Remove contacts from an Engage Audience to a TikTok Audience Segment.
1964+
platform: CLOUD
1965+
hidden: false
1966+
defaultTrigger: event = "Audience Exited"
1967+
fields:
1968+
- id: s4BN3Z8Hex6d1xx8DkCt2c
1969+
sortOrder: 0
1970+
fieldKey: selected_advertiser_id
1971+
label: Advertiser ID
1972+
type: STRING
1973+
description: The advertiser ID to use when syncing audiences.
1974+
placeholder: ''
1975+
required: true
1976+
multiple: false
1977+
choices: null
1978+
dynamic: true
1979+
allowNull: false
1980+
- id: 3AmWNvAowMWZWfK9sZUPt2
1981+
sortOrder: 1
1982+
fieldKey: audience_id
1983+
label: Audience ID
1984+
type: STRING
1985+
description: >-
1986+
Audience ID for the TikTok Audience you want to sync your Engage
1987+
audience to. This is returned after you create an audience and can
1988+
also be found in the TikTok Audiences dashboard.
1989+
placeholder: ''
1990+
required: true
1991+
multiple: false
1992+
choices: null
1993+
dynamic: false
1994+
allowNull: false
1995+
- id: 5BbN5xmibbTeE8K5RyYbh3
1996+
sortOrder: 2
1997+
fieldKey: email
1998+
label: User Email
1999+
type: HIDDEN
2000+
description: The user's email address to send to TikTok.
2001+
placeholder: ''
2002+
defaultValue:
2003+
'@path': $.context.traits.email
2004+
required: false
2005+
multiple: false
2006+
choices: null
2007+
dynamic: false
2008+
allowNull: false
2009+
- id: gE3mpGwawWgPMHRdj8mmCc
2010+
sortOrder: 3
2011+
fieldKey: advertising_id
2012+
label: User Advertising ID
2013+
type: HIDDEN
2014+
description: >-
2015+
The user's mobile advertising ID to send to TikTok. This could be
2016+
a GAID, IDFA, or AAID
2017+
placeholder: ''
2018+
defaultValue:
2019+
'@path': $.context.device.advertisingId
2020+
required: false
2021+
multiple: false
2022+
choices: null
2023+
dynamic: false
2024+
allowNull: false
2025+
- id: coL9WBSPEiURvuLhGoVGGb
2026+
sortOrder: 4
2027+
fieldKey: send_email
2028+
label: Send Email
2029+
type: BOOLEAN
2030+
description: Send email to TikTok. Segment will hash this value before sending
2031+
placeholder: ''
2032+
defaultValue: true
2033+
required: false
2034+
multiple: false
2035+
choices: null
2036+
dynamic: false
2037+
allowNull: false
2038+
- id: 2cj729UfyaQbwAvyZuHJvR
2039+
sortOrder: 5
2040+
fieldKey: send_advertising_id
2041+
label: Send Mobile Advertising ID
2042+
type: BOOLEAN
2043+
description: >-
2044+
Send mobile advertising ID (IDFA, AAID or GAID) to TikTok. Segment
2045+
will hash this value before sending.
2046+
placeholder: ''
2047+
defaultValue: true
2048+
required: false
2049+
multiple: false
2050+
choices: null
2051+
dynamic: false
2052+
allowNull: false
2053+
- id: 67B5HrY6kayg6JdshFWUHT
2054+
sortOrder: 6
2055+
fieldKey: event_name
2056+
label: Event Name
2057+
type: HIDDEN
2058+
description: The name of the current Segment event.
2059+
placeholder: ''
2060+
defaultValue:
2061+
'@path': $.event
2062+
required: false
2063+
multiple: false
2064+
choices: null
2065+
dynamic: false
2066+
allowNull: false
2067+
- id: 3arZ4T2ohVDfuRjLbYY662
2068+
sortOrder: 7
2069+
fieldKey: enable_batching
2070+
label: Enable Batching
2071+
type: BOOLEAN
2072+
description: Enable batching of requests to the TikTok Audiences.
2073+
placeholder: ''
2074+
defaultValue: true
2075+
required: false
2076+
multiple: false
2077+
choices: null
2078+
dynamic: false
2079+
allowNull: false
2080+
presets: []
18022081
- id: 63e42b47479274407b671071
18032082
display_name: LiveLike
18042083
name: LiveLike

‎src/connections/destinations/catalog/actions-tiktok-audiences/index.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: TikTok Audiences Destination
3+
id: 63d2e550fb90f1632ed8820a
4+
hide-personas-partial: true
5+
hide-boilerplate: true
6+
hide-dossier: false
7+
hidden: true
8+
private: true
9+
---
10+
11+
The TikTok Audiences destination enables advertisers to send Engage audiences to TikTok as Custom Audiences using [TikTok's Segment API](https://ads.tiktok.com/marketing_api/docs?id=1739940504185857){:target="_blank"}.
12+
13+
By using Segment's TikTok Audiences destination, you can increase traffic and drive conversions with hyper-relevant ads that promote product discovery.
14+
15+
> info ""
16+
> The TikTok Audiences destination is in beta and is in active development. Some functionality may change before it becomes generally available.
17+
18+
## Getting started
19+
20+
### Prerequisites
21+
22+
1. Before connecting to the TikTok Audiences destination, you must have a [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account.
23+
24+
2. You must also have an audience segment created in your TikTok Advertising account. You can send Engage audiences to an existing audience segment, or you can create a new audience in TikTok. Please take note of the `audience_id` as this will be required to send Engage audiences to TikTok. See TikTok's [Create/Delete an audience segment](https://ads.tiktok.com/marketing_api/docs?id=1739940583739393){:target="_blank"} for instructions on how to create a TikTok audience segment.
25+
26+
### Connect the TikTok Audiences destination
27+
28+
1. From the Segment web app, navigate to **Engage > Audiences**. Ensure you are in the Engage space you plan to use with the TikTok Audiences destination. Either choose an existing Engage Audience or create a new one. This is the Audience you plan to send to TikTok.
29+
30+
2. Navigate to **Engage > Engage Settings** and click **Destinations**. Please ensure you are still in the correct Engage space.
31+
32+
3. Search for “TikTok Audiences” and select the destination. Click **Configure TikTok Audiences**.
33+
34+
4. On the Select Source screen, your Engage space should already be selected as the source. Click **Confirm Source**.
35+
36+
5. On the Destination **Settings** tab, name your destination and authenticate with TikTok Audiences using OAuth.
37+
38+
6. Once authenticated, toggle “Enable Destination” on and click **Save Changes**.
39+
40+
7. Navigate to the **Mappings** tab, click **New Mapping**, and select **Add Users**.
41+
42+
8. Under Select mappings, select the TikTok "Advertiser ID" of the audience segment you want to add users to. Input the `audience_id` of that audience segment under "Audience ID." **Note: A separate mapping must be created for each audience segment you plan to send Engage audiences to.**
43+
44+
9. Repeat Steps 7 and 8 to also set up a **Remove Users** mapping.
45+
46+
10. Navigate back to **Engage > Audiences** and click on the Audience from Step 1.
47+
48+
11. Click **Add Destinations** and select the TikTok Audiences destination you just created. In the settings that appear in the side panel, toggle the **Send Track** option on and do **not** change the Audience Entered/Audience Exited event names. Click **Save Settings**.
49+
50+
The setup is complete and the audience will start syncing to TikTok. The audience will appear in your [TikTok Ads Manager](https://www.tiktok.com/business/en-US/solutions/ads-manager){:target="_blank"} account under **Assets > Audiences**. Please note that it can take 24-28 hours for users to appear in TikTok.
51+
52+
To sync additional audiences from your Engage space, create a separate mapping in the TikTok Audiences destination. Navigate to **Connections > Destinations**, search and select the TikTok Audiences destination, and follow Steps 7-11 above.
53+
54+
{% include components/actions-fields.html settings="true"%}

0 commit comments

Comments
 (0)