Data Dictionary

15 Minutes to read

Data Dictionary

15 Minutes to read

Article summary

Did you find this summary helpful?

Thank you for your feedback!

This article describes the data dictionary, a service that enables developers to identify supported values for common DSP Traffic API objects.

Overview

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

Dictionary Types

To get all of the supported dictionary types, make a GET call to the /dictionary endpoint.

The dictionary type values can be used in the URI in order to get a list of the supported values for those dictionary types. 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.

Endpoint

/traffic/dictionary

The response returns an array of Dictionary types.

Note
Calling dictionary APIs do not count against any rate limits.

Sample 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": "Languages",
      "value": "languages"
    },
    {
      "name": "Targeting Types",
      "value": "targetingTypes"
    },
    {
      "name": "Timezones",
      "value": "timezones"
    },
    {
      "name": "Ad Behavior Types",
      "value": "adBehaviorTypes"
    },
    {
      "name": "IAB Taxonomy Categories",
      "value": "iabTaxonomyCategories"
    },
    {
      "name": "Premium Native Languages",
      "value": "premiumnative/languages"
    },
    {
      "name": "Premium Native Predefined CTA Labels",
      "value": "premiumnative/predefinedctalabels"
    },
    {
      "name": "Premium Native Predefined Countdown Prefixes",
      "value": "premiumnative/countdownprefixes"
    }
  ],
  "errors": null,
  "timeStamp": "2023-01-30T18:03:29.048Z"
}

Layouts

Get supported layout types for ads or creatives.

Endpoint

GET /traffic/dictionary/layouts

Sample Response

{
  "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

Get supported MIME types for ads or creatives.

Endpoint

GET /traffic/dictionary/mimeTypes

Sample Response

{
  "response": [
    {
      "id": 0,
      "value": ""
    },
    {
      "id": 1,
      "value": "image/gif"
    },
    {
      "id": 2,
      "value": "image/jpeg"
    },
    {
      "id": 3,
      "value": "image/png"
    },
    {
      "id": 4,
      "value": "application/x-shockwave-flash"
    },
    {
      "id": 5,
      "value": "video/x-flv"
    },
    {
      "id": 6,
      "value": "video/x-ms-wmv"
    },
    {
      "id": 7,
      "value": "text/plain"
    },
    {
      "id": 8,
      "value": "text/html"
    },
    {
      "id": 9,
      "value": "text/javascript"
    },
    {
      "id": 10,
      "value": "application/javascript"
    },
    {
      "id": 11,
      "value": "video/mp4"
    },
    {
      "id": 12,
      "value": "video/webm"
    },
    {
      "id": 13,
      "value": "video/x-msvideo"
    },
    {
      "id": 14,
      "value": "video/quicktime"
    },
    {
      "id": 15,
      "value": "video/mpeg"
    },
    {
      "id": 16,
      "value": "video/ogg"
    },
    {
      "id": 17,
      "value": "video/x-ms-asf"
    },
    {
      "id": 18,
      "value": "video/3gpp"
    },
    {
      "id": 19,
      "value": "application/x-mpegURL"
    },
    {
      "id": 20,
      "value": "audio/mpeg"
    },
    {
      "id": 21,
      "value": "audio/ogg"
    },
    {
      "id": 22,
      "value": "audio/mp4"
    },
    {
      "id": 23,
      "value": "audio/webm"
    },
    {
      "id": 24,
      "value": "audio/vnd.wav"
    }
  ],
  "errors": null,
  "timeStamp": "2020-05-03T18:34:28.730Z"
}

Creative Types

Get supported creative types.

Endpoint

GET /traffic/dictionary/creativeTypes

Sample Response

{
  "response": [
    {
      "id": 1,
      "value": "STATIC_IMAGE"
    },
    {
      "id": 2,
      "value": "STATIC_HTML"
    },
    {
      "id": 3,
      "value": "DYNAMIC_IMAGE_TEXT"
    },
    {
      "id": 4,
      "value": "THIRD_PARTY"
    },
    {
      "id": 5,
      "value": "STATIC_VIDEO"
    },
    {
      "id": 6,
      "value": "NATIVE"
    },
    {
      "id": 7,
      "value": "NATIVE_VIDEO"
    },
    {
      "id": 8,
      "value": "AUDIO"
    }
  ],
  "errors": null,
  "timeStamp": "2020-05-03T19:19:35.954Z"
}

Currency Types

Get supported currency types.

Endpoint

GET /traffic/dictionary/currencyTypes

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

Languages

Get supported languages.

Endpoint

GET /traffic/dictionary/languages

Sample Response

{
  "response": [
    {
      "id": 1,
      "value": "ENGLISH"
    },
    {
      "id": 3,
      "value": "SPANISH"
    },
    {
      "id": 8,
      "value": "FRENCH"
    },
    {
      "id": 2,
      "value": "CHINESE"
    },
    {
      "id": 4,
      "value": "JAPANESE"
    },
    {
      "id": 6,
      "value": "GERMAN"
    },
    {
      "id": 5,
      "value": "PORTUGUESE"
    },
    {
      "id": 7,
      "value": "ARABIC"
    },
    {
      "id": 9,
      "value": "RUSSIAN"
    },
    {
      "id": 13,
      "value": "ITALIAN"
    },
    {
      "id": 10,
      "value": "KOREAN"
    },
    {
      "id": 11,
      "value": "DUTCH"
    },
    {
      "id": 12,
      "value": "SWEDISH"
    },
    {
      "id": 14,
      "value": "INDONESIAN"
    },
    {
      "id": 0,
      "value": "UNKNOWN"
    },
    {
      "id": 47,
      "value": "POLISH"
    },
    {
      "id": 29,
      "value": "FINNISH"
    },
    {
      "id": 63,
      "value": "VIETNAMESE"
    },
    {
      "id": 43,
      "value": "MALAY"
    },
    {
      "id": 49,
      "value": "ROMANIAN"
    },
    {
      "id": 24,
      "value": "DANISH"
    },
    {
      "id": 23,
      "value": "CZECH"
    },
    {
      "id": 59,
      "value": "TURKISH"
    },
    {
      "id": 31,
      "value": "GREEK"
    },
    {
      "id": 58,
      "value": "THAI"
    },
    {
      "id": 52,
      "value": "SLOVAK"
    },
    {
      "id": 34,
      "value": "HINDI"
    },
    {
      "id": 20,
      "value": "BULGARIAN"
    },
    {
      "id": 46,
      "value": "NORWEGIAN"
    },
    {
      "id": 35,
      "value": "HUNGARIAN"
    },
    {
      "id": 100,
      "value": "TAGALOG"
    },
    {
      "id": 101,
      "value": "CHINESE_SIMPLIFIED"
    },
    {
      "id": 102,
      "value": "CHINESE_TRADITIONAL"
    }
  ],
  "errors": null,
  "timeStamp": "2020-05-03T19:21:31.141Z"
}

Targeting Types

Get supported targeting types.

Endpoint

GET /traffic/dictionary/targetingTypes

Sample 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": "CONNECTION"
    },
    {
      "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"
    },
    {
      "id": 27,
      "value": "ENHANCED_DAY_PARTING"
    },
    {
      "id": 28,
      "value": "PRIORITIZED_INVENTORY"
    },
    {
      "id": 29,
      "value": "MOBILE_PLACEMENT"
    },
    {
      "id": 30,
      "value": "WEATHER"
    },
    {
      "id": 31,
      "value": "CROSS_DEVICE_ID_ESCALATION"
    },
    {
      "id": 32,
      "value": "AUCTION_TYPE"
    },
    {
      "id": 33,
      "value": "NATIVE_LIST"
    },
    {
      "id": 34,
      "value": "SELLER_RELATIONSHIPS"
    },
    {
      "id": 36,
      "value": "VIDEO_CONTENT_LENGTH"
    },
    {
      "id": 37,
      "value": "VIDEO_PLACEMENT_TYPE"
    },
    {
      "id": 38,
      "value": "MOBILE_MEASUREMENT"
    },
    {
      "id": 43,
      "value": "AUDIENCE_ESCALATION_TYPE"
    }
  ],
  "errors": null,
  "timeStamp": "2020-05-03T19:50:26.893Z"
}

Timezones

Get supported timezones.

Endpoint

GET /traffic/dictionary/timezones

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

Ad Behavior Types

Get supported ad behavior types for creatives.

Note
AdBehavior ids 1xx are for DISPLAY creatives and 2xx are for VIDEO creatives.

Endpoint

GET /traffic/dictionary/adBehaviorTypes

Sample Response (Partial)

{
  "response": [
    {
      "id": 101,
      "value": "Billboard - Standard"
    },
    {
      "id": 102,
      "value": "Billboard - Interactive"
    }
  ],
  "errors": null,
  "timeStamp": "2018-01-03T00:29:47Z"
}

IAB Taxonomy Categories

Get supported IAB Taxonomy Categories.

Endpoint

GET /traffic/dictionary/iabTaxonomyCategories

Response Fields

The response contains the following fields of interest:

Name	Description
`id`	Unique ID of the category. This value will be used when creating an Advertiser. To learn more, refer to Advertisers.
`name`	IAB provided name for the category.
`description`	Category name.
`parentCategoryId`	ID of the parent category. For a top-level (PRIMARY) category, the value will always be 0.
`type`	Category type: `PRIMARY`: Indicates a top-level category. `SECONDARY`: Indicates a child category.

Sample Response (Partial)

{
  "response": [
    {
      "id": 3,
      "name": "IAB3",
      "description": "Business",
      "parentCategoryId": 0,
      "type": "PRIMARY"
    },
    {
      "id": 304,
      "name": "IAB3-4",
      "description": "Business Software",
      "parentCategoryId": 3,
      "type": "SECONDARY"
    }
  ],
  "errors": null,
  "timeStamp": "2023-01-30T17:57:01.898Z"
}

Premium Native Predefined CTA Labels

Get Premium Native predefined CTA (Call To Action) labels.

Endpoint

GET /traffic/dictionary/premiumnative/predefinedctalabels?language={language}

Parameters

Parameter	Description	Data Type	Required
language	Specifies the language. If not specified, defaults to ENGLISH.	string	N

Sample Request

GET /traffic/dictionary/premiumnative/predefinedctalabels?language=ENGLISH

Sample Response (Partial)

{
  "response": [
    {
      "callToActionText": "Buy Now",
      "language": "ENGLISH"
    },
    {
      "callToActionText": "Directions",
      "language": "ENGLISH"
    }
  ],
  "errors": null,
  "timeStamp": "2020-08-11T10:18:15.268Z"
}

Premium Native Languages

Get supported Premium Native languages.

Endpoint

GET /traffic/dictionary/premiumnative/languages

Sample Response (Partial)

{
  "response": [
    {
      "name": "ARABIC",
      "value": "Arabic"
    },
    {
      "name": "GERMAN",
      "value": "German"
    },
    {
      "name": "GREEK",
      "value": "Greek"
    },
    {
      "name": "ENGLISH",
      "value": "English"
    },
    {
      "name": "SPANISH",
      "value": "Spanish"
    },
    {
      "name": "FRENCH",
      "value": "French"
    },
    {
      "name": "INDONESIAN",
      "value": "Indonesian"
    },
    {
      "name": "ITALIAN",
      "value": "Italian"
    },
    {
      "name": "JAPANESE",
      "value": "Japanese"
    },
    {
      "name": "MALAY",
      "value": "Malay"
    },
    {
      "name": "DUTCH",
      "value": "Dutch"
    },
    {
      "name": "PORTUGUESE",
      "value": "Portuguese"
    },
    {
      "name": "ROMANIAN",
      "value": "Romanian"
    },
    {
      "name": "RUSSIAN",
      "value": "Russian"
    },
    {
      "name": "SWEDISH",
      "value": "Swedish"
    },
    {
      "name": "TURKISH",
      "value": "Turkish"
    },
    {
      "name": "VIETNAMESE",
      "value": "Vietnamese"
    },
    {
      "name": "SIMPLIFIED_CHINESE",
      "value": "Simplified Chinese"
    },
    {
      "name": "TRADITIONAL_CHINESE",
      "value": "Traditional Chinese"
    },
    {
      "name": "HINDI",
      "value": "Hindi"
    },
    {
      "name": "FINNISH",
      "value": "Finnish"
    },
    {
      "name": "NORWEGIAN",
      "value": "Norwegian"
    },
    {
      "name": "DANISH",
      "value": "Danish"
    }
  ],
  "errors": null,
  "timeStamp": "2020-08-21T00:10:40.230Z"
}

Premium Native Countdown Prefixes

Get Premium Native Countdown Prefixes.

Endpoint

GET /traffic/dictionary/premiumnative/countdownprefixes?language={language}

Parameters

Parameter	Description	Data Type	Required
language	Specifies the language. If not specified, defaults to ENGLISH.	string	N

Sample Request

GET /traffic/dictionary/premiumnative/countdownprefixes?language=ENGLISH

Sample Response (Partial)

{
  "response": [
    {
      "id": 17,
      "countdownPrefix": "Deal ends in"
    },
    {
      "id": 18,
      "countdownPrefix": "Expires in"
    }
  ],
  "errors": null,
  "timeStamp": "2020-08-31T00:25:45.329Z"
}

Was this article helpful?

What's Next

Deals

Contents

Overview
Dictionary Types
Layouts
Ad/Creative MIME Types
Creative Types
Currency Types
Languages
Targeting Types
Timezones
Ad Behavior Types
IAB Taxonomy Categories
Premium Native Predefined CTA Labels
Premium Native Languages
Premium Native Countdown Prefixes