Creatives

Overview

A creative is an image or video file that serves as a building block for ad assembly. When linked to a line item, a creative is considered an “ad” ready to be served on a web page. The same creative can be associated with multiple line items.

Endpoint

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

Fields (Common)

The Creative object contains the following fields:

Name Description Type Add Update
id ID of the creative. integer N/A Required
name Name of the creative. Note: If you update the name of the creative, any liked Ads will also inherit the creative’s name. text Required Optional
status

Current status of the creative.

  • ACTIVE - Active.
  • INACTIVE - Inactive
text Required Optional
accountId Advertiser/account ID. Refer to Advertisers. integer Required Optional
landingPageUrl URL that will redirect to the landing page. This URL can be a click tracker or landing page URL. text Required Optional
mimeType Creative MIME type. Use the value field from the Creative MIME Types response. Some example values: image/png, video/mp4. text Required Optional
creativeType

Creative type.

  • DISPLAY_HOSTED
  • DISPLAY_THIRD_PARTY
  • VIDEO_HOSTED
  • NATIVE_DISPLAY
  • NATIVE_VIDEO
text Required Optional
         
creativeImpressionTracking Array containing creativeImpressionTracking objects. array Optional Optional
updatedAt (Read-Only) Last updated timestamp. datetime N/A N/A

Fields (Display Common)

In addition to the Common fields, Display creative object contains the following fields:

creativeImpressionTracking 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.

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

Each element in the creativeImpressionTracking object contains the following fields:

Name Description Type Add Update
id ID of the tracker. integer N/A N/A
impTrackerUrl Tracking url. text Required Optional
trackingEventType

Tracking url type.

Following values are valid when creativeType is DISPLAY_HOSTED or DISPLAY_THIRD_PARTY:

  • IMPRESSION
text Required Optional

Example Payload

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

Read Creative (Single)

To retrieve data for a specific Creative, make a GET call with the id parameter.

GET https://dspapi.admanagerplus.yahoo.com/traffic/creatives/{id}
Name Description Type Required?
id Creative ID integer Y

The response will be the Creative associated with the given ID.

Example Request

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

Example Response

{
  "response": {
    "id": 1,
    "accountId": 1,
    "name": "test_creative",
    "landingPageUrl": "https://www.test.com",
    "creativeTypeId": 1,
    "mimeTypeId": 1,
    "layoutId": 1,
    "clientStatusId": 1,
    "adChoicesEnabled": false,
    "isThirdPartyCodeSecure": true,
    "updatedAt": 1446228889000,
    "creativeImpressionTracking": []
  },
  "errors": null,
  "timeStamp": "2017-04-12T04:49:06Z"
}

Read Creatives (Filtered)

To retrieve a filtered list of Creatives, make a GET call with the supported query parameters.

GET https://dspapi.admanagerplus.yahoo.com/traffic/creatives?accountId={accountId}&category={category}&adformat={adformat}&page={page}&limit={limit}&sort={sort}&dir={dir}&query={query}
Name Description Type Required?
accountId Account or Advertiser ID integer Y
category Creative type: display|dynamic|video|native text N
adformat Ad format type: image|video text N
page Page number integer N
limit Total number of items to return. Maximum allowed value is 100. integer N
sort Column to sort by text N
dir Sort direction. Valid values: asc, desc text N
query Search term. Use url encoding conventions (i.e. a space should be replaced with a + or %20). text N

The response will be a list of matching Creatives.

Example Request

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

Example Response

{
  "response": [
    {
      "id": 1,
      "accountId": 1,
      "name": "test video creative 1",
      "landingPageUrl": "http://yahoo.com",
      "creativeTypeId": 5,
      "mimeTypeId": 11,
      "layoutId": 19,
      "clientStatusId": 1,
      "adChoicesEnabled": true,
      "isThirdPartyCodeSecure": true,
      "updatedAt": 1489516709000,
      "creativeImpressionTracking": [
        {
          "id": 1,
          "impTrackerUrl": "http://yahoo.com",
          "trackingEventTypeId": 0
        },
        {
          "id": 2,
          "impTrackerUrl": "https://ad.doubleclick.net/ddm/ad/ord=${REQUESTID};dc_lat=;dc_rdid=",
          "trackingEventTypeId": 4
        }
      ]
    },
    {
      "id": 2,
      "accountId": 1,
      "name": "test video creative 2",
      "landingPageUrl": "http://yahoo.com/sports",
      "creativeTypeId": 5,
      "mimeTypeId": 14,
      "layoutId": 19,
      "clientStatusId": 1,
      "adChoicesEnabled": true,
      "isThirdPartyCodeSecure": true,
      "updatedAt": 1489682007000,
      "creativeImpressionTracking": [
        {
          "id": 3,
          "impTrackerUrl": "https://ad.doubleclick.net/ddm/ad/sz=1x1",
          "trackingEventTypeId": 4
        },
        {
          "id": 4,
          "impTrackerUrl": "http://yahoo.com",
          "trackingEventTypeId": 0
        }
      ]
    }
  ],
  "errors": null,
  "timeStamp": "2017-04-12T04:49:06Z"
}