Skip to main content

Tiktok marketing

Setting up the Tiktok marketing connector

NoItemRequiredExampleNotes
1Authentication MethodYesAuthentication method
Refer to the documentation in the form while using the connector
OAuth2.0
Sandbox Access Token
2Replication Start DateNoThe Start Date in format: YYYY-MM-DD. Any data before this date will not be replicated. If this parameter is not set, all data will be replicated.
3End DateNoThe date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DD. All data generated between start_date and this date will be replicated. Not setting this option will result in always syncing the data till the current date.
4Report Aggregation GranularityNoThe granularity used for aggregating performance data in reports. See the docs.

Tables in the Tiktok marketing connector

NoTable NameColumnsPrimary KeysRead ModeInc. Sync KeysAPI Info
1ad_groups87
2ads47API Reference
3advertiser_ids2
4campaigns18API Reference
5basic_reports8
6advertisers21API Reference
7audience_reports8

Table: ad_groups

NoColumn NameTypeNotes
1placement_typeVARCHAR
2ios_quota_typeVARCHAR
3billing_eventVARCHAR
4carriers_v2VARCHAR
5audience_ruleVARCHAR
6skip_learning_phaseINTEGER
7bid_typeVARCHAR
8pixel_idINTEGER
9frequencyINTEGER
10deep_bid_typeVARCHAR
11deep_cpabidDOUBLE
12frequency_scheduleINTEGER
13interest_category_v2VARCHAR
14rf_predict_frequencyDOUBLE
15app_idINTEGER
16app_download_urlVARCHAR
17campaign_idINTEGER
18action_daysINTEGER
19budgetDOUBLE
20audienceVARCHAR
21packageVARCHAR
22video_downloadVARCHAR
23create_timeVARCHAR
24android_osvVARCHAR
25device_modelsVARCHAR
26operation_systemVARCHAR
27brand_safety_partnerVARCHAR
28product_set_idINTEGER
29rf_buy_typeVARCHAR
30carriersVARCHAR
31ios_target_deviceVARCHAR
32buy_impressionDOUBLE
33catalog_idINTEGER
34action_categoriesVARCHAR
35catalog_authorized_bcINTEGER
36pacingVARCHAR
37video_actionsVARCHAR
38brand_safetyVARCHAR
39creative_material_modeVARCHAR
40deep_external_actionVARCHAR
41schedule_end_timeVARCHAR
42ios_osvVARCHAR
43daypartingVARCHAR
44placementVARCHAR
45pangle_audience_package_includeVARCHAR
46adgroup_nameVARCHAR
47conversion_windowVARCHAR
48schedule_start_timeVARCHAR
49rf_predict_cprDOUBLE
50statusVARCHAR
51adgroup_idINTEGER
52is_comment_disableINTEGER
53is_hfssBOOLEAN
54genderVARCHAR
55external_actionVARCHAR
56modify_timeVARCHAR
57include_custom_actionsVARCHAR
58roas_bidDOUBLE
59advertiser_idINTEGER
60device_priceVARCHAR
61interest_keywordsVARCHAR
62cpv_video_durationVARCHAR
63excluded_audienceVARCHAR
64split_test_adgroup_idsVARCHAR
65conversion_bidDOUBLE
66enable_inventory_filterBOOLEAN
67pangle_block_app_list_idVARCHAR
68schedule_typeVARCHAR
69languagesVARCHAR
70connection_typeVARCHAR
71pangle_audience_package_excludeVARCHAR
72external_typeVARCHAR
73statistic_typeVARCHAR
74promotion_website_typeVARCHAR
75opt_statusVARCHAR
76dpa_retargeting_typeVARCHAR
77optimize_goalVARCHAR
78action_v2VARCHAR
79audience_typeVARCHAR
80exclude_custom_actionsVARCHAR
81targeting_expansionVARCHAR
82locationVARCHAR
83budget_modeVARCHAR
84buy_reachDOUBLE
85bidDOUBLE
86is_new_structureBOOLEAN
87ageVARCHAR

Table: ads

NoColumn NameTypeNotes
1tiktok_item_idVARCHAR
2vast_moatBOOLEAN
3adgroup_idINTEGER
4call_to_actionVARCHAR
5item_duet_statusVARCHAR
6modify_timeVARCHAR
7open_urlVARCHAR
8dpa_open_url_typeVARCHAR
9landing_page_urlsVARCHAR
10advertiser_idINTEGER
11campaign_nameVARCHAR
12page_idDOUBLE
13disclaimer_typeVARCHAR
14profile_imageVARCHAR
15premium_badge_idVARCHAR
16is_acoBOOLEAN
17disclaimer_clickable_textsVARCHAR
18disclaimer_textVARCHAR
19is_creative_authorizedBOOLEAN
20dpa_video_tpl_idVARCHAR
21ad_textVARCHAR
22landing_page_urlVARCHAR
23campaign_idINTEGER
24ad_formatVARCHAR
25dpa_fallback_typeVARCHAR
26playable_urlVARCHAR
27create_timeVARCHAR
28ad_textsVARCHAR
29fallback_typeVARCHAR
30item_stitch_statusVARCHAR
31ad_nameVARCHAR
32promotional_music_disabledBOOLEAN
33display_nameVARCHAR
34card_idINTEGER
35impression_tracking_urlVARCHAR
36opt_statusVARCHAR
37app_nameVARCHAR
38click_tracking_urlVARCHAR
39ad_idINTEGER
40call_to_action_idVARCHAR
41image_idsVARCHAR
42image_modeVARCHAR
43open_url_typeVARCHAR
44adgroup_nameVARCHAR
45is_new_structureBOOLEAN
46statusVARCHAR
47video_idVARCHAR

Table: advertiser_ids

NoColumn NameTypeNotes
1advertiser_nameVARCHAR
2advertiser_idINTEGER

Table: campaigns

NoColumn NameTypeNotes
1create_timeVARCHAR
2campaign_typeVARCHAR
3modify_timeVARCHAR
4objective_typeVARCHAR
5bid_typeVARCHAR
6advertiser_idINTEGER
7objectiveVARCHAR
8opt_statusVARCHAR
9budget_optimize_switchDOUBLE
10campaign_nameVARCHAR
11optimize_goalVARCHAR
12deep_bid_typeVARCHAR
13split_test_variableVARCHAR
14budget_modeVARCHAR
15is_new_structureBOOLEAN
16campaign_idINTEGER
17budgetDOUBLE
18statusVARCHAR

Table: basic_reports

NoColumn NameTypeNotes
1ad_idINTEGER
2adgroup_idINTEGER
3stat_time_dayVARCHAR
4stat_time_hourVARCHAR
5metricsVARCHAR
6campaign_idINTEGER
7advertiser_idINTEGER
8dimensionsVARCHAR

Table: advertisers

NoColumn NameTypeNotes
1countryVARCHAR
2reasonVARCHAR
3addressVARCHAR
4roleVARCHAR
5create_timeINTEGER
6timezoneVARCHAR
7promotion_areaVARCHAR
8phonenumberVARCHAR
9descriptionVARCHAR
10industryVARCHAR
11languageVARCHAR
12license_noVARCHAR
13contacterVARCHAR
14balanceDOUBLE
15nameVARCHAR
16companyVARCHAR
17currencyVARCHAR
18idINTEGER
19emailVARCHAR
20license_urlVARCHAR
21statusVARCHAR

Table: audience_reports

NoColumn NameTypeNotes
1ad_idINTEGER
2adgroup_idINTEGER
3stat_time_dayVARCHAR
4stat_time_hourVARCHAR
5metricsVARCHAR
6campaign_idINTEGER
7advertiser_idINTEGER
8dimensionsVARCHAR

External Resources

Zipstack Cloud features a powerful SQL querying engine on top of many types of connectors, including those from Trino, some custom connectors and connectors from the open source Airbyte project. Some Zipstack cloud connectors are designed to utilize and expand upon Airbyte's connector protocol, but they do not use Airbyte's EL core. Additionally, some parts of the documentation for these connectors have been adapted from the connector documentation found in Airbyte's open source project.