Creatives

A creative is an image or video file that is a building block for ad assembly.

Overview

A creative is an object that defines the image or video asset that is the foundation of an ad.

The creative identifies the file type (image or video file), the advertising environment (native or web), and the file hosting information (Oath or third-party). Depending on the creative’s creativeType, a variety of additional attributes may be optional or required.

The BrightRoll DSP API supports the following types of creatives:

DISPLAY_HOSTED
A hosted display creative defines an image asset that is hosted by Oath. If the creativeType is DISPLAY_HOSTED, the creative is defined by a landingPageUrl and the content of the creative (binaryData and largeMobileImageData).
DISPLAY_THIRD_PARTY
A third-party display creative defines an image asset that is hosted by a third-party server. If the creativeType is DISPLAY_THIRD_PARTY, the creative is defined by its adBehaviorTypeId, isThirdPartyCodeSecure, thirdPartyCode, adType, and adChoicesEnabled attributes.
NATIVE_DISPLAY
A native display creative defines an image asset that integrates with mobile content layouts. If the creativeType is NATIVE_DISPLAY, the creative is defined by a landingPageUrl and the content of the creative (binaryData, smallBinaryData, and smallImageBinaryData).
VIDEO_HOSTED
A third-party video creative defines a video asset that is hosted by a third-party server. If the creativeType is VIDEO_HOSTED, the creative is defined by a adBehaviorTypeId and the content of the creative (binaryData).
VIDEO_THIRD_PARTY
A third-party video creative defines a video asset that is hosted by a third-party server. If the creativeType is VIDEO_THIRD_PARTY, the creative is defined by its adBehaviorTypeId and creativeTagUrl attributes.
NATIVE_VIDEO
A native video creative defines a video asset that integrates with mobile content layouts. If the creativeType is NATIVE_VIDEO, the creative is defined by the content of the creative (binaryData, smallBinaryData, and nativeVideoImageData).

A single creative may be used in many different ads. Every ad is defined by a creative, which is identified by its creativeId. To learn more, see Ads.

Endpoint

You can use this endpoint to read, create, and update both display and video creative objects.

/traffic/creatives

The action taken depends on the HTTP method and the parameters specified.

  • Use the GET method to read existing creatives.
  • Use the POST method to add new display or video creatives.
  • Use the PUT method to update existing display or video creatives.

Resources

Creatives are managed and tracked using the creative object.

Creative Object

All creatives are defined by a unique id, a name, its status, an advertiser accountId, and a creativeType.

Additional fields may be required depending on whether it is a display creative or a video creative.

Creative Object Common Fields
Field Description Data Type
id Specifies the ID of the creative. integer
name

Specifies the name of the creative.

Note: If you update the name of the creative, the names of all linked ads are updated as well with the name specified for the creative.

string
status

Specifies the current status of the creative.

  • ACTIVE - Active
  • INACTIVE - Inactive
string
accountId

Specifies the advertiser ID.

To learn more, see Advertisers / Accounts.

integer
landingPageUrl Specifies the URL that redirects to the landing page. May be a click tracker or landing page URL. string
mimeType

Specifies the creative MIME type. For example, image/png, video/mp4.

To learn more, see Ad/Creative MIME Types.

string
creativeType

Specifies the creative type.

  • DISPLAY_HOSTED
  • DISPLAY_THIRD_PARTY
  • VIDEO_HOSTED
  • VIDEO_THIRD_PARTY
  • NATIVE_DISPLAY
  • NATIVE_VIDEO
string
creativeImpressionTracking

An array of creativeImpressionTracking objects.

To learn more, see Creative Impression Tracking Object.

array
customIdentifierValues

Specifies an array of customIdentifier objects.

To learn more, see Custom Identifier Object.

array
adBehaviorTypeId

Specifies ad behavior.

To learn more, see Ad Behavior Types.

integer
isSmartAd

Specifies whether the creative is a Smart Ad.

  • If true, the creative is a Smart Ad.
  • If false, the creative is not a Smart Ad.
boolean
updatedAt A read-only field that specifies the time of the last update. string
content

Content object contains the following fields for providing hosted and native creative binary data:

  • binaryData - Base64 encoded creative image/video. Required if creativeType is DISPLAY_HOSTED, VIDEO_HOSTED, NATIVE_DISPLAY, and NATIVE_VIDEO.
  • largeMobileImageData - Base64 encoded mobile web image. Required if creativeType is DISPLAY_HOSTED
  • smallBinaryData - Base64 encoded advertiser logo. equired when creativeType is NATIVE_DISPLAY, and NATIVE_VIDEO
  • smallImageBinaryData - Base64 encoded image file for mobile image. Required if creativeType is NATIVE_DISPLAY.
  • nativeVideoImageData - Base64 encoded main cover image file. Required if creativeType is NATIVE_VIDEO
string
layout

Specifies the layout ad size of the creative.

To learn more, see Layouts.

string
adChoicesEnabled

Indicates whether AdChoices CLEAR Ad Notice enabled. Required if the creativeType of the display ad is DISPLAY_THIRD_PARTY or DISPLAY_HOSTED.

  • If true, display a CLEAR Ad Notice on or near the ad.
  • If false, do not display a CLEAR Ad Notice notification.
boolean
isThirdPartyCodeSecure

Indicates whether an ad tag is secure for third-party creatives. Required if creativeType is DISPLAY_THIRD_PARTY.

  • If true, the ad tag is secure for third-party creatives.
  • If false, the ad tag is unsecure for third-party creatives.
boolean
adxCategories

An array of ADX categories. Supported categories:

  • ALCOHOL_AD
array
thirdPartyCode Specifies a third-party ad tag. Required if creativeType is DISPLAY_THIRD_PARTY. string
adType

Specifies the ad type. Required if creativeType is DISPLAY_THIRD_PARTY.

  • BANNER
  • RICH_MEDIA
  • MRAID
string
userInteractions

Specifies user interaction. Required if the display creative’s adType is RICH_MEDIA.

  • ON_LOAD
  • ON_CLICK
  • ON_HOVER
array
expandDirections

Specifies the expandable direction.

Required if the display creative’s adType is RICH_MEDIA.

  • LEFT
  • RIGHT
  • UP
  • DOWN
  • FULLSCREEN
  • AUTOMATIC
array
creativeTagUrl

Specifies the VAST URL for the creatives.

Required if the creativeType is VIDEO_THIRD_PARTY.

string

Creative Impression Tracking Object

You can set up multiple impression tracking URLs and/or a single click tracking URL for the creative to track impressions or clicks in the ad server of your choice (such as Doubleclick or Sizmek) and using Yahoo’s reporting.

BrightRoll DSP uses the click tracking URL during live ad serving to redirect the user to the final landing page destination. If the landing page URL and the final destination of the click tracking URL are different, then the SSP and Yahoo will flag the creative during the creative audit process.

The creativeImpressionTracking object is defined by the following fields:

Creative Impression Tracking Fields
Field Description Data Type
id Specifies the ID of the tracker. integer
impTrackerUrl Specifies the URL of the tracker. string
trackingEventType

Specifies the event type of the tracker.

If the creativeType is DISPLAY_HOSTED, DISPLAY_THIRD_PARTY, or NATIVE_DISPLAY valid values include:

  • IMPRESSION

If the creativeType is VIDEO_HOSTED or VIDEO_THIRD_PARTY, valid values include:

  • IMPRESSION
  • PERCENT_25
  • PERCENT_50
  • PERCENT_75
  • PERCENT_100
  • CLICK

If the creativeType is NATIVE_DISPLAY or NATIVE_VIDEO, valid values include:

  • JAVASCRIPT
string

Note

Do not add multiple Javascript impression-tracking pixels to the creative. You should only designate one Javascript pixel. Additional Javascript pixels will not be used.

Example Payload

{
  "creativeImpressionTracking": [
    {
      "id": 1,
      "impTrackerUrl": "http://yahoo.com",
      "trackingEventType": "IMPRESSION"
    },
    {
      "id": 2,
      "impTrackerUrl": "https://ad.doubleclick.net/ddm/ad/ord=${REQUESTID};dc_lat=;dc_rdid=",
      "trackingEventTypeId": "PERCENT_100"
    }
  ]
}

Custom Identifier Object

The customIdentifier object defines an identifier for a creative. Must be specified when you add a creative. Optional when updating a creative.

Custom Identifier Object Fields
Field Description Data Type
id Specifies the the identifier ID. integer
identifierValue Specifies the identifier value. string

Example Payload

{
  "customIdentifierValues": [
    {
      "id": 1,
      "identifierValue": "Value1",
    },
    {
      "id": 2,
      "identifierValue": "Value2",
    }
  ]
}

Read Creatives by ID

Returns the specified creative.

GET /traffic/creatives/{id}

The service takes a single parameter, a creative id that is specified in the URL path.

The response returns the creative associated with the specified ID.

Parameters

Read Creatives by ID
Parameter Parameter Type Description Data Type Required?
id path Specifies the creative ID. integer Y

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/creatives/370529

Example Response

{
  "response": {
    "status": "ACTIVE",
    "creativeType": "DISPLAY_THIRD_PARTY",
    "adxCategories": [
      "ALCOHOL_AD"
    ],
    "adType": "MRAID",
    "id": 370529,
    "accountId": 1356341,
    "name": "UPDATED-TEST-DISPLAY-THIRDPARTY",
    "landingPageUrl": "http://abc.com",
    "landingPageDomain": "http://abc.go.com/",
    "layout": "728x90",
    "adChoicesEnabled": true,
    "isThirdPartyCodeSecure": true,
    "hasCompanionAds": false,
    "thirdPartyCode": "<!-- YAMPlus Vendor: Desktop Interactive, Format: Standard Graphical -->\n   <!-- Start of Genome from Yahoo! (C) In-Page Code --> <!-- Publisher Name: interclick (5011) --> <!-- Ad Format: 728x90 - Leaderboard --> <!-- Site: http://www.ybuytest.com --> <!-- Section: http://www.ybuytest.com --> <!-- Copy and paste this ad code between the <BODY> and </BODY> tags of your page. -->  <iframe src=\"http://a1.interclick.com/getInPage.aspx?a=53&b=54335&cid=635185718966131470&click=${CLICKURL}\" width='728' height='90' scrolling='no' frameborder='0' marginheight='0' marginwidth='0'>     <script src=\"http://a1.interclick.com/getInPageJS.aspx?a=53&b=54335&cid=635185718966131470\"></script>     <noscript><a HREF=\"${CLICKURL}http://a1.interclick.com/getInPageTarget.aspx?a=53&b=54335&cid=635185718966131470\">         <img src=\"http://a1.interclick.com/getInPageImage.aspx?a=53&b=54335&cid=635185718966131470\" border='0' /></a>      </noscript> </iframe>  <!-- End of Genome from Yahoo! (C) In-Page Code -->",
    "updatedAt": 1515090300000,
    "creativeImpressionTracking": [
      {
        "impTrackerUrl": "<img src=\"https://abc.com\" />",
        "trackingEventType": "IMPRESSION"
      }
    ],
    "isSmartAd": true,
    "customIdentifierValues": [
      {
        "id": 428,
        "identifierValue": "35353535353535"
      },
      {
        "id": 427,
        "identifierValue": "123"
      }
    ],
    "adBehaviorTypeId": 108
  },
  "errors": null,
  "timeStamp": "2018-01-04T18:26:36Z"
}

Read Creatives by Query

Returns a filtered list of creatives.

GET /traffic/creatives?accountId={accountId}&category={category}&adformat={adformat}&page={page}&limit={limit}&sort={sort}&dir={dir}&query={query}

The service accepts multiple query parameters. The response returns a list of matching creatives.

Parameters

The service accepts the following parameters:

Read Creatives by Query
Parameter Parameter Type Description Data Type Required?
accountId query Specifies the advertiser ID. integer Y
category query

Specifies the creative type.

  • display
  • video
  • native_d
  • native_v
string N
addformat query

Specifies the ad format type.

  • image
  • video
string N
name query Specifies the creative name. string N
creativeIds query Specifies comma-separated creative ID values. string N
page query Specifies the page number. integer N
sort query Specifies the column to sort by. string N
dir query

Specifies the sort direction:

  • asc
  • desc
string N
query query Specifies a query. string N

Note

If both category and adformat are specified, the adformat filter will be ignored.

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/creatives?accountId=1356341&category=video&page=1&limit=2

Example Response

{
  "response": [
    {
      "status": "ACTIVE",
      "creativeType": "VIDEO_THIRD_PARTY",
      "id": 369699,
      "accountId": 1356341,
      "name": "test-video",
      "landingPageUrl": "http://www.target.com",
      "layout": "400x300",
      "adChoicesEnabled": true,
      "isThirdPartyCodeSecure": true,
      "creativeTagUrl": "https://demo.tremorvideo.com/proddev/vast/vast2RegularLinear.xml",
      "hasCompanionAds": true,
      "updatedAt": 1514434641000,
      "isSmartAd": false,
      "adBehaviorTypeId": 207
    },
    {
      "status": "ACTIVE",
      "creativeType": "VIDEO_THIRD_PARTY",
      "id": 369702,
      "accountId": 1356341,
      "name": "TRAFFIC_API_Bp4ZP",
      "landingPageUrl": "http://g.com",
      "layout": "400x300",
      "adChoicesEnabled": true,
      "isThirdPartyCodeSecure": true,
      "creativeTagUrl": "https://demo.tremorvideo.com/proddev/vast/vast2RegularLinear.xml",
      "hasCompanionAds": true,
      "updatedAt": 1514506573000,
      "creativeImpressionTracking": [
        {
          "impTrackerUrl": "http://t.com",
          "trackingEventType": "IMPRESSION"
        }
      ],
      "isSmartAd": false,
      "adBehaviorTypeId": 207
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-04T18:27:38Z"
}

Create Display Creatives

Adds a new display creative.

The platform supports three types of display creative types: DISPLAY_HOSTED, DISPLAY_THIRD_PARTY, and NATIVE_DISPLAY.

POST /traffic/creatives

Note

The creative image size can be up to 2MB.

Note

The creative image size is as follows: at least 1200 X 627 pixels for the main creative image in the ad, at least 80 X 80 pixels for the advertiser’s brand logo, and at least 627 X 627 pixels for the mobile web image.

Parameters

All parameters are specified in the body of the application/json payload.

All new display creatives are defined by name, status, accountId, isSmartAd and creativeType parameters. Additional parameters may be required depending on whether the creativeType specified is DISPLAY_HOSTED, DISPLAY_THIRD_PARTY, or NATIVE_DISPLAY.

Create Display Creatives
Parameter Parameter Type Description Data Type Required?
name body Specifies the name of the creative. string Y
status body

Specifies the current status of the creative.

  • ACTIVE - Active
  • INACTIVE - Inactive
string Y
accountId body

Specifies the advertiser ID.

To learn more, see Advertisers / Accounts.

integer Y
landingPageUrl body

Specifies the URL that redirects to the landing page. May be a click tracker or landing page URL.

[1]Required if the creativeType is DISPLAY_HOSTED or NATIVE_DISPLAY.
string Y [1]
landingPageDomain body Specifies the top-level domain of the landingPageUrl. string N
mimeType body Specifies the creative MIME type. Use the value field from the Creative MIME Types response. For example, image/png, video/mp4. string N
creativeType body

Specifies the creative type.

  • DISPLAY_HOSTED
  • DISPLAY_THIRD_PARTY
  • NATIVE_DISPLAY
string Y
creativeImpressionTracking body

Specifies an array of creativeImpressionTracking objects.

To learn more, see Creative Impression Tracking Object.

array N
customIdentifierValues body

Specifies an array of customIdentifier objects.

To learn more, see Custom Identifier Object.

array N
adBehaviorTypeId body

Specifies ad behavior.

[2]Required if the creativeType is DISPLAY_THIRD_PARTY.

To learn more, see Ad Behavior Types.

integer Y [2]
isSmartAd body Specifies the ad is a Smart Ad. boolean Y
content body

An object that identifies hosted and native creative binary data.

  • binaryData - Base64 encoded creative image/video. Required if creativeType is DISPLAY_HOSTED, or NATIVE_DISPLAY.
  • largeMobileImageData - Base64 encoded mobile web image. Required if creativeType is DISPLAY_HOSTED.
  • smallBinaryData - Base64 encoded advertiser logo. Required when creativeType is NATIVE_DISPLAY.
  • smallImageBinaryData- Base64 encoded image file for mobile image. Required if creativeType is NATIVE_DISPLAY.
[3]Required if the creativeType is DISPLAY_HOSTED or NATIVE_DISPLAY.
string Y [3]
layout body

Specifies the layout (ad size).

To learn more, see Layouts.

string Y
adChoicesEnabled body

Indicates whether AdChoices CLEAR Ad Notice enabled.

  • If true, display a CLEAR Ad Notice on or near the ad.
  • If false, do not display a CLEAR Ad Notice notification.
[4]Required if the creativeType is DISPLAY_HOSTED or DISPLAY_THIRD_PARTY.
boolean Y [4]
isThirdPartyCodeSecure body

Indicates whether an ad tag is secure for third-party creatives.

  • If true, the ad tag is secure for third-party creatives.
  • If false, the ad tag is unsecure for third-party creatives.
[5]Required if the creativeType is DISPLAY_THIRD_PARTY.
boolean Y [5]
adxCategories body

An array of ADX categories. Supported categories:

  • ALCOHOL_AD
array N
thirdPartyCode body

Specifies a third-party ad tag.

[6]Required if the creativeType is DISPLAY_THIRD_PARTY.
string Y [6]
adType body

Specifies the ad type.

  • BANNER
  • RICH_MEDIA
  • MRAID
[7]Required if the creativeType is DISPLAY_THIRD_PARTY.
string Y [7]
userInteractions body

Specifies user interaction. - ON_LOAD - ON_CLICK - ON_HOVER

[8]Required if the adType is RICH_MEDIA.
array Y [8]
expandDirections body

Specifies the expandable direction.

  • LEFT
  • RIGHT
  • UP
  • DOWN
  • FULLSCREEN
  • AUTOMATIC
[9]Required if the adType is RICH_MEDIA.
array Y [9]

DISPLAY_THIRD_PARTY Example

The payload specifies a third-party display creative (DISPLAY_THIRD_PARTY).

DISPLAY_THIRD_PARTY Request

The adChoiceEnabled, isThirdPartyCodeSecure, thirdPartyCode, and adType parameters must be specified if the creativeType is DISPLAY_THIRD_PARTY.

{
  "name": "TEST-DISPLAY-THIRD-PARTY",
  "thirdPartyCode": "<!-- YAMPlus Vendor: Desktop Interactive, Format: Standard Graphical -->\n   <!-- Start of Genome from Yahoo! (C) In-Page Code --> <!-- Publisher Name: interclick (5011) --> <!-- Ad Format: 728x90 - Leaderboard --> <!-- Site: http://www.ybuytest.com --> <!-- Section: http://www.ybuytest.com --> <!-- Copy and paste this ad code between the <BODY> and </BODY> tags of your page. -->  <iframe src=\"http://a1.interclick.com/getInPage.aspx?a=53&b=54335&cid=635185718966131470&click=${CLICKURL}\" width='728' height='90' scrolling='no' frameborder='0' marginheight='0' marginwidth='0'>     <script src=\"http://a1.interclick.com/getInPageJS.aspx?a=53&b=54335&cid=635185718966131470\"></script>     <noscript><a HREF=\"${CLICKURL}http://a1.interclick.com/getInPageTarget.aspx?a=53&b=54335&cid=635185718966131470\">         <img src=\"http://a1.interclick.com/getInPageImage.aspx?a=53&b=54335&cid=635185718966131470\" border='0' /></a>      </noscript> </iframe>  <!-- End of Genome from Yahoo! (C) In-Page Code -->",
  "layout": "728x90",
  "mimeType": "image/png",
  "creativeType": "DISPLAY_THIRD_PARTY",
  "landingPageUrl": "http://abc.com",
  "adType": "MRAID",
  "status": "ACTIVE",
  "isThirdPartyCodeSecure": true,
  "adChoicesEnabled": true,
  "adxCategories": [
    "ALCOHOL_AD"
  ],
  "adBehaviorType": "Billboard - Motion",
  "isSmartAd": true,
  "creativeImpressionTracking": [
    {
      "impTrackerUrl": "<img src=\"https://abc.com\" />",
      "trackingEventType": "IMPRESSION"
    }
  ],
  "customIdentifierValues": [
    {
      "identifierValue": "123"
    },
    {
      "identifierValue": "35353535353535"
    }
  ],
  "accountId": 1356341
}

DISPLAY_THIRD_PARTY Response

The response returns details of the newly created display creative object.

{
  "response": {
    "status": "ACTIVE",
    "mimeType": "image/png",
    "creativeType": "DISPLAY_THIRD_PARTY",
    "adxCategories": [
      "ALCOHOL_AD"
    ],
    "adType": "MRAID",
    "id": 373256,
    "accountId": 1356341,
    "name": "TEST-DISPLAY-THIRD-PARTY",
    "landingPageUrl": "http://abc.com",
    "landingPageDomain": "http://abc.go.com/",
    "layout": "728x90",
    "adChoicesEnabled": true,
    "isThirdPartyCodeSecure": true,
    "hasCompanionAds": false,
    "thirdPartyCode": "<!-- YAMPlus Vendor: Desktop Interactive, Format: Standard Graphical -->\n   <!-- Start of Genome from Yahoo! (C) In-Page Code --> <!-- Publisher Name: interclick (5011) --> <!-- Ad Format: 728x90 - Leaderboard --> <!-- Site: http://www.ybuytest.com --> <!-- Section: http://www.ybuytest.com --> <!-- Copy and paste this ad code between the <BODY> and </BODY> tags of your page. -->  <iframe src=\"http://a1.interclick.com/getInPage.aspx?a=53&b=54335&cid=635185718966131470&click=${CLICKURL}\" width='728' height='90' scrolling='no' frameborder='0' marginheight='0' marginwidth='0'>     <script src=\"http://a1.interclick.com/getInPageJS.aspx?a=53&b=54335&cid=635185718966131470\"></script>     <noscript><a HREF=\"${CLICKURL}http://a1.interclick.com/getInPageTarget.aspx?a=53&b=54335&cid=635185718966131470\">         <img src=\"http://a1.interclick.com/getInPageImage.aspx?a=53&b=54335&cid=635185718966131470\" border='0' /></a>      </noscript> </iframe>  <!-- End of Genome from Yahoo! (C) In-Page Code -->",
    "updatedAt": 1516150349000,
    "creativeImpressionTracking": [
      {
        "impTrackerUrl": "<img src=\"https://abc.com\" />",
        "trackingEventType": "IMPRESSION"
      }
    ],
    "isSmartAd": true,
    "customIdentifierValues": [
      {
        "id": 536,
        "identifierValue": "123"
      },
      {
        "id": 537,
        "identifierValue": "35353535353535"
      }
    ],
    "adBehaviorTypeId": 108
  },
  "errors": null,
  "timeStamp": "2018-01-17T00:52:29Z"
}

DISPLAY_HOSTED Example

The payload specifies a hosted display creative (DISPLAY_HOSTED).

The landingPageUrl, content, and adChoiceEnabled parameters must be specified if the creativeType is DISPLAY_HOSTED.

DISPLAY_HOSTED Request

  {
  "name": "hostedDisplay",
  "layout": "115x15",
  "creativeType": "DISPLAY_HOSTED",
  "landingPageUrl": "http://facebook.com",
  "adChoicesEnabled": false,
  "status": "ACTIVE",
  "mimeType": "image/jpeg",
  "adxCategories": [
    "ALCOHOL_AD"
  ],
  "creativeImpressionTracking": [
    {
      "impTrackerUrl": "<img src=\"https://abc.com\" />",
      "trackingEventType": "IMPRESSION"
    }
  ],
  "customIdentifierValues": [
    {
      "identifierValue": "123"
    },
    {
      "identifierValue": "35353535353535"
    }
  ],
  "accountId": 1356341,
  "content": {
    "binaryData": "BASE64FORMATOFIMAGE"
  }
}

DISPLAY_HOSTED Response

{
 "response": {
     "status": "ACTIVE",
     "mimeType": "image/jpeg",
     "creativeType": "DISPLAY_HOSTED",
     "adxCategories": [
         "ALCOHOL_AD"
     ],
     "layout": "115x15",
     "id": 375464,
     "accountId": 1356341,
     "name": "hostedDisplay",
     "landingPageUrl": "http://facebook.com",
     "landingPageDomain": "https://www.facebook.com/",
     "adChoicesEnabled": false,
     "hasCompanionAds": false,
     "updatedAt": 1516916970000,
     "details": {
         "images": {
             "creativeFileUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/78cc3fa4-a240-4dd0-8ea2-92e153049c274864576132918418530.plain",
             "ycsHttpsFileUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/78cc3fa4-a240-4dd0-8ea2-92e153049c274864576132918418530.plain"
         }
     },
     "creativeImpressionTracking": [
         {
             "impTrackerUrl": "<img src=\"https://abc.com\" />",
             "trackingEventType": "IMPRESSION"
         }
     ],
     "customIdentifierValues": [
         {
             "id": 809,
             "identifierValue": "35353535353535"
         },
         {
             "id": 810,
             "identifierValue": "123"
         }
     ],
     "isPreviewAvailable": false
 },
 "errors": null,
 "timeStamp": "2018-01-25T21:49:29Z"
}

DISPLAY_NATIVE Example

The payload specifies a native display creative (NATIVE_DISPLAY).

The landingPageUrl and content parameters must be specified if the creativeType is DISPLAY_NATIVE.

DISPLAY_NATIVE Request

{
  "name": "NATIVE_DISPLAY_TEST",
  "creativeType": "NATIVE_DISPLAY",
  "landingPageUrl": "http://facebook.com",
  "status": "ACTIVE",
  "creativeImpressionTracking": [
    {
      "impTrackerUrl": "<img src=\"https://yahoo.com\" />",
      "trackingEventType": "JAVASCRIPT"
    }
  ],
  "customIdentifierValues": [
    {
      "identifierValue": "123"
    }
  ],
  "accountId": 1356341,
  "content": {
    "binaryData": "binaryData",
    "largeMobileImageData": "largeMobileImageData",
    "smallBinaryData": "largeMobileImageData",
    "smallImageBinaryData": "largeMobileImageData"
  },
  "details": {
    "title": "AdTitile125",
    "companyName": "Adv.Name",
    "description": "Ad.Description"
  }
}

DISPLAY_NATIVE Response

 {
 "response": {
     "status": "ACTIVE",
     "creativeType": "NATIVE_DISPLAY",
     "layout": "Native-Display",
     "id": 375466,
     "accountId": 1356341,
     "name": "NATIVE_DISPLAY_TEST",
     "landingPageUrl": "http://facebook.com",
     "landingPageDomain": "https://www.facebook.com/",
     "hasCompanionAds": false,
     "updatedAt": 1516917138000,
     "details": {
         "title": "AdTitile125",
         "description": "Ad.Description",
         "companyName": "Adv.Name",
         "images": {
             "iconImageSecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/31a3392f-b5b9-4198-a0bc-54da2af3a8e06455621281053895808.octet-stream",
             "iconImageUnsecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/31a3392f-b5b9-4198-a0bc-54da2af3a8e06455621281053895808.octet-stream",
             "imageSecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/bba78eac-b4c0-4e24-995a-e8d76a85f49c2191578831137715663.plain",
             "imageUnsecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/bba78eac-b4c0-4e24-995a-e8d76a85f49c2191578831137715663.plain",
             "smallImageSecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/e8d8db0b-f878-4963-a661-c9feeaec55b76373792801048114791.octet-stream",
             "smallImageUnsecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/e8d8db0b-f878-4963-a661-c9feeaec55b76373792801048114791.octet-stream",
             "largeMobileImageSecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/96749bf1-18e0-4ff6-b834-89f8161811b57885392384658302348.octet-stream",
             "largeMobileImageUnsecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/96749bf1-18e0-4ff6-b834-89f8161811b57885392384658302348.octet-stream"
         }
     },
     "creativeImpressionTracking": [
         {
             "impTrackerUrl": "<img src=\"https://yahoo.com\" />",
             "trackingEventType": "JAVASCRIPT"
         }
     ],
     "customIdentifierValues": [
         {
             "id": 813,
             "identifierValue": "123"
         }
     ],
     "isPreviewAvailable": false
 },
 "errors": null,
 "timeStamp": "2018-01-25T21:52:18Z"
}

Update Display Creatives

Updates the properties of a display creative object.

PUT /traffic/creatives/{id}

The id parameter is required and specified in the path of the endpoint. All other parameters are optional and specified in the body of the application/json.

Parameter Parameter Type Description Data Type Required?
id path Specifies the ID of a creative. integer Y
name body

Specifies the name of the creative.

Note: If you update the name of the creative, the names of all linked ads are updated as well with the name specified for the creative.

string N
status body

Specifies the current status of the creative.

  • ACTIVE - Active
  • INACTIVE - Inactive
string N
accountId body

Specifies the advertiser ID.

To learn more, see Advertisers / Accounts.

integer N
landingPageUrl body Specifies the URL that redirects to the landing page. May be a click tracker or landing page URL. string N
landingPageDomain body Specifies the top-level domain of the landingPageUrl. string N
mimeType body Specifies the creative MIME type. Use the value field from the Creative MIME Types response. For example, image/png. string N
creativeType body

Specifies the creative type.

  • DISPLAY_HOSTED
  • DISPLAY_THIRD_PARTY
  • NATIVE_DISPLAY
string N
creativeImpressionTracking body

Specifies an array of creativeImpressionTracking objects.

To learn more, see Creative Impression Tracking Object.

array N
customIdentifierValues body

Specifies an array of customIdentifier objects.

To learn more, see Custom Identifier Object.

array N
adBehaviorTypeId body

Specifies ad behavior.

To learn more, see Ad Behavior Types.

integer N
isSmartAd body Specifies the ad is a Smart Ad. boolean N
content body

An object that identifies hosted and native creative binary data.

  • binaryData - Base64 encoded creative image/video.
  • largeMobileImageData - Base64 encoded mobile web image.
  • smallBinaryData - Base64 encoded advertiser logo.
  • smallImageBinaryData- Base64 encoded image file for mobile image.
string N
layout body

Specifies the ad size of the creative.

To learn more, see layout.

integer N
adChoicesEnabled body

Indicates whether AdChoices CLEAR Ad Notice enabled.

  • If true, display a CLEAR Ad Notice on or near the ad.
  • If false, do not display a CLEAR Ad Notice notification.
boolean N
isThirdPartyCodeSecure body

Indicates whether an ad tag is secure for third-party creatives. Required if creativeType is DISPLAY_THIRD_PARTY.

  • If true, the ad tag is secure for third-party creatives.
  • If false, the ad tag is unsecure for third-party creatives.
boolean N
adxCategories body

An array of ADX categories. Supported categories:

  • ALCOHOL_AD
array N
thirdPartyCode body Specifies a third-party ad tag. Required if creativeType is DISPLAY_THIRD_PARTY. string N
adType body

Specifies the ad type.

  • BANNER
  • RICH_MEDIA
  • MRAID
string N
userInteractions body

Specifies user interaction. Required if the creative’s adType is RICH_MEDIA.

  • ON_LOAD
  • ON_CLICK
  • ON_HOVER
array N
expandDirections body

Specifies the expandable direction.

  • LEFT
  • RIGHT
  • UP
  • DOWN
  • FULLSCREEN
  • AUTOMATIC
array N

Example Request

PUT https://dspapi.admanagerplus.yahoo.com/traffic/creatives/370529

All parameters are specified in the body of the application/json.

{
   "name": "UPDATED-TEST-DISPLAY-THIRDPARTY"
}

Example Response

The response returns the updated creative.

{
  "response": {
    "status": "ACTIVE",
    "creativeType": "DISPLAY_THIRD_PARTY",
    "adxCategories": [
      "ALCOHOL_AD"
    ],
    "adType": "MRAID",
    "id": 370529,
    "accountId": 1356341,
    "name": "UPDATED-TEST-DISPLAY-THIRDPARTY",
    "landingPageUrl": "http://abc.com",
    "landingPageDomain": "http://abc.go.com/",
    "layout": "728x90",
    "adChoicesEnabled": true,
    "isThirdPartyCodeSecure": true,
    "hasCompanionAds": false,
    "thirdPartyCode": "<!-- YAMPlus Vendor: Desktop Interactive, Format: Standard Graphical -->\n   <!-- Start of Genome from Yahoo! (C) In-Page Code --> <!-- Publisher Name: interclick (5011) --> <!-- Ad Format: 728x90 - Leaderboard --> <!-- Site: http://www.ybuytest.com --> <!-- Section: http://www.ybuytest.com --> <!-- Copy and paste this ad code between the <BODY> and </BODY> tags of your page. -->  <iframe src=\"http://a1.interclick.com/getInPage.aspx?a=53&b=54335&cid=635185718966131470&click=${CLICKURL}\" width='728' height='90' scrolling='no' frameborder='0' marginheight='0' marginwidth='0'>     <script src=\"http://a1.interclick.com/getInPageJS.aspx?a=53&b=54335&cid=635185718966131470\"></script>     <noscript><a HREF=\"${CLICKURL}http://a1.interclick.com/getInPageTarget.aspx?a=53&b=54335&cid=635185718966131470\">         <img src=\"http://a1.interclick.com/getInPageImage.aspx?a=53&b=54335&cid=635185718966131470\" border='0' /></a>      </noscript> </iframe>  <!-- End of Genome from Yahoo! (C) In-Page Code -->",
    "updatedAt": 1515090300000,
    "creativeImpressionTracking": [
      {
        "impTrackerUrl": "<img src=\"https://abc.com\" />",
        "trackingEventType": "IMPRESSION"
      }
    ],
    "isSmartAd": true,
    "customIdentifierValues": [
      {
        "id": 428,
        "identifierValue": "35353535353535"
      },
      {
        "id": 427,
        "identifierValue": "123"
      }
    ],
    "adBehaviorTypeId": 108
  },
  "errors": null,
  "timeStamp": "2018-01-04T18:25:02Z"
}

Create Video Creatives

Adds a new video creative.

The platform supports three types of video creative types: VIDEO_HOSTED, VIDEO_THIRD_PARTY, and NATIVE_VIDEO.

All new video creatives are defined by name, status, accountId, isSmartAd and creativeType parameters. Additional parameters may be required depending on whether the creativeType specified is VIDEO_HOSTED or VIDEO)_THIRD_PARTY.

POST /traffic/creatives

The creative is defined within the body of the application/json payload.

Note

The creative video size can be up to 300MB.

Note

Supported native creative video formats include:

  • MOV
  • AVI
  • ASF
  • OGG
  • WEBM
  • FLV
  • MP4
  • WMV

Parameters

Different parameters may be specified depending on the creativeType specified.

All parameters are specified in the body of the application/json payload.

Create Video Creatives
Parameter Parameter Type Description Data Type Required?
name body Specifies the name of the creative. string Y
status body

Specifies the current status of the creative.

  • ACTIVE - Active
  • INACTIVE - Inactive
string Y
accountId body

Specifies the advertiser ID.

To learn more, see Advertisers / Accounts.

integer Y
landingPageUrl body Specifies the URL that redirects to the landing page. May be a click tracker or landing page URL. string N
landingPageDomain body Specifies the top-level domain of the landingPageUrl. string N
mimeType body Specifies the creative MIME type. Use the value field from the Creative MIME Types response. For example, image/png, video/mp4. string N
creativeType body

Specifies the video creative type.

  • VIDEO_HOSTED
  • VIDEO_THIRD_PARTY
  • NATIVE_VIDEO
string Y
creativeImpressionTracking body

Specifies an array of creativeImpressionTracking objects.

To learn more, see Creative Impression Tracking Object.

array N
customIdentifierValues body

Specifies an array of customIdentifier objects.

To learn more, see Custom Identifier Object.

array N
adBehaviorTypeId body

Specifies ad behavior. To learn more, see Ad Behavior Types.

[10]Required if the creativeType is VIDEO_HOSTED or VIDEO_THIRD_PARTY.
integer Y [10]
isSmartAd body Specifies the ad is a Smart Ad. boolean Y
content body

An object that identifies hosted and native creative binary data.

  • binaryData - Base64 encoded creative image/video. Required if creativeType is VIDEO_HOSTED or NATIVE_VIDEO.
  • smallBinaryData - Base64 encoded advertiser logo. Required when creativeType is NATIVE_VIDEO.
  • nativeVideoImageData - Base64 encoded main cover image file. Required if creativeType is NATIVE_VIDEO.
[11]Required if the creativeType is VIDEO_HOSTED or VIDEO_THIRD_PARTY.
string Y [11]
creativeTagUrl body

Specifies the VAST URL for the creatives.

[12]Required if the creativeType is VIDEO_THIRD_PARTY.
string Y [12]

VIDEO_HOSTED Example

The payload specifies a third-party display creative (VIDEO_HOSTED).

The content and creativeTagUrl parameters must be specified if the creativeType is VIDEO_HOSTED.

VIDEO_HOSTED Request

{
   "name": "hostedVideoPOSTMAN",
   "landingPageUrl": "http://abc.com",
   "accountId": 1356341,
   "creativeType": "VIDEO_HOSTED",
   "status": "ACTIVE",
   "adxCategories": [
     "ALCOHOL_AD"
   ],
   "adBehaviorType": "Ad Bar",
   "content": {
     "binaryData": "BASE64VIDEO"
   }
}

VIDEO_HOSTED Response

{
    "response": {
        "status": "ACTIVE",
        "creativeType": "VIDEO_HOSTED",
        "adxCategories": [
            "ALCOHOL_AD"
        ],
        "layout": "400x300",
        "adBehaviorType": "Ad Bar",
        "id": 377178,
        "accountId": 1356341,
        "name": "hostedVideoPOSTMAN",
        "landingPageUrl": "http://abc.com",
        "landingPageDomain": "http://abc.go.com/",
        "updatedAt": 1517429457000,
        "isSmartAd": false,
        "isPreviewAvailable": false
    },
    "errors": null,
    "timeStamp": "2018-01-31T20:11:03Z"
}

VIDEO_NATIVE Example

The payload specifies a native video creative (VIDEO_NATIVE).

The content parameter must be specified if the creativeType is VIDEO_NATIVE.

VIDEO_NATIVE Request

{
  "name": "NativeVideoTest",
  "landingPageUrl": "http://abc.com",
  "accountId": 1356341,
  "creativeType": "NATIVE_VIDEO",
  "status": "ACTIVE",
  "content": {
    "binaryData": "BASE64VIDEO",
    "smallBinaryData": "Advertiser logo",
    "nativeVideoImageData": "Video cover"
  },
  "details": {
    "title": "AdTitile125",
    "companyName": "Adv.Name",
    "description": "Ad.Description"
  }
}

VIDEO_NATIVE Response

{
    "response": {
        "status": "ACTIVE",
        "creativeType": "NATIVE_VIDEO",
        "adxCategories": [
            "ALCOHOL_AD"
        ],
        "layout": "Native-Video",
        "adBehaviorType": "Ad Bar",
        "id": 377198,
        "accountId": 1356341,
        "name": "NativeVideoTest",
        "landingPageUrl": "http://abc.com",
        "landingPageDomain": "http://abc.go.com/",
        "updatedAt": 1517434646000,
        "details": {
            "title": "AdTitile125",
            "description": "Ad.Description",
            "companyName": "Adv.Name",
            "images": {
                "creativeFileUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/4574b8da-e55d-4ea9-b44d-5f506d53fe4e4029658108682567411.plain",
                "ycsHttpsFileUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/4574b8da-e55d-4ea9-b44d-5f506d53fe4e4029658108682567411.plain",
                "iconImageSecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/d2029f02-0eca-49d1-952e-b1b927111cab598924900760060466.octet-stream",
                "iconImageUnsecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/d2029f02-0eca-49d1-952e-b1b927111cab598924900760060466.octet-stream",
                "imageSecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/5536f6c5-9677-4f18-9b6e-de88c59a9db14013367401075629047.octet-stream",
                "imageUnsecuredUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/5536f6c5-9677-4f18-9b6e-de88c59a9db14013367401075629047.octet-stream"
            }
        },
        "isPreviewAvailable": false
    },
    "errors": null,
    "timeStamp": "2018-01-31T21:37:37Z"
}

Update Video Creatives

Updates video creatives.

PUT /traffic/creatives/{id}

Parameters

The id parameter is specified in the path of the endpoint. All other parameters are specified in the body of the application/json.

Parameter Parameter Type Description Data Type Required?
id path Specifies the ID of a creative. integer Y
name body

Specifies the name of the creative.

Note: If you update the name of the creative, the names of all linked ads are updated as well with the name specified for the creative.

string N
status body

Specifies the current status of the creative.

  • ACTIVE - Active
  • INACTIVE - Inactive
string N
accountId body

Specifies the advertiser ID.

To learn more, see Advertisers / Accounts.

integer N
landingPageUrl body Specifies the URL that redirects to the landing page. May be a click tracker or landing page URL. string N
landingPageDomain body Specifies the top-level domain of the landingPageUrl. string N
mimeType body Specifies the creative MIME type. Use the value field from the Creative MIME Types response. For example, video/mp4. string N
creativeType body

Specifies the creative type.

  • VIDEO_HOSTED
  • VIDEO_THIRD_PARTY
  • NATIVE_VIDEO
string N
creativeImpressionTracking body

Specifies an array of creativeImpressionTracking objects.

To learn more, see Creative Impression Tracking Object.

array N
customIdentifierValues body

Specifies an array of customIdentifier objects.

To learn more, see Custom Identifier Object.

array N
adBehaviorTypeId body

Specifies ad behavior.

To learn more, see Ad Behavior Types.

integer N
isSmartAd body Specifies the ad is a Smart Ad. boolean N
content body

An object that identifies hosted and native creative binary data.

  • binaryData - Base64 encoded creative image/video.
  • largeMobileImageData - Base64 encoded mobile web image.
  • smallBinaryData - Base64 encoded advertiser logo.
  • smallImageBinaryData- Base64 encoded image file for mobile image.
string N
creativeTagUrl body Specifies the VAST URL for the creatives. string N

Example Request

PUT https://dspapi.admanagerplus.yahoo.com/traffic/creatives/370529
{
        "name": "UPDATED-TEST-DISPLAY-THIRDPARTY"
}

Example Response

{
  "response": {
    "status": "ACTIVE",
    "creativeType": "DISPLAY_THIRD_PARTY",
    "adxCategories": [
      "ALCOHOL_AD"
    ],
    "adType": "MRAID",
    "id": 370529,
    "accountId": 1356341,
    "name": "UPDATED-TEST-DISPLAY-THIRDPARTY",
    "landingPageUrl": "http://abc.com",
    "landingPageDomain": "http://abc.go.com/",
    "layout": "728x90",
    "adChoicesEnabled": true,
    "isThirdPartyCodeSecure": true,
    "hasCompanionAds": false,
    "thirdPartyCode": "<!-- YAMPlus Vendor: Desktop Interactive, Format: Standard Graphical -->\n   <!-- Start of Genome from Yahoo! (C) In-Page Code --> <!-- Publisher Name: interclick (5011) --> <!-- Ad Format: 728x90 - Leaderboard --> <!-- Site: http://www.ybuytest.com --> <!-- Section: http://www.ybuytest.com --> <!-- Copy and paste this ad code between the <BODY> and </BODY> tags of your page. -->  <iframe src=\"http://a1.interclick.com/getInPage.aspx?a=53&b=54335&cid=635185718966131470&click=${CLICKURL}\" width='728' height='90' scrolling='no' frameborder='0' marginheight='0' marginwidth='0'>     <script src=\"http://a1.interclick.com/getInPageJS.aspx?a=53&b=54335&cid=635185718966131470\"></script>     <noscript><a HREF=\"${CLICKURL}http://a1.interclick.com/getInPageTarget.aspx?a=53&b=54335&cid=635185718966131470\">         <img src=\"http://a1.interclick.com/getInPageImage.aspx?a=53&b=54335&cid=635185718966131470\" border='0' /></a>      </noscript> </iframe>  <!-- End of Genome from Yahoo! (C) In-Page Code -->",
    "updatedAt": 1515090300000,
    "creativeImpressionTracking": [
      {
        "impTrackerUrl": "<img src=\"https://abc.com\" />",
        "trackingEventType": "IMPRESSION"
      }
    ],
    "isSmartAd": true,
    "customIdentifierValues": [
      {
        "id": 428,
        "identifierValue": "35353535353535"
      },
      {
        "id": 427,
        "identifierValue": "123"
      }
    ],
    "adBehaviorTypeId": 108
  },
  "errors": null,
  "timeStamp": "2018-01-04T18:25:02Z"
}

Delete Creatives

The deletion of creatives is not supported by the BrightRoll DSP API.