TikTok Ads

App · 14 actions

Read TikTok advertising campaigns, audiences and performance; manage ad status and asynchronous reports.

Actions

ActionWhat it does
Cancel report taskCancel report task in TikTok Ads.
Create report taskStart an asynchronous basic report and return its task ID.
Get ad group quotaGet ad group quota in TikTok Ads.
Get custom audiencesGet custom audiences in TikTok Ads.
Get reportGet report in TikTok Ads.
Get report taskGet report task in TikTok Ads.
List ad groupsList ad groups in TikTok Ads.
List adsList ads in TikTok Ads.
List campaignsList campaigns in TikTok Ads.
List custom audiencesList custom audiences in TikTok Ads.
List saved audiencesList saved audiences in TikTok Ads.
Set ad statusChange ad status.
Set adgroup statusChange ad group status.
Set campaign statusChange campaign status.

Cancel report task

Cancel report task in TikTok Ads.

Inputs

Advertiser IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Task IDtask_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Data leveldata_leveltextRequired
Data level.One of: AUCTION_ADVERTISER, AUCTION_CAMPAIGN, AUCTION_ADGROUP, AUCTION_AD.
DimensionsdimensionslistRequired
Dimensions.One or more of: advertiser_id, campaign_id, adgroup_id, ad_id, stat_time_day, stat_time_hour.
Metricsmetricslist
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 IDadvertiser_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Custom audience IDscustom_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Data leveldata_leveltextRequired
Data level.One of: AUCTION_ADVERTISER, AUCTION_CAMPAIGN, AUCTION_ADGROUP, AUCTION_AD.
DimensionsdimensionslistRequired
Dimensions.One or more of: advertiser_id, campaign_id, adgroup_id, ad_id, stat_time_day, stat_time_hour.
Metricsmetricslist
Metrics.One or more of: spend, impressions, clicks, ctr, cpc, cpm, conversion, cost_per_conversion, conversion_rate.
Pagepagenumber
Page.At least 1.
Page sizepage_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Task IDtask_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Pagepagenumber
Page.At least 1.
Page sizepage_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Pagepagenumber
Page.At least 1.
Page sizepage_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Pagepagenumber
Page.At least 1.
Page sizepage_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Pagepagenumber
Page.At least 1.
Page sizepage_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Pagepagenumber
Page.At least 1.
Page sizepage_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Ad IDsad_idslistRequired
Ad ids.
Operation statusoperation_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Adgroup IDsadgroup_idslistRequired
Adgroup ids.
Operation statusoperation_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 IDadvertiser_idtext
Advertiser ID. Leave empty to use the connected advertiser.
Campaign IDscampaign_idslistRequired
Campaign ids.
Operation statusoperation_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
}

On this page