Trade Desk Workflows

https://ttd-workflows.apidocumentation.com/
Admin
The Trade Desk Workflows Service provides a platform for defining, managing, and interacting with...
Tokens:1,536
Snippets:14
Trust Score:6
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /standardjob/{id}/status

Source: https://ttd-workflows.apidocumentation.com/reference

Retrieves the status of a standard job by its ID.

```APIDOC
## GET /standardjob/{id}/status

### Description
Retrieves the current status of a standard job.

### Method
GET

### Endpoint
/standardjob/{id}/status

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the job.
```

--------------------------------

### POST /graphqlrequest

Source: https://ttd-workflows.apidocumentation.com/reference

Submits a generic GraphQL API request.

```APIDOC
## POST /graphqlrequest

### Description
Submits a generic GraphQL API request to the platform.

### Method
POST

### Endpoint
/graphqlrequest
```

--------------------------------

### POST /adgroup

Source: https://ttd-workflows.apidocumentation.com/reference

Creates a new ad group.

```APIDOC
## POST /adgroup

### Description
Creates a new ad group within the platform.

### Method
POST

### Endpoint
/adgroup
```

--------------------------------

### POST /restrequest

Source: https://ttd-workflows.apidocumentation.com/reference

Submits a generic REST API request.

```APIDOC
## POST /restrequest

### Description
Submits a generic REST API request to the platform.

### Method
POST

### Endpoint
/restrequest
```

--------------------------------

### POST /adgroup

Source: https://ttd-workflows.apidocumentation.com/reference

Creates a new ad group within the specified campaign using the provided configuration inputs.

```APIDOC
## POST /adgroup

### Description
Creates a new ad group. This endpoint requires a TTD-Auth security token in the headers.

### Method
POST

### Endpoint
https://ext-api.sb.thetradedesk.com/workflows/adgroup

### Request Body
- **primaryInput** (object) - Required - The core settings for the ad group including budget, audience targeting, and creative IDs.
- **campaignId** (string) - Required - The ID of the campaign to which the ad group belongs.
- **advancedInput** (object) - Optional - Advanced configuration settings such as KOA optimization, Comscore settings, and inventory targeting.
- **validateInputOnly** (boolean) - Optional - If set to true, validates the input without creating the ad group.

### Request Example
{
  "primaryInput": {
    "name": "Example Ad Group",
    "channel": "Other",
    "includeDefaultsFromCampaign": true
  },
  "campaignId": "12345678"
}
```

--------------------------------

### Ad Group Creation Request Body

Source: https://ttd-workflows.apidocumentation.com/reference

The JSON structure required for the POST request to create a new ad group, containing primary and advanced configuration settings.

```json
{
"primaryInput": {
"isEnabled": null,
"description": null,
"budget": {
"allocationType": "Minimum",
"budgetInAdvertiserCurrency": null,
"budgetInImpressions": null,
"dailyTargetInAdvertiserCurrency": null,
"dailyTargetInImpressions": null
},
"baseBidCPMInAdvertiserCurrency": null,
"maxBidCPMInAdvertiserCurrency": null,
"audienceTargeting": {
"audienceId": null,
"audienceAcceleratorExclusionsEnabled": null,
"audienceBoosterEnabled": null,
"audienceExcluderEnabled": null,
"audiencePredictorEnabled": null,
"crossDeviceVendorListForAudience": [
1
],
"recencyExclusionWindowInMinutes": null,
"targetTrackableUsersEnabled": null,
"useMcIdAsPrimary": null
},
"roiGoal": {
"maximizeReach": null,
"maximizeLtvIncrementalReach": null,
"cpcInAdvertiserCurrency": null,
"ctrInPercent": null,
"nielsenOTPInPercent": null,
"cpaInAdvertiserCurrency": null,
"returnOnAdSpendPercent": null,
"vcrInPercent": null,
"viewabilityInPercent": null,
"vcpmInAdvertiserCurrency": null,
"cpcvInAdvertiserCurrency": null,
"miaozhenOTPInPercent": null
},
"creativeIds": [
""
],
"associatedBidLists": [
{
"bidListId": "",
"isEnabled": null,
"isDefaultForDimension": null
}
],
"name": null,
"channel": "Other",
"funnelLocation": "None",
"marketType": "OpenMarket",
"programmaticGuaranteedPrivateContractId": null,
"includeDefaultsFromCampaign": true
},
"campaignId": null,
"advancedInput": {
"koaOptimizationSettings": {
"areFutureKoaFeaturesEnabled": null,
"predictiveClearingEnabled": null
},
"comscoreSettings": {
"isEnabled": true,
"populationId": null,
"demographicMemberIds": [
1
],
"mobileDemographicMemberIds": [
1
]
},
"contractTargeting": {
"allowOpenMarketBiddingWhenTargetingContracts": null
},
"dimensionalBiddingAutoOptimizationSettings": [
[
"UnknownDimension"
]
],
"isUseClicksAsConversionsEnabled": null,
"isUseSecondaryConversionsEnabled": null,
"nielsenTrackingAttributes": {
"enhancedReportingOption": "None",
"gender": "Male",
"startAge": "Two",
"endAge": "Seventeen",
"countries": [
""
]
},
"newFrequencyConfigs": [
{
"counterName": null,
"frequencyCap": null,
"frequencyGoal": null,
"resetIntervalInMinutes": 1
}
],
"inventoryTargeting": {
"dealGroupIdsToInclude": [
""
],
"dealGroupIdsToExclude": [
""
],
"dealIdsToExclude": [
1
],
"dealIdsToInclude": [
1
],
"includeDefaultOnDeals": null
},
"isNonDecisioned": null,
"flights": [
{
"allocationType": "Minimum",
"budgetInAdvertiserCurrency": null,
"budgetInImpressions": null,
"dailyTargetInAdvertiserCurrency": null,
"dailyTargetInImpressions": null,
"campaignFlightId": 1
}
],
"callerSource": null
},
"validateInputOnly": null
}
```
Tokens:
Raw