Data Dictionary

The data dictionary service allows you to get a list of the supported values for different DSP+ object attributes.

Dictionary Types

To retrieve a list of the supported dictionary types, make a GET call to the /dictionary endpoint.

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

The response will be an array of all the supported Dictionary types.

Example Response

{
  "response": [
    {
      "name": "Ad Sizes (Layouts) in an Ad object",
      "value": "layouts"
    },
    {
      "name": "MIME Types in an Ad object",
      "value": "mimeTypes"
    },
    {
      "name": "Creative Types in an Ad object",
      "value": "creativeTypes"
    },
    {
      "name": "Currency Types",
      "value": "currencyTypes"
    },
    {
      "name": "Iab Taxonomy Categories",
      "value": "iabTaxonomyTypes"
    },
    {
      "name": "Languages",
      "value": "languages"
    },
    {
      "name": "Targeting Types",
      "value": "targetingTypes"
    },
    {
      "name": "Timezones",
      "value": "timezones"
    },
    {
      "name": "DoubleVerify Categories",
      "value": "doubleVerifyCategories"
    }
  ],
  "errors": null,
  "timeStamp": "2017-05-15T22:20:42Z"
}

The dictionary type values can be used in the URI in order to get a list of the supported values for those dictionary types (see examples below). Note that more dictionary types may be added over time, in which case the array in the response will grow. The GET call required in order to retrieve this list will not change.

Ad/Creative Sizes (Layouts)

To retrieve a list of the supported layout types for ads or creatives, make a GET call to the dictionary endpoint and specify layouts in the URI:

GET https://dspapi.admanagerplus.yahoo.com/traffic/dictionary/layouts

Example Response (Partial)

{
  "response": [
    {
      "id": 78,
      "name": "0x0",
      "description": "Native Ad",
      "width": 0,
      "height": 0
    },
    {
      "id": 82,
      "name": "1x1",
      "description": "1x1 Ad Size",
      "width": 1,
      "height": 1
    }
  ],
  "errors": null,
  "timeStamp": "2017-04-12T04:49:06Z"
}

Ad/Creative MIME Types

To retrieve a list of the supported MIME types for ads or creatives, make a GET call to the dictionary endpoint and specify mimeTypes in the URI:

GET https://dspapi.admanagerplus.yahoo.com/traffic/dictionary/mimeTypes

Example Response (Partial)

{
  "response": [
    {
      "id": 0,
      "value": ""
    },
    {
      "id": 1,
      "value": "image/gif"
    },
    {
      "id": 2,
      "value": "image/jpeg"
    }
  ],
  "errors": null,
  "timeStamp": "2017-04-12T04:49:06Z"
}

Creative Types

To retrieve a list of the supported creative types, make a GET call to the dictionary endpoint and specify creativeTypes in the URI:

GET https://dspapi.admanagerplus.yahoo.com/traffic/dictionary/creativeTypes

Example Response

{
  "response": [
    {
      "id": 1,
      "value": "Static Image"
    },
    {
      "id": 2,
      "value": "Static HTML"
    },
    {
      "id": 3,
      "value": "Dynamic Image and Text"
    },
    {
      "id": 4,
      "value": "Third Party"
    },
    {
      "id": 5,
      "value": "Static Video"
    },
    {
      "id": 6,
      "value": "Native"
    },
    {
      "id": 7,
      "value": "Native Video"
    }
  ],
  "errors": null,
  "timeStamp": "2017-04-12T04:49:06Z"
}

Currency Types

To retrieve a list of the supported currency types, make a GET call to the dictionary endpoint and specify currencyTypes in the URI:

GET https://dspapi.admanagerplus.yahoo.com/traffic/dictionary/currencyTypes

Example Response

{
  "response": [
    {
      "id": 1,
      "code": "AED"
    },
    {
      "id": 7,
      "code": "ARS"
    },
    {
      "id": 8,
      "code": "AUD"
    },
    {
      "id": 20,
      "code": "BRL"
    },
    {
      "id": 26,
      "code": "CAD"
    },
    {
      "id": 28,
      "code": "CHF"
    },
    {
      "id": 43,
      "code": "EGP"
    },
    {
      "id": 46,
      "code": "EUR"
    },
    {
      "id": 49,
      "code": "GBP"
    },
    {
      "id": 58,
      "code": "HKD"
    },
    {
      "id": 63,
      "code": "IDR"
    },
    {
      "id": 66,
      "code": "INR"
    },
    {
      "id": 73,
      "code": "JPY"
    },
    {
      "id": 103,
      "code": "MXN"
    },
    {
      "id": 104,
      "code": "MYR"
    },
    {
      "id": 111,
      "code": "NZD"
    },
    {
      "id": 116,
      "code": "PHP"
    },
    {
      "id": 128,
      "code": "SEK"
    },
    {
      "id": 129,
      "code": "SGD"
    },
    {
      "id": 141,
      "code": "THB"
    },
    {
      "id": 149,
      "code": "TWD"
    },
    {
      "id": 153,
      "code": "USD"
    },
    {
      "id": 157,
      "code": "VND"
    },
    {
      "id": 170,
      "code": "ZAR"
    }
  ],
  "errors": null,
  "timeStamp": "2017-04-12T04:49:06Z"
}

IAB Taxonomy Types

To retrieve a list of the supported IAB Taxonomy Types, make a GET call to the dictionary endpoint and specify iabTaxonomyTypes in the URI:

GET https://dspapi.admanagerplus.yahoo.com/traffic/dictionary/iabTaxonomyTypes

Example Response (Partial)

{
  "response": [
    {
      "id": 1901,
      "name": "IAB19-1",
      "description": "3-D Graphics",
      "parentCategoryId": 19
    },
    {
      "id": 501,
      "name": "IAB5-1",
      "description": "7-12 Education",
      "parentCategoryId": 5
    },
    {
      "id": 702,
      "name": "IAB7-2",
      "description": "A.D.D.",
      "parentCategoryId": 7
    },
    {
      "id": 1806,
      "name": "IAB18-6",
      "description": "Accessories",
      "parentCategoryId": 18
    }
  ],
  "errors": null,
  "timeStamp": "2017-04-12T04:49:06Z"
}

Languages

To retrieve a list of the supported languages, make a GET call to the dictionary endpoint and specify languages in the URI:

GET https://dspapi.admanagerplus.yahoo.com/traffic/dictionary/languages

Example Response

{
  "response": [
    {
      "id": 0,
      "value": "UNKNOWN"
    },
    {
      "id": 1,
      "value": "ENGLISH"
    },
    {
      "id": 2,
      "value": "CHINESE"
    },
    {
      "id": 3,
      "value": "SPANISH"
    },
    {
      "id": 4,
      "value": "JAPANESE"
    },
    {
      "id": 5,
      "value": "PORTUGUESE"
    },
    {
      "id": 6,
      "value": "GERMAN"
    },
    {
      "id": 7,
      "value": "ARABIC"
    },
    {
      "id": 8,
      "value": "FRENCH"
    },
    {
      "id": 9,
      "value": "RUSSIAN"
    },
    {
      "id": 10,
      "value": "KOREAN"
    },
    {
      "id": 11,
      "value": "DUTCH"
    },
    {
      "id": 12,
      "value": "SWEDISH"
    },
    {
      "id": 13,
      "value": "ITALIAN"
    },
    {
      "id": 14,
      "value": "INDONESIAN"
    }
  ],
  "errors": null,
  "timeStamp": "2017-05-03T17:44:24Z"
}

Targeting Types

To retrieve a list of the supported Targeting Types, make a GET call to the dictionary endpoint and specify targetingTypes in the URI:

GET https://dspapi.admanagerplus.yahoo.com/traffic/dictionary/targetingTypes

Example Response

{
  "response": [
    {
      "id": 1,
      "value": "FREQUENCY_CAPPING"
    },
    {
      "id": 2,
      "value": "CONTEXTUALS"
    },
    {
      "id": 3,
      "value": "AD_POSITION"
    },
    {
      "id": 4,
      "value": "GEOGRAPHY"
    },
    {
      "id": 6,
      "value": "DEMOGRAPHIC"
    },
    {
      "id": 7,
      "value": "TECHNOLOGY"
    },
    {
      "id": 8,
      "value": "DAY_PARTING"
    },
    {
      "id": 9,
      "value": "SITE_LISTS"
    },
    {
      "id": 10,
      "value": "AB_TESTING"
    },
    {
      "id": 11,
      "value": "EXCHANGES"
    },
    {
      "id": 12,
      "value": "SEGMENT"
    },
    {
      "id": 13,
      "value": "TARGET_VIEWABILITY"
    },
    {
      "id": 14,
      "value": "PLAYER_SIZE"
    },
    {
      "id": 15,
      "value": "AD_INITIATION"
    },
    {
      "id": 16,
      "value": "MOBILE"
    },
    {
      "id": 17,
      "value": "INTERESTS"
    },
    {
      "id": 18,
      "value": "GENDERS"
    },
    {
      "id": 19,
      "value": "LANGUAGES"
    },
    {
      "id": 20,
      "value": "SEAT_LEVEL_SITE_LISTS"
    },
    {
      "id": 21,
      "value": "BOT"
    },
    {
      "id": 22,
      "value": "DEVICE"
    },
    {
      "id": 23,
      "value": "SERVE_UNKNOWN_USER"
    },
    {
      "id": 24,
      "value": "VIEWABILITY"
    },
    {
      "id": 25,
      "value": "VIDEO_INVENTORY"
    },
    {
      "id": 26,
      "value": "INVENTORY_TYPE"
    }
  ],
  "errors": null,
  "timeStamp": "2017-05-04T01:59:53Z"
}

Timezones

To retrieve a list of the supported timezones, make a GET call to the dictionary endpoint and specify timezones in the URI:

GET https://dspapi.admanagerplus.yahoo.com/traffic/dictionary/timezones

Example Response

{
  "response": [
    {
      "id": 1,
      "abbreviation": "EST/EDT",
      "name": "Eastern Time",
      "tzId": "America/New_York"
    },
    {
      "id": 2,
      "abbreviation": "PST/PDT",
      "name": "Pacific Time",
      "tzId": "America/Los_Angeles"
    },
    {
      "id": 3,
      "abbreviation": "CST/CDT",
      "name": "Central Time",
      "tzId": "America/Chicago"
    },
    {
      "id": 4,
      "abbreviation": "AEST/AEDT",
      "name": "Australian Eastern Time",
      "tzId": "Australia/Sydney"
    },
    {
      "id": 5,
      "abbreviation": "AWST",
      "name": "Australian Western Time",
      "tzId": "Australia/Perth"
    },
    {
      "id": 6,
      "abbreviation": "WIB",
      "name": "Western Indonesian Time",
      "tzId": "Asia/Jakarta"
    },
    {
      "id": 7,
      "abbreviation": "JST",
      "name": "Japan Time",
      "tzId": "Asia/Tokyo"
    },
    {
      "id": 8,
      "abbreviation": "CST",
      "name": "China Time",
      "tzId": "Asia/Shanghai"
    },
    {
      "id": 9,
      "abbreviation": "GMT",
      "name": "Greenwich Mean Time",
      "tzId": "Etc/GMT"
    },
    {
      "id": 10,
      "abbreviation": "GMT/BST",
      "name": "London Time",
      "tzId": "Europe/London"
    },
    {
      "id": 11,
      "abbreviation": "IST/IDT",
      "name": "Israel Time",
      "tzId": "Asia/Jerusalem"
    },
    {
      "id": 12,
      "abbreviation": "CET/CEST",
      "name": "Central European Time",
      "tzId": "Europe/Paris"
    },
    {
      "id": 13,
      "abbreviation": "GST",
      "name": "Gulf Time",
      "tzId": "Asia/Dubai"
    },
    {
      "id": 14,
      "abbreviation": "NZST/NZDT",
      "name": "New Zealand Time",
      "tzId": "Pacific/Auckland"
    },
    {
      "id": 15,
      "abbreviation": "BDT",
      "name": "Bangladesh Time",
      "tzId": "Asia/Dhaka"
    },
    {
      "id": 16,
      "abbreviation": "AST/ADT",
      "name": "Atlantic Time",
      "tzId": "America/Halifax"
    },
    {
      "id": 17,
      "abbreviation": "CST",
      "name": "Central Standard Time",
      "tzId": "America/El_Salvador"
    },
    {
      "id": 18,
      "abbreviation": "PKT",
      "name": "Pakistan Standard Time",
      "tzId": "Asia/Karachi"
    },
    {
      "id": 19,
      "abbreviation": "BRT/BRST",
      "name": "Brasilia Time",
      "tzId": "America/Sao_Paulo"
    },
    {
      "id": 20,
      "abbreviation": "CST/CDT",
      "name": "Central Time",
      "tzId": "America/Mexico_City"
    },
    {
      "id": 21,
      "abbreviation": "ART",
      "name": "Argentina Time",
      "tzId": "America/Argentina/Buenos_Aires"
    },
    {
      "id": 22,
      "abbreviation": "COT",
      "name": "Colombia Time",
      "tzId": "America/Bogota"
    },
    {
      "id": 23,
      "abbreviation": "CLT/CLST",
      "name": "Chile Time",
      "tzId": "America/Santiago"
    },
    {
      "id": 24,
      "abbreviation": "PET",
      "name": "Peru Time",
      "tzId": "America/Lima"
    },
    {
      "id": 25,
      "abbreviation": "AST",
      "name": "Atlantic Standard Time",
      "tzId": "America/Puerto_Rico"
    },
    {
      "id": 26,
      "abbreviation": "MST/MDT",
      "name": "Mountain Time",
      "tzId": "America/Denver"
    }
  ],
  "errors": null,
  "timeStamp": "2017-04-12T04:49:06Z"
}

DoubleVerify Categories

To retrieve a list of the DoubleVerify Brand Safety Categories, make a GET call to the dictionary endpoint and specify doubleVerifyCategories in the URI:

GET https://dspapi.admanagerplus.yahoo.com/traffic/dictionary/doubleVerifyCategories

Example Response (Partial)

{
  "response": [
    {
      "id": 3,
      "description": "Controversial Subjects: Alternative Lifestyles",
      "parentCategoryId": 0
    },
    {
      "id": 4,
      "description": "Controversial Subjects: Celebrity Gossip",
      "parentCategoryId": 0
    }
  ],
  "errors": null,
  "timeStamp": "2017-04-12T04:49:06Z"
}