post
https://sandbox-api.viantinc.com/{basePath}/adorder
Creates an Ad Order.
Note
io_number and externalAdOrderId both serve the same purpose and refer to the same value: an external ID for use by clients. These fields point to the same value; on input, a caller should use one field or the other, not both; on output, both fields are provided (currently), and will have the same value.
Submitting a record with both fields is an error condition, and will result in a 400 response.
Request Body
| Name | Type | Description | Required |
|---|---|---|---|
| id | Number | Ad order ID. | Required for update. |
| name | String | Ad order name. | Yes |
| campaignId | Number | Campaign ID associated with the ad order. | Yes |
| optimizationGoal | String | Optimization goal for the ad order: CPM, CPC, CPA | Yes |
| startDate | Number | Start date of the ad order, passed as Unix time in milliseconds. | Yes for creation. After creation the flight endpoint must be used to update and modify. |
| endDate | Number | End date of the ad order, passed as Unix time in milliseconds. | Yes for creation. After creation the flight endpoint must be used to update and modify. |
| lifetimeBudget | Number | The total lifetime budget for the ad order in USD. | Yes for creation. After creation the flight endpoint must be used to update and modify. |
| frequencyCap | Object | Holds all frequency cap settings. If not present, defaults to null. | No |
| frequencyCap.limit | Number | The maximum number of impressions a user is exposed to per frequency cap time period duration. See frequencyCap.duration and frequencyCap.timePeriod. | Yes (if parent object present) |
| frequencyCap.duration | Number | The number of given frequencyCap.timePeriod | Yes (if parent object present) |
| frequencyCap.timePeriod | String | One of: MINUTE, HOUR, DAY | Yes (if parent object present) |
| channelsV2 | String Array/Null | Channels the Ad Order will be capable of serving on: Display, Video, Native, Audio, DOOH, CTV, LTV, LTV Wide Orbit | No |
| max_bid | Number | The maximum bid. Default values apply when no values are present. | No |
| audienceWeightsEnabled | Boolean | Controls whether audience weights are enabled. If null or absent, defaults to false on create, and left untouched on update. | No |