Get creatives for an audience - DEPRECATED

Returns creatives associated to the audience

Request

GET /creative/getCreativesByAudience/<audience ID>

Response

JSON Fields Type Description
messagesObject ArrayAn array of any error messages.
messages[].levelStringError level.
messages[].codeStringError code.
messages[].messageStringError message.
entityObject ArrayAn array of creative objects.
entity[].idNumberCreative ID.
entity[].statusString Status of the creative. It can be one of the following values:
  • INCOMPLETE
  • PENDING
  • APPROVED
  • DISABLED
  • VIOLATION
entity[].nameStringCreative name.
entity[].typeObject
entity[].type.idNumberCreative type ID as shown in the UI.
entity[].type.vendorStringCreative type vendor as shown in the UI.
entity[].type.mediaTypeString Can be one of the following values:
  • BANNER
  • VAST
  • NATIVE
  • MRAID
  • VPAID
  • VAST_WITH_VPAID
entity[].type.videoTypeStringWill be null for non-video creative types.
Can be one of the following values:
  • FLV
  • MP4
  • WMV
  • WEBM
  • JS
entity[].externalCreativeidString
entity[].crawlableUrlStringCrawlable URL for the creative's advertising target
entity[].landingPageUrlStringClickthrough URL for the creative. This may not be the final destination.
entity[].impressionTrackingPixel_1StringURL of first tracking pixel
entity[].impressionTrackingPixel_2StringURL of second tracking pixel
entity[].impressionTrackingPixel_3StringURL of third tracking pixel
entity[].impressionTrackingPixel_4StringURL of fourth tracking pixel
entity[].sizeObject
entity[].size.widthNumberWidth of creative (if applicable)
entity[].size.heightNumberHeight of creative (if applicable)
entity[].channelsString ArrayChannels selected for this creative. Possible values are:
  • MOBILE
  • DESKTOP
  • CONNECTED_TV
entity[].adTagIdStringAdTag identifier. Varies by vendor. Only populated on AdTag type creatives
entity[].durationNumberDuration of creative in seconds. Currently only populated for video type creatives.
entity[].bitRateNumberBitrate of creative. Currently only populated for video type creatives.

Example

Request to get creatives for an audience

curl -u <user>:<password> https://sandbox-api.viant.com/v1/creative/getCreativesByAudience/218012

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
    }
  ]
}
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!