Skip to main content
Last updated on

TikTok Ads connector reference

Beta

This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.

This article provides reference information for the TikTok Ads connector, including supported tables, dimensions, and metrics.

Supported source tables​

The TikTok Ads connector supports the following source tables:

Tables that support incremental updates​

The following prebuilt report tables support incremental ingestion:

  • campaign_report_daily
  • campaign_report_hourly
  • adgroup_report_daily
  • adgroup_report_hourly
  • ad_report_daily
  • ad_report_hourly

Tables that support batch updates only (non-incremental)​

The following tables are refreshed on each pipeline update:

  • campaign
  • adgroup
  • ad
  • campaign_report_lifetime
  • adgroup_report_lifetime
  • ad_report_lifetime

Prebuilt report schema​

The following table describes the schema for supported prebuilt report tables:

Report name

Dimensions

Metric groups

Data level

Report type

campaign_report_daily

campaign_id, stat_time_day

AUCTION_ADS_BASIC, VIDEO_PLAY, ENGAGEMENT, IN-APP, PAGE EVENT, SHOP EVENT, ATTRIBUTION, SKAN

CAMPAIGN

BASIC

campaign_report_hourly

campaign_id, stat_time_hour

AUCTION_ADS_BASIC, VIDEO_PLAY, ENGAGEMENT, IN-APP, PAGE EVENT, SHOP EVENT, ATTRIBUTION

CAMPAIGN

BASIC

campaign_report_lifetime

campaign_id

AUCTION_ADS_BASIC, VIDEO_PLAY, ENGAGEMENT, IN-APP, PAGE EVENT, SHOP EVENT, ATTRIBUTION

CAMPAIGN

BASIC

adgroup_report_daily

adgroup_id, stat_time_day

AUCTION_ADS_BASIC, VIDEO_PLAY, ENGAGEMENT, IN-APP, PAGE EVENT, SHOP EVENT, ATTRIBUTION, SKAN

ADGROUP

BASIC

adgroup_report_hourly

adgroup_id, stat_time_hour

AUCTION_ADS_BASIC, VIDEO_PLAY, ENGAGEMENT, IN-APP, PAGE EVENT, SHOP EVENT, ATTRIBUTION

ADGROUP

BASIC

adgroup_report_lifetime

adgroup_id

AUCTION_ADS_BASIC, VIDEO_PLAY, ENGAGEMENT, IN-APP, PAGE EVENT, SHOP EVENT, ATTRIBUTION

ADGROUP

BASIC

ad_report_daily

ad_id, stat_time_day

AUCTION_ADS_BASIC, VIDEO_PLAY, ENGAGEMENT, IN-APP, PAGE EVENT, SHOP EVENT, ATTRIBUTION

AD

BASIC

ad_report_hourly

ad_id, stat_time_hour

AUCTION_ADS_BASIC, VIDEO_PLAY, ENGAGEMENT, IN-APP, PAGE EVENT, SHOP EVENT, ATTRIBUTION

AD

BASIC

ad_report_lifetime

ad_id

AUCTION_ADS_BASIC, VIDEO_PLAY, ENGAGEMENT, IN-APP, PAGE EVENT, SHOP EVENT, ATTRIBUTION

AD

BASIC

Metric groups​

The following metric groups are available in TikTok Ads reports:

AUCTION_ADS_BASIC​

  • spend
  • impressions
  • clicks
  • cpc
  • cpm
  • ctr
  • reach
  • cost_per_1000_reached
  • frequency

VIDEO_PLAY​

  • video_play_actions
  • video_watched_2s
  • video_watched_6s
  • video_views_p25
  • video_views_p50
  • video_views_p75
  • video_views_p100
  • average_video_play
  • average_video_play_per_user

ENGAGEMENT​

  • likes
  • comments
  • shares
  • follows
  • profile_visits
  • profile_visits_rate

ATTRIBUTION​

  • conversion
  • cost_per_conversion
  • conversion_rate
  • real_time_conversion
  • real_time_cost_per_conversion
  • real_time_conversion_rate
  • total_complete_payment_rate

IN_APP​

  • app_install
  • cost_per_app_install
  • registration
  • cost_per_registration
  • purchase
  • cost_per_purchase
  • app_event_add_to_cart
  • cost_per_app_event_add_to_cart
  • checkout
  • cost_per_checkout

PAGE_EVENT​

  • page_event_search
  • cost_per_page_event_search
  • complete_payment
  • cost_per_complete_payment

SHOP_EVENT​

  • product_details_page_browse
  • initiate_checkout
  • live_views
  • live_product_clicks

SKAN​

  • skan_conversion
  • skan_cost_per_conversion
  • skan_app_install
  • skan_cost_per_app_install
  • skan_purchase
  • skan_cost_per_purchase
  • skan_registration
  • skan_cost_per_registration
note

SKAN metrics aren't supported for lifetime reports.