TikTok Ads is a social media advertising platform for businesses to promote their products or services on TikTok.

TikTok Ads allows businesses to create and run ads on the popular social media platform TikTok, reaching a large and engaged audience of users. With a variety of ad formats available, including in-feed ads, brand takeovers, and hashtag challenges, businesses can tailor their advertising strategy to their specific goals and target audience. TikTok Ads also provides detailed analytics and targeting options to help businesses optimize their campaigns and reach the right audience.

This extractor supports the standard TikTok Ads streams and also supports custom basic reports via the custom_basic_report setting. custom_basic_report should be provided as an array of report definitions.

Settings

Advertiser IDs

The TikTok advertiser account IDs to sync.

Start Date

The earliest record date to sync.

Include Deleted

Include deleted entities in supported streams.

Lookback

Number of days prior to today to refetch data.

Custom Basic Report

A list of report definition objects

Report definition

• dimensions: array of strings (required)

  The report dimensions - e.g. campaign_id, country_code, stat_time_day

• metrics: array of strings (required)

  The report metrics - e.g. spend

• name: string (default: custom_basic_report)

  The name to assign to the stream

• service_type: string (default: AUCTION)

  The TikTok service type to report on

• data_level: string

  The level to report at - one of AUCTION_ADVERTISER, AUCTION_CAMPAIGN, AUCTION_ADGROUP or AUCTION_AD

• primary_keys: array of strings (default: dimensions)

  The stream primary keys

• replication_key: string (default: stat_time_hour or stat_time_day, if in dimensions)

  The stream replication key

• page_size: integer (default: 1000)

  The number of rows to request per page

Filtering

• filtering: array of objects

  TikTok API filters to apply - replaces the default status filter

• include_status_filter: boolean (default: true)

  Whether or not to filter on entity status - the filter includes deleted entities when include_deleted is true

• status_field: string (default: from data_level)

  The field to filter on status - e.g. campaign_status for AUCTION_CAMPAIGN

Each report definition becomes its own stream, synced one day at a time for each advertiser. See the tap README for further information