/the-trade-desk | Type: Application | PCID required: Yes
Tools
the_trade_desk_create_ad_group
Create a new ad group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AdGroupName | string | Yes | — | Display name of the ad group |
AssociatedBidLists | any[] | No | — | Bid lists associated with this ad group |
CampaignId | string | Yes | — | ID of the campaign this ad group belongs to |
CreativeIds | any[] | No | — | Creative IDs to associate with this ad group |
Description | string | No | — | Optional description |
IndustryCategoryId | integer | No | — | Industry category ID |
IsEnabled | boolean | No | — | Whether the ad group is enabled |
RTBAttributes | object | No | — | RTB Attributes |
the_trade_desk_create_advertiser
Create a new advertiser Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AdvertiserName | string | Yes | — | Display name of the advertiser |
CurrencyCode | string | Yes | — | Currency code for the advertiser (e.g., USD, EUR) |
Description | string | No | — | Optional description of the advertiser |
DomainAddress | string | No | — | Primary website URL for the advertiser |
IndustryCategoryId | integer | No | — | Industry category ID for the advertiser |
PartnerId | string | Yes | — | ID of the partner that owns this advertiser |
the_trade_desk_create_audience
Create a new audience segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AdvertiserId | string | Yes | — | ID of the advertiser that owns this audience |
AudienceName | string | Yes | — | Display name of the audience |
Description | string | No | — | Optional description |
the_trade_desk_create_bid_list
Create a new bid list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AdvertiserId | string | No | — | Advertiser ID (required if BidListOwner is Advertiser) |
BidListAdjustmentType | string | No | — | Type of bid adjustment |
BidListName | string | Yes | — | Display name of the bid list |
BidListOwner | string | Yes | — | Owner type (Advertiser or Partner) |
BidListSource | string | No | — | Source of the bid list |
Description | string | No | — | The description value |
PartnerId | string | No | — | Partner ID (required if BidListOwner is Partner) |
the_trade_desk_create_campaign
Create a new campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AdvertiserId | string | Yes | — | ID of the advertiser that owns this campaign |
Budget | object | Yes | — | The budget value |
CampaignConversionReportingColumns | any[] | No | — | Conversion reporting column IDs to associate |
CampaignName | string | Yes | — | Display name of the campaign |
DailyBudget | object | No | — | Daily Budget |
Description | string | No | — | Optional campaign description |
EndDate | string | No | — | Campaign end date in UTC (ISO 8601 format) |
FrequencyConfig | object | No | — | Frequency Config |
PacingMode | string | No | — | Budget pacing mode |
PartnerCostPercentageFee | number | No | — | Partner cost percentage fee |
StartDate | string | Yes | — | Campaign start date in UTC (ISO 8601 format) |
the_trade_desk_create_campaign_flight
Create a campaign flight (budget allocation period) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
BudgetInAdvertiserCurrency | number | Yes | — | Budget amount in the advertiser’s currency |
CampaignId | string | Yes | — | ID of the campaign this flight belongs to |
DailyTargetInAdvertiserCurrency | number | No | — | Daily budget target |
EndDate | string | No | — | Flight end date in UTC |
StartDate | string | Yes | — | Flight start date in UTC |
the_trade_desk_create_creative
Create a new creative Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AdvertiserId | string | Yes | — | ID of the advertiser that owns this creative |
Attributes | object | No | — | The attributes value |
Availability | string | Yes | — | Creative availability status |
CreativeName | string | Yes | — | Display name of the creative |
Description | string | No | — | Optional description |
IsHTTPS | boolean | No | — | Whether the creative serves over HTTPS |
LandingPageUrl | string | No | — | Click-through URL |
Tag | string | No | — | The ad tag or creative markup |
ThirdPartyTags | any[] | No | — | Third-party tracking tags |
the_trade_desk_delete_bid_list
Delete a bid list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bidListId | string | Yes | — | The bid list ID |
the_trade_desk_get_ad_group
Retrieve an ad group by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
adGroupId | string | Yes | — | The ad group ID |
the_trade_desk_get_ad_group_status
Get the status of an ad group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
adGroupId | string | Yes | — | The ad group ID |
the_trade_desk_get_advertiser
Retrieve an advertiser by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
advertiserId | string | Yes | — | The advertiser ID |
the_trade_desk_get_audience
Retrieve an audience by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
audienceId | string | Yes | — | The audience ID |
the_trade_desk_get_bid_list
Retrieve a bid list by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bidListId | string | Yes | — | The bid list ID |
the_trade_desk_get_campaign
Retrieve a campaign by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaignId | string | Yes | — | The campaign ID |
the_trade_desk_get_campaign_flight
Retrieve a campaign flight by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaignFlightId | string | Yes | — | The campaign flight ID |
the_trade_desk_get_campaign_metrics
Get performance metrics for a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaignId | string | Yes | — | The campaign ID |
the_trade_desk_get_creative
Retrieve a creative by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
creativeId | string | Yes | — | The creative ID |
the_trade_desk_query_ad_groups_by_campaign
Query ad groups by campaign ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CampaignId | string | Yes | — | ID of the campaign to query ad groups for |
PageSize | integer | No | — | Number of results per page |
PageStartIndex | integer | No | — | Page Start Index |
SearchTerms | any[] | No | — | Optional search terms to filter ad groups by name |
the_trade_desk_query_advertisers_by_partner
Query advertisers by partner ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
PageSize | integer | No | — | Number of results per page |
PageStartIndex | integer | No | — | Zero-based index of the first result to return |
PartnerId | string | Yes | — | ID of the partner to query advertisers for |
SearchTerms | any[] | No | — | Optional search terms to filter advertisers by name |
the_trade_desk_query_campaigns_by_advertiser
Query campaigns by advertiser ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AdvertiserId | string | Yes | — | ID of the advertiser to query campaigns for |
PageSize | integer | No | — | Number of results per page |
PageStartIndex | integer | No | — | Page Start Index |
SearchTerms | any[] | No | — | Optional search terms to filter campaigns by name |
the_trade_desk_query_creatives_by_advertiser
Query creatives by advertiser ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AdvertiserId | string | Yes | — | ID of the advertiser to query creatives for |
PageSize | integer | No | — | Number of results per page |
PageStartIndex | integer | No | — | Page Start Index |
SearchTerms | any[] | No | — | Optional search terms to filter by name |
the_trade_desk_update_ad_group
Update an existing ad group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AdGroupId | string | Yes | — | ID of the ad group to update |
AdGroupName | string | No | — | Ad Group Name |
AssociatedBidLists | any[] | No | — | Associated Bid Lists |
CreativeIds | any[] | No | — | Creative Ids |
Description | string | No | — | The description value |
IndustryCategoryId | integer | No | — | Industry Category Id |
IsEnabled | boolean | No | — | Is Enabled |
RTBAttributes | object | No | — | RTB Attributes |
the_trade_desk_update_advertiser
Update an existing advertiser Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AdvertiserId | string | Yes | — | ID of the advertiser to update |
AdvertiserName | string | No | — | Updated display name |
Description | string | No | — | Updated description |
DomainAddress | string | No | — | Updated primary website URL |
IndustryCategoryId | integer | No | — | Updated industry category ID |
the_trade_desk_update_audience
Update an existing audience Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AudienceId | string | Yes | — | ID of the audience to update |
AudienceName | string | No | — | Audience Name |
Description | string | No | — | The description value |
the_trade_desk_update_bid_list
Update an existing bid list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
BidListId | string | Yes | — | ID of the bid list to update |
BidListName | string | No | — | Bid List Name |
Description | string | No | — | The description value |
the_trade_desk_update_campaign
Update an existing campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Budget | object | No | — | The budget value |
CampaignId | string | Yes | — | ID of the campaign to update |
CampaignName | string | No | — | Updated display name |
DailyBudget | object | No | — | Daily Budget |
Description | string | No | — | The description value |
EndDate | string | No | — | Updated end date |
FrequencyConfig | object | No | — | Frequency Config |
PacingMode | string | No | — | Pacing Mode |
StartDate | string | No | — | Updated start date |
the_trade_desk_update_campaign_flight
Update a campaign flight Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
BudgetInAdvertiserCurrency | number | No | — | Budget In Advertiser Currency |
CampaignFlightId | string | Yes | — | ID of the campaign flight to update |
DailyTargetInAdvertiserCurrency | number | No | — | Daily Target In Advertiser Currency |
EndDate | string | No | — | End date for filtering |
StartDate | string | No | — | Start date for filtering |
the_trade_desk_update_creative
Update an existing creative Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Attributes | object | No | — | The attributes value |
Availability | string | No | — | The availability value |
CreativeId | string | Yes | — | ID of the creative to update |
CreativeName | string | No | — | Creative Name |
Description | string | No | — | The description value |
IsHTTPS | boolean | No | — | Is HTTPS |
LandingPageUrl | string | No | — | Landing Page Url |
Tag | string | No | — | The tag value |
ThirdPartyTags | any[] | No | — | Third Party Tags |

