GET_ADGROUP_METRICS_TIKTOK_ADS

Insights about your TikTok Ads ad group.

icon of TikTok AdsTikTok Ads
Not a big fan of functions?
Use the Actions Wizard to configure any action in Rows without functions.

Parameter List

Syntax
GET_ADGROUP_METRICS_TIKTOK_ADS(advertiser id
[campaign id]
[adgroup id]
[report type]
[date range]
[metrics]
[dimensions]
)
advertiser id

The ID of your TikTok Ads account.

[optional] campaign id

Name or ID of your campaign.

[optional] adgroup id

Name or ID of your ad group.

[optional] report type

The type of report.

Selected options:
Basic
Audience
Playable ad
[optional] date range

Date range to get insights for. For example: ">2019", ">2019-11-01" or "[2010-01-01;2019-01-01]". By default, you get insights for the last 30 days.

[optional] metrics

Range of fields to retrieve about the ad account. For example: 'clicks','country'. By default, it returns the most common metrics about the ad account.

Selected options:
Ad Format Asset
Total Cost
Ad url
CPC (Destination)
Campaign Name
Ad Group Name
CPM
Impressions
Gross Impressions (Includes Invalid Impressions)
Clicks (Destination)
CTR (Destination)
Conversion
CPA
CVR (Clicks)
CVR (Impressions)
Real-time Conversions
Real-time CPA
Real-time CVR (Clicks)
Real-time CVR (Impressions)
Result
Cost Per Result
Result Rate (%)
Real-time Result
Real-time Cost Per Result
Real-time Result Rate (%)
Currency
Is Automated Ad
Is Smart Creative Ad
[optional] dimensions

Range of values to break down the results into different sets. For example: 'age'.

Selected options:
Campaign ID
AdGroup ID
Day
Hour
Video id
Gender
Age
Country Code
Province ID
DMA ID
Language
Interest Category
Interest Category Tier 2
Interest Category Tier 3

Examples

GET_ADGROUP_METRICS_TIKTOK_ADS("adidas", "ad group Summer", , audience, ">2021-09-01", "impressions,clicks,spend,cpc,cpm", "age") returns report with clicks, spend, cpc and cpm per age of the audience.