The Trade Desk
App · 20 actions
Manage advertisers, campaigns, flights, ad groups and creatives in The Trade Desk, and follow their changes.
Actions
| Action | What it does |
|---|---|
| Add campaign flight | Add a date range with its own budget to a campaign that already has a flight. |
| Archive ad group | Archive an ad group so it stops and is hidden. |
| Archive campaign | Archive a campaign so it stops and is hidden. |
| Create ad group | Create an ad group in a campaign. |
| Create campaign | Create a campaign with one flight. |
| Delete campaign flight | Delete a flight that hasn't started. |
| Get ad group | Get an ad group's details, including its bids and whether it is turned on. |
| Get advertiser | Get an advertiser's details, including its currency. |
| Get campaign | Get a campaign's details, including its budget and flights. |
| Get campaign pacing and goal metrics | Get how a campaign is pacing against its budget and how it is doing against its goal over the last four weeks. |
| Get creative | Get a creative's details and its review status with each ad exchange. |
| List ad groups | List a campaign's ad groups. |
| List advertisers | List the advertisers (brands) under a partner. |
| List campaigns | List an advertiser's campaigns, newest first. |
| List creatives | List an advertiser's creatives (the ads themselves) with their review status. |
| List partners | List the partners (seats) your token can reach. |
| Turn ad group on or off | Turn an ad group on so it can spend, or off so it stops. |
| Update ad group | Change an ad group's name or description. |
| Update campaign | Change a campaign's name, description, pacing, channel or purchase order number. |
| Update campaign flight | Change a flight's dates or budget. |
Add campaign flight
Add a date range with its own budget to a campaign that already has a flight.
Inputs
- Campaign
campaign_idtextRequired - The campaign.
- Start
start_datedate and timeRequired - When the flight starts.
- End
end_datedate and time - When the flight ends.
- Budget
budgetnumberRequired - The most the flight may spend, in the advertiser's currency.At least 0.
- Daily spend target
daily_targetnumber - The most the flight should spend in a day, in the advertiser's currency.At least 0.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"BudgetInAdvertiserCurrency": 1,
"CampaignFlightId": 1,
"CampaignId": "example",
"DailyTargetInAdvertiserCurrency": 1,
"EndDateExclusiveUTC": "example",
"StartDateInclusiveUTC": "example"
}
}Archive ad group
Archive an ad group so it stops and is hidden. This can't be undone.
Inputs
- Ad group
ad_group_idtextRequired - The ad group.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"AdGroupId": "example",
"AdGroupName": "example",
"Availability": "example",
"CampaignId": "example",
"ChannelId": "example",
"CreatedAtUTC": "example",
"Description": "example",
"IsEnabled": true,
"LastUpdatedAtUTC": "example"
}
}Archive campaign
Archive a campaign so it stops and is hidden. This can't be undone, and a campaign with an ad group that is turned on can't be archived.
Inputs
- Campaign
campaign_idtextRequired - The campaign.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"AdvertiserId": "example",
"Availability": "example",
"Budget": {
"Amount": 1,
"CurrencyCode": "example"
},
"CampaignFlights": [
{
"BudgetInAdvertiserCurrency": 1,
"CampaignFlightId": 1,
"CampaignId": "example",
"DailyTargetInAdvertiserCurrency": 1,
"EndDateExclusiveUTC": "example",
"StartDateInclusiveUTC": "example"
}
],
"CampaignId": "example",
"CampaignName": "example",
"CreatedAtUTC": "example",
"Description": "example",
"EndDate": "example",
"LastUpdatedAtUTC": "example",
"PacingMode": "example",
"PrimaryChannel": "example",
"PurchaseOrderNumber": "example",
"StartDate": "example"
}
}Create ad group
Create an ad group in a campaign. It is created turned off, so it spends nothing until you turn it on.
Inputs
- Campaign
campaign_idtextRequired - The campaign.
- Name
nametextRequired - The ad group's name.
- Channel
channeltextRequired - Where the ads run. Match the campaign's channel.One of:
Display,Video,Audio,TV,NativeDisplay(Native display),NativeVideo(Native video),OutOfHome(Out-of-home). - Base bid (CPM)
base_bidnumberRequired - The usual bid per thousand impressions, in the advertiser's currency.At least 0.
- Maximum bid (CPM)
max_bidnumberRequired - The most the ad group will ever bid per thousand impressions, in the advertiser's currency.At least 0.
- Description
descriptiontext - A note about the ad group.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"AdGroupId": "example",
"AdGroupName": "example",
"Availability": "example",
"CampaignId": "example",
"ChannelId": "example",
"CreatedAtUTC": "example",
"Description": "example",
"IsEnabled": true,
"LastUpdatedAtUTC": "example"
}
}Create campaign
Create a campaign with one flight. It spends nothing until it has an ad group that is turned on.
Inputs
- Advertiser
advertiser_idtextRequired - The advertiser.
- Name
nametextRequired - The campaign's name.
- Budget
budgetnumberRequired - The most the campaign may spend, in the advertiser's currency.At least 0.
- Start
start_datedate and timeRequired - When the campaign starts spending.
- End
end_datedate and time - When the campaign stops spending, if its budget isn't used up first.
- Channel
channeltextRequired - Where the ads run. Each ad group in the campaign must use the same channel.One of:
Display,Video,Audio,TV,NativeDisplay(Native display),NativeVideo(Native video),DigitalOutOfHome(Digital out-of-home). - Goal
goaltextRequired - What The Trade Desk should optimize the campaign for.One of:
MaximizeReach(Reach as many people as possible),CPAInAdvertiserCurrency(Cost per acquisition),CPCInAdvertiserCurrency(Cost per click),CPCVInAdvertiserCurrency(Cost per completed view),VCPMInAdvertiserCurrency(Cost per thousand viewable impressions),CTRInPercent(Click-through rate (%)),VCRInPercent(Video completion rate (%)),ViewabilityInPercent(Viewability (%)),ReturnOnAdSpendPercent(Return on ad spend (%)). - Goal target
goal_targetnumber - The target for the goal: an amount in the advertiser's currency, or a percentage (1 means 1%). Not needed for reach.At least 0.
- Description
descriptiontext - A note about the campaign.
- Pacing
pacingtext - How the budget is spread over the flight.One of:
PaceToEndOfFlight(Spread evenly to the end of the flight),PaceAhead(Spend slightly ahead of schedule),PaceAsSoonAsPossible(Spend as soon as possible),Off(No pacing (set daily targets on the flights)). - Purchase order number
purchase_order_numbertext - Your own reference, such as a purchase order number.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"AdvertiserId": "example",
"Availability": "example",
"Budget": {
"Amount": 1,
"CurrencyCode": "example"
},
"CampaignFlights": [
{
"BudgetInAdvertiserCurrency": 1,
"CampaignFlightId": 1,
"CampaignId": "example",
"DailyTargetInAdvertiserCurrency": 1,
"EndDateExclusiveUTC": "example",
"StartDateInclusiveUTC": "example"
}
],
"CampaignId": "example",
"CampaignName": "example",
"CreatedAtUTC": "example",
"Description": "example",
"EndDate": "example",
"LastUpdatedAtUTC": "example",
"PacingMode": "example",
"PrimaryChannel": "example",
"PurchaseOrderNumber": "example",
"StartDate": "example"
}
}Delete campaign flight
Delete a flight that hasn't started. A campaign's only flight can't be deleted.
Inputs
- Campaign flight
campaign_flight_idnumberRequired - The campaign flight: one of the campaign's date ranges with its own budget.At least 1.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {}
}Get ad group
Get an ad group's details, including its bids and whether it is turned on.
Inputs
- Ad group
ad_group_idtextRequired - The ad group.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"AdGroupId": "example",
"AdGroupName": "example",
"Availability": "example",
"CampaignId": "example",
"ChannelId": "example",
"CreatedAtUTC": "example",
"Description": "example",
"IsEnabled": true,
"LastUpdatedAtUTC": "example"
}
}Get advertiser
Get an advertiser's details, including its currency.
Inputs
- Advertiser
advertiser_idtextRequired - The advertiser.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"AdvertiserId": "example",
"AdvertiserName": "example",
"Availability": "example",
"CurrencyCode": "example",
"Description": "example",
"DomainAddress": "example",
"PartnerId": "example"
}
}Get campaign
Get a campaign's details, including its budget and flights.
Inputs
- Campaign
campaign_idtextRequired - The campaign.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"AdvertiserId": "example",
"Availability": "example",
"Budget": {
"Amount": 1,
"CurrencyCode": "example"
},
"CampaignFlights": [
{
"BudgetInAdvertiserCurrency": 1,
"CampaignFlightId": 1,
"CampaignId": "example",
"DailyTargetInAdvertiserCurrency": 1,
"EndDateExclusiveUTC": "example",
"StartDateInclusiveUTC": "example"
}
],
"CampaignId": "example",
"CampaignName": "example",
"CreatedAtUTC": "example",
"Description": "example",
"EndDate": "example",
"LastUpdatedAtUTC": "example",
"PacingMode": "example",
"PrimaryChannel": "example",
"PurchaseOrderNumber": "example",
"StartDate": "example"
}
}Get campaign pacing and goal metrics
Get how a campaign is pacing against its budget and how it is doing against its goal over the last four weeks.
Inputs
- Campaign
campaign_idtextRequired - The campaign.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"CampaignFlightId": 1,
"CampaignId": "example",
"GoalInfo": {},
"Pacing": {}
}
}Get creative
Get a creative's details and its review status with each ad exchange.
Inputs
- Creative
creative_idtextRequired - The creative (the ad itself: an image, video, audio or tag).
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"AdvertiserId": "example",
"Availability": "example",
"CreatedAtUTC": "example",
"CreativeAuditStatuses": [
{
"AuditStatus": "example",
"CreativeAuditor": "example",
"ReasonForStatus": "example"
}
],
"CreativeId": "example",
"CreativeName": "example",
"CreativeType": "example",
"Description": "example",
"LastUpdatedAtUTC": "example"
}
}List ad groups
List a campaign's ad groups.
Inputs
- Campaign
campaign_idtextRequired - The campaign.
- Search terms
search_termslist - Only return records whose name or description contains every one of these words.
- Status
availabilitylist - Show active records, archived ones, or both. Leave empty for active only.One or more of:
Available(Active),Archived. - Start at record
page_startnumber - How many records to skip, for reading the next page. Leave empty to start at the first record.At least 0.
- Records per page
page_sizenumber - How many records to return, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"Result": [
{
"AdGroupId": "example",
"AdGroupName": "example",
"Availability": "example",
"CampaignId": "example",
"ChannelId": "example",
"CreatedAtUTC": "example",
"Description": "example",
"IsEnabled": true,
"LastUpdatedAtUTC": "example"
}
],
"ResultCount": 1,
"TotalFilteredCount": 1,
"TotalUnfilteredCount": 1
}
}List advertisers
List the advertisers (brands) under a partner.
Inputs
- Partner
partner_idtextRequired - The partner (your seat in The Trade Desk) the advertisers belong to.
- Search terms
search_termslist - Only return records whose name or description contains every one of these words.
- Status
availabilitylist - Show active records, archived ones, or both. Leave empty for active only.One or more of:
Available(Active),Archived. - Start at record
page_startnumber - How many records to skip, for reading the next page. Leave empty to start at the first record.At least 0.
- Records per page
page_sizenumber - How many records to return, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"Result": [
{
"AdvertiserId": "example",
"AdvertiserName": "example",
"Availability": "example",
"CurrencyCode": "example",
"Description": "example",
"DomainAddress": "example",
"PartnerId": "example"
}
],
"ResultCount": 1,
"TotalFilteredCount": 1,
"TotalUnfilteredCount": 1
}
}List campaigns
List an advertiser's campaigns, newest first.
Inputs
- Advertiser
advertiser_idtextRequired - The advertiser.
- Search terms
search_termslist - Only return records whose name or description contains every one of these words.
- Status
availabilitylist - Show active records, archived ones, or both. Leave empty for active only.One or more of:
Available(Active),Archived. - Start at record
page_startnumber - How many records to skip, for reading the next page. Leave empty to start at the first record.At least 0.
- Records per page
page_sizenumber - How many records to return, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"Result": [
{
"AdvertiserId": "example",
"Availability": "example",
"Budget": {
"Amount": 1,
"CurrencyCode": "example"
},
"CampaignFlights": [
{
"BudgetInAdvertiserCurrency": 1,
"CampaignFlightId": 1,
"CampaignId": "example",
"DailyTargetInAdvertiserCurrency": 1,
"EndDateExclusiveUTC": "example",
"StartDateInclusiveUTC": "example"
}
],
"CampaignId": "example",
"CampaignName": "example",
"CreatedAtUTC": "example",
"Description": "example",
"EndDate": "example",
"LastUpdatedAtUTC": "example",
"PacingMode": "example",
"PrimaryChannel": "example",
"PurchaseOrderNumber": "example",
"StartDate": "example"
}
],
"ResultCount": 1,
"TotalFilteredCount": 1,
"TotalUnfilteredCount": 1
}
}List creatives
List an advertiser's creatives (the ads themselves) with their review status.
Inputs
- Advertiser
advertiser_idtextRequired - The advertiser.
- Search terms
search_termslist - Only return records whose name or description contains every one of these words.
- Status
availabilitylist - Show active records, archived ones, or both. Leave empty for active only.One or more of:
Available(Active),Archived. - Start at record
page_startnumber - How many records to skip, for reading the next page. Leave empty to start at the first record.At least 0.
- Records per page
page_sizenumber - How many records to return, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"Result": [
{
"AdvertiserId": "example",
"Availability": "example",
"CreatedAtUTC": "example",
"CreativeAuditStatuses": [
{
"AuditStatus": "example",
"CreativeAuditor": "example",
"ReasonForStatus": "example"
}
],
"CreativeId": "example",
"CreativeName": "example",
"CreativeType": "example",
"Description": "example",
"LastUpdatedAtUTC": "example"
}
],
"ResultCount": 1,
"TotalFilteredCount": 1,
"TotalUnfilteredCount": 1
}
}List partners
List the partners (seats) your token can reach.
Inputs
- Search terms
search_termslist - Only return records whose name or description contains every one of these words.
- Start at record
page_startnumber - How many records to skip, for reading the next page. Leave empty to start at the first record.At least 0.
- Records per page
page_sizenumber - How many records to return, up to 1000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"Result": [
{
"PartnerId": "example",
"PartnerName": "example"
}
],
"ResultCount": 1,
"TotalFilteredCount": 1,
"TotalUnfilteredCount": 1
}
}Turn ad group on or off
Turn an ad group on so it can spend, or off so it stops.
Inputs
- Ad group
ad_group_idtextRequired - The ad group.
- On
enabledtrue/falseRequired - On lets the ad group spend; off stops it.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"AdGroupId": "example",
"IsEnabled": true
}
}Update ad group
Change an ad group's name or description. Fields left empty stay as they are.
Inputs
- Ad group
ad_group_idtextRequired - The ad group.
- Name
nametext - The new name.
- Description
descriptiontext - The new description.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"AdGroupId": "example",
"AdGroupName": "example",
"Availability": "example",
"CampaignId": "example",
"ChannelId": "example",
"CreatedAtUTC": "example",
"Description": "example",
"IsEnabled": true,
"LastUpdatedAtUTC": "example"
}
}Update campaign
Change a campaign's name, description, pacing, channel or purchase order number. Fields left empty stay as they are.
Inputs
- Campaign
campaign_idtextRequired - The campaign.
- Name
nametext - The new name.
- Description
descriptiontext - The new description.
- Pacing
pacingtext - How the budget is spread over the flight.One of:
PaceToEndOfFlight(Spread evenly to the end of the flight),PaceAhead(Spend slightly ahead of schedule),PaceAsSoonAsPossible(Spend as soon as possible),Off(No pacing (set daily targets on the flights)). - Channel
channeltext - Where the ads run.One of:
Display,Video,Audio,TV,NativeDisplay(Native display),NativeVideo(Native video),DigitalOutOfHome(Digital out-of-home). - Purchase order number
purchase_order_numbertext - Your own reference, such as a purchase order number.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"AdvertiserId": "example",
"Availability": "example",
"Budget": {
"Amount": 1,
"CurrencyCode": "example"
},
"CampaignFlights": [
{
"BudgetInAdvertiserCurrency": 1,
"CampaignFlightId": 1,
"CampaignId": "example",
"DailyTargetInAdvertiserCurrency": 1,
"EndDateExclusiveUTC": "example",
"StartDateInclusiveUTC": "example"
}
],
"CampaignId": "example",
"CampaignName": "example",
"CreatedAtUTC": "example",
"Description": "example",
"EndDate": "example",
"LastUpdatedAtUTC": "example",
"PacingMode": "example",
"PrimaryChannel": "example",
"PurchaseOrderNumber": "example",
"StartDate": "example"
}
}Update campaign flight
Change a flight's dates or budget. A flight that has ended can't be changed.
Inputs
- Campaign flight
campaign_flight_idnumberRequired - The campaign flight: one of the campaign's date ranges with its own budget.At least 1.
- Start
start_datedate and time - When the flight starts.
- End
end_datedate and time - When the flight ends.
- Budget
budgetnumber - The most the flight may spend, in the advertiser's currency.At least 0.
- Daily spend target
daily_targetnumber - The most the flight should spend in a day, in the advertiser's currency.At least 0.
Outputs
dataobject- The response from The Trade Desk.
Example output
{
"data": {
"BudgetInAdvertiserCurrency": 1,
"CampaignFlightId": 1,
"CampaignId": "example",
"DailyTargetInAdvertiserCurrency": 1,
"EndDateExclusiveUTC": "example",
"StartDateInclusiveUTC": "example"
}
}