route1io_connectors.tiktok module

TikTok

This module contains code for pulling data via TikTok Marketing API.

get_tiktok_data(access_token: str, advertiser_id: int, data_level: str = 'AUCTION_AD', dimensions: List[str] = ['ad_id', 'stat_time_day'], metrics: List[str] = ['campaign_name', 'adgroup_name', 'ad_id', 'spend', 'impressions', 'reach', 'clicks'], start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None) → pandas.core.frame.DataFrame

Return pd.DataFrame of TikTok Marketing API data for an authorized advertiser.

Parameters

  • access_token (str) – Valid access token with permissions to access advertiser’s ad account data via API https://ads.tiktok.com/marketing_api/docs?id=1701890912382977

  • advertiser_id (int) – Ad account we want to pull data from

  • data_level (str) – Level of data to pull from. Campaign ID grouping needs AUCTION_CAMPAIGN, Adgroup ID grouping needs ADGROUP_ADGROUP, etc. Default is AUCTION_AD.

  • dimensions (List[str]) – List of dimension(s) to group by. Each request can only have one ID dimension and one time dimension. ID dimensions include advertiser_id, campaign_id, adgroup_id, and ad_id. Time dimensions include stat_time_day and stat_time_hour. Default is [‘ad_id’, ‘stat_time_day’] https://ads.tiktok.com/marketing_api/docs?id=1707957200780290

  • start_date (datetime.date) – Inclusive datetime object start date to pull data. Default is today.

  • end_date (datetime.date) – Inclusive datetime object end date to pull data. Default is seven days before end_date.

Returns

df – DataFrame containing search ad data between start and end date for the organization

Return type

pd.DataFrame