get
https://sandbox-api.viantinc.com/{basePath}/creative/getCreativesByAdOrder/
Returns Creatives associated with an Ad Order
Request
GET /creative/getCreativesByAdOrder/<adorder ID>
Response
| JSON Fields | Type | Description |
|---|---|---|
| messages | Object Array | An array of any error messages. |
| messages[].level | String | Error level. |
| messages[].code | String | Error code. |
| messages[].message | String | Error message. |
| entity | Object Array | An array of creative objects. |
| entity[].id | Number | Creative ID. |
| entity[].status | String | Status of the creative. It can be one of the following values:
|
| entity[].name | String | Creative name. |
| entity[].type | Object | |
| entity[].type.id | Number | Creative type ID as shown in the UI. |
| entity[].type.vendor | String | Creative type vendor as shown in the UI. |
| entity[].type.mediaType | String | Can be one of the following values:
|
| entity[].type.videoType | String | Will be null for non-video creative types. Can be one of the following values:
|
| entity[].externalCreativeid | String | |
| entity[].crawlableUrl | String | Crawlable URL for the creative's advertising target |
| entity[].landingPageUrl | String | Clickthrough URL for the creative. This may not be the final destination. |
| entity[].impressionTrackingPixel_1 | String | URL of first tracking pixel |
| entity[].impressionTrackingPixel_2 | String | URL of second tracking pixel |
| entity[].impressionTrackingPixel_3 | String | URL of third tracking pixel |
| entity[].impressionTrackingPixel_4 | String | URL of fourth tracking pixel |
| entity[].size | Object | |
| entity[].size.width | Number | Width of creative (if applicable) |
| entity[].size.height | Number | Height of creative (if applicable) |
| entity[].channels | String Array | Channels selected for this creative. Possible values are:
|
| entity[].adTagId | String | AdTag identifier. Varies by vendor. Only populated on AdTag type creatives |
| entity[].duration | Number | Duration of creative in seconds. Currently only populated for video type creatives. |
| entity[].bitRate | Number | Bitrate of creative. Currently only populated for video type creatives. |
Example
Request to get creatives for an ad order
curl -u <user>:<password> https://sandbox-api.viant.com/v1/creative/getCreativesByAdOrder/175132
Response
{
"messages":[],
"entity":
[
{
"id":662692,
"name":"Viant Creative 300x250.gif",
"type":
{ "id":1,
"vendor":"Generic",
"mediaType":"BANNER",
"videoType":null
},
"status":"APPROVED"
"externalCreativeid": null,
"crawlableUrl": null,
"impressionTrackingPixel_1": null,
"impressionTrackingPixel_2": null,
"impressionTrackingPixel_3": null,
"impressionTrackingPixel_4": null,
"size": {
"width": 300,
"height": 250
},
"channels": [
"MOBILE"
],
"landingPageUrl": null,
"adTagId": null,
"duration": null,
"bitRate": null
}
]
}