TikTok Ads
App · 14 actions
Read TikTok advertising campaigns, audiences and performance; manage ad status and asynchronous reports.
Actions
| Action | What it does |
|---|---|
| Cancel report task | Cancel report task in TikTok Ads. |
| Create report task | Start an asynchronous basic report and return its task ID. |
| Get ad group quota | Get ad group quota in TikTok Ads. |
| Get custom audiences | Get custom audiences in TikTok Ads. |
| Get report | Get report in TikTok Ads. |
| Get report task | Get report task in TikTok Ads. |
| List ad groups | List ad groups in TikTok Ads. |
| List ads | List ads in TikTok Ads. |
| List campaigns | List campaigns in TikTok Ads. |
| List custom audiences | List custom audiences in TikTok Ads. |
| List saved audiences | List saved audiences in TikTok Ads. |
| Set ad status | Change ad status. |
| Set adgroup status | Change ad group status. |
| Set campaign status | Change campaign status. |
Cancel report task
Cancel report task in TikTok Ads.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Task ID
task_idtextRequired - Task id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Create report task
Start an asynchronous basic report and return its task ID. Use Get report task to check progress.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Start date
start_datedateRequired - Start date.
- End date
end_datedateRequired - End date.
- Data level
data_leveltextRequired - Data level.One of:
AUCTION_ADVERTISER,AUCTION_CAMPAIGN,AUCTION_ADGROUP,AUCTION_AD. - Dimensions
dimensionslistRequired - Dimensions.One or more of:
advertiser_id,campaign_id,adgroup_id,ad_id,stat_time_day,stat_time_hour. - Metrics
metricslist - Metrics.One or more of:
spend,impressions,clicks,ctr,cpc,cpm,conversion,cost_per_conversion,conversion_rate.
Outputs
Response.
dataobject- Task creation response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"code": 0,
"data": {
"task_id": "Example"
}
},
"has_more": false,
"next_cursor": null
}Get ad group quota
Get ad group quota in TikTok Ads.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get custom audiences
Get custom audiences in TikTok Ads.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Custom audience IDs
custom_audience_idslistRequired - Custom audience ids.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get report
Get report in TikTok Ads.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Start date
start_datedateRequired - Start date.
- End date
end_datedateRequired - End date.
- Data level
data_leveltextRequired - Data level.One of:
AUCTION_ADVERTISER,AUCTION_CAMPAIGN,AUCTION_ADGROUP,AUCTION_AD. - Dimensions
dimensionslistRequired - Dimensions.One or more of:
advertiser_id,campaign_id,adgroup_id,ad_id,stat_time_day,stat_time_hour. - Metrics
metricslist - Metrics.One or more of:
spend,impressions,clicks,ctr,cpc,cpm,conversion,cost_per_conversion,conversion_rate. - Page
pagenumber - Page.At least 1.
- Page size
page_sizenumber - Page size.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": {
"list": []
}
},
"has_more": false,
"next_cursor": null
}Get report task
Get report task in TikTok Ads.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Task ID
task_idtextRequired - Task id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List ad groups
List ad groups in TikTok Ads.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Page
pagenumber - Page.At least 1.
- Page size
page_sizenumber - Page size.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": {
"list": []
}
},
"has_more": false,
"next_cursor": null
}List ads
List ads in TikTok Ads.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Page
pagenumber - Page.At least 1.
- Page size
page_sizenumber - Page size.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": {
"list": []
}
},
"has_more": false,
"next_cursor": null
}List campaigns
List campaigns in TikTok Ads.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Page
pagenumber - Page.At least 1.
- Page size
page_sizenumber - Page size.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": {
"list": []
}
},
"has_more": false,
"next_cursor": null
}List custom audiences
List custom audiences in TikTok Ads.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Page
pagenumber - Page.At least 1.
- Page size
page_sizenumber - Page size.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": {
"list": []
}
},
"has_more": false,
"next_cursor": null
}List saved audiences
List saved audiences in TikTok Ads.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Page
pagenumber - Page.At least 1.
- Page size
page_sizenumber - Page size.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": {
"list": []
}
},
"has_more": false,
"next_cursor": null
}Set ad status
Change ad status. ENABLE can start ad spending; DELETE is irreversible.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Ad IDs
ad_idslistRequired - Ad ids.
- Operation status
operation_statustextRequired - Operation status.One of:
ENABLE,DISABLE,DELETE.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Set adgroup status
Change ad group status. ENABLE can start ad spending; DELETE is irreversible.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Adgroup IDs
adgroup_idslistRequired - Adgroup ids.
- Operation status
operation_statustextRequired - Operation status.One of:
ENABLE,DISABLE,DELETE.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Set campaign status
Change campaign status. ENABLE can start ad spending; DELETE is irreversible.
Inputs
- Advertiser ID
advertiser_idtext - Advertiser ID. Leave empty to use the connected advertiser.
- Campaign IDs
campaign_idslistRequired - Campaign ids.
- Operation status
operation_statustextRequired - Operation status.One of:
ENABLE,DISABLE,DELETE.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}