This integration is powered by Singer's tiktok-ads tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
TikTok Ads integration summary
Stitch’s TikTok Ads integration replicates data using the TikTok Ads API (v1.3). Refer to the Schema section for a list of objects available for replication.
TikTok Ads feature snapshot
A high-level look at Stitch's TikTok Ads (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on February 9, 2023 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting TikTok Ads
TikTok Ads setup requirements
To set up TikTok Ads in Stitch, you need:
-
Access to a TikTok Ads account. This is necessary to login to the Ad Manager account.
-
Access to a TikTok Ads Ad Manager account. Verify that you have access to use the Ad accounts you want to replicate data from. This is necessary to connect to Stitch.
Step 1: Add TikTok Ads as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the TikTok Ads icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch TikTok Ads” would create a schema called
stitch_tiktok_ads
in the destination. Note: Schema names cannot be changed after you save the integration. - Check the include_deleted box to have Stitch replicate data from deleted campaigns, ads, and adgroups.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your TikTok Ads integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond TikTok Ads’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
TikTok Ads integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Authorize Stitch
- Next, you’ll be prompted to log into your TikTok account and approve Stitch’s access to your TikTok Ads data. Note that we will only ever read your data.
- Click Sign in with TikTok to connect.
- Sign in with your TikTok account.
- After your credentials are validated, you’ll be directed back to Stitch and prompted to select the TikTok Ads accounts you want to for which you want to run extractions.
- When finished, click Check and Save, then click All Done.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For TikTok Ads integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up TikTok Ads, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
TikTok Ads table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the TikTok Ads integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
adgroups
Replication Method : |
Key-based Incremental |
Replication Key |
modify_time |
Primary Key |
adgroup_id : advertiser_id : campaign_id : modify_time |
Official docs : |
actions
|
||||
adgroup_app_profile_page_state
|
||||
adgroup_id
Ad group ID |
||||
adgroup_name
|
||||
advertiser_id
Advertiser ID |
||||
age_groups
|
||||
app_download_url
|
||||
app_id
|
||||
audience
|
||||
audience_type
|
||||
bid_price
|
||||
bid_type
|
||||
billing_event
|
||||
brand_safety_partner
|
||||
brand_safety_type
|
||||
budget
|
||||
budget_mode
|
||||
campaign_id
Campaign ID |
||||
carriers_v2
|
||||
catalog_authorized_bc
|
||||
catalog_id
|
||||
conversion_bid_price
|
||||
conversion_window
|
||||
cpv_video_duration
|
||||
create_time
|
||||
creative_material_mode
|
||||
dayparting
|
||||
deep_bid_type
|
||||
deep_cpa_bid
|
||||
delivery_mode
|
||||
device_models
|
||||
device_price_ranges
|
||||
excluded_audience
|
||||
excluded_custom_actions
|
||||
frequency
|
||||
frequency_schedule
|
||||
gender
|
||||
included_custom_actions
|
||||
interest_category_v2
|
||||
interest_keywords
|
||||
inventory_filter_enabled
|
||||
ios14_targeting
|
||||
ios_quota_type
|
||||
is_comment_disable
|
||||
is_hfss
|
||||
is_new_structure
|
||||
languages
|
||||
location
|
||||
min_android_version
|
||||
min_ios_version
|
||||
modify_time
Time at which the ad group was Modified. |
||||
network_types
|
||||
next_day_retention
|
||||
operating_systems
|
||||
operation_status
|
||||
optimization_event
|
||||
optimization_goal
|
||||
pacing
|
||||
package
|
||||
pangle_audience_package_exclude
|
||||
pangle_audience_package_include
|
||||
pangle_block_app_list_id
|
||||
pixel_id
|
||||
placement_type
|
||||
placements
|
||||
product_set_id
|
||||
promotion_type
|
||||
promotion_website_type
|
||||
purchased_impression
|
||||
purchased_reach
|
||||
rf_estimated_cpr
|
||||
rf_estimated_frequency
|
||||
rf_purchased_type
|
||||
roas_bid
|
||||
schedule_end_time
|
||||
schedule_start_time
|
||||
schedule_type
|
||||
secondary_optimization_event
|
||||
secondary_status
|
||||
share_disabled
|
||||
shopping_ads_retargeting_type
|
||||
skip_learning_phase
|
||||
statistic_type
|
||||
targeting_expansion
|
||||
video_download
|
Replication Method : |
Key-based Incremental |
Replication Key |
modify_time |
Primary Key |
ad_id : adgroup_id : advertiser_id : campaign_id : modify_time |
Official docs : |
ad_format
|
|||
ad_id
Ad ID |
|||
ad_name
|
|||
ad_text
|
|||
adgroup_id
Ad group ID |
|||
adgroup_name
|
|||
advertiser_id
Advertiser ID |
|||
app_name
|
|||
brand_safety_vast_url
|
|||
call_to_action
|
|||
campaign_id
Campaign ID |
|||
campaign_name
|
|||
card_id
|
|||
carousel_image_index
|
|||
catalog_id
|
|||
click_tracking_url
|
|||
create_time
|
|||
creative_authorized
|
|||
deeplink
|
|||
deeplink_type
|
|||
display_name
|
|||
dynamic_destination
|
|||
dynamic_format
|
|||
fallback_type
|
|||
image_ids
|
|||
image_mode
|
|||
impression_tracking_url
|
|||
is_aco
|
|||
is_new_structure
|
|||
item_duet_status
|
|||
item_group_ids
|
|||
item_stitch_status
|
|||
landing_page_url
|
|||
landing_page_urls
|
|||
modify_time
Time at which the ad was Modified. |
|||
music_id
|
|||
operation_status
|
|||
page_id
|
|||
playable_url
|
|||
product_set_id
|
|||
product_specific_type
|
|||
profile_image_url
|
|||
promotional_music_disabled
|
|||
secondary_status
|
|||
shopping_ads_fallback_type
|
|||
shopping_ads_video_package_id
|
|||
shopping_deeplink_type
|
|||
showcase_products
|
|||
sku_ids
|
|||
tiktok_item_id
|
|||
tracking_app_id
|
|||
tracking_offline_event_set_ids
|
|||
utm_params
|
|||
vast_moat_enabled
|
|||
vertical_video_strategy
|
|||
video_id
|
|||
viewability_postbid_partner
|
|||
viewability_vast_url
|
advertisers
Replication Method : |
Key-based Incremental |
Replication Key |
create_time |
Primary Key |
advertiser_id : create_time |
Official docs : |
address
|
advertiser_account_type
|
advertiser_id
Advertiser ID |
balance
|
cellphone_number
|
company
|
contacter
|
country
|
create_time
Advertiser’s create time |
currency
|
description
|
email
|
industry
|
language
|
license_no
|
license_url
|
name
|
promotion_area
|
promotion_center_city
|
promotion_center_province
|
rejection_reason
|
role
|
status
|
telephone_number
|
timezone
|
ad_insights
Replication Method : |
Key-based Incremental |
Replication Key |
stat_time_day |
Primary Key |
ad_id : adgroup_id : advertiser_id : campaign_id : stat_time_day |
Official docs : |
ad_id
Ad ID |
ad_name
|
ad_text
|
adgroup_id
Ad group ID. Supported in Ad level. |
adgroup_name
|
advertiser_id
Advertiser ID |
app_promotion_type
|
average_video_play
|
average_video_play_per_user
|
bid
|
bid_strategy
|
billing_event
|
budget
|
call_to_action
|
campaign_budget
|
campaign_dedicate_type
|
campaign_id
Campaign ID. Supported in Ad Group and Ad level. |
campaign_name
|
clicks
|
clicks_on_music_disc
|
comments
|
conversion
|
conversion_rate
|
conversion_rate_v2
|
cost_per_1000_reached
|
cost_per_100_reached
|
cost_per_conversion
|
cost_per_result
|
cost_per_secondary_goal_result
|
cpc
|
cpm
|
ctr
|
dpa_target_audience_type
|
follows
|
frequency
|
gross_impressions
|
image_mode
|
impressions
|
is_smart_creative
|
likes
|
mobile_app_id
|
objective_type
|
opt_status
|
placement_type
|
profile_visits
|
profile_visits_rate
|
promotion_type
|
reach
|
real_time_conversion
|
real_time_conversion_rate
|
real_time_conversion_rate_v2
|
real_time_cost_per_conversion
|
real_time_cost_per_result
|
real_time_result
|
real_time_result_rate
|
result
|
result_rate
|
secondary_goal_result
|
secondary_goal_result_rate
|
shares
|
smart_target
|
spend
|
split_test
|
stat_time_day
|
tt_app_id
|
tt_app_name
|
video_play_actions
|
video_views_p100
|
video_views_p25
|
video_views_p50
|
video_views_p75
|
video_watched_2s
|
video_watched_6s
|
ad_insights_by_age_and_gender
Replication Method : |
Key-based Incremental |
Replication Key |
stat_time_day |
Primary Key |
ad_id : adgroup_id : advertiser_id : age : campaign_id : gender : stat_time_day |
Official docs : |
ad_id
Ad ID |
ad_name
|
ad_text
|
adgroup_id
Ad group ID. Avaialble at Ad level. |
adgroup_name
|
advertiser_id
Advertiser ID |
age
|
bid
|
bid_strategy
|
billing_event
|
budget
|
call_to_action
|
campaign_budget
|
campaign_dedicate_type
|
campaign_id
Campaign ID. Available at Ad Group and Ad levels. |
campaign_name
|
clicks
|
conversion
|
conversion_rate
|
conversion_rate_v2
|
cost_per_conversion
|
cost_per_result
|
cpc
|
cpm
|
ctr
|
dpa_target_audience_type
|
gender
|
gross_impressions
|
impressions
|
is_smart_creative
|
mobile_app_id
|
objective_type
|
opt_status
|
promotion_type
|
real_time_conversion
|
real_time_conversion_rate
|
real_time_conversion_rate_v2
|
real_time_cost_per_conversion
|
real_time_cost_per_result
|
real_time_result
|
real_time_result_rate
|
result
|
result_rate
|
rf_campaign_type
|
smart_target
|
spend
|
split_test
|
stat_time_day
|
tt_app_id
|
tt_app_name
|
user_action
|
ad_insights_by_country
Replication Method : |
Key-based Incremental |
Replication Key |
stat_time_day |
Primary Key |
ad_id : adgroup_id : advertiser_id : campaign_id : country_code : stat_time_day |
Official docs : |
ad_id
Ad ID |
ad_name
|
ad_text
|
adgroup_id
Ad group ID. Avaialble at Ad level. |
adgroup_name
|
advertiser_id
Advertiser ID |
bid
|
bid_strategy
|
billing_event
|
budget
|
call_to_action
|
campaign_budget
|
campaign_dedicate_type
|
campaign_id
Campaign ID. Available at Ad Group and Ad levels. |
campaign_name
|
clicks
|
conversion
|
conversion_rate
|
conversion_rate_v2
|
cost_per_conversion
|
cost_per_result
|
country_code
|
cpc
|
cpm
|
ctr
|
dpa_target_audience_type
|
gross_impressions
|
impressions
|
is_smart_creative
|
mobile_app_id
|
objective_type
|
opt_status
|
promotion_type
|
real_time_conversion
|
real_time_conversion_rate
|
real_time_conversion_rate_v2
|
real_time_cost_per_conversion
|
real_time_cost_per_result
|
real_time_result
|
real_time_result_rate
|
result
|
result_rate
|
rf_campaign_type
|
smart_target
|
spend
|
split_test
|
stat_time_day
|
tt_app_id
|
tt_app_name
|
user_action
|
ad_insights_by_platform
Replication Method : |
Key-based Incremental |
Replication Key |
stat_time_day |
Primary Key |
ad_id : adgroup_id : campaign_id : platform : stat_time_day |
Official docs : |
ad_id
Ad ID |
ad_name
|
ad_text
|
adgroup_id
Ad group ID. Avaialble at Ad level. |
adgroup_name
|
advertiser_id
|
bid
|
bid_strategy
|
billing_event
|
budget
|
call_to_action
|
campaign_budget
|
campaign_dedicate_type
|
campaign_id
Campaign ID. Available at Ad Group and Ad levels. |
campaign_name
|
clicks
|
conversion
|
conversion_rate
|
conversion_rate_v2
|
cost_per_conversion
|
cost_per_result
|
cpc
|
cpm
|
ctr
|
dpa_target_audience_type
|
gross_impressions
|
impressions
|
is_smart_creative
|
mobile_app_id
|
objective_type
|
opt_status
|
platform
|
promotion_type
|
real_time_conversion
|
real_time_conversion_rate
|
real_time_conversion_rate_v2
|
real_time_cost_per_conversion
|
real_time_cost_per_result
|
real_time_result
|
real_time_result_rate
|
result
|
result_rate
|
rf_campaign_type
|
smart_target
|
spend
|
split_test
|
stat_time_day
|
tt_app_id
|
tt_app_name
|
user_action
|
campaigns
Replication Method : |
Key-based Incremental |
Replication Key |
modify_time |
Primary Key |
advertiser_id : campaign_id : modify_time |
Official docs : |
advertiser_id
Advertiser ID |
app_id
|
app_promotion_type
|
bid_type
|
budget
|
budget_mode
|
budget_optimize_on
|
campaign_app_profile_page_state
|
campaign_id
Campaign ID |
campaign_name
|
campaign_product_source
|
campaign_type
|
create_time
|
deep_bid_type
|
is_new_structure
|
is_smart_performance_campaign
|
modify_time
Time at which the campaign was Modified. |
objective
|
objective_type
|
operation_status
|
optimization_goal
|
rf_campaign_type
|
roas_bid
|
secondary_status
|
special_industries
|
campaign_insights_by_province
Replication Method : |
Key-based Incremental |
Replication Key |
stat_time_day |
Primary Key |
advertiser_id : campaign_id : province_id : stat_time_day |
Official docs : |
advertiser_id
Advertiser ID |
campaign_budget
|
campaign_dedicate_type
|
campaign_id
Campaign ID |
campaign_name
|
clicks
|
conversion
|
conversion_rate
|
conversion_rate_v2
|
cost_per_conversion
|
cost_per_result
|
cpc
|
cpm
|
ctr
|
gross_impressions
|
impressions
|
objective_type
|
province_id
Province ID |
real_time_conversion
|
real_time_conversion_rate
|
real_time_conversion_rate_v2
|
real_time_cost_per_conversion
|
real_time_cost_per_result
|
real_time_result
|
real_time_result_rate
|
result
|
result_rate
|
rf_campaign_type
|
spend
|
split_test
|
stat_time_day
|
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.