Release Notes
November 2024
We added a buying_types
filter to our calls to retrieve all possible buying_types entities {AUCTION, RESERVATION_RF, RESERVATION_TOP_VIEW} for the following tables:
- AD_HISTORY
- ADGROUP_HISTORY
- CAMPAIGN_HISTORY
We added the buying_type
field to all three tables (AD_HISTORY, ADGROUP_HISTORY, CAMPAIGN_HISTORY) to reflect the buying_types
filter value used in our data requests.
We added the following fields to the AD_HISTORY table (see the TikTok documentation for details):
aigc_disclosure_type
avatar_icon_web_uri
brand_safety_postbid_partner
brand_safety_vast_url
branded_content_disabled
call_to_action_id
card_id
carousel_image_index
cpp_url
creative_type
dark_post_status
deeplink_type
dynamic_destination
dynamic_format
fallback_type
identity_authorized_bc_id
identity_id
identity_type
item_duet_status
item_stitch_status
music_id
optimization_event
page_id
phone_number
phone_region_calling_code
phone_region_code
product_set_id
product_specific_type
promotional_music_disabled
shopping_ads_deeplink_type
shopping_ads_fallback_type
shopping_ads_video_package_id
tiktok_page_category
tracking_app_id
tracking_pixel_id
vast_moat_enabled
vertical_video_strategy
viewability_postbid_partner
viewability_vast_url
We added the following fields to the ADGROUP_HISTORY table (see the TikTok documentation for details):
adgroup_app_profile_page_state
attribution_event_count
bid_display_mode
brand_safety_partner
brand_safety_type
click_attribution_window
comment_disabled
cpm
delivery_mode
discount_amount
discount_percentage
discount_type
engaged_view_attribution_window
feed_type
identity_authorized_bc_id
identity_id
identity_type
ios14_quota_type
ios14_targeting
is_smart_performance_campaign
next_day_retention
pre_discount_budget
pre_discount_cpm
predict_impression
product_source
promotion_target_type
promotion_type
promotion_website_type
purchased_impression
purchased_reach
rf_estimated_cpr
rf_estimated_frequency
rf_purchased_type
roas_bid
saved_audience_id
scheduled_budget
search_result_enabled
share_disabled
shopping_ads_retargeting_actions_days
shopping_ads_retargeting_custom_audience_relation
shopping_ads_retargeting_type
shopping_ads_type
smart_audience_enabled
smart_interest_behavior_enabled
spending_power
split_test_group_id
split_test_status
store_authorized_bc_id
store_id
String> tiktok_subplacements
vbo_window
vertical_sensitivity_id
video_download_disabled
view_attribution_window
We added the following fields to the CAMPAIGN_HISTORY table (see the TikTok documentation for details):
app_id
app_promotion_type
bid_type
budget_optimize_on
campaign_app_profile_page_state
campaign_product_source
deep_bid_type
is_advanced_dedicated_campaign
is_search_campaign
is_smart_performance_campaign
objective
optimization_goal
postback_window_mode
rf_campaign_type
roas_bid
rta_id
rta_product_selection_enabled
October 2024
We added a new table, IMAGE_HISTORY
. Until November 22, 2024, all usage for this table will count towards free MAR.
For more information, see the TikTok API documentation.
September 2024
We added the ad_format
field to the AD_HISTORY
table. We also added a new table, UTM_PARAM
.
For more information, see the TikTok API documentation.
August 2024
We've added support for the custom_event_type
dimension for custom reports.
We've also added new page event
metrics to custom reports:
View Content Metrics:
cost_per_page_content_view_event
page_content_view_event_rate
page_content_view_events
total_page_view_content_events_value
value_per_page_content_view_event
Custom Page Event Metrics:
cost_per_custom_page_event
custom_page_event_rate
custom_page_events
custom_page_events_value
value_per_custom_page_event
For more information, see TikTok API documentation.
July 2024
We have added a new field, asset_ownership_status
, to the PIXEL
table.
We have added a new field, custom_event_type
, to the PIXEL_EVENT
table.
We have added new metrics to our basic prebuilt reports.
Reports:
AD_REPORT_DAILY
AD_REPORT_HOURLY
AD_REPORT_LIFETIME
ADGROUP_REPORT_DAILY
ADGROUP_REPORT_HOURLY
ADGROUP_REPORT_LIFETIME
CAMPAIGN_REPORT_DAILY
CAMPAIGN_REPORT_HOURLY
CAMPAIGN_REPORT_LIFETIME
Metrics:
Shop Event Metrics:
cost_per_onsite_initiate_checkout_count
cost_per_onsite_on_web_cart
cost_per_onsite_on_web_detail
cost_per_onsite_shopping
onsite_initiate_checkout_count_rate
onsite_initiate_checkout_count
onsite_on_web_cart_rate
onsite_on_web_cart
onsite_on_web_detail_rate
onsite_on_web_detail
onsite_shopping_rate
onsite_shopping_roas
onsite_shopping
total_onsite_initiate_checkout_count_value
total_onsite_on_web_cart_value
total_onsite_on_web_detail_value
total_onsite_shopping_value
value_per_onsite_initiate_checkout_count
value_per_onsite_on_web_cart
value_per_onsite_on_web_detail
value_per_onsite_shopping
Page Event Metrics:
cost_per_on_web_subscribe
on_web_subscribe_per_click
on_web_subscribe
total_on_web_subscribe_value
value_per_on_web_subscribe
June 2024
We have added the total_landing_page_view
, cost_per_landing_page_view
, landing_page_view_rate
, total_pageview
, cost_per_pageview
, pageview_rate
, avg_value_per_pageview
, and total_value_per_pageview
fields to the following reports:
CAMPAIGN_REPORT_DAILY
CAMPAIGN_REPORT_HOURLY
CAMPAIGN_REPORT_LIFETIME
ADGROUP_REPORT_DAILY
ADGROUP_REPORT_HOURLY
ADGROUP_REPORT_LIFETIME
AD_REPORT_DAILY
AD_REPORT_HOURLY
AD_REPORT_LIFETIM
We have added the total_landing_page_view
, cost_per_landing_page_view
, and landing_page_view_rate
fields to the following reports:
CAMPAIGN_AGE_GENDER_REPORT
CAMPAIGN_COUNTRY_REPORT
CAMPAIGN_LANGUAGE_REPORT
CAMPAIGN_PLATFORM_REPORT
AD_AGE_GENDER_REPORT
AD_COUNTRY_REPORT
AD_LANGUAGE_REPORT
AD_PLATFORM_REPORT
March 2024
We have added a new column, tiktok_item_id
, to the AD_HISTORY
table. For more information on this field, see TikTok ads' documentation.
We now use STATUS_ALL
filtering option for basic reports which include all statuses. Previously, by default, we used the STATUS_NOT_DELETE
filtering option for basic reports which includes all statuses except Deleted
. All basic report aggregations will now also include the deleted entities.
August 2023
We have added a new table, VIDEO_HISTORY
.
This change is applicable for all new connectors, and we are gradually rolling out this change to all existing connectors.
We have added new IN-APP METRICS
, PAGE EVENT METRICS
, and ATTRIBUTION METRICS
fields to the following reports:
AD_REPORT_DAILY
AD_REPORT_HOURLY
AD_REPORT_LIFETIME
ADGROUP_REPORT_DAILY
ADGROUP_REPORT_HOURLY
ADGROUP_REPORT_LIFETIME
CAMPAIGN_REPORT_DAILY
CAMPAIGN_REPORT_HOURLY
CAMPAIGN_REPORT_LIFETIME
For more information about the fields, see our prebuilt reports documentation.
We are gradually rolling out these changes to all existing connectors. If you want to sync the historical data for these fields, contact our support team.
July 2023
We have upgraded our TikTok Ads connector to TikTok Ads API v1.3. As part of the upgrade, we have renamed the following columns in the tables below:
Table name | Old column name | New column name |
---|---|---|
ADGROUP_HISTORY | placement | placements |
enable_inventory_filter | inventory_filter_enabled | |
external_action | optimization_event | |
deep_external_action | secondary_optimization_event | |
age | age_groups | |
operation_system | operating_systems | |
connection_type | network_types | |
device_price | device_price_ranges | |
android_osv | min_android_version | |
ios_osv | min_ios_version | |
optimize_goal | optimization_goal | |
bid | bid_price | |
conversion_bid | conversion_bid_price | |
deep_cpabid | deep_cpa_bid | |
opt_status | operation_status | |
status | secondary_status | |
AD_HISTORY | profile_image | profile_image_url |
open_url | deeplink | |
is_creative_authorized | creative_authorized | |
opt_status | operation_status | |
status | secondary_status | |
ADVERTISER | reason | rejected_reason |
phone_number | cellphone_number | |
telephone | telephone_number | |
CAMPAIGN_HISTORY | opt_status | operation_status |
status | secondary_status | |
PIXEL | asset_ownership_owned_by | asset_ownership_owner_bc_id |
PIXEL_EVENT | external_action | optimization_event |
We are gradually rolling out these changes to all existing connectors.
June 2023
You can now opt to configure the attribution window to capture conversions. In the connector setup form, set the Show advanced options toggle to ON, and set the attribution window using the Rollback sync (optional) drop-down. By default, the window is 7 days. For more information, see our setup guide and REST API Config.
We have added a new option, Add custom report, to the setup form. This option enables you to configure and sync your custom reports using our TikTok Ads connector. For more information, see our setup guide. We are gradually rolling out this feature to all existing connectors.
December 2022
We have added the following new tables:
PIXEL_HISTORY
PIXEL_EVENT_HISTORY
PIXEL_EVENT_RULE_HISTORY
PIXEL_STATISTICS
November 2022
We have added the following new tables:
AD_REPORT_LIFETIME
ADGROUP_REPORT_LIFETIME
CAMPAIGN_REPORT_LIFETIME
March 2022
We have added new IN-APP METRICS
fields to the following reports:
- CAMPAIGN_REPORT_DAILY
- CAMPAIGN_REPORT_HOURLY
- ADGROUP_REPORT_DAILY
- ADGROUP_REPORT_HOURLY
- AD_REPORT_DAILY
- AD_REPORT_HOURLY
For more information about the fields, see our prebuilt reports documentation.
January 2022
Our Tiktok Ads connector is now generally available. Read our TikTok Ads connector documentation.
We have released pre-built, dbt Core-compatible data models for TikTok Ads. Find the models in Fivetran's dbt hub or data models documentation. Learn more about our dbt Core integration in our Transformations for dbt Core documentation*.
* dbt Core is a trademark of dbt Labs, Inc. All rights therein are reserved to dbt Labs, Inc. Fivetran Transformations is not a product or service of or endorsed by dbt Labs, Inc.
November 2021
We have added a new column, status
, to the CAMPAIGN_HISTORY
table.
August 2021
TikTok Ads is a video-sharing social networking platform.