Creatives¶
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 creativeType
, a variety of additional attributes may be optional or required.
The Verizon Media 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
isDISPLAY_HOSTED
, the creative is defined by alandingPageUrl
and the content of the creative (binaryData
andlargeMobileImageData
). - DISPLAY_THIRD_PARTY
- A third-party display creative defines an image asset that is hosted by a third-party server. If the
creativeType
isDISPLAY_THIRD_PARTY
, the creative is defined by itsadBehaviorType
,isThirdPartyCodeSecure
,thirdPartyCode
,adType
, andadChoicesEnabled
attributes. - NATIVE_DISPLAY
- A native display creative defines an image asset that integrates with mobile content layouts. If the
creativeType
isNATIVE_DISPLAY
, the creative is defined by alandingPageUrl
and the content of the creative (binaryData
,smallBinaryData
, andsmallImageBinaryData
). - NATIVE_VIDEO
- A native video creative defines a video asset that integrates with mobile content layouts. If the
creativeType
isNATIVE_VIDEO
, the creative is defined by the content of the creative (binaryData
,smallBinaryData
, andnativeVideoImageData
). - VIDEO_HOSTED
- A third-party video creative defines a video asset that is hosted by a third-party server. If the
creativeType
isVIDEO_HOSTED
, the creative is defined by aadBehaviorType
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
isVIDEO_THIRD_PARTY
, the creative is defined by itsadBehaviorType
andcreativeTagUrl
attributes. - AUDIO_HOSTED
- A third-party audio creative defines an audio asset that is hosted by a third-party server. If the
creativeType
isAUDIO_HOSTED
, the creative is defined by aadBehaviorType
and the content of the creative (binaryData
).
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 /traffic/ad/index.
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
POST
method to add new display, video, or audio creatives. - Use the
PUT
method to update individual display, video, or audio creatives. - Use the
PATCH
method to update display, video, and audio creatives in bulk.
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.
Field | Description | Data Type |
---|---|---|
id |
Specifies the creative ID. | integer |
name |
Specifies the name of the creative.
|
string |
status |
Specifies the current status of the creative.
|
string |
accountId |
Specifies the advertiser ID. To learn more, see Advertisers. |
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, To learn more, see Ad/Creative MIME Types. |
string |
creativeType |
Specifies the creative type.
|
string |
creativeImpressionTracking |
An array of To learn more, see Creative Impression Tracking Object. |
array |
customIdentifierValues |
Specifies an array of To learn more, see Custom Identifier Object. |
array |
adBehaviorType |
Specifies ad behavior. To learn more, see Ad Behavior Types. |
string |
isSmartAd |
Specifies whether the creative is 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:
|
object |
details |
Details object contains information on creative media such as URLs for videos or images. It is read-only for all creative types except for To learn more, see Details Object. |
object |
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
|
boolean |
isThirdPartyCodeSecure |
Indicates whether an ad tag is secure for third-party creatives. Required if
|
boolean |
adxCategories |
An array of ADX categories. Supported categories:
|
array |
thirdPartyCode |
Specifies a third-party ad tag. Required if creativeType is DISPLAY_THIRD_PARTY . |
string |
adType |
Specifies the ad type. Required if
|
string |
userInteractions |
Specifies user interaction. Required if the display creative’s
|
array |
expandDirections |
Specifies the expandable direction. Options include:
Required if the display creative’s |
array |
creativeTagUrl |
Specifies the VAST URL for the creatives. Required if the |
string |
creativeCompanionBanner |
Specifies the a creativeCompanionBanner object. To learn more, see Creative Companion Banner Object. |
object |
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.
Verizon Media 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:
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
If the
If the
|
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.
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",
}
]
}
Creative Companion Banner Object¶
The creativeCompanionBanner
object defines a banner object for a video creative.
Field | Description | Data Type |
---|---|---|
id |
Specifies the ID number of the creative companion banner. | integer |
campanionBinaryData |
Specifies the Base64 encoded image. | string |
mimeType |
Specifies the creative companion banner’s mime type. Options include:
|
string |
name |
Specifies the name of the creative companion banner. | string |
Example Payload¶
{
"name": "hostedVideoPOSTMAN",
"landingPageUrl": "http://abc.com",
"accountId": 1356341,
"creativeType": "VIDEO_HOSTED",
"status": "ACTIVE",
"adxCategories": [
"ALCOHOL_AD"
],
"adBehaviorType": "Ad Bar",
"content": {
"binaryData": "BASE64VIDEO"
},
"companionBanner": {
"companionBinaryData": "iVBORw0KGg...",
"mimeTypeId": "image/jpeg",
"Name": "cloud1"
}
}
Details Object¶
details
is a read-only object that provides information on creative media.
Field | Description | Data Type |
---|---|---|
title |
For NATIVE_DISPLAY and NATIVE_VIDEO creatives, specifies the ad title. |
string |
description |
For NATIVE_DISPLAY and NATIVE_VIDEO creatives, specifies the ad description. |
string |
companyName |
For NATIVE_DISPLAY and NATIVE_VIDEO creatives, specifies the advertiser name. |
string |
callToAction |
For NATIVE_DISPLAY and NATIVE_VIDEO creatives, specifies the custom call to action text. |
string |
duration |
For VIDEO_HOSTED and VIDEO_THIRD_PARTY creatives, specifies duration of the video. |
integer |
images |
Contains URLs for the raw files.
|
string |
creativeMedia |
For
|
array |
Example Response¶
{
"details": {
"duration": 6,
"images": {
"creativeFileUrl": "https://s.yimg.com/zi/raw-videos/281ee3b6-ff8a-4faf-820c-3736ed8af6e9.mp4"
},
"creativeMedia": [
{
"mediaMimeType": "video/mp4",
"id": 637825,
"bitRate": 235,
"frameRate": 30,
"mediaUrl": "http://edgecast-vod.yimg.com/brdsp-dev/c7269865-d316-53ea-b8d3-3c85ba77eefd/video_output_6.mp4",
"mimeType": 11,
"width": 320,
"height": 240
},
{
"mediaMimeType": "video/mp4",
"id": 637824,
"bitRate": 131,
"frameRate": 15,
"mediaUrl": "http://edgecast-vod.yimg.com/brdsp-dev/c7269865-d316-53ea-b8d3-3c85ba77eefd/video_output_5.mp4",
"mimeType": 11,
"width": 256,
"height": 192
}
]
}
}
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¶
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",
"mimeType": "image/jpeg",
"creativeType": "DISPLAY_HOSTED",
"layout": "300x250",
"adBehaviorType": "Interactive - Banner",
"id": 556057,
"accountId": 1356341,
"name": "Mail Creative",
"landingPageUrl": "https://www.yahoo.com",
"landingPageDomain": "https://www.yahoo.com",
"adChoicesEnabled": true,
"updatedAt": "2019-05-17T22:45:03Z",
"details": {
"images": {
"creativeFileUrl": "http://l.yimg.com/ff/pbp/creatives/db15e4b1-7eb4-4619-8028-27ebfde5a495102902407536230059.jpeg",
"imageSecuredUrl": "https://s.yimg.com/ff/pbp/creatives/db15e4b1-7eb4-4619-8028-27ebfde5a495102902407536230059.jpeg"
},
"creativeMedia": []
},
"customIdentifierValues": [
{
"id": 1014,
"identifierValue": "35353535353535"
},
{
"id": 1013,
"identifierValue": "123"
}
]
},
"errors": null,
"timeStamp": "2019-09-25T18:59:11Z"
}
Read Creatives by Query¶
Returns a filtered list of creatives.
GET /traffic/creatives?accountId={accountId}&category={category}&adformat={adformat}&nonBriefGet={nonBriefGet}&query={query}&page={page}&limit={limit}&sort={sort}&dir={dir}
The service accepts multiple query parameters. The response returns a list of matching creatives.
Parameters¶
The service accepts the following parameters:
Parameter | Parameter Type | Description | Data Type | Required? |
---|---|---|---|---|
accountId |
query | Specifies the advertiser ID. | integer |
Y |
category |
query | Specifies the creative type. Options include:
|
string |
N |
adformat |
query | Specifies the ad format type. Options include:
|
string |
N |
nonBriefGet |
query | Specifies the verbosity of the response. Options include:
|
boolean |
N |
name |
query | Specifies the creative name. | string |
N |
creativeIds |
query | Specifies comma-separated creative ID values. | string |
N |
query |
query | Specifies the search term. Use URL encoding conventions (i.e. a space should be replaced with a |
string |
N |
page |
query | Specifies the page number. | integer |
N |
limit |
query | Specifies the total number of items to return. Maximum allowed value is 100 . |
integer |
N |
sort |
query | Specifies the column to sort by. | string |
N |
dir |
query | Specifies the sort direction:
|
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": "INACTIVE",
"mimeType": "application/javascript",
"creativeType": "VIDEO_THIRD_PARTY",
"id": 516976,
"accountId": 1356341,
"name": "Test Creative",
"landingPageUrl": "https://www.facebook.com",
"landingPageDomain": "https://www.facebook.com",
"adChoicesEnabled": true,
"isThirdPartyCodeSecure": true,
"creativeTagUrl": "https://s.yimg.com/cv/ae/1478818651857/2971479843340.xml",
"updatedAt": "2019-07-23T07:28:57Z",
"details": {
"duration": 30,
"images": {},
"creativeMedia": [
{
"mediaMimeType": "application/javascript",
"id": 7144841,
"bitRate": -1,
"frameRate": 1,
"mediaUrl": "https://s.yimg.com/cv/ae/1478818651857/2971479843340.js",
"mimeType": 10,
"width": 640,
"height": 360
}
]
},
"isSmartAd": false
},
{
"status": "INACTIVE",
"mimeType": "video/mp4",
"creativeType": "VIDEO_HOSTED",
"adBehaviorType": "Standard Pre-Roll Video",
"id": 530957,
"accountId": 1356341,
"name": "The World of Autism PSA - 30 sec [mp4]",
"landingPageUrl": "https://www.autismspeaks.org/what-autism/learn-signs",
"landingPageDomain": "https://www.autismspeaks.org/what-autism/learn-signs",
"adChoicesEnabled": true,
"updatedAt": "2019-07-27T00:41:58Z",
"details": {
"duration": 30,
"images": {
"creativeFileUrl": "http://l.yimg.com/ff/pbp/creatives/ef5cac5f-92bd-4b05-af6e-13309c017ab13350401952247988883.mp4",
"imageSecuredUrl": "https://s.yimg.com/ff/pbp/creatives/ef5cac5f-92bd-4b05-af6e-13309c017ab13350401952247988883.mp4"
},
"creativeMedia": [
{
"mediaMimeType": "video/webm",
"id": 901399,
"bitRate": 140,
"frameRate": 30,
"mediaUrl": "http://edgecast-vod.yimg.com/yamplus/video_MDvZrnYvD5T8rbVFBuMdHlX8xCakrcxPWco2aXNcV14CsqGcNKSsRFMR7S50NW77jNkCiHMjDmI-_15.webm?a=yamplus&mr=0&c=530957",
"mimeType": 12,
"width": 640,
"height": 360
},
{
"mediaMimeType": "video/mp4",
"id": 901401,
"bitRate": 299,
"frameRate": 30,
"mediaUrl": "http://edgecast-vod.yimg.com/yamplus/video_MDvZrnYvD5T8rbVFBuMdHlX8xCakrcxPWco2aXNcV14CsqGcNKSsRFMR7S50NW77jNkCiHMjDmI-_9.mp4?a=yamplus&mr=0&c=530957",
"mimeType": 11,
"width": 640,
"height": 360
}
]
},
"isSmartAd": false
}
],
"errors": null,
"timeStamp": "2019-09-25T18:53:21Z"
}
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
.
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.
|
string |
Y | ||
accountId |
body | Specifies the advertiser ID. To learn more, see /traffic/advertiser/index. |
integer |
Y | ||
landingPageUrl |
body | Specifies the URL that redirects to the landing page. May be a click tracker or landing page URL.
|
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 Ad/Creative MIME Types response. For example, image/png , video/mp4 . |
string |
N | ||
creativeType |
body | Specifies the creative type.
|
string |
Y | ||
creativeImpressionTracking |
body | Specifies an array of To learn more, see Creative Impression Tracking Object. |
array |
N | ||
customIdentifierValues |
body | Specifies an array of To learn more, see Custom Identifier Object. |
array |
N | ||
adBehaviorType |
body | Specifies ad behavior.
To learn more, see Ad Behavior Types. |
string |
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.
|
string |
Y [3] | ||
layout |
body | Specifies the layout (ad size).
To learn more, see Layouts. |
string |
Y [4] | ||
adChoicesEnabled |
body | Indicates whether AdChoices CLEAR Ad Notice enabled.
|
boolean |
Y [5] | ||
isThirdPartyCodeSecure |
body | Indicates whether an ad tag is secure for third-party creatives.
|
boolean |
Y [6] | ||
adxCategories |
body | An array of ADX categories. Supported categories:
|
array |
N | ||
thirdPartyCode |
body | Specifies a third-party ad tag.
|
string |
Y [7] | ||
adType |
body | Specifies the ad type.
|
string |
Y [8] | ||
userInteractions |
body | Specifies user interaction. Options include:
|
array |
Y [9] | ||
expandDirections |
body | Specifies the expandable direction. Options include:
|
array |
Y [10] |
DISPLAY_THIRD_PARTY Example¶
The payload specifies a third-party display creative (DISPLAY_THIRD_PARTY
).
DISPLAY_THIRD_PARTY Request¶
The adChoicesEnabled
, 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",
"layout": "728x90",
"adBehaviorType": "Billboard - Motion",
"id": 435524,
"accountId": 1356341,
"name": "TEST-DISPLAY-THIRD-PARTY",
"landingPageUrl": "http://abc.com",
"landingPageDomain": "https://abc.go.com/",
"adChoicesEnabled": true,
"isThirdPartyCodeSecure": true,
"thirdPartyCode": "<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></iframe>",
"updatedAt": "2018-08-03T19:21:37Z",
"creativeImpressionTracking": [
{
"impTrackerUrl": "<img src=\"https://abc.com\" />",
"trackingEventType": "IMPRESSION"
}
],
"isSmartAd": true,
"customIdentifierValues": [
{
"id": 3432,
"identifierValue": "35353535353535"
},
{
"id": 3433,
"identifierValue": "123"
}
]
},
"errors": null,
"timeStamp": "2018-08-03T19:21:38Z"
}
DISPLAY_HOSTED Example¶
The payload specifies a hosted display creative (DISPLAY_HOSTED
).
The landingPageUrl
, content
, and adChoicesEnabled
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": 435533,
"accountId": 1356341,
"name": "hostedDisplay",
"landingPageUrl": "http://facebook.com",
"landingPageDomain": "https://www.facebook.com/",
"adChoicesEnabled": false,
"updatedAt": "2018-08-03T23:28:27Z",
"details": {
"images": {
"creativeFileUrl": "https://s.yimg.com/zi/3f745217-757f-4068-926f-6faf4801a270.png"
}
},
"creativeImpressionTracking": [
{
"impTrackerUrl": "<img src=\"https://abc.com\" />",
"trackingEventType": "IMPRESSION"
}
],
"customIdentifierValues": [
{
"id": 3435,
"identifierValue": "123"
},
{
"id": 3434,
"identifierValue": "35353535353535"
}
]
},
"errors": null,
"timeStamp": "2018-08-03T23:28:27Z"
}
NATIVE_DISPLAY Example¶
The payload specifies a native display creative (NATIVE_DISPLAY
).
The landingPageUrl
and content
parameters must be specified if the creativeType
is NATIVE_DISPLAY
.
NATIVE_DISPLAY 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"
}
}
NATIVE_DISPLAY Response¶
{
"response": {
"status": "ACTIVE",
"creativeType": "NATIVE_DISPLAY",
"id": 375466,
"accountId": 1356341,
"name": "NATIVE_DISPLAY_TEST",
"landingPageUrl": "http://facebook.com",
"landingPageDomain": "https://www.facebook.com/",
"hasCompanionAds": false,
"updatedAt": "2018-01-26T04:16:02Z",
"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",
"imageSecuredUrl": "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",
"largeMobileImageSecuredUrl": "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"
}
]
},
"errors": null,
"timeStamp": "2018-01-25T21:52:18Z"
}
Update Display Creatives¶
Updates 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.
Parameters¶
Parameter | Parameter Type | Description | Data Type | Required? |
---|---|---|---|---|
id |
path | Specifies the creative ID. | 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.
|
string |
N |
accountId |
body | Specifies the advertiser ID. To learn more, see Advertisers. |
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 Ad/Creative MIME Types response. For example, image/png . |
string |
N |
creativeType |
body | Specifies the creative type.
|
string |
Y |
creativeImpressionTracking |
body | Specifies an array of To learn more, see Creative Impression Tracking Object. |
array |
N |
customIdentifierValues |
body | Specifies an array of To learn more, see Custom Identifier Object. |
array |
N |
adBehaviorType |
body | Specifies ad behavior. To learn more, see Ad Behavior Types. |
string |
Y |
isSmartAd |
body | Specifies the ad is a Smart Ad. | boolean |
N |
content |
body | An object that identifies hosted and native creative binary data.
|
string |
N |
layout |
body | Specifies the ad size of the creative. To learn more, see Layouts. |
string |
N |
adChoicesEnabled |
body | Indicates whether AdChoices CLEAR Ad Notice enabled.
|
boolean |
N |
isThirdPartyCodeSecure |
body | Indicates whether an ad tag is secure for third-party creatives.
|
boolean |
N |
adxCategories |
body | An array of ADX categories. Supported categories:
|
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.
|
string |
Y |
userInteractions |
body | Specifies user interaction. Required if the creative’s
|
array |
N |
expandDirections |
body | Specifies the expandable direction.
|
array |
N |
Example Request¶
PUT https://dspapi.admanagerplus.yahoo.com/traffic/creatives/435524
All parameters are specified in the body of the application/json payload.
{
"name": "UPDATED-TEST-DISPLAY-THIRDPARTY"
}
Example Response¶
The response returns the updated creative.
{
"response": {
"status": "ACTIVE",
"mimeType": "image/png",
"creativeType": "DISPLAY_THIRD_PARTY",
"adxCategories": [
"ALCOHOL_AD"
],
"adType": "MRAID",
"layout": "728x90",
"adBehaviorType": "Billboard - Motion",
"id": 435524,
"accountId": 1356341,
"name": "UPDATED-TEST-DISPLAY-THIRDPARTY",
"landingPageUrl": "http://abc.com",
"landingPageDomain": "https://abc.go.com/",
"adChoicesEnabled": true,
"isThirdPartyCodeSecure": true,
"thirdPartyCode": "<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></iframe>",
"updatedAt": "2018-08-03T19:21:37Z",
"creativeImpressionTracking": [
{
"impTrackerUrl": "<img src=\"https://abc.com\" />",
"trackingEventType": "IMPRESSION"
}
],
"isSmartAd": true,
"customIdentifierValues": [
{
"id": 3432,
"identifierValue": "35353535353535"
},
{
"id": 3433,
"identifierValue": "123"
}
]
},
"errors": null,
"timeStamp": "2018-08-03T19:21:38Z"
}
Create Video Creatives¶
Adds a new video creative.
POST /traffic/creatives
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.
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
.
All parameters are specified in the body of the application/json payload.
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.
|
string |
Y | ||
accountId |
body | Specifies the advertiser ID. To learn more, see /traffic/advertiser/index. |
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 Ad/Creative MIME Types response. For example, image/png , video/mp4 . |
string |
N | ||
creativeType |
body | Specifies the video creative type.
|
string |
Y | ||
creativeImpressionTracking |
body | Specifies an array of To learn more, see Creative Impression Tracking Object. |
array |
N | ||
customIdentifierValues |
body | Specifies an array of To learn more, see Custom Identifier Object. |
array |
N | ||
adBehaviorType |
body | Specifies ad behavior. To learn more, see Ad Behavior Types.
|
string |
Y [11] | ||
isSmartAd |
body | Specifies the ad is a Smart Ad. | boolean |
Y | ||
content |
body | An object that identifies hosted and native creative binary data.
|
string |
Y [12] | ||
adChoicesEnabled |
body | Indicates whether AdChoices CLEAR Ad Notice enabled.
|
boolean |
Y [13] | ||
isThirdPartyCodeSecure |
body | Indicates whether an ad tag is secure for third-party creatives.
|
boolean |
Y [14] | ||
creativeTagUrl |
body | Specifies the VAST URL for the creatives.
|
string |
Y [15] | ||
creativeCompanionBanner |
body | Specifies the creative companion banner. Can be specified if the To learn more, see creative-companion-banner. |
object |
N |
VIDEO_HOSTED Example¶
The payload specifies a hosted video creative (VIDEO_HOSTED
).
The content
and creativeTagUrl
parameters must be specified if the creativeType
is VIDEO_HOSTED
.
VIDEO_HOSTED Request¶
{
"name": "Hosted Video Creative",
"landingPageUrl": "http://abc.com",
"accountId": 1356341,
"creativeType": "VIDEO_HOSTED",
"status": "ACTIVE",
"adxCategories": [
"ALCOHOL_AD"
],
"content": {
"binaryData": "BASE64VIDEO"
},
"companionBanners": {
"companionBinaryData": "iVBORw0KGg...",
"mimeType": "image/jpeg",
"Name": "cloud1"
}
}
VIDEO_HOSTED Response¶
{
"response": {
"status": "ACTIVE",
"mimeType": "video/mp4",
"creativeType": "VIDEO_HOSTED",
"id": 552633,
"accountId": 1356341,
"name": "Hosted Video Creative",
"landingPageUrl": "https://ad.doubleclick.net/ddm/clk/319233694;147898959;j",
"landingPageDomain": "http://www.brightroll.com",
"adChoicesEnabled": true,
"updatedAt": "2019-04-11T20:44:28Z",
"details": {
"images": {
"creativeFileUrl": "http://l.yimg.com/ff/pbp/creatives/d38813a5-17a3-4e88-93ff-525025c50f15426413245567033751.mp4"
},
"creativeMedia": [
{
"mediaMimeType": "video/mp4",
"id": 934201,
"bitRate": 299,
"frameRate": 30,
"mediaUrl": "http://edgecast-vod.yimg.com/yamplus/video_hzyJ_LJxBcfiY0MNzNAJW6BG5j4Q-QMJs-6UtSphIqzLaVw_JmPIsViuEoHwiW_0fI27VO41gEc-_9.mp4?a=yamplus&mr=0&c=552633",
"mimeType": 11,
"width": 640,
"height": 360
},
{
"mediaMimeType": "video/webm",
"id": 934207,
"bitRate": 121,
"frameRate": 30,
"mediaUrl": "http://edgecast-vod.yimg.com/yamplus/video_hzyJ_LJxBcfiY0MNzNAJW6BG5j4Q-QMJs-6UtSphIqzLaVw_JmPIsViuEoHwiW_0fI27VO41gEc-_15.webm?a=yamplus&mr=0&c=552633",
"mimeType": 12,
"width": 640,
"height": 360
}
]
},
"companionBanners": [
{
"id": 14,
"name": "cloud1",
"mimeType": "PNG",
"mimeTypeId": 3,
"bannerSecuredUrl": "https://s.yimg.com/zm/pbp/creatives/f64cbdfd-0407-4365-86f7-f647e1c59d3e.png",
"bannerUnsecuredUrl": "https://s.yimg.com/zm/pbp/creatives/f64cbdfd-0407-4365-86f7-f647e1c59d3e.png",
"width": 250,
"height": 150,
"sizeInBytes": 2825
}
],
"isSmartAd": false
},
"errors": null,
"timeStamp": "2019-09-25T19:15:32Z"
}
VIDEO_THIRD_PARTY Example¶
The payload specifies a third-party video creative (VIDEO_THIRD_PARTY
).
VIDEO_THIRD_PARTY Request¶
{
"name": "Test Video 3rd Party",
"status": "ACTIVE",
"accountId": 1356341,
"creativeType": "VIDEO_THIRD_PARTY",
"isSmartAd": false,
"adChoicesEnabled": true,
"mimeType": "video/mp4",
"adBehaviorType": "Standard Pre-Roll Video",
"creativeTagUrl": "https://svastx.moatads.com/maxusnbcudcmvpaid724386723387/ZNB_WOD_World_of_Dance_S2_Summer_2018-220962546_js.xml?zMoatADV=4481714&",
"isThirdPartyCodeSecure": true
}
VIDEO_THIRD_PARTY Response¶
{
"response": {
"status": "ACTIVE",
"creativeType": "VIDEO_THIRD_PARTY",
"adBehaviorType": "Standard Pre-Roll Video",
"id": 677274,
"accountId": 1356341,
"name": "Test Video 3rd Party",
"landingPageUrl": "https://adclick.g.doubleclick.net/pcs/click?xa-Yahoo",
"landingPageDomain": "https://itunes.apple.com/us/tv-season/the-young-pope/id1194064536?mt=4&ign-mpt=uo%3D4",
"adChoicesEnabled": true,
"isThirdPartyCodeSecure": true,
"creativeTagUrl": "https://vast.doubleverify.com/v3/vast?_vast=https%3a%2f%2fad.doubleclick.net%2fddm%2fpfadx%2fN286407.153731YAHOOINC.%2fB11546373.200047576%3bsz%3d0x0%3bord%3d%5btimestamp%5d%3bdc_lat%3d%3bdc_rdid%3d%3btag_for_child_directed_treatment%3d%3bdcmt%3dtext%2fxml&_media=15&ctx=1095775&cmp=11546373&sid=3289435&plc=200047576&advid=3065265&adsrv=166®ion=30&blk=1",
"updatedAt": "2018-08-04T05:40:02Z",
"details": {
"duration": 15,
"images": {},
"creativeMedia": [
{
"mediaMimeType": "video/mp4",
"id": 2093970,
"bitRate": 650,
"frameRate": 1,
"mediaUrl": "https://gcdn.2mdn.net/videoplayback/id/fcbf2ffcfb335cff/itag/59/source/doubleclick_dmm/ratebypass/yes/acao/yes/ip/0.0.0.0/ipbits/0/expire/3640877312/sparams/id,itag,source,ratebypass,acao,ip,ipbits,expire/signature/6FB48A70841372E6C30529F991C8C241AE6199EA.E2AC3687A7F0F4A6BE0F51D13A62D634D840BEE/key/ck2/file/file.mp4",
"mimeType": 11,
"width": 854,
"height": 480
},
{
"mediaMimeType": "video/mp4",
"id": 2093956,
"bitRate": 1540,
"frameRate": 1,
"mediaUrl": "https://gcdn.2mdn.net/videoplayback/id/fcbf2ffcfb335cff/itag/22/source/doubleclick_dmm/ratebypass/yes/acao/yes/ip/0.0.0.0/ipbits/0/expire/3640877321/sparams/id,itag,source,ratebypass,acao,ip,ipbits,expire/signature/5E19FC08277B3CE8C727822F09D32C3322CF1223.9FE2D3246426D7061E8811F08A94ACBF031119E2/key/ck2/file/file.mp4",
"mimeType": 11,
"width": 1280,
"height": 720
},
{
"mediaMimeType": "video/mp4",
"id": 2093954,
"bitRate": 3063,
"frameRate": 1,
"mediaUrl": "https://gcdn.2mdn.net/videoplayback/id/fcbf2ffcfb335cff/itag/37/source/doubleclick_dmm/ratebypass/yes/acao/yes/ip/0.0.0.0/ipbits/0/expire/3640877347/sparams/id,itag,source,ratebypass,acao,ip,ipbits,expire/signature/9663C1CFFE9466F676D2603C3AF83C624BD285C2.199190E0341ED3C1E6297AC8A86D32EB9C4605CE/key/ck2/file/file.mp4",
"mimeType": 11,
"width": 1920,
"height": 1080
}
]
},
"isSmartAd": false
},
"errors": null,
"timeStamp": "2019-09-25T19:21:03Z"
}
NATIVE_VIDEO Example¶
The payload specifies a native video creative (NATIVE_VIDEO
).
The content
parameter must be specified if the creativeType
is NATIVE_VIDEO
.
NATIVE_VIDEO Request¶
{
"name": "Native Video",
"landingPageUrl": "https://advertising.yahoo.com/insights/creating-video-programming-reaches-right-audiences",
"accountId": 1356341,
"creativeType": "NATIVE_VIDEO",
"status": "ACTIVE",
"content": {
"binaryData": "BASE64VIDEO",
"smallBinaryData": "Advertiser logo",
"nativeVideoImageData": "Video cover"
},
"details": {
"title": "Reach the right audience",
"companyName": "Adv.Name",
"description": "Ad.Description"
},
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "CLICK"
}
]
}
NATIVE_VIDEO Response¶
{
"response": {
"status": "ACTIVE",
"mimeType": "video/quicktime",
"creativeType": "NATIVE_VIDEO",
"adBehaviorType": "Standard Pre-Roll Video",
"id": 592158,
"accountId": 1356341,
"name": "Native Video",
"landingPageUrl": "https://advertising.yahoo.com/insights/creating-video-programming-reaches-right-audiences",
"updatedAt": "2019-04-11T20:54:21Z",
"details": {
"duration": 99,
"title": "Reach the right audience",
"description": "Ad.Description",
"companyName": "Adv.Name",
"images": {
"creativeFileUrl": "http://l.yimg.com/ff/pbp/creatives/04a64614-90db-47b3-8776-368c32a3ce40154483942691298668.quicktime",
"iconImageSecuredUrl": "https://s.yimg.com/ff/pbp/creatives/8e33a1b9-e3ca-41c3-ad1a-f3642384e1017347566883354617084.png",
"imageSecuredUrl": "https://s.yimg.com/ff/pbp/creatives/21b165d4-73df-40a9-ac49-2b4db561a8645372795989322205278.jpeg"
},
"creativeMedia": [
{
"id": 1045728,
"bitRate": 699,
"frameRate": 30,
"mediaUrl": "http://edgecast-vod.yimg.com/yamplus/video_6jd0ErIlCJb4yqqMB2nTYve6HLRJ5S3N9GlHWooxW0ZYdIWREAr44OCfbgd38qXCf51BnvaX0_A-_10.mp4?a=yamplus&mr=0&c=592158",
"mimeType": 11,
"width": 640,
"height": 360
},
{
"id": 1045723,
"bitRate": 943,
"frameRate": 30,
"mediaUrl": "http://edgecast-vod.yimg.com/yamplus/video_6jd0ErIlCJb4yqqMB2nTYve6HLRJ5S3N9GlHWooxW0ZYdIWREAr44OCfbgd38qXCf51BnvaX0_A-_19.webm?a=yamplus&mr=0&c=592158",
"mimeType": 12,
"width": 640,
"height": 360
}
]
},
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "CLICK"
}
]
},
"errors": null,
"timeStamp": "2019-09-25T19:24:30Z"
}
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 payload.
Parameter | Parameter Type | Description | Data Type | Required? |
---|---|---|---|---|
id |
path | Specifies the creative ID. | 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.
|
string |
N |
accountId |
body | Specifies the advertiser ID. To learn more, see /traffic/advertiser/index. |
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 Ad/Creative MIME Types response. For example, video/mp4 . |
string |
N |
creativeType |
body | Specifies the creative type.
|
string |
N |
creativeImpressionTracking |
body | Specifies an array of To learn more, see Creative Impression Tracking Object. |
array |
N |
customIdentifierValues |
body | Specifies an array of To learn more, see Custom Identifier Object. |
array |
N |
adBehaviorType |
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.
|
string |
N |
adChoicesEnabled |
body | Indicates whether AdChoices CLEAR Ad Notice enabled.
|
boolean |
N |
isThirdPartyCodeSecure |
body | Indicates whether an ad tag is secure for third-party creatives.
|
boolean |
N |
creativeTagUrl |
body | Specifies the VAST URL for the creatives. | string |
N |
creativeCompanionBanner |
body | Specifies the creative companion banner. You can update
To learn more, see creative-companion-banner. |
object |
N |
Example Request¶
PUT https://dspapi.admanagerplus.yahoo.com/traffic/creatives/552633
{
"name": "Updated Hosted Video Creative"
}
Example Response¶
{
"response": {
"status": "ACTIVE",
"mimeType": "video/mp4",
"creativeType": "VIDEO_HOSTED",
"id": 552633,
"accountId": 1356341,
"name": "Updated Hosted Video Creative",
"landingPageUrl": "https://ad.doubleclick.net/ddm/clk/319233694;147898959;j",
"landingPageDomain": "http://www.brightroll.com",
"adChoicesEnabled": true,
"updatedAt": "2019-04-11T20:44:28Z",
"details": {
"images": {
"creativeFileUrl": "http://l.yimg.com/ff/pbp/creatives/d38813a5-17a3-4e88-93ff-525025c50f15426413245567033751.mp4"
},
"creativeMedia": [
{
"mediaMimeType": "video/mp4",
"id": 934201,
"bitRate": 299,
"frameRate": 30,
"mediaUrl": "http://edgecast-vod.yimg.com/yamplus/video_hzyJ_LJxBcfiY0MNzNAJW6BG5j4Q-QMJs-6UtSphIqzLaVw_JmPIsViuEoHwiW_0fI27VO41gEc-_9.mp4?a=yamplus&mr=0&c=552633",
"mimeType": 11,
"width": 640,
"height": 360
},
{
"mediaMimeType": "video/webm",
"id": 934207,
"bitRate": 121,
"frameRate": 30,
"mediaUrl": "http://edgecast-vod.yimg.com/yamplus/video_hzyJ_LJxBcfiY0MNzNAJW6BG5j4Q-QMJs-6UtSphIqzLaVw_JmPIsViuEoHwiW_0fI27VO41gEc-_15.webm?a=yamplus&mr=0&c=552633",
"mimeType": 12,
"width": 640,
"height": 360
}
]
},
"companionBanners": [
{
"id": 14,
"name": "cloud1",
"mimeType": "PNG",
"mimeTypeId": 3,
"bannerSecuredUrl": "https://s.yimg.com/zm/pbp/creatives/f64cbdfd-0407-4365-86f7-f647e1c59d3e.png",
"bannerUnsecuredUrl": "https://s.yimg.com/zm/pbp/creatives/f64cbdfd-0407-4365-86f7-f647e1c59d3e.png",
"width": 250,
"height": 150,
"sizeInBytes": 2825
}
],
"isSmartAd": false
},
"errors": null,
"timeStamp": "2019-09-25T19:15:32Z"
}
Example Request¶
PUT https://dspapi.admanagerplus.yahoo.com/traffic/creatives/370529
You can update the companionBanner
in a hosted video. An empty object removes the companionBanner
objects.
{
"name": "hostedVideoPOSTMAN",
"landingPageUrl": "http://abc.com",
"accountId": 1356341,
"creativeType": "VIDEO_HOSTED",
"status": "ACTIVE",
"adxCategories": [
"ALCOHOL_AD"
],
"adBehaviorType": "Ad Bar",
"content": {
"binaryData": "BASE64VIDEO"
},
"companionBanner": {
"companionBinaryData": "iVBORw0KGg...",
"mimeType": "image/jpeg",
"name": "cloud1"
}
}
Create Audio Creatives¶
Adds a new audio creative.
POST /traffic/creatives
Note
The creative audio size can be up to 100MB.
Note
Supported native creative audio formats include:
MP3
OGG
MP4
WEBM
WAV
Parameters¶
The platform supports one type of audio creative: AUDIO_HOSTED
.
All new audio creatives are defined by name
, status
, accountId
, isSmartAd
and creativeType
parameters.
All parameters are specified in the body of the application/json payload.
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.
|
string |
Y | ||
accountId |
body | Specifies the advertiser ID. To learn more, see /traffic/advertiser/index. |
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 Ad/Creative MIME Types response. For example, audio/ogg , audio/mp4 . |
string |
N | ||
creativeType |
body | Specifies the video creative type.
|
string |
Y | ||
creativeImpressionTracking |
body | Specifies an array of To learn more, see Creative Impression Tracking Object. |
array |
N | ||
customIdentifierValues |
body | Specifies an array of To learn more, see Custom Identifier Object. |
array |
N | ||
adBehaviorType |
body | Specifies ad behavior. To learn more, see Ad Behavior Types.
|
string |
Y [16] | ||
isSmartAd |
body | Specifies the ad is a Smart Ad. | boolean |
Y | ||
content |
body | An object that identifies hosted and native creative binary data.
|
string |
Y [17] | ||
adChoicesEnabled |
body | Indicates whether AdChoices CLEAR Ad Notice enabled.
|
boolean |
Y [18] | ||
isThirdPartyCodeSecure |
body | Indicates whether an ad tag is secure for third-party creatives.
|
boolean |
Y [19] | ||
creativeTagUrl |
body | Specifies the VAST URL for the creatives. | string |
Y [20] | ||
creativeCompanionBanner |
body | Specifies the creative companion banner. Can be specified if the To learn more, see creative-companion-banner. |
object |
N |
Update Audio Creatives¶
Updates audio 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 payload.
Parameter | Parameter Type | Description | Data Type | Required? |
---|---|---|---|---|
id |
path | Specifies the creative ID. | 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.
|
string |
N |
accountId |
body | Specifies the advertiser ID. To learn more, see /traffic/advertiser/index. |
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 Ad/Creative MIME Types response. For example, audio/mp4 . |
string |
N |
creativeType |
body | Specifies the creative type.
|
string |
N |
creativeImpressionTracking |
body | Specifies an array of To learn more, see Creative Impression Tracking Object. |
array |
N |
customIdentifierValues |
body | Specifies an array of To learn more, see Custom Identifier Object. |
array |
N |
adBehaviorType |
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.
|
string |
N |
adChoicesEnabled |
body | Indicates whether AdChoices CLEAR Ad Notice enabled.
|
boolean |
N |
isThirdPartyCodeSecure |
body | Indicates whether an ad tag is secure for third-party creatives.
|
boolean |
N |
creativeTagUrl |
body | Specifies the VAST URL for the creatives. | string |
N |
creativeCompanionBanner |
body | Specifies the creative companion banner. You can update
To learn more, see creative-companion-banner. |
object |
N |
Example Request¶
PUT https://dspapi.admanagerplus.yahoo.com/traffic/creatives/1795615
{
"name": "UPDATED-TEST-AUDIO"
}
Example Response¶
{
"response": {
"status": "ACTIVE",
"mimeType": "audio/mpeg",
"creativeType": "AUDIO_HOSTED",
"layout": "400x300",
"adBehaviorType": "Standard Pre-Roll Audio",
"id": 1795615,
"accountId": 42819,
"name": "UPDATED-TEST-AUDIO",
"landingPageUrl": "https://www.yahoo.com",
"landingPageDomain": "https://www.yahoo.com",
"adChoicesEnabled": false,
"isThirdPartyCodeSecure": true,
"updatedAt": "2019-08-07T03:47:58Z",
"details": {
"duration": 3,
"images": {
"creativeFileUrl": "https://s.yimg.com/ch/raw-videos/b32625d0-1e8b-45ef-beb8-9f8318d2a5e4.mp3"
},
"creativeMedia": [
{
"id": 7283274,
"bitRate": 125,
"frameRate": 44100,
"mediaUrl": "http://edgecast-vod.yimg.com/brdsp/e3aa150d-af82-5be2-b13f-00e760dffb37/video_output_1.mp3",
"mimeType": 20,
"width": 1,
"height": 1
},
{
"id": 7283273,
"bitRate": 125,
"frameRate": 44100,
"mediaUrl": "http://edgecast-vod.yimg.com/brdsp/e3aa150d-af82-5be2-b13f-00e760dffb37/video_output_2.mp4",
"mimeType": 22,
"width": 1,
"height": 1
},
{
"id": 7283275,
"bitRate": 125,
"frameRate": 44100,
"mediaUrl": "http://edgecast-vod.yimg.com/brdsp/e3aa150d-af82-5be2-b13f-00e760dffb37/video_output_3.ogg",
"mimeType": 21,
"width": 1,
"height": 1
}
]
},
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://ad.doubleclick.net/ad/N6616.8578.YAHOOINC/B8067401.10;sz=1x1;ord=${REQUESTID}?",
"trackingEventType": "IMPRESSION"
}
],
"isSmartAd": false,
"companionBanners": [
{
"id": 1364,
"name": "2019_q2_ca_events_bts_300x250_fr",
"mimeType": "JPEG",
"mimeTypeId": 2,
"bannerSecuredUrl": "https://s.yimg.com/ch/727dcc23-c8d4-489c-9f00-93576199de74.jpeg",
"bannerUnsecuredUrl": "https://s.yimg.com/ch/727dcc23-c8d4-489c-9f00-93576199de74.jpeg",
"width": 300,
"height": 250,
"sizeInBytes": 31595
}
]
},
"errors": null,
"timeStamp": "2019-09-25T22:26:58Z"
}
Example Request¶
PUT https://dspapi.admanagerplus.yahoo.com/traffic/creatives/370529
You can update the companionBanner
in a hosted audio. An empty object removes the companionBanner
objects.
{
"name": "hostedAudioPOSTMAN",
"landingPageUrl": "http://abc.com",
"accountId": 1356341,
"creativeType": "AUDIO_HOSTED",
"status": "ACTIVE",
"adxCategories": [
"ALCOHOL_AD"
],
"adBehaviorType": "Ad Bar",
"content": {
"binaryData": "BASE64VIDEO"
},
"companionBanner": {
"companionBinaryData": "iVBORw0KGg...",
"mimeType": "image/jpeg",
"name": "cloud1"
}
}
Upload Bulk Creatives¶
Uploads multiple display or video creatives for a specified advertiser.
POST /traffic/creatives/advertiser/{id}/bulkupload
Parameters¶
The advertiser ID is specified in the path of the endpoint. All other parameters are specified as an array in the body of the application/json.
Parameter | Parameter Type | Description | Data Type | Required? | ||
---|---|---|---|---|---|---|
id |
path | Specifies the creative ID. | 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.
|
string |
N | ||
accountId |
body | Specifies the advertiser ID. To learn more, see /traffic/advertiser/index. |
integer |
N | ||
landingPageUrl |
body | Specifies the URL that redirects to the landing page. May be a click tracker or landing page URL.
|
string |
Y [21] | ||
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 Ad/Creative MIME Types response. For example, video/mp4 . |
string |
N | ||
creativeType |
body | Specifies the creative type.
|
string |
N | ||
creativeImpressionTracking |
body | Specifies an array of To learn more, see Creative Impression Tracking Object. |
array |
N | ||
customIdentifierValues |
body | Specifies an array of To learn more, see Custom Identifier Object. |
array |
N | ||
adBehaviorType |
body | Specifies ad behavior.
To learn more, see Ad Behavior Types. |
integer |
Y [22] | ||
isSmartAd |
body | Specifies the ad is a Smart Ad. | boolean |
N | ||
content |
body | An object that identifies hosted and native creative binary data.
|
string |
Y [23] | ||
creativeTagUrl |
body | Specifies the VAST URL for the creatives. | 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.
|
boolean |
Y [24] | ||
isThirdPartyCodeSecure |
body | Indicates whether an ad tag is secure for third-party creatives. Required if
|
boolean |
Y [25] | ||
adxCategories |
body | An array of ADX categories. Supported categories:
|
array |
N | ||
thirdPartyCode |
body | Specifies a third-party ad tag.
|
string |
Y [26] | ||
adType |
body | Specifies the ad type.
|
string |
Y [#]_ | ||
userInteractions |
body | Specifies user interaction. Required if the creative’s
|
array |
Y [#]_ | ||
expandDirections |
body | Specifies the expandable direction.
|
array |
Y [#]_ |
Example Request¶
The advertiser ID is specified in the path of the resource endpoint.
POST https://dspapi.admanagerplus.yahoo.com/traffic/creatives/advertiser/8094/bulkupload
All other parameters are specified as an array in the body of the application/json.
[
{
"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": 8094
},
{
"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": 8094
},
{
"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": 8094,
"content": {
"binaryData": "BASE64FORMATOFIMAGE"
}
},
{
"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": 8094,
"content": {
"binaryData": "binaryData",
"largeMobileImageData": "largeMobileImageData",
"smallBinaryData": "largeMobileImageData",
"smallImageBinaryData": "largeMobileImageData"
},
"details": {
"title": "AdTitile125",
"companyName": "Adv.Name",
"description": "Ad.Description"
}
},
{
"name": "hostedVideoPOSTMAN",
"landingPageUrl": "http://abc.com",
"accountId": 8094,
"creativeType": "VIDEO_HOSTED",
"status": "ACTIVE",
"adxCategories": [
"ALCOHOL_AD"
],
"adBehaviorType": "Ad Bar",
"content": {
"binaryData": "BASE64VIDEO"
}
},
{
"name": "NativeVideoTest",
"landingPageUrl": "http://abc.com",
"accountId": 8094,
"creativeType": "NATIVE_VIDEO",
"status": "ACTIVE",
"content": {
"binaryData": "BASE64VIDEO",
"smallBinaryData": "Advertiser logo",
"nativeVideoImageData": "Video cover"
},
"details": {
"title": "AdTitile125",
"companyName": "Adv.Name",
"description": "Ad.Description"
}
}
]
Example Response¶
The response returns the IDs of the newly uploaded creatives.
{
"response": {
"creatives": [
{
"id": 399612
},
{
"id": 399613
},
{
"id": 399614
},
{
"id": 399615
},
{
"id": 399616
},
{
"id": 399617
}
]
},
"errors": null,
"timeStamp": "2018-04-18T20:30:11Z"
}
Update Bulk Creatives¶
Updates multiple display or video creatives.
PATCH /traffic/creatives
Parameters¶
All parameters are specified as an array in the body of the application/json.
For each creative, you must specify an object that consists of the creative ID (id
) and the attributes to be updated for that creative.
Parameter | Parameter Type | Description | Data Type | Required? |
---|---|---|---|---|
id |
body | Specifies the creative ID. | 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.
|
string |
N |
accountId |
body | Specifies the advertiser ID. To learn more, see /traffic/advertiser/index. |
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 Ad/Creative MIME Types response. For example, video/mp4 . |
string |
N |
creativeType |
body | Specifies the creative type.
|
string |
N |
creativeImpressionTracking |
body | Specifies an array of To learn more, see Creative Impression Tracking Object. |
array |
N |
customIdentifierValues |
body | Specifies an array of To learn more, see Custom Identifier Object. |
array |
N |
adBehaviorType |
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.
|
string |
N |
creativeTagUrl |
body | Specifies the VAST URL for the creatives. | 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.
|
boolean |
N |
isThirdPartyCodeSecure |
body | Indicates whether an ad tag is secure for third-party creatives.
|
boolean |
N |
adxCategories |
body | An array of ADX categories. Supported categories:
|
array |
N |
thirdPartyCode |
body | Specifies a third-party ad tag. | string |
N |
adType |
body | Specifies the ad type.
|
string |
N |
userInteractions |
body | Specifies user interaction. Required if the creative’s
|
array |
N |
expandDirections |
body | Specifies the expandable direction.
|
array |
N |
Example Request¶
No parameters are specified in the endpoint path.
PATCH https://dspapi.admanagerplus.yahoo.com/traffic/creatives
All parameters are specified as an array in the body of the application/json.
For each creative updated, you must specify an object that consists of the creative ID and the attributes to be updated for that creative.
[
{
"id": "398922",
"name": "tyutTEST-DISPLAY-THIRD-PARTYgh"
},
{
"id": "398925",
"landingPageUrl": "http://yahoo.com"
}
]
Example Response¶
{
"response": "Success",
"errors": null,
"timeStamp": "2018-05-04T18:07:19Z"
}
Delete Creatives¶
The deletion of creatives is not supported by the Verizon Media DSP API.