Skip to main content
Server path: /the-trade-desk | Type: Application | PCID required: Yes

Tools

ToolDescription
the_trade_desk_create_ad_groupCreate a new ad group
the_trade_desk_create_advertiserCreate a new advertiser
the_trade_desk_create_audienceCreate a new audience segment
the_trade_desk_create_bid_listCreate a new bid list
the_trade_desk_create_campaignCreate a new campaign
the_trade_desk_create_campaign_flightCreate a campaign flight (budget allocation period)
the_trade_desk_create_creativeCreate a new creative
the_trade_desk_delete_bid_listDelete a bid list
the_trade_desk_get_ad_groupRetrieve an ad group by ID
the_trade_desk_get_ad_group_statusGet the status of an ad group
the_trade_desk_get_advertiserRetrieve an advertiser by ID
the_trade_desk_get_audienceRetrieve an audience by ID
the_trade_desk_get_bid_listRetrieve a bid list by ID
the_trade_desk_get_campaignRetrieve a campaign by ID
the_trade_desk_get_campaign_flightRetrieve a campaign flight by ID
the_trade_desk_get_campaign_metricsGet performance metrics for a campaign
the_trade_desk_get_creativeRetrieve a creative by ID
the_trade_desk_query_ad_groups_by_campaignQuery ad groups by campaign ID
the_trade_desk_query_advertisers_by_partnerQuery advertisers by partner ID
the_trade_desk_query_campaigns_by_advertiserQuery campaigns by advertiser ID
the_trade_desk_query_creatives_by_advertiserQuery creatives by advertiser ID
the_trade_desk_update_ad_groupUpdate an existing ad group
the_trade_desk_update_advertiserUpdate an existing advertiser
the_trade_desk_update_audienceUpdate an existing audience
the_trade_desk_update_bid_listUpdate an existing bid list
the_trade_desk_update_campaignUpdate an existing campaign
the_trade_desk_update_campaign_flightUpdate a campaign flight
the_trade_desk_update_creativeUpdate an existing creative

the_trade_desk_create_ad_group

Create a new ad group Parameters:
ParameterTypeRequiredDefaultDescription
AdGroupNamestringYesDisplay name of the ad group
AssociatedBidListsany[]NoBid lists associated with this ad group
CampaignIdstringYesID of the campaign this ad group belongs to
CreativeIdsany[]NoCreative IDs to associate with this ad group
DescriptionstringNoOptional description
IndustryCategoryIdintegerNoIndustry category ID
IsEnabledbooleanNoWhether the ad group is enabled
RTBAttributesobjectNoRTB Attributes

the_trade_desk_create_advertiser

Create a new advertiser Parameters:
ParameterTypeRequiredDefaultDescription
AdvertiserNamestringYesDisplay name of the advertiser
CurrencyCodestringYesCurrency code for the advertiser (e.g., USD, EUR)
DescriptionstringNoOptional description of the advertiser
DomainAddressstringNoPrimary website URL for the advertiser
IndustryCategoryIdintegerNoIndustry category ID for the advertiser
PartnerIdstringYesID of the partner that owns this advertiser

the_trade_desk_create_audience

Create a new audience segment Parameters:
ParameterTypeRequiredDefaultDescription
AdvertiserIdstringYesID of the advertiser that owns this audience
AudienceNamestringYesDisplay name of the audience
DescriptionstringNoOptional description

the_trade_desk_create_bid_list

Create a new bid list Parameters:
ParameterTypeRequiredDefaultDescription
AdvertiserIdstringNoAdvertiser ID (required if BidListOwner is Advertiser)
BidListAdjustmentTypestringNoType of bid adjustment
BidListNamestringYesDisplay name of the bid list
BidListOwnerstringYesOwner type (Advertiser or Partner)
BidListSourcestringNoSource of the bid list
DescriptionstringNoThe description value
PartnerIdstringNoPartner ID (required if BidListOwner is Partner)

the_trade_desk_create_campaign

Create a new campaign Parameters:
ParameterTypeRequiredDefaultDescription
AdvertiserIdstringYesID of the advertiser that owns this campaign
BudgetobjectYesThe budget value
CampaignConversionReportingColumnsany[]NoConversion reporting column IDs to associate
CampaignNamestringYesDisplay name of the campaign
DailyBudgetobjectNoDaily Budget
DescriptionstringNoOptional campaign description
EndDatestringNoCampaign end date in UTC (ISO 8601 format)
FrequencyConfigobjectNoFrequency Config
PacingModestringNoBudget pacing mode
PartnerCostPercentageFeenumberNoPartner cost percentage fee
StartDatestringYesCampaign start date in UTC (ISO 8601 format)

the_trade_desk_create_campaign_flight

Create a campaign flight (budget allocation period) Parameters:
ParameterTypeRequiredDefaultDescription
BudgetInAdvertiserCurrencynumberYesBudget amount in the advertiser’s currency
CampaignIdstringYesID of the campaign this flight belongs to
DailyTargetInAdvertiserCurrencynumberNoDaily budget target
EndDatestringNoFlight end date in UTC
StartDatestringYesFlight start date in UTC

the_trade_desk_create_creative

Create a new creative Parameters:
ParameterTypeRequiredDefaultDescription
AdvertiserIdstringYesID of the advertiser that owns this creative
AttributesobjectNoThe attributes value
AvailabilitystringYesCreative availability status
CreativeNamestringYesDisplay name of the creative
DescriptionstringNoOptional description
IsHTTPSbooleanNoWhether the creative serves over HTTPS
LandingPageUrlstringNoClick-through URL
TagstringNoThe ad tag or creative markup
ThirdPartyTagsany[]NoThird-party tracking tags

the_trade_desk_delete_bid_list

Delete a bid list Parameters:
ParameterTypeRequiredDefaultDescription
bidListIdstringYesThe bid list ID

the_trade_desk_get_ad_group

Retrieve an ad group by ID Parameters:
ParameterTypeRequiredDefaultDescription
adGroupIdstringYesThe ad group ID

the_trade_desk_get_ad_group_status

Get the status of an ad group Parameters:
ParameterTypeRequiredDefaultDescription
adGroupIdstringYesThe ad group ID

the_trade_desk_get_advertiser

Retrieve an advertiser by ID Parameters:
ParameterTypeRequiredDefaultDescription
advertiserIdstringYesThe advertiser ID

the_trade_desk_get_audience

Retrieve an audience by ID Parameters:
ParameterTypeRequiredDefaultDescription
audienceIdstringYesThe audience ID

the_trade_desk_get_bid_list

Retrieve a bid list by ID Parameters:
ParameterTypeRequiredDefaultDescription
bidListIdstringYesThe bid list ID

the_trade_desk_get_campaign

Retrieve a campaign by ID Parameters:
ParameterTypeRequiredDefaultDescription
campaignIdstringYesThe campaign ID

the_trade_desk_get_campaign_flight

Retrieve a campaign flight by ID Parameters:
ParameterTypeRequiredDefaultDescription
campaignFlightIdstringYesThe campaign flight ID

the_trade_desk_get_campaign_metrics

Get performance metrics for a campaign Parameters:
ParameterTypeRequiredDefaultDescription
campaignIdstringYesThe campaign ID

the_trade_desk_get_creative

Retrieve a creative by ID Parameters:
ParameterTypeRequiredDefaultDescription
creativeIdstringYesThe creative ID

the_trade_desk_query_ad_groups_by_campaign

Query ad groups by campaign ID Parameters:
ParameterTypeRequiredDefaultDescription
CampaignIdstringYesID of the campaign to query ad groups for
PageSizeintegerNoNumber of results per page
PageStartIndexintegerNoPage Start Index
SearchTermsany[]NoOptional search terms to filter ad groups by name

the_trade_desk_query_advertisers_by_partner

Query advertisers by partner ID Parameters:
ParameterTypeRequiredDefaultDescription
PageSizeintegerNoNumber of results per page
PageStartIndexintegerNoZero-based index of the first result to return
PartnerIdstringYesID of the partner to query advertisers for
SearchTermsany[]NoOptional search terms to filter advertisers by name

the_trade_desk_query_campaigns_by_advertiser

Query campaigns by advertiser ID Parameters:
ParameterTypeRequiredDefaultDescription
AdvertiserIdstringYesID of the advertiser to query campaigns for
PageSizeintegerNoNumber of results per page
PageStartIndexintegerNoPage Start Index
SearchTermsany[]NoOptional search terms to filter campaigns by name

the_trade_desk_query_creatives_by_advertiser

Query creatives by advertiser ID Parameters:
ParameterTypeRequiredDefaultDescription
AdvertiserIdstringYesID of the advertiser to query creatives for
PageSizeintegerNoNumber of results per page
PageStartIndexintegerNoPage Start Index
SearchTermsany[]NoOptional search terms to filter by name

the_trade_desk_update_ad_group

Update an existing ad group Parameters:
ParameterTypeRequiredDefaultDescription
AdGroupIdstringYesID of the ad group to update
AdGroupNamestringNoAd Group Name
AssociatedBidListsany[]NoAssociated Bid Lists
CreativeIdsany[]NoCreative Ids
DescriptionstringNoThe description value
IndustryCategoryIdintegerNoIndustry Category Id
IsEnabledbooleanNoIs Enabled
RTBAttributesobjectNoRTB Attributes

the_trade_desk_update_advertiser

Update an existing advertiser Parameters:
ParameterTypeRequiredDefaultDescription
AdvertiserIdstringYesID of the advertiser to update
AdvertiserNamestringNoUpdated display name
DescriptionstringNoUpdated description
DomainAddressstringNoUpdated primary website URL
IndustryCategoryIdintegerNoUpdated industry category ID

the_trade_desk_update_audience

Update an existing audience Parameters:
ParameterTypeRequiredDefaultDescription
AudienceIdstringYesID of the audience to update
AudienceNamestringNoAudience Name
DescriptionstringNoThe description value

the_trade_desk_update_bid_list

Update an existing bid list Parameters:
ParameterTypeRequiredDefaultDescription
BidListIdstringYesID of the bid list to update
BidListNamestringNoBid List Name
DescriptionstringNoThe description value

the_trade_desk_update_campaign

Update an existing campaign Parameters:
ParameterTypeRequiredDefaultDescription
BudgetobjectNoThe budget value
CampaignIdstringYesID of the campaign to update
CampaignNamestringNoUpdated display name
DailyBudgetobjectNoDaily Budget
DescriptionstringNoThe description value
EndDatestringNoUpdated end date
FrequencyConfigobjectNoFrequency Config
PacingModestringNoPacing Mode
StartDatestringNoUpdated start date

the_trade_desk_update_campaign_flight

Update a campaign flight Parameters:
ParameterTypeRequiredDefaultDescription
BudgetInAdvertiserCurrencynumberNoBudget In Advertiser Currency
CampaignFlightIdstringYesID of the campaign flight to update
DailyTargetInAdvertiserCurrencynumberNoDaily Target In Advertiser Currency
EndDatestringNoEnd date for filtering
StartDatestringNoStart date for filtering

the_trade_desk_update_creative

Update an existing creative Parameters:
ParameterTypeRequiredDefaultDescription
AttributesobjectNoThe attributes value
AvailabilitystringNoThe availability value
CreativeIdstringYesID of the creative to update
CreativeNamestringNoCreative Name
DescriptionstringNoThe description value
IsHTTPSbooleanNoIs HTTPS
LandingPageUrlstringNoLanding Page Url
TagstringNoThe tag value
ThirdPartyTagsany[]NoThird Party Tags