The Trade Desk

App · 20 actions

Manage advertisers, campaigns, flights, ad groups and creatives in The Trade Desk, and follow their changes.

Actions

ActionWhat it does
Add campaign flightAdd a date range with its own budget to a campaign that already has a flight.
Archive ad groupArchive an ad group so it stops and is hidden.
Archive campaignArchive a campaign so it stops and is hidden.
Create ad groupCreate an ad group in a campaign.
Create campaignCreate a campaign with one flight.
Delete campaign flightDelete a flight that hasn't started.
Get ad groupGet an ad group's details, including its bids and whether it is turned on.
Get advertiserGet an advertiser's details, including its currency.
Get campaignGet a campaign's details, including its budget and flights.
Get campaign pacing and goal metricsGet how a campaign is pacing against its budget and how it is doing against its goal over the last four weeks.
Get creativeGet a creative's details and its review status with each ad exchange.
List ad groupsList a campaign's ad groups.
List advertisersList the advertisers (brands) under a partner.
List campaignsList an advertiser's campaigns, newest first.
List creativesList an advertiser's creatives (the ads themselves) with their review status.
List partnersList the partners (seats) your token can reach.
Turn ad group on or offTurn an ad group on so it can spend, or off so it stops.
Update ad groupChange an ad group's name or description.
Update campaignChange a campaign's name, description, pacing, channel or purchase order number.
Update campaign flightChange 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

Campaigncampaign_idtextRequired
The campaign.
Startstart_datedate and timeRequired
When the flight starts.
Endend_datedate and time
When the flight ends.
BudgetbudgetnumberRequired
The most the flight may spend, in the advertiser's currency.At least 0.
Daily spend targetdaily_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 groupad_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

Campaigncampaign_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

Campaigncampaign_idtextRequired
The campaign.
NamenametextRequired
The ad group's name.
ChannelchanneltextRequired
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.
Descriptiondescriptiontext
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

Advertiseradvertiser_idtextRequired
The advertiser.
NamenametextRequired
The campaign's name.
BudgetbudgetnumberRequired
The most the campaign may spend, in the advertiser's currency.At least 0.
Startstart_datedate and timeRequired
When the campaign starts spending.
Endend_datedate and time
When the campaign stops spending, if its budget isn't used up first.
ChannelchanneltextRequired
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).
GoalgoaltextRequired
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 targetgoal_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.
Descriptiondescriptiontext
A note about the campaign.
Pacingpacingtext
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 numberpurchase_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 flightcampaign_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 groupad_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

Advertiseradvertiser_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

Campaigncampaign_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

Campaigncampaign_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

Creativecreative_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

Campaigncampaign_idtextRequired
The campaign.
Search termssearch_termslist
Only return records whose name or description contains every one of these words.
Statusavailabilitylist
Show active records, archived ones, or both. Leave empty for active only.One or more of: Available (Active), Archived.
Start at recordpage_startnumber
How many records to skip, for reading the next page. Leave empty to start at the first record.At least 0.
Records per pagepage_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

Partnerpartner_idtextRequired
The partner (your seat in The Trade Desk) the advertisers belong to.
Search termssearch_termslist
Only return records whose name or description contains every one of these words.
Statusavailabilitylist
Show active records, archived ones, or both. Leave empty for active only.One or more of: Available (Active), Archived.
Start at recordpage_startnumber
How many records to skip, for reading the next page. Leave empty to start at the first record.At least 0.
Records per pagepage_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

Advertiseradvertiser_idtextRequired
The advertiser.
Search termssearch_termslist
Only return records whose name or description contains every one of these words.
Statusavailabilitylist
Show active records, archived ones, or both. Leave empty for active only.One or more of: Available (Active), Archived.
Start at recordpage_startnumber
How many records to skip, for reading the next page. Leave empty to start at the first record.At least 0.
Records per pagepage_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

Advertiseradvertiser_idtextRequired
The advertiser.
Search termssearch_termslist
Only return records whose name or description contains every one of these words.
Statusavailabilitylist
Show active records, archived ones, or both. Leave empty for active only.One or more of: Available (Active), Archived.
Start at recordpage_startnumber
How many records to skip, for reading the next page. Leave empty to start at the first record.At least 0.
Records per pagepage_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 termssearch_termslist
Only return records whose name or description contains every one of these words.
Start at recordpage_startnumber
How many records to skip, for reading the next page. Leave empty to start at the first record.At least 0.
Records per pagepage_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 groupad_group_idtextRequired
The ad group.
Onenabledtrue/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 groupad_group_idtextRequired
The ad group.
Namenametext
The new name.
Descriptiondescriptiontext
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

Campaigncampaign_idtextRequired
The campaign.
Namenametext
The new name.
Descriptiondescriptiontext
The new description.
Pacingpacingtext
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)).
Channelchanneltext
Where the ads run.One of: Display, Video, Audio, TV, NativeDisplay (Native display), NativeVideo (Native video), DigitalOutOfHome (Digital out-of-home).
Purchase order numberpurchase_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 flightcampaign_flight_idnumberRequired
The campaign flight: one of the campaign's date ranges with its own budget.At least 1.
Startstart_datedate and time
When the flight starts.
Endend_datedate and time
When the flight ends.
Budgetbudgetnumber
The most the flight may spend, in the advertiser's currency.At least 0.
Daily spend targetdaily_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"
  }
}

On this page