Creatives¶
This article describes resources and services for reading, adding, and updating display and video creatives individually and in bulk.
Overview¶
A creative is an object that defines the image or video asset that is the foundation of an ad.
The Yahoo DSP API supports the following types of creatives:
- DISPLAY_HOSTED
A hosted display creative defines an image asset that is hosted by Yahoo.
- DISPLAY_THIRD_PARTY
A third-party display creative defines an image asset that is hosted by a third-party server.
- NATIVE_DISPLAY
A native display creative defines an image asset that integrates with mobile content layouts.
- NATIVE_VIDEO
A native video creative defines a video asset that integrates with mobile content layouts.
- VIDEO_HOSTED
A hosted video creative defines a video asset that is hosted by Yahoo.
- VIDEO_THIRD_PARTY
A third-party video creative defines a video asset that is hosted by a third-party server.
- AUDIO_HOSTED
A hosted audio creative defines an audio asset that is hosted by Yahoo.
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, refer to 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
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¶
Parameter |
Description |
Data Type |
Required |
---|---|---|---|
|
Specifies the name of the creative. |
|
Y |
|
Specifies the current status of the creative.
|
|
Y |
|
Specifies the advertiser ID. To learn more, refer to Advertisers. |
|
Y |
|
Specifies the call to action text language. Use the value of the name field in the Premium Native Languages response. |
|
N [1] |
|
Specifies the URL that redirects to the landing page. Can be a click tracker or landing page URL. Required for all creative types except for the following: |
|
N [2] |
|
The top-level domain of the |
|
N |
|
Specifies the creative MIME type. Use the |
|
Y |
|
Specifies the creative type. Allowed values:
|
|
Y |
|
Specifies the layout (ad size). Required if Make sure this value is in the UI Ad Size dropdown (e.g., 1000x300). Layout option can be To learn more, refer to Layouts. |
|
N [3] |
|
Specifies multipleLayouts (ad sizes). Required if multiple ad sizes are desired for Make sure this value is in the UI ad size dropdown (e.g., 1000x300). Type one or multiple values separated by “,”. |
|
N [4] |
|
Indicates whether AdChoices CLEAR Ad Notice enabled. Required if
|
|
N [5] |
|
Specifies the location of the AdChoices Icon with respect to the creative. This option is available only to Pharma Advertisers i.e. advertisers having Allowed values:
|
|
N |
|
Indicates whether an ad tag is secure for third-party creatives. Required if
|
|
N [6] |
|
Specifies a third-party ad tag. Required if |
|
N [7] |
|
Specifies the ad type. Required if Allowed values:
|
|
N [8] |
|
Specifies user interaction. Required if Allowed values:
Type one or multiple values separated by “,”. |
|
N [9] |
|
Specifies the expandable direction. Required if Allowed values:
Type one or multiple values separated by “,”. |
|
N [10] |
|
Specifies the VAST URL for the creatives. Required if |
|
N [11] |
|
Content object contains the following fields for providing hosted and native creative binary data:
Required for certain creative types as noted above. |
|
N [12] |
|
Details object contains information on creative media such as URLs for videos or images. Required if To learn more, refer to Details Object. |
|
N [13] |
|
Specifies an array of To learn more, refer to Creative Impression Tracking Object. |
|
N |
|
Specifies an array of To learn more, refer to Custom Identifier Object. |
|
N |
|
Specifies the companion banner. Only valid when An empty object removes any existing |
|
N |
|
An array of ADX categories. Supported categories: Allowed values:
|
|
N |
|
A read-only field that specifies the time of the last update. |
|
N/A |
|
Indicates whether the creative is a DOOH creative or not. Can only be true if |
|
N |
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 reporting.
Yahoo 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 |
---|---|---|
|
Specifies the ID of the tracker. |
|
|
Specifies the URL of the tracker. |
|
|
Specifies the event type of the tracker. If
If
If
|
|
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.
Field |
Description |
Data Type |
---|---|---|
|
Specifies the identifier ID. |
|
|
Specifies the identifier value. |
|
Example Payload¶
{
"customIdentifierValues": [
{
"id": 1,
"identifierValue": "Value1",
},
{
"id": 2,
"identifierValue": "Value2",
}
]
}
Details Object¶
details
is a read-only object that provides information on creative media.
Field |
Description |
Data Type |
---|---|---|
|
Specifies the ad title. Required if |
|
|
Specifies the ad description. Required if |
|
|
Specifies the advertiser name. Required if |
|
|
Specifies the custom call to action text. You can specify your own text or use predefined labels as returned by the Premium Native Predefined CTA Labels response. Required if |
|
|
Specifies if the This feature is only available for Native Portrait Video creatives ( |
|
|
Contains URLs for the raw files.
|
|
|
For video creatives, this element contains information on the transcoded video formats.
|
|
Example Response¶
{
"details": {
"duration": 3,
"images": {
"creativeFileUrl": "https://s.yimg.com/zi/raw-videos/fd9829a8-0f1a-4259-b642-ff677acff511.mov"
},
"creativeMedia": [
{
"id": 726239,
"bitRate": 308,
"frameRate": 30,
"mediaUrl": "http://edgecast-vod.yimg.com/brdsp-dev/2b12dd25-d5e1-5b66-bec3-7ddd9fadade0/video_output_7.mp4",
"width": 640,
"height": 360,
"mediaMimeType": "video/mp4"
},
{
"id": 726237,
"bitRate": 102,
"frameRate": 15,
"mediaUrl": "http://edgecast-vod.yimg.com/brdsp-dev/2b12dd25-d5e1-5b66-bec3-7ddd9fadade0/video_output_5.mp4",
"width": 340,
"height": 192,
"mediaMimeType": "video/mp4"
},
{
"id": 726238,
"bitRate": 188,
"frameRate": 30,
"mediaUrl": "http://edgecast-vod.yimg.com/brdsp-dev/2b12dd25-d5e1-5b66-bec3-7ddd9fadade0/video_output_6.mp4",
"width": 426,
"height": 240,
"mediaMimeType": "video/mp4"
}
]
}
}
Read Creative¶
Get data for a specific creative.
GET /traffic/creatives/{id}
Parameters¶
Parameter |
Parameter Type |
Description |
Data Type |
Required |
---|---|---|---|---|
|
path |
Specifies the creative ID. |
|
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",
"id": 556057,
"accountId": 1,
"name": "Mail Creative",
"landingPageUrl": "https://www.yahoo.com",
"landingPageDomain": "https://www.yahoo.com",
"adChoicesEnabled": true,
"updatedAt": "2019-05-17T22:45:03Z",
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com,
"trackingEventType": "IMPRESSION"
}
],
"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¶
Get 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}
Parameters¶
Parameter |
Description |
Data Type |
Required |
---|---|---|---|
|
Specifies the advertiser ID. |
|
Y |
|
Specifies the creative type. Options include:
|
|
N |
|
Specifies the ad format type. Options include:
|
|
N |
|
Specifies the verbosity of the response. Options include:
|
|
N |
|
Specifies the creative name. |
|
N |
|
Specifies comma-separated creative ID values. |
|
N |
|
Specifies the search term. Use URL encoding conventions (i.e. a space should be replaced with a |
|
N |
|
Specifies the page number. |
|
N |
|
Specifies the total number of items to return. Maximum allowed value is |
|
N |
|
Specifies the column to sort by. |
|
N |
|
Specifies the sort direction:
|
|
N |
Note
If both category
and adformat
are specified, the adformat
filter will be ignored.
Example Request (All Fields)¶
GET https://dspapi.admanagerplus.yahoo.com/traffic/creatives?accountId=1356341&category=video&page=1&limit=2&nonBriefGet=true
Example Response¶
{
"response": [
{
"id": 657,
"accountId": 1356341,
"name": "Video test",
"status": "INACTIVE",
"creativeType": "VIDEO_THIRD_PARTY",
"creativeTagUrl": "http://ad.doubleclick.net/pfadx/N6036.1041586.YAHOOINCGENOMEFROM/B7700683;sz=0x0;ord=%7Bcachebreaker%7D;dcmt=text/xml",
"adChoicesEnabled": true,
"isThirdPartyCodeSecure": true,
"details": {
"images": {
"creativeFileUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/8e6a30eb-72f6-4389-b1b7-0f31c66a0c2e"
},
"creativeMedia": []
},
"updatedAt": "2021-01-21T00:28:32Z"
},
{
"id": 768,
"accountId": 1356341,
"name": "VAST Test Video",
"landingPageUrl": "http://www.yahoo.com",
"status": "INACTIVE",
"creativeType": "VIDEO_HOSTED",
"adChoicesEnabled": true,
"details": {
"duration": 32,
"images": {
"creativeFileUrl": "http://pbp-ci.yahoofs.com/pbp-stg/creatives/big-buck-bunny_trailer.webm"
},
"creativeMedia": [
{
"id": 2063,
"bitRate": 302,
"frameRate": 25,
"mediaUrl": "http://http.stgatlas.cdn.yimg.com/yamplusstg/video_xPP5qSxzC5h71KpgTgZOMcmWVotLZ3sKp9Mn85.TKrdD51.P71ydO1quHPub8ohkxWKKVAo9LFg-_16.webm?a=yamplusstg&c=768",
"width": 640,
"height": 360,
"mediaMimeType": "video/webm"
},
{
"id": 2060,
"bitRate": 274,
"frameRate": 25,
"mediaUrl": "http://http.stgatlas.cdn.yimg.com/yamplusstg/video_xPP5qSxzC5h71KpgTgZOMcmWVotLZ3sKp9Mn85.TKrdD51.P71ydO1quHPub8ohkxWKKVAo9LFg-_9.mp4?a=yamplusstg&c=768",
"width": 640,
"height": 360,
"mediaMimeType": "video/mp4"
}
]
},
"updatedAt": "2021-01-21T00:28:32Z",
"creativeImpressionTracking": [
{
"impTrackerUrl": "http://www.hundredpercentview.com",
"trackingEventType": "PERCENT_100"
},
{
"impTrackerUrl": "http://www.fiftypercentview.com",
"trackingEventType": "PERCENT_50"
}
]
}
],
"errors": null,
"timeStamp": "2021-09-25T18:53:21Z"
}
Example Request (Common Fields)¶
GET https://dspapi.admanagerplus.yahoo.com/traffic/creatives?accountId=1356341&category=video&page=1&limit=2
Example Response¶
{
"response": [
{
"id": 657,
"accountId": 1,
"name": "Video test",
"status": "INACTIVE",
"creativeType": "VIDEO_THIRD_PARTY",
"creativeTagUrl": "http://ad.doubleclick.net/pfadx/N6036.1041586.YAHOOINCGENOMEFROM/B7700683;sz=0x0;ord=%7Bcachebreaker%7D;dcmt=text/xml",
"adChoicesEnabled": true,
"isThirdPartyCodeSecure": true,
"details": {
"images": {},
"creativeMedia": []
},
"updatedAt": "2021-01-21T00:28:32Z"
},
{
"id": 768,
"accountId": 1,
"name": "VAST Test Video",
"landingPageUrl": "http://www.yahoo.com",
"status": "INACTIVE",
"creativeType": "VIDEO_HOSTED",
"adChoicesEnabled": true,
"details": {
"duration": 32,
"images": {},
"creativeMedia": [
{
"id": 2062,
"bitRate": 299,
"width": 640,
"height": 360,
"mediaMimeType": "video/x-flv"
},
{
"id": 2061,
"bitRate": 110,
"width": 640,
"height": 360,
"mediaMimeType": "video/webm"
}
]
},
"updatedAt": "2021-01-21T00:28:32Z",
"creativeImpressionTracking": [
{
"impTrackerUrl": "http://www.fiftypercentview.com",
"trackingEventType": "PERCENT_50"
},
{
"impTrackerUrl": "http://www.twentyfivepercentview.com",
"trackingEventType": "PERCENT_25"
}
]
}
],
"errors": null,
"timeStamp": "2021-09-25T18:53:21Z"
}
Create Creative¶
Create one of the following creative types: Create Display Creative, Create Video Creative, Create Audio Creative and Create Native Creative.
Create Display Creative¶
Creative a new display creative (DISPLAY_HOSTED
, DISPLAY_THIRD_PARTY
).
POST /traffic/creatives
Note
The creative image size can be up to 2MB.
DISPLAY_THIRD_PARTY Example¶
DISPLAY_THIRD_PARTY Request Body¶
{
"name": "TEST-DISPLAY-THIRD-PARTY-5",
"accountId": 1
"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": "https://yahoo.com",
"adChoicesEnabled": true,
"adType": "BANNER",
"status": "ACTIVE",
"isThirdPartyCodeSecure": true,
"creativeImpressionTracking": [
{
"impTrackerUrl": "https:/yahoo.com",
"trackingEventType": "IMPRESSION"
}
],
"customIdentifierValues": [
{
"identifierValue": "123"
}
]
}
DISPLAY_THIRD_PARTY Response¶
{
"response": {
"id": 492729,
"accountId": 1,
"name": "TEST-DISPLAY-THIRD-PARTY-5",
"landingPageUrl": "https://yahoo.com",
"landingPageDomain": "https://yahoo.com/",
"status": "ACTIVE",
"mimeType": "image/png",
"creativeType": "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 -->",
"adType": "BANNER",
"adChoicesEnabled": true,
"isThirdPartyCodeSecure": true,
"layout": "728x90",
"details": {
"images": {},
"creativeMedia": []
},
"customIdentifierValues": [
{
"id": 851,
"identifierValue": "35353535353535"
}
],
"updatedAt": "2020-06-12T02:20:13Z",
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "IMPRESSION"
}
]
},
"errors": null,
"timeStamp": "2020-06-12T02:20:30.206Z"
}
DISPLAY_HOSTED Example¶
DISPLAY_HOSTED Request Body¶
{
"name": "TEST-DISPLAY-HOSTED-5",
"accountId": 1,
"layout": "115x15",
"creativeType": "DISPLAY_HOSTED",
"landingPageUrl": "https://yahoo.com",
"adChoicesEnabled": false,
"status": "ACTIVE",
"mimeType": "image/jpeg",
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "IMPRESSION"
}
],
"content": {
"binaryData": "BASE64DATA"
}
}
DISPLAY_HOSTED Response¶
{
"response": {
"id": 435533,
"status": "ACTIVE",
"mimeType": "image/jpeg",
"creativeType": "DISPLAY_HOSTED",
"layout": "115x15",
"accountId": 1,
"name": "TEST-DISPLAY-HOSTED-5",
"landingPageUrl": "https://yahoo.com",
"landingPageDomain": "https://www.yahoo.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": "https://yahoo.com",
"trackingEventType": "IMPRESSION"
}
]
},
"errors": null,
"timeStamp": "2018-08-03T23:28:27Z"
}
Create Video Creative¶
Create a new video creative (VIDEO_HOSTED
and VIDEO_THIRD_PARTY
).
POST /traffic/creatives
Note
The creative video size can be up to 300MB. Supported creative video formats include:
MOV
AVI
ASF
OGG
WEBM
FLV
MP4
WMV
M3U8
VIDEO_THIRD_PARTY Example¶
VIDEO_THIRD_PARTY Request Body¶
{
"accountId": 1,
"name": "TEST-VIDEO-THIRD-PARTY-5",
"landingPageUrl": "https://www.yahoo.com",
"creativeTagUrl": "https://svastx.moatads.com/maxusnbcudcmvpaid724386723387/ZNB_WOD_World_of_Dance_S2_Summer_2018-220962546_js.xml?zMoatADV=4481714&",
"mimeType": "video/mp4",
"creativeType": "VIDEO_THIRD_PARTY",
"status": "ACTIVE",
"isThirdPartyCodeSecure": true,
"adChoicesEnabled": true,
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "IMPRESSION"
}
]
}
VIDEO_THIRD_PARTY Response¶
{
"response": {
"id": 528375,
"accountId": 1,
"name": "TEST-VIDEO-THIRD-PARTY-5",
"landingPageUrl": "https://www.yahoo.com",
"landingPageDomain": "https://www.yahoo.com/",
"status": "ACTIVE",
"mimeType": "application/javascript",
"creativeType": "VIDEO_THIRD_PARTY",
"creativeTagUrl": "https://svastx.moatads.com/maxusnbcudcmvpaid724386723387/ZNB_WOD_World_of_Dance_S2_Summer_2018-220962546_js.xml?zMoatADV=4481714&",
"adChoicesEnabled": true,
"isThirdPartyCodeSecure": true,
"details": {
"duration": 15,
"images": {},
"creativeMedia": [
{
"id": 731041,
"bitRate": -1,
"frameRate": 1,
"mediaUrl": "https://svastx.moatads.com/maxusnbcudcmvpaid724386723387/moatwrapper.js#vast=https%3a%2f%2fad.doubleclick.net%2fddm%2fpfadx%2fN9003.1864407SAMBATV%2fB21005979.220962546%3bsz%3d0x0%3bdcmt%3dtext%2fxml%3btag_for_child_directed_treatment%3d%3bdc_rdid%3d%3bord%3d399805072%3bdc_lat%3d%5b%5bextras%5d%5d&level1=21005979&level2=Samba%20TV&level3=220962546&level4=vpaid_creative_unit&slicer1=undefined&slicer2=undefined&pcode=maxusnbcudcmvpaid724386723387&spvb=1&zMoatADV=4481714",
"width": 1280,
"height": 720,
"mediaMimeType": "application/javascript"
}
]
},
"updatedAt": "2020-08-12T21:48:44Z",
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "IMPRESSION"
}
]
},
"errors": null,
"timeStamp": "2020-08-12T21:48:45.641Z"
}
VIDEO_HOSTED Example¶
VIDEO_HOSTED Request Body¶
{
"accountId": 1,
"name": "TEST-VIDEO-HOSTED-5",
"landingPageUrl": "https://yahoo.com",
"creativeType": "VIDEO_HOSTED",
"status": "ACTIVE",
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "IMPRESSION"
}
],
"content": {
"binaryData": "BASE64DATA"
}
}
VIDEO_HOSTED Response¶
{
"response": {
"id": 528375,
"accountId": 1,
"name": "TEST-VIDEO-HOSTED-5",
"landingPageUrl": "https://www.yahoo.com",
"landingPageDomain": "https://www.yahoo.com/",
"status": "ACTIVE",
"mimeType": "application/javascript",
"creativeType": "VIDEO_THIRD_PARTY",
"creativeTagUrl": "https://svastx.moatads.com/maxusnbcudcmvpaid724386723387/ZNB_WOD_World_of_Dance_S2_Summer_2018-220962546_js.xml?zMoatADV=4481714&",
"adChoicesEnabled": true,
"isThirdPartyCodeSecure": true,
"details": {
"duration": 15,
"images": {},
"creativeMedia": [
{
"id": 729654,
"bitRate": -1,
"frameRate": 1,
"mediaUrl": "https://svastx.moatads.com/maxusnbcudcmvpaid724386723387/moatwrapper.js#vast=https%3a%2f%2fad.doubleclick.net%2fddm%2fpfadx%2fN9003.1864407SAMBATV%2fB21005979.220962546%3bsz%3d0x0%3bdcmt%3dtext%2fxml%3btag_for_child_directed_treatment%3d%3bdc_rdid%3d%3bord%3d831095759%3bdc_lat%3d%5b%5bextras%5d%5d&level1=21005979&level2=Samba%20TV&level3=220962546&level4=vpaid_creative_unit&slicer1=undefined&slicer2=undefined&pcode=maxusnbcudcmvpaid724386723387&spvb=1&zMoatADV=4481714",
"width": 1280,
"height": 720,
"mediaMimeType": "application/javascript"
}
]
},
"updatedAt": "2020-08-07T20:05:06Z",
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "IMPRESSION"
}
]
},
"errors": null,
"timeStamp": "2020-08-07T20:05:40.667Z"
}
Create Audio Creative¶
Create a new audio creative.
The following creative types are supported: AUDIO_HOSTED
.
POST /traffic/creatives
Note
The creative audio size can be up to 100MB. Supported creative audio formats include:
MP3
OGG
MP4
AUDIO_HOSTED Example¶
AUDIO_HOSTED Request Body¶
{
"accountId": 1,
"name": "TEST-AUDIO-HOSTED-6",
"creativeType": "AUDIO_HOSTED",
"landingPageUrl": "https://yahoo.com",
"status": "ACTIVE",
"mimeType": "audio/ogg",
"adChoicesEnabled": false,
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "IMPRESSION"
}
],
"content": {
"binaryData": "BASE64DATA"
}
}
AUDIO_HOSTED Response¶
{
"response": {
"id": 528421,
"accountId": 1,
"name": "TEST-AUDIO-HOSTED-6",
"landingPageUrl": "https://yahoo.com",
"landingPageDomain": "https://www.yahoo.com/",
"status": "ACTIVE",
"mimeType": "audio/ogg",
"creativeType": "AUDIO_HOSTED",
"adChoicesEnabled": true,
"isThirdPartyCodeSecure": true,
"details": {
"images": {
"creativeFileUrl": "https://s.yimg.com/zi/raw-videos/4ff924df-cf53-4798-af37-cc27dc030b3a.ogg"
},
"creativeMedia": []
},
"updatedAt": "2020-08-13T03:48:07Z",
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "IMPRESSION"
}
]
},
"errors": null,
"timeStamp": "2020-08-13T03:48:07.654Z"
}
Create Native Creative¶
This section provides information on creating third-party native creatives.
Note
Refer to Yahoo Native Creatives for details on Yahoo native creatives.
Create a new native creative (NATIVE_DISPLAY
, NATIVE_VIDEO
).
In combination with the adType
, you can create new ad formats. The platform supports creatives with the following ad type(s): CAROUSEL
, XBOX
. You can also create a native creative without an adType
.
POST /traffic/creatives
NATIVE_DISPLAY Example¶
NATIVE_DISPLAY Request Body¶
{
"name": "NATIVE_DISPLAY_TEST",
"accountId": 1,
"creativeType": "NATIVE_DISPLAY",
"landingPageUrl": "https://yahoo.com",
"status": "ACTIVE",
"language": "ENGLISH",
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "JAVASCRIPT"
}
],
"customIdentifierValues": [
{
"identifierValue": "123"
}
],
"content": {
"binaryData": "BASE64DATA",
"largeMobileImageData": "BASE64DATA",
"smallBinaryData": "BASE64DATA",
"smallImageBinaryData": "BASE64DATA"
},
"details": {
"title": "AdTitle125",
"companyName": "Adv.Name",
"description": "Ad.Description",
"callToAction": "Buy Now"
}
}
NATIVE_DISPLAY Response¶
{
"response": {
"id": 2617293,
"accountId": 1,
"name": "NATIVE_DISPLAY_TEST",
"landingPageUrl": "https://yahoo.com",
"landingPageDomain": "https://www.yahoo.com/",
"status": "ACTIVE",
"creativeType": "NATIVE_DISPLAY",
"language": "ENGLISH",
"details": {
"title": "AdTitle125",
"description": "Ad.Description",
"companyName": "Adv.Name",
"callToAction": "Buy Now",
"images": {
"iconImageSecuredUrl": "https://s.yimg.com/zi/b9e68cd4-d5df-4348-ae86-e3af90b7a55f.png",
"imageSecuredUrl": "https://s.yimg.com/zi/c063b0ad-3c90-42a1-a79a-852f0dbd5ce8.png",
"smallImageSecuredUrl": "https://s.yimg.com/zi/0ba78f74-0c66-4629-aaf0-474efd630421.png",
"largeMobileImageSecuredUrl": "https://s.yimg.com/zi/7b0bc009-57ab-4893-b6c8-97c2b1a997e7.png"
},
"creativeMedia": []
},
"customIdentifierValues": [
{
"id": 2290,
"identifierValue": "123"
}
],
"updatedAt": "2020-08-21T01:15:31Z",
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "JAVASCRIPT"
}
]
},
"errors": null,
"timeStamp": "2020-08-21T01:15:31.554Z"
}
XBOX Example¶
XBOX Request Body¶
{
"name": "Xbox test",
"landingPageUrl": "https://yahoo.com",
"accountId": 1,
"creativeType": "NATIVE_VIDEO",
"adType": "XBOX",
"landingPageDomain": "https://yahoo.com",
"mimeType": "video/mp4",
"status": "ACTIVE",
"content": {
"binaryData": "BASE64DATA",
"smallBinaryData": "BASE64DATA",
"nativeVideoImageData": "BASE64DATA"
},
"details": {
"title": "Reach the right audience",
"companyName": "Adv.Name",
"description": "Ad.Description",
"displayUrl": "yahoo.com"
},
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "CLICK"
}
]
}
XBOX Response¶
{
"response": {
"id": 592158,
"accountId": 1,
"name": "Xbox test",
"landingPageUrl": "https://advertising.yahoo.com/insights/creating-video-programming-reaches-right-audiences",
"landingPageDomain": "https://advertising.yahoo.com/insights/creating-video-programming-reaches-right-audiences",
"status": "ACTIVE",
"mimeType": "video/mp4",
"creativeType": "NATIVE_VIDEO",
"adFormat": "XBOX",
"details": {
"title": "Reach the right audience",
"duration": 99,
"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",
"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",
"width": 640,
"height": 360
}
]
},
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "CLICK"
}
],
"updatedAt": "2020-11-05T20:12:47Z"
},
"errors": null,
"timeStamp": "2019-09-25T19:24:30Z"
}
NATIVE_VIDEO Example¶
NATIVE_VIDEO Request Body¶
{
"name": "Native Video",
"landingPageUrl": "https://advertising.yahoo.com/insights/creating-video-programming-reaches-right-audiences",
"accountId": 1,
"creativeType": "NATIVE_VIDEO",
"status": "ACTIVE",
"language": "ENGLISH",
"content": {
"binaryData": "BASE64DATA",
"smallBinaryData": "Advertiser logo",
"nativeVideoImageData": "Video cover"
},
"details": {
"title": "Reach the right audience",
"companyName": "Adv.Name",
"description": "Ad.Description",
"callToAction": "Buy Now"
},
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "CLICK"
}
]
}
NATIVE_VIDEO Response¶
{
"response": {
"status": "ACTIVE",
"mimeType": "video/quicktime",
"creativeType": "NATIVE_VIDEO",
"id": 592158,
"accountId": 1,
"name": "Native Video",
"landingPageUrl": "https://advertising.yahoo.com/insights/creating-video-programming-reaches-right-audiences",
"updatedAt": "2019-04-11T20:54:21Z",
"language": "ENGLISH",
"details": {
"duration": 99,
"title": "Reach the right audience",
"description": "Ad.Description",
"companyName": "Adv.Name",
"callToAction": "Buy Now",
"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",
"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",
"width": 640,
"height": 360
}
]
},
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "CLICK"
}
]
},
"errors": null,
"timeStamp": "2019-09-25T19:24:30Z"
}
Update Creative¶
Update an existing creative.
PUT /traffic/creatives/{id}
Partial updates are supported; values of supported fields which are not in the payload will remain unchanged.
Parameters¶
The Creative id
is specified in the url path. All other fields are specified in the body of the application/json payload.
Example Request¶
PUT https://dspapi.admanagerplus.yahoo.com/traffic/creatives/528375
Example Request Body¶
{
"name": "UPDATED-TEST-VIDEO-HOSTED-5"
}
Example Response¶
{
"response": {
"status": "ACTIVE",
"mimeType": "video/mp4",
"creativeType": "VIDEO_HOSTED",
"id": 552633,
"accountId": 1,
"name": "UPDATED-TEST-VIDEO-HOSTED-5",
"landingPageUrl": "https://ad.doubleclick.net/ddm/clk/319233694;147898959;j",
"landingPageDomain": "https://www.yahoo.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",
"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",
"width": 640,
"height": 360
}
]
}
},
"errors": null,
"timeStamp": "2019-09-25T19:15:32Z"
}
Parameters¶
If it is MRAID_PLAYABLE
, the payload needs to be updated as shown below.
Example Request¶
{
"name": "${NAME}",
"layout": "Responsive",
"adType": "MRAID_PLAYABLE",
"multipleLayouts": "160x600",
"userInteractions": [
"ON_LOAD",
"ON_CLICK"
],
"expandDirections": [
"LEFT",
"UP"
]
}
Bulk Upload Creatives¶
Upload multiple creatives for a specified advertiser.
POST /traffic/creatives/bulkupload?accountId={accountId}
Parameters¶
Parameter |
Description |
Data Type |
Required |
---|---|---|---|
|
Specifies the advertiser ID. |
|
Y |
Example Request¶
POST https://dspapi.admanagerplus.yahoo.com/traffic/creatives/bulkupload?accountId=1
All other fields are specified as an array in the body of the application/json.
Example Request Body¶
[
{
"name": "TEST-DISPLAY-HOSTED-7",
"accountId": 1,
"layout": "115x15",
"creativeType": "DISPLAY_HOSTED",
"landingPageUrl": "https://yahoo.com",
"adChoicesEnabled": false,
"status": "ACTIVE",
"mimeType": "image/jpeg",
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "IMPRESSION"
}
],
"content": {
"binaryData": "BASE64DATA"
}
},
{
"accountId": 1,
"name": "TEST-VIDEO-THIRD-PARTY-5",
"landingPageUrl": "https://www.yahoo.com",
"creativeTagUrl": "https://svastx.moatads.com/maxusnbcudcmvpaid724386723387/ZNB_WOD_World_of_Dance_S2_Summer_2018-220962546_js.xml?zMoatADV=4481714&",
"mimeType": "video/mp4",
"creativeType": "VIDEO_THIRD_PARTY",
"status": "ACTIVE",
"isThirdPartyCodeSecure": true,
"adChoicesEnabled": true,
"creativeImpressionTracking": [
{
"impTrackerUrl": "https://yahoo.com",
"trackingEventType": "IMPRESSION"
}
]
}
]
Example Response¶
The response returns the IDs of the uploaded creatives.
{
"response": {
"creatives": [
{
"id": 514283
},
{
"id": 514284
}
]
},
"errors": null,
"timeStamp": "2020-07-24T22:07:14.740Z"
}
Delete Creatives¶
The deletion of creatives is not supported by the Yahoo DSP API.