Tiktok marketing
Setting up the Tiktok marketing connector
| No | Item | Required | Example | Notes |
|---|---|---|---|---|
| 1 | Authentication Method | Yes | Authentication method Refer to the documentation in the form while using the connector OAuth2.0Sandbox Access Token | |
| 2 | Replication Start Date | No | The 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. | |
| 3 | End Date | No | The 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. | |
| 4 | Report Aggregation Granularity | No | The granularity used for aggregating performance data in reports. See the docs. |
Tables in the Tiktok marketing connector
| No | Table Name | Columns | Primary Keys | Read Mode | Inc. Sync Keys | API Info |
|---|---|---|---|---|---|---|
| 1 | ad_groups | 87 | ||||
| 2 | ads | 47 | API Reference | |||
| 3 | advertiser_ids | 2 | ||||
| 4 | campaigns | 18 | API Reference | |||
| 5 | basic_reports | 8 | ||||
| 6 | advertisers | 21 | API Reference | |||
| 7 | audience_reports | 8 |
Table: ad_groups
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | placement_type | VARCHAR | |
| 2 | ios_quota_type | VARCHAR | |
| 3 | billing_event | VARCHAR | |
| 4 | carriers_v2 | VARCHAR | |
| 5 | audience_rule | VARCHAR | |
| 6 | skip_learning_phase | INTEGER | |
| 7 | bid_type | VARCHAR | |
| 8 | pixel_id | INTEGER | |
| 9 | frequency | INTEGER | |
| 10 | deep_bid_type | VARCHAR | |
| 11 | deep_cpabid | DOUBLE | |
| 12 | frequency_schedule | INTEGER | |
| 13 | interest_category_v2 | VARCHAR | |
| 14 | rf_predict_frequency | DOUBLE | |
| 15 | app_id | INTEGER | |
| 16 | app_download_url | VARCHAR | |
| 17 | campaign_id | INTEGER | |
| 18 | action_days | INTEGER | |
| 19 | budget | DOUBLE | |
| 20 | audience | VARCHAR | |
| 21 | package | VARCHAR | |
| 22 | video_download | VARCHAR | |
| 23 | create_time | VARCHAR | |
| 24 | android_osv | VARCHAR | |
| 25 | device_models | VARCHAR | |
| 26 | operation_system | VARCHAR | |
| 27 | brand_safety_partner | VARCHAR | |
| 28 | product_set_id | INTEGER | |
| 29 | rf_buy_type | VARCHAR | |
| 30 | carriers | VARCHAR | |
| 31 | ios_target_device | VARCHAR | |
| 32 | buy_impression | DOUBLE | |
| 33 | catalog_id | INTEGER | |
| 34 | action_categories | VARCHAR | |
| 35 | catalog_authorized_bc | INTEGER | |
| 36 | pacing | VARCHAR | |
| 37 | video_actions | VARCHAR | |
| 38 | brand_safety | VARCHAR | |
| 39 | creative_material_mode | VARCHAR | |
| 40 | deep_external_action | VARCHAR | |
| 41 | schedule_end_time | VARCHAR | |
| 42 | ios_osv | VARCHAR | |
| 43 | dayparting | VARCHAR | |
| 44 | placement | VARCHAR | |
| 45 | pangle_audience_package_include | VARCHAR | |
| 46 | adgroup_name | VARCHAR | |
| 47 | conversion_window | VARCHAR | |
| 48 | schedule_start_time | VARCHAR | |
| 49 | rf_predict_cpr | DOUBLE | |
| 50 | status | VARCHAR | |
| 51 | adgroup_id | INTEGER | |
| 52 | is_comment_disable | INTEGER | |
| 53 | is_hfss | BOOLEAN | |
| 54 | gender | VARCHAR | |
| 55 | external_action | VARCHAR | |
| 56 | modify_time | VARCHAR | |
| 57 | include_custom_actions | VARCHAR | |
| 58 | roas_bid | DOUBLE | |
| 59 | advertiser_id | INTEGER | |
| 60 | device_price | VARCHAR | |
| 61 | interest_keywords | VARCHAR | |
| 62 | cpv_video_duration | VARCHAR | |
| 63 | excluded_audience | VARCHAR | |
| 64 | split_test_adgroup_ids | VARCHAR | |
| 65 | conversion_bid | DOUBLE | |
| 66 | enable_inventory_filter | BOOLEAN | |
| 67 | pangle_block_app_list_id | VARCHAR | |
| 68 | schedule_type | VARCHAR | |
| 69 | languages | VARCHAR | |
| 70 | connection_type | VARCHAR | |
| 71 | pangle_audience_package_exclude | VARCHAR | |
| 72 | external_type | VARCHAR | |
| 73 | statistic_type | VARCHAR | |
| 74 | promotion_website_type | VARCHAR | |
| 75 | opt_status | VARCHAR | |
| 76 | dpa_retargeting_type | VARCHAR | |
| 77 | optimize_goal | VARCHAR | |
| 78 | action_v2 | VARCHAR | |
| 79 | audience_type | VARCHAR | |
| 80 | exclude_custom_actions | VARCHAR | |
| 81 | targeting_expansion | VARCHAR | |
| 82 | location | VARCHAR | |
| 83 | budget_mode | VARCHAR | |
| 84 | buy_reach | DOUBLE | |
| 85 | bid | DOUBLE | |
| 86 | is_new_structure | BOOLEAN | |
| 87 | age | VARCHAR |
Table: ads
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | tiktok_item_id | VARCHAR | |
| 2 | vast_moat | BOOLEAN | |
| 3 | adgroup_id | INTEGER | |
| 4 | call_to_action | VARCHAR | |
| 5 | item_duet_status | VARCHAR | |
| 6 | modify_time | VARCHAR | |
| 7 | open_url | VARCHAR | |
| 8 | dpa_open_url_type | VARCHAR | |
| 9 | landing_page_urls | VARCHAR | |
| 10 | advertiser_id | INTEGER | |
| 11 | campaign_name | VARCHAR | |
| 12 | page_id | DOUBLE | |
| 13 | disclaimer_type | VARCHAR | |
| 14 | profile_image | VARCHAR | |
| 15 | premium_badge_id | VARCHAR | |
| 16 | is_aco | BOOLEAN | |
| 17 | disclaimer_clickable_texts | VARCHAR | |
| 18 | disclaimer_text | VARCHAR | |
| 19 | is_creative_authorized | BOOLEAN | |
| 20 | dpa_video_tpl_id | VARCHAR | |
| 21 | ad_text | VARCHAR | |
| 22 | landing_page_url | VARCHAR | |
| 23 | campaign_id | INTEGER | |
| 24 | ad_format | VARCHAR | |
| 25 | dpa_fallback_type | VARCHAR | |
| 26 | playable_url | VARCHAR | |
| 27 | create_time | VARCHAR | |
| 28 | ad_texts | VARCHAR | |
| 29 | fallback_type | VARCHAR | |
| 30 | item_stitch_status | VARCHAR | |
| 31 | ad_name | VARCHAR | |
| 32 | promotional_music_disabled | BOOLEAN | |
| 33 | display_name | VARCHAR | |
| 34 | card_id | INTEGER | |
| 35 | impression_tracking_url | VARCHAR | |
| 36 | opt_status | VARCHAR | |
| 37 | app_name | VARCHAR | |
| 38 | click_tracking_url | VARCHAR | |
| 39 | ad_id | INTEGER | |
| 40 | call_to_action_id | VARCHAR | |
| 41 | image_ids | VARCHAR | |
| 42 | image_mode | VARCHAR | |
| 43 | open_url_type | VARCHAR | |
| 44 | adgroup_name | VARCHAR | |
| 45 | is_new_structure | BOOLEAN | |
| 46 | status | VARCHAR | |
| 47 | video_id | VARCHAR |
Table: advertiser_ids
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | advertiser_name | VARCHAR | |
| 2 | advertiser_id | INTEGER |
Table: campaigns
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | create_time | VARCHAR | |
| 2 | campaign_type | VARCHAR | |
| 3 | modify_time | VARCHAR | |
| 4 | objective_type | VARCHAR | |
| 5 | bid_type | VARCHAR | |
| 6 | advertiser_id | INTEGER | |
| 7 | objective | VARCHAR | |
| 8 | opt_status | VARCHAR | |
| 9 | budget_optimize_switch | DOUBLE | |
| 10 | campaign_name | VARCHAR | |
| 11 | optimize_goal | VARCHAR | |
| 12 | deep_bid_type | VARCHAR | |
| 13 | split_test_variable | VARCHAR | |
| 14 | budget_mode | VARCHAR | |
| 15 | is_new_structure | BOOLEAN | |
| 16 | campaign_id | INTEGER | |
| 17 | budget | DOUBLE | |
| 18 | status | VARCHAR |
Table: basic_reports
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | ad_id | INTEGER | |
| 2 | adgroup_id | INTEGER | |
| 3 | stat_time_day | VARCHAR | |
| 4 | stat_time_hour | VARCHAR | |
| 5 | metrics | VARCHAR | |
| 6 | campaign_id | INTEGER | |
| 7 | advertiser_id | INTEGER | |
| 8 | dimensions | VARCHAR |
Table: advertisers
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | country | VARCHAR | |
| 2 | reason | VARCHAR | |
| 3 | address | VARCHAR | |
| 4 | role | VARCHAR | |
| 5 | create_time | INTEGER | |
| 6 | timezone | VARCHAR | |
| 7 | promotion_area | VARCHAR | |
| 8 | phonenumber | VARCHAR | |
| 9 | description | VARCHAR | |
| 10 | industry | VARCHAR | |
| 11 | language | VARCHAR | |
| 12 | license_no | VARCHAR | |
| 13 | contacter | VARCHAR | |
| 14 | balance | DOUBLE | |
| 15 | name | VARCHAR | |
| 16 | company | VARCHAR | |
| 17 | currency | VARCHAR | |
| 18 | id | INTEGER | |
| 19 | email | VARCHAR | |
| 20 | license_url | VARCHAR | |
| 21 | status | VARCHAR |
Table: audience_reports
| No | Column Name | Type | Notes |
|---|---|---|---|
| 1 | ad_id | INTEGER | |
| 2 | adgroup_id | INTEGER | |
| 3 | stat_time_day | VARCHAR | |
| 4 | stat_time_hour | VARCHAR | |
| 5 | metrics | VARCHAR | |
| 6 | campaign_id | INTEGER | |
| 7 | advertiser_id | INTEGER | |
| 8 | dimensions | VARCHAR |
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.