Creatives

26 Minutes to read

Creatives

26 Minutes to read

Article summary

Did you find this summary helpful?

Thank you for your feedback!

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
`name`	Specifies the name of the creative.	`string`	Y
`status`	Specifies the current status of the creative. `ACTIVE` - Active `INACTIVE` - Inactive	`string`	Y
`accountId`	Specifies the advertiser ID. To learn more, refer to Advertisers.	`integer`	Y
`language`	Specifies the call to action text language. Use the value of the name field in the Premium Native Languages response. Required if `creativeType` is `NATIVE_DISPLAY` or `NATIVE_DISPLAY` and only when using predefined CTA labels.	`string`	N
`landingPageUrl`	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: `CAROUSEL`, `DISPLAY_THIRD_PARTY`, `VIDEO_THIRD_PARTY`.	`string`	N
`landingPageDomain`	The top-level domain of the `landingPageUrl`.	`string`	N
`mimeType`	Specifies the creative MIME type. Use the `value` field from the Ad/Creative MIME Types response. For example: `image/png`, `video/mp4`.	`string`	Y
`creativeType`	Specifies the creative type. Allowed values: `DISPLAY_HOSTED` `DISPLAY_THIRD_PARTY` `VIDEO_HOSTED` `VIDEO_THIRD_PARTY` `NATIVE_DISPLAY` `NATIVE_VIDEO` `AUDIO_HOSTED`	`string`	Y
`layout`	Specifies the layout (ad size). Required if `creativeType` is any of the following: `DISPLAY_HOSTED`, `DISPLAY_THIRD_PARTY`. Make sure this value is in the UI Ad Size dropdown (e.g., 1000x300). Layout option can be `Responsive` if it’s an `MRAID_PLAYABLE` ad. It is required if advertiser wants to use `multipleLayouts`. To learn more, refer to Layouts.	`string`	N
`multipleLayouts`	Specifies multipleLayouts (ad sizes). Required if multiple ad sizes are desired for `MRAID_PLAYABLE`. Make sure this value is in the UI ad size dropdown (e.g., 1000x300). Type one or multiple values separated by “,”.	`string`	N
`adChoicesEnabled`	Indicates whether AdChoices CLEAR Ad Notice enabled. Required if `creativeType` is any of the following: `DISPLAY_THIRD_PARTY`, `DISPLAY_HOSTED`, `VIDEO_THIRD_PARTY`, `AUDIO_HOSTED`. If `true`, display a CLEAR Ad Notice on or near the ad. If `false`, do not display a CLEAR Ad Notice notification.	`boolean`	N
`adChoiceIconLocation`	Specifies the location of the AdChoices Icon with respect to the creative. This option is available only to Pharma Advertisers i.e. advertisers having `iabCategoryId` = 7. To learn more refer to Advertisers. Also, this requires field `adChoicesEnabled` to be `true`. The default value is UPPER_RIGHT. Allowed values: `UPPER_RIGHT` `UPPER_LEFT` `LOWER_LEFT`	`string`	N
`isThirdPartyCodeSecure`	Indicates whether an ad tag is secure for third-party creatives. Required if `creativeType` is any of the following: `DISPLAY_THIRD_PARTY`, `VIDEO_THIRD_PARTY`. If `true`, the ad tag is secure for third-party creatives. If `false`, the ad tag is unsecure for third-party creatives.	`boolean`	N
`thirdPartyCode`	Specifies a third-party ad tag. Required if `creativeType` is `DISPLAY_THIRD_PARTY`.	`string`	N
`adType`	Specifies the ad type. Required if `creativeType` is `DISPLAY_THIRD_PARTY`. Allowed values: `BANNER` `RICH_MEDIA` `MRAID`	`string`	N
`userInteractions`	Specifies user interaction. Required if `adType` is `RICH_MEDIA` or `MRAID_PLAYABLE`. Allowed values: `ON_LOAD` `ON_CLICK` `ON_HOVER` Type one or multiple values separated by “,”.	`array`	N
`expandDirections`	Specifies the expandable direction. Required if `adType` is `RICH_MEDIA` or `MRAID_PLAYABLE`. Allowed values: `LEFT` `RIGHT` `UP` `DOWN` `FULLSCREEN` `RICH_MEDIA` only: `AUTOMATIC` Type one or multiple values separated by “,”.	`array`	N
`creativeTagUrl`	Specifies the VAST URL for the creatives. Required if `creativeType` is `VIDEO_THIRD_PARTY`.	`string`	N
`content`	Content object contains the following fields for providing hosted and native creative binary data: `binaryData` - Base64 encoded creative image/video. Required if `creativeType` is `DISPLAY_HOSTED`, `VIDEO_HOSTED`, `NATIVE_DISPLAY`, `NATIVE_VIDEO` or `AUDIO_HOSTED`. `largeMobileImageData` - Base64 encoded mobile web image. Required if `creativeType` is `NATIVE_DISPLAY` or `NATIVE_VIDEO`. `smallBinaryData` - Base64 encoded advertiser logo. Required when `creativeType` is `NATIVE_DISPLAY` or `NATIVE_VIDEO`. `smallImageBinaryData` - Base64 encoded image file for mobile image. Required if `creativeType` is `NATIVE_DISPLAY`. `nativeVideoImageData` - Base64 encoded main cover image file. Required if `creativeType` is `NATIVE_VIDEO`. `panoramaImageData` - Base64 encoded panorama image file. This is an optional field that takes effect only when used on Native Portrait Image creatives (`creativeType` is `NATIVE_DISPLAY` and `adType` is `PORTRAIT`). Required for certain creative types as noted above.	`object`	N
`details`	Details object contains information on creative media such as URLs for videos or images. Required if `creativeType` is any of the following: `NATIVE_DISPLAY`, `NATIVE_VIDEO`. To learn more, refer to Details Object.	`object`	N
`creativeImpressionTracking`	Specifies an array of `creativeImpressionTracking` objects. To learn more, refer to Creative Impression Tracking Object.	`array`	N
`customIdentifierValues`	Specifies an array of `customIdentifier` objects. To learn more, refer to Custom Identifier Object.	`array`	N
`companionBanners`	Specifies the companion banner. Only valid when `creativeType` is `VIDEO_HOSTED` or `AUDIO_HOSTED`. An empty object removes any existing `companionBanners` objects. To learn more, refer to Creative Companion Banner Object.	`object`	N
`adxCategories`	An array of ADX categories. Supported categories: Allowed values: `ALCOHOL_AD`	`array`	N
`updatedAt`	A read-only field that specifies the time of the last update.	`string`	N/A
`isDooh`	Indicates whether the creative is a DOOH creative or not. Can only be true if `creativeType` is `VIDEO_HOSTED` or `DISPLAY_HOSTED`.	`boolean`	N
channelType	Specifies the type of media used to build the line’s creatives. Accepted values: null `DEFAULT` `CTV`	`string`	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
`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 `creativeType` is `DISPLAY_HOSTED` or `DISPLAY_THIRD_PARTY`, allowed values include: `IMPRESSION` If `creativeType` is `NATIVE_DISPLAY`, allowed values include: `IMPRESSION` `JAVASCRIPT` If `creativeType` is `NATIVE_VIDEO`, allowed values include: `IMPRESSION` `PERCENT_25` `PERCENT_50` `PERCENT_75` `PERCENT_100` `CLICK` `JAVASCRIPT` If `creativeType` is `VIDEO_HOSTED` or `AUDIO_HOSTED`, allowed values include: `IMPRESSION` `PERCENT_25` `PERCENT_50` `PERCENT_75` `PERCENT_100` `CLICK` `COMPANION_IMPRESSION` `COMPANION_CLICK` If `creativeType` is `VIDEO_THIRD_PARTY`, allowed values include: `IMPRESSION` `PERCENT_25` `PERCENT_50` `PERCENT_75` `PERCENT_100` `CLICK`	`string`

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 creativeType is DISPLAY_HOSTED or DISPLAY_THIRD_PARTY, allowed values include:

IMPRESSION

If creativeType is NATIVE_DISPLAY, allowed values include:

IMPRESSION
JAVASCRIPT

If creativeType is NATIVE_VIDEO, allowed values include:

IMPRESSION
PERCENT_25
PERCENT_50
PERCENT_75
PERCENT_100
CLICK
JAVASCRIPT

If creativeType is VIDEO_HOSTED or AUDIO_HOSTED, allowed values include:

IMPRESSION
PERCENT_25
PERCENT_50
PERCENT_75
PERCENT_100
CLICK
COMPANION_IMPRESSION
COMPANION_CLICK

If creativeType is VIDEO_THIRD_PARTY, allowed values include:

IMPRESSION
PERCENT_25
PERCENT_50
PERCENT_75
PERCENT_100
CLICK

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.

Field	Description	Data Type
`id`	Specifies 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 companionBanners object defines a banner object for a video creative.

Field	Description	Data Type
`id`	Specifies the ID number of the creative companion banner.	`integer`
`companionBinaryData`	Specifies the Base64 encoded image.	`string`
`mimeType`	Specifies the creative companion banner’s mime type. Allowed values: `image/jpeg` `image/png` `image/gif` `zip`	`string`
`name`	Specifies the name of the creative companion banner.	`string`

Example Payload

{
  "name": "hostedVideo",
  "accountId": 1,
  "landingPageUrl": "https://yahoo.com",
  "creativeType": "VIDEO_HOSTED",
  "status": "ACTIVE",
  "adxCategories": [
    "ALCOHOL_AD"
  ],
  "content": {
    "binaryData": "BASE64DATA"
  },
  "companionBanners": [
    {
      "companionBinaryData": "BASE64DATA",
      "mimeTypeId": "image/jpeg",
      "name": "cloud1"
    }
  ]
}

Details Object

details is a read-only object that provides information on creative media.

Field	Description	Data Type
`title`	Specifies the ad title. Required if `creativeType` is any of the following: `NATIVE_DISPLAY`, `NATIVE_VIDEO`.	`string`
`description`	Specifies the ad description. Required if `creativeType` is any of the following: `NATIVE_DISPLAY`, `NATIVE_VIDEO`.	`string`
`companyName`	Specifies the advertiser name. Required if `creativeType` is any of the following: `NATIVE_DISPLAY`, `NATIVE_VIDEO`.	`string`
`callToAction`	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 `creativeType` is any of the following: `NATIVE_DISPLAY`, `NATIVE_VIDEO`.	`string`
`isVideoScrollable`	Specifies if the `Sync Video with Scroll` feature should be enabled. When enabled, the video playback syncs with vertical scroll, creating a frame-by-frame experience that can play forward and reverse based on scroll position. Your video must be at least 10 seconds long to enable this. This feature is only available for Native Portrait Video creatives (`creativeType = NATIVE_VIDEO` and `adType = PORTRAIT`). Setting this field on other creative types will have no effect.	`boolean`
`images`	Contains URLs for the raw files. `creativeFileUrl` - For `VIDEO_HOSTED` and `DISPLAY_HOSTED` creatives, URL of the raw file (video or image depending on the creative type). `imageSecuredUrl` - For `NATIVE_DISPLAY` and `NATIVE_VIDEO` creatives, URL of the main image. `smallImageSecuredUrl` - For `NATIVE_DISPLAY` creatives, URL of the mobile image. `largeMobileImageSecuredUrl` - For `NATIVE_DISPLAY` creatives, URL of the mobile web image. `iconImageSecuredUrl` - For `NATIVE_DISPLAY` creatives, URL of the advertiser logo image. `panoramaImageSecuredUrl` - For Native Portrait Image creatives (`creativeType` is `NATIVE_DISPLAY` and `adType` is `PORTRAIT`), URL of the optional panorama image.	`string`
`creativeMedia`	For video creatives, this element contains information on the transcoded video formats. `id` - Creative media ID. `mediaMimeType` - MIME type. Refer to `value` field from the Ad/Creative MIME Types response. For example, `image/png`, `video/mp4`. `bitRate` - Bit rate of the transcoded video. `frameRate` - Frame rate of the transcoded video. `width` - Width of the transcoded video. `height` - Height of the transcoded video. `mediaUrl` - URL of the transcoded video file.	`array`

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 by ID

Get data for a specific creative.

GET /traffic/creatives/{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",
    "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 Multiple 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
`accountId`	Specifies the advertiser ID.	`integer`	Y
`category`	Specifies the creative type. Options include: `display` `video` `audio` `native_d` `native_v`	`string`	N
`adformat`	Specifies the ad format type. Options include: `image` `video` `audio`	`string`	N
`nonBriefGet`	Specifies the verbosity of the response. Options include: `true` - Return all supported and relevant fields. `false` (Default) - Return most common fields. Note that `images` field is not populated with this option.	`boolean`	N
`name`	Specifies the creative name.	`string`	N
`creativeIds`	Specifies comma-separated creative ID values.	`string`	N
`query`	Specifies the search term. Use URL encoding conventions (i.e. a space should be replaced with a `+` or `%20`).	`string`	N
`page`	Specifies the page number.	`integer`	N
`limit`	Specifies the total number of items to return. Maximum allowed value is `100`.	`integer`	N
`sort`	Specifies the column to sort by.	`string`	N
`dir`	Specifies the sort direction: `asc` `desc`	`string`	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, Create Native Creative and Create CTV 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"
}

Create CTV Creative

Create a new CTV Creative.

Example Request Body

{
    "layout": "1920x1080",
    "_placementId": "384350208",
    "accountId": 3228327,
    "adType": "BANNER",
    "creativeType": "VIDEO_THIRD_PARTY",
    "creativeTagUrl": "https://creativeTagUrlExample.com",
    "name": "CTV Creative",
    "adChoicesEnabled": true,
    "seatId": "2",
    "mimeType": "video/mp4",
    "isThirdPartyCodeSecure": true,
    "status": "ACTIVE",
    "channelType": "CTV"
}

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"
  ]
}

Read Creative Status from Creative ID

Get creative status for a specific creative.

Parameters

Parameter	Description	Data Type
`auditStatus`	Specifies the audit status. Processing - creative has been submitted and is being processed by the exchange. Audited - creative has been audited and approved. Rejected - creative has been audited and rejected, details in the auditFeedback field. Pending - creative has not yet been submitted to the exchange. Unauditable - creative has been submitted, but it has been deemed un-auditable by the exchange, details in the `auditFeedback` field. processing video - same as processing but for video creatives.	`string`

Parameter

Description

Data Type

auditStatus

Specifies the audit status.

Processing - creative has been submitted and is being processed by the exchange.
Audited - creative has been audited and approved.
Rejected - creative has been audited and rejected, details in the auditFeedback field.
Pending - creative has not yet been submitted to the exchange.
Unauditable - creative has been submitted, but it has been deemed un-auditable by the exchange, details in the auditFeedback field.
processing video - same as processing but for video creatives.

string

GET /traffic/creative/creativestatus/{id}

Sample Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/creatives/creativestatus/9999999

Sample Response

The response returns the creative status/IDs.

{
    "response": {
        "id": 9999999,
        "accountId": 1111111,
        "name": "name",
        "status": "status",
        "creativeType": "creativeType",
        "creativeStatus": "creativeStatus",
        "exchangeAuditResults": [
            {
                "id": 2222222,
                "auditStatus": "auditStatus",
                "updatedAt": "2020-03-05T19:45:21Z",
                "exchangeName": "exchangeName"
            },
            {
                "id": 3333333,
                "auditStatus": "auditStatus",
                "updatedAt": "2020-03-05T19:45:21Z",
                "exchangeName": "exchangeName"
            },
            {
                "id": 4444444,
                "auditStatus": "auditStatus",
                "updatedAt": "2020-03-05T19:45:21Z",
                "exchangeName": "exchangeName"
            },
            {
                "id": 5555555,
                "auditStatus": "auditStatus",
                "updatedAt": "2020-03-05T19:45:21Z",
                "exchangeName": "exchangeName"
            },
            {
                "id": 6666666,
                "auditStatus": "auditStatus",
                "updatedAt": "2020-03-05T19:45:21Z",
                "exchangeName": "exchangeName"
            }
        ],
        "updatedAt": "2020-03-21T04:05:06Z",
        "createdAt": "2020-02-12T22:35:35Z"
    },
    "errors": null,
    "timeStamp": "2024-06-14T14:56:09.236Z"
}

Bulk Upload Creatives

Upload multiple creatives for a specified advertiser.

POST /traffic/creatives/bulkupload?accountId={accountId}

Parameters

Parameter	Description	Data Type	Required
`accountId`	Specifies the advertiser ID.	`integer`	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"
}

Bulk Upload Creatives with Excel

Complete the following three steps to bulk upload multiple creatives with Excel.

Step 1 Download the Creative Template

Download the template based on the designated creative type parameter. Refer to the Endpoints by Creative Type table below to select a creative type parameter.

Important
Refer to the Bulk Upload Creative Data for more information about what columns are required and what are optional in the Excel template.

GET /traffic/creatives/template?{creative type parameter}

Endpoints by Creative Type

Creative Type	Endpoint
Hosted Display	traffic/creatives/template?type=display&hosted=true
Third Party Display	traffic/creatives/template?type=display&thirdparty=true
Hosted DOOH Display	traffic/creatives/template?type=dooh-display&hosted=true
Hosted Video	traffic/creatives/template?type=video&hosted=true
Third Party Video	traffic/creatives/template?type=video&thirdparty=true
Hosted DOOH Video	traffic/creatives/template?type=dooh-video&hosted=true
Hosted Connected TV Video	traffic/creatives/template?type=connectedTV&hosted=true
Third Party Connected TV Video	traffic/creatives/template?type=connectedTV&thirdparty=true
Hosted Audio	traffic/creatives/template?type=audio&hosted=true
Third Party Audio	traffic/creatives/template?type=audio&thirdparty=true
Hosted DOOH Audio	traffic/creatives/template?type=dooh-audio&hosted=true
Hosted Native Display	traffic/creatives/template?type=native&native=true
Hosted Native Video	traffic/creatives/template?type=video&native=true
Native Cinemagraph	traffic/creatives/template?type=cinemagraph&native=true
Upload Multiple Formats	traffic/creatives/template?type=all&native=true
Native mail	traffic/creatives/template?type=mail&native=true

Step 2 Upload the Creative Template and Asset File

The Creative Template lists each creative’s details along with an asset file that contains all the creatives to be uploaded.

POST /traffic/creatives/bulk?accountId={accountId}

Note
The names of the creatives in the zipped file should match the names specified in the Excel template.
Creative assets should be in a zipped folder.

Parameters

Parameter	Description	Data Type	Required
`file`	Excel template	`xlsx`	Y
`zipfile`	Zipped folder containing the assets associated with the creatives that are to be uploaded	`zip`	Y
`accountid`	Specifies the advertiser ID	`integer`	Y

Step 3 Return Creative Template Upload Status

GET /traffic/creatives/bulk/upload/status

Parameters

Parameter	Description	Data Type	Required
accountId	Specifies the advertiser ID	Integer	Y

GET/traffic/creatives/bulk/upload/status?accountId={accountId}

Sample Response

  {
               "bulkUploadId": 123,
               "fileName": "UPLOAD.xlsx",
               "totalRows": 1,
               "successRecords": 0,
               "errorRecords": 1,
               "unchangedRecords": 0,
               "bulkUploadStatus": "DONE",
               "downloadURI": "RESULTSDOWNLOAD.xlsx",
               "uploadDate": "2024-06-18T12:53:59Z"
           }
         
       ]
   },
   "errors": null,
   "timeStamp": "2024-07-02T10:08:50.810Z"
}

Delete Creatives

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

Was this article helpful?

What's Next

Bulk Upload Creative Data