Ads

This article describes services for reading, adding, and updating ads.

Overview

An ad is a creative that is linked to a line item and ready to serve on a web page.

Endpoint

/traffic/ads

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

• Use the GET method to read an existing ad.

• Use the POST method to create a new ad.

• Use the PUT method to update an existing ad.

Resources

The ads resource is defined by the following following fields:

Ad Schedule Object

Ad Countdown Object

The countdown object contains the following fields:

Read Ad

Get data for a specific ad.

GET /traffic/ads/{id}

Parameters

Example Request URL

GET https://dspapi.admanagerplus.yahoo.com/traffic/ads/644808

Example Response

{
  "response": {
  "id": 644808,
  "name": "Creative DV Video Tags 1",
  "lineId": 1886417,
  "creativeId": 3125385,
  "updatedAt": "2021-12-07T15:15:30Z",
  "status": "ACTIVE",
  "nativeAdStatus": "ON_LIMITED",
  "nativeAdRestrictions": [
    "Antivirus or computer-cleaning software",
    “Apple competitors”
  ],
  "mediaType": "VIDEO",
  "schedules": []
  },
  "errors": null,
  "timeStamp": "2022-10-11T15:36:45.348Z"
}

Read Ads

Get a filtered list of ads.

GET /traffic/ads?lineId={lineId}&query={query}&page={page}&limit={limit}&sort={sort}&dir={dir}

Parameters

Example Request URL

GET https://dspapi.admanagerplus.yahoo.com/traffic/ads?lineId=361734&page=1&limit=20

{
  "response": [
    {
      "status": "ACTIVE",
      "mediaType": "DISPLAY",
      "id": 148458,
      "name": "ad-display-2x2",
      "lineId": 361734,
      "creativeId": 358605,
      "updatedAt": "2017-11-02T21:42:20Z",
      "schedules": [
        {
          "id": 338,
          "startDate": "2019-12-01T07:00:00Z",
          "endDate": "2020-01-05T06:59:59Z"
        }
      ]
    },
    {
      "status": "ACTIVE",
      "mediaType": "DISPLAY",
      "id": 152630,
      "name": "ad-display-2x2",
      "lineId": 361734,
      "creativeId": 358605,
      "updatedAt": "2017-11-03T00:23:25Z",
      "schedules": [
        {
          "id": 339,
          "startDate": "2019-12-01T07:00:00Z",
          "endDate": "2019-12-05T06:59:59Z"
        }
      ]
    }
  ],
  "errors": null,
  "timeStamp": "2017-11-03T00:25:35Z"
}

Create Ad

Create a new ad.

POST /traffic/ads

Parameters

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

Example Request URL

POST https://dspapi.admanagerplus.yahoo.com/traffic/ads

Example Request Body

{
  "lineId": 361734,
  "creativeId": 358605,
  "status": "ACTIVE",
  "schedules": [
    {
      "startDate": "2019-12-01T07:00:00Z",
      "endDate": "2019-12-05T06:59:59Z"
    }
  ]
}

Example Response

{
  "response": {
    "status": "ACTIVE",
    "mediaType": "DISPLAY",
    "id": 152630,
    "name": "ad-display-2x2",
    "lineId": 361734,
    "creativeId": 358605,
    "updatedAt": "2017-11-03T00:23:25Z",
    "schedules": [
      {
        "id": 340,
        "startDate": "2019-12-01T07:00:00Z",
        "endDate": "2019-12-05T06:59:59Z"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2017-11-03T00:23:25Z"
}

Create Native Ad

Create a new native ad with an optional countdown.

POST /traffic/ads

Parameters

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

Example Request URL

POST https://dspapi.admanagerplus.yahoo.com/traffic/ads

Example Request Body

{
  "lineId": 361734,
  "creativeId": 358605,
  "status": "ACTIVE",
  "mediaType": "NATIVE",
  "countdown": {
    "countdownPrefixId": 22,
    "endDate": "2020-09-25T23:59:56Z",
    "timezone": "America/New_York"
  }
}

Example Response

{
  "response": {
    "id": 506506,
    "name": "native-ad-standard",
    "lineId": 669814,
    "creativeId": 520828,
    "updatedAt": "2020-09-09T13:11:55Z",
    "status": "ACTIVE",
    "mediaType": "NATIVE",
    "schedules": [],
    "countdown": {
      "id": 1466,
      "countdownPrefixId": 22,
      "endDate": "2020-09-25T22:59:56Z",
      "timezone": "America/New_York"
    }
  },
  "errors": null,
  "timeStamp": "2020-09-09T13:12:00.841Z"
}

Update Ad

Update an existing ad.

PUT /traffic/ad/{id}

Partial updates are supported; values of supported fields that are not in the payload remain unchanged.

Parameters

The Ad id is specified in the url path. All other fields are specified in the body of the application/json payload.

Example Request URL

PUT https://dspapi.admanagerplus.yahoo.com/traffic/ads/152630

Example Request Body

{
  "status": "INACTIVE",
  "schedules": [
    {
      "id": 340,
      "startDate": "2020-01-01T07:00:00Z",
      "endDate": "2020-01-05T06:59:59Z"
    },
    {
      "startDate": "2020-02-01T00:00:00Z",
      "endDate": "2020-02-28T00:00:00Z"
    }
  ]
}

Example Response

{
  "response": {
    "status": "INACTIVE",
    "mediaType": "DISPLAY",
    "id": 152630,
    "name": "ad-display-2x2",
    "lineId": 361734,
    "creativeId": 358605,
    "updatedAt": "2017-11-03T00:43:55Z",
    "schedules": [
      {
        "id": 341,
        "startDate": "2020-02-01T00:00:00Z",
        "endDate": "2020-02-28T00:00:00Z"
      },
      {
        "id": 340,
        "startDate": "2020-01-01T07:00:00Z",
        "endDate": "2020-01-05T06:59:59Z"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2017-11-03T00:43:55Z"
}

Delete Ad

The DSP Traffic API does not support deletion of ads.