Dimensions
- 19 Minutes to read
Dimensions
- 19 Minutes to read
Article summary
Did you find this summary helpful?
Thank you for your feedback!
This article describes the dimensions of data returned by the Yahoo DSP API.
Overview
A dimension is an attribute of data. A dimension may represent an attribute of a consumer, segment, campaign, ad, or line. For example, the MobileOS dimension tracks the operating system (Android, iOS, etc.) of consumer mobile devices. Compare with Metrics.
In the Yahoo DSP Reporting API, all report dimensions are identified by a unique dimension type ID. You can run reports on dimensions of data by specifying one or more report dimension IDs in the dimensionTypeIds array of a request.
Several dimension types return multiple report fields. For example, a request that specifies the Ad dimension (7) returns two fields: the ID and the Name of the ad.
You must specify at least one dimension type ID in every Reporting API request.
Dimension Types
A dimension may or may not be returned in a report depending on whether you have Seat access or GAN access to the Yahoo DSP platform.
Seat Access
GAN Access
The table lists DSP Reporting API dimension types by dimension type ID, provides the dimensions that are returned for each dimension type, and indicates whether the dimension type is available to clients with seat or GAN access.
Dimension Type ID | Dimension Type | Description | Seat Access | GAN Access | Limitations |
|---|---|---|---|---|---|
1 | Publisher | Returns two dimensions: the ID and name of the publisher.
Note: This is the same dimension as the Exchange dimension in Report Builder. | Y | N | |
3 | Layout | Returns two dimensions: the ID and name of the layout.
| Y | Y | |
4 | Advertiser | Returns two dimensions: the ID and name of the advertiser.
| Y | Y | |
5 | Campaign | Returns two dimensions: the ID and name of the campaign.
| Y | Y | |
6 | Line | Returns two dimensions: the ID and name of the line.
| Y | Y | |
7 | Ad | Returns two dimensions: the ID and name of the ad.
| Y | Y | |
8 | Creative | Returns two dimensions: the ID and name of the creative.
| Y | N | |
9 | Domain | Returns the unique Internet address for a website. | Y | N | |
14 | Advertiser Category ID | Returns the advertiser category ID as defined by the trafficker. | Y | N | |
19 | Country | Returns two dimensions: the ID and name of the country.
| Y | N | |
20 | Region | Returns the name of the consumer’s region or state. | Y | N | |
21 | City | Returns two dimensions: the ID and name of the city.
| Y | N | |
22 | Postal Code | Returns the consumer’s zip or postal code.
| Y | Y | 500,000 row limit per report |
23 | Device Category | Returns two dimensions: the ID and name of device category.
| Y | N | |
24 | Mobile OS Version | The release number of the operating system for iOS, Android, RIM OS, or Windows Phone OS. Make sure to include the Mobile OS dimension when you use this dimension. | Y | Y | 500,000 row limit per report |
25 | Browser Type | Returns two dimensions: the ID and name of the browser type.
| Y | N | |
26 | Desktop OS | Returns two dimensions: the ID and name of the consumer’s operating system.
Possible values:
| Y | N | |
27 | Age | Returns two dimensions: the ID and age range.
Possible values:
Note: All data for this dimension is sourced from Yahoo. | Y | N | |
28 | Gender | Returns two dimensions: the ID and name of the gender.
Possible values:
Note: All data for this dimension is sourced from Yahoo. | Y | N | |
31 | Ad Position | The location on a page where the ad is displayed. | Y | Y | |
34 | Device Type | Returns the device type used by the consumer. Possible values:
| Y | N | |
39 | Targeted Audience | DEPRECATED Use | Y | N | 500,000 row limit per report |
42 | Advertiser Sub-Category | Returns two dimensions: the ID and name of the advertiser subcategory in the IAB Taxonomy.
| Y | N | 500,000 row limit per report |
46 | Pixel | Returns two dimensions: the Beacon ID and name of a conversion rule.
| Y | Y | |
47 | Subdomain | Returns a subdomain of a site such as a regional property or subsite that is distinguished from a parent site. For example, | Y | N | |
50 | Exchange Deal ID | A string that specifies the name of the deal. | Y | N | |
55 | App Name | Name of the app. Supported for both mobile and Connected TV (CTV) apps. | Y | Y | |
56 | Seat ID | Returns two dimensions: the Seat ID and the Seat Name. Advertisers who have the appropriate privileges may access and return advertising data from multiple seats. To learn more, check out seats. | Y | Y | |
63 | Line Type | Type of line item (e.g., display, video, audio). | Y | Y | |
64 | Advertiser Group | A customized group of advertisers as defined by the user (e.g., an advertiser group can be defined as all advertisers in the NE region of the United States.) | Y | Y | |
66 | Mobile Carrier | The name of the carrier for the device on which the ad was served (e.g, Verizon, AT&T). | Y | Y | |
67 | Goal Type | Returns two dimensions: the ID and name of the line’s goal type.
Possible values:
| Y | N | |
73 | Line Billing Method | Returns two dimensions: the ID and the name of the Line Billing Method.
Possible values:
| Y | N | |
74 | Parent Line | The name of the original line for a cloned line. | Y | Y | |
75 | Market Area | Returns two dimensions: the ID and name of the Nielsen Designated Marketing Area.
| Y | N | |
80 | Frequency Bucket 1d | The frequency bucket based on a one-day frequency window. For example, if you select the Campaign and Frequency Bucket 1d dimensions and the Impressions metric, DSP provides details on how many users saw the ad from the campaign 0, 1, 2-3, etc. times for each one-day window within the reporting date range. Possible values include:
Do not combine with Frequency Bucket 30d ( | Y | Y | |
81 | Frequency Bucket 7d | The frequency bucket based on a seven-day frequency window. For example, if you select the Campaign and Frequency Bucket 7d dimensions and the Impressions metric, DSP provides details on how many users saw the ad from the campaign 0, 1, 2-3, etc. times for each seven-day window within the reporting date range. Possible values include:
Do not combine with Frequency Bucket 1d ( | Y | Y | |
82 | Frequency Bucket 30d | The frequency bucket based on a thirty-day frequency window. For example, if you select the Campaign and Frequency Bucket 30d dimensions and the Impressions metric, DSP provides details on how many users saw the ad from the campaign 0, 1, 2-3, etc. times for each thirty-day window within the reporting date range. Possible values include:
Do not combine with Frequency Bucket 1d ( | Y | Y | |
103 | Pixel Parameter | Returns the Pixel Query String, the parameters passed to a pixel query. | Y | N | |
104 | Target Audience ID : Group A | Returns two dimensions: the ID and name of the targeted segment.
| Y | Y | |
106 | Inventory Type | Returns the name of the inventory type. Options include:
| Y | N | |
107 | Bucketed Age | Returns two dimensions: the ID and age range. The Age ID is an integer that specifies the age ID. The Age is a string that specifies the name of the age group expressed as a range of ages. Options include:
Note: This is the same dimension as the Age (ID: 27) dimension. | Y | Y | |
108 | Demo Vendor | The selected demographic data provider used for targeting and measurement in a campaign. | Y | Y | |
122 | Mobile OS | Operating System where the ad was served (e.g., iOS, Android, RIM OS, Windows Phone OS, or Unknown). | Y | Y | 500,000 row limit per report |
124 | Mobile Make | The make of the device on which the ad was served (e.g., Apple, Samsung) | Y | Y | |
125 | Mobile Model | The model of the device on which the ad was served (e.g., iPhone X, Galaxy S10 Plus) | Y | Y | |
126 | Connection Type | The active connection type for the device when the ad was displayed (e.g., Wifi, Cellular). | Y | Y | |
127 | ISP | Internet Service Provider. | Y | Y | |
128 | Creative Custom ID | The custom ID set by an advertiser for the creative. Requires Creative (Dimension 8) also in the request for creative custom ID to work. | Y | Y | |
147 | Days to Conversion | Filters by time bucket (‘number of days’ groupings) that elapsed between impressions and conversions. | Y | Y | |
149 | Package | The package name and ID. | Y | N | |
150 | Exchange Deal ID | Returns two dimensions: the deal ID and name of the exchange deal received from the supply partner to uniquely identify a supply slice. | Y | N | |
151 | Dot Rule | Returns the dot rule ID. | Y | Y | |
153 | Connected TV Device | A filter to distinguish between the Connected TV (CTV) device types “Smart TV” or “Streaming Device.” | Y | Y | For connected TV lines only. |
154 | Inventory Auction Type | The auction type–First Price, Second Price, or Other (if indeterminate or unavailable). | Y | Y | |
155 | Supply Group | Returns the gemini supply group, i.e., | Y | Y | |
158 | Native Type | The type of native inventory (Yahoo Inc Native or third-party supply). | Y | Y | 500,000 row limit per report |
159 | Bid Request Ad Size | The video player size (Height x Width) in pixels. | Y | Y | |
162 | Weather Condition | For weather targeting, the weather condition, such as Sunny, Stormy, Cloudy, or Windy. | Y | Y | |
165 | Target Audience ID : Group B | Returns two dimensions: the ID and name of the targeted segment.
| Y | Y | |
166 | Channel Type | A filter for Connected TV (CTV) and Digital out of Home (DOOH) lines, campaigns, and impressions. | Y | Y | |
167 | Video Content Length | The length of a video (such as Up to 2 mins, 2-5 mins, etc.). | Y | Y | |
169 | Video Ad Placement | The type of video ad placement (InStream or Outstream). | Y | Y | |
171 | Ads.txt Declaration | Filters for inventory from publishers that meet the Authorized Digital Sellers IAB Standard. | Y | Y | |
174 | Creative Format | Returns the creative format ID. | Y | Y | |
175 | Site Name | Returns the Gemini site name ID. | Y | Y | |
182 | Video Player Size | Returns the player size based on the bid request dimensions:
| Y | Y | |
183 | Site Group Name | Returns the Gemini site group ID. | Y | Y | |
185 | Offline Rule | Provides the Offline Rule Name and Offline Rule ID. | Y | Y | |
188 | DCO Variation | Returns two dimensions: the ID and name of the DCO Variation (only for DCO campaigns).
| Y | Y | |
189 | DCO Set | Returns two dimensions: the ID and name of the DCO Set (only for DCO campaigns).
| Y | Y | |
192 | Line Start Date | The date on which the line is eligible to start serving. This dimension works only when the Line dimension is selected. | Y | Y | |
193 | Line End Date | The date on which the line will stop serving. The end date can be null. This dimension works only when the Line dimension is selected. | Y | Y | |
194 | Package Start Date | The date on which the package is eligible to start serving. This dimension works only when the Package dimension is selected. | Y | N | |
195 | Package End Date | The date on which the package will stop serving. The end date can be null. This dimension works only when the Package dimension is selected. | Y | N | |
196 | Campaign Current Schedule Total Budget | The total budget assigned to the current schedule in the campaign. The total budget set to the current schedule for past or future campaigns is shown. This dimension works only when the Campaign and Campaign Schedule Name dimensions are selected. | Y | Y | |
197 | Package Schedule Name | Same as the Package Budget Schedule dimension ( | Y | N | |
198 | Package Current Schedule Total Budget | The total budget assigned to the current schedule in the package. For past or future schedules, the total budget set for that schedule is shown. This dimension works only when the Package and Package Schedule Name dimensions are selected. | Y | N | |
201 | Line Schedule Name | Same as Line Flight dimension ( | Y | Y | |
202 | Line Schedule Start Date | The start date of each line schedule. This dimension works only when the Line and Line Schedule Name dimensions are selected. | Y | Y | |
203 | Line Schedule End Date | The end date of each line schedule. This dimension works only when the Line and Line Schedule Name dimensions are selected. | Y | Y | |
204 | Line Daily Budget Schedule | The daily budget assigned to a line for a given schedule. This dimension is populated only for a line that has the line schedule and remains null for a line that does not have the schedule. This dimension works only when the Line and Line Schedule Name dimensions are selected. | Y | Y | |
205 | Line Current Schedule Total Budget | The total budget assigned to the current schedule in a line. For past or future schedules, the total budget set to that schedule is shown. This dimension works only when the Line and Line Schedule Name dimensions are selected. | Y | Y | |
206 | Line Budget Pacing | This value is the same as the text value in the line properties for budget pacing. The three values allowed are “Even,” “Ahead” and “ASAP.” This dimension works only when the Line dimension is selected. | Y | Y | |
207 | Line Pacing Acceleration | This percentage value is set if the Line Budget Pacing is set to “Ahead”; otherwise, it is null. This dimension works only when the Line dimension is selected. | Y | Y | |
282 | Major Metro Area | Returns DMA. | Y | N | 500,000 row limit per report |
1028 | Connected TV Make | The brand name of the connected TV device. For example, Amazon, Sony or Google. | Y | Y | 500,000 row limit per report |
1029 | Connected TV Model | The model name of the connected TV device. For example, Fire TV, Playstation, or Chromecast. | Y | Y | |
1030 | Line Flight | The line flight name and ID for lines that include line schedules. | Y | Y | |
1031 | Package Budget Schedule | The name of the budget schedule associated with a package with multiple schedules. | Y | Y | |
1033 | Deal Type | The type of deal (if any) DSP used to win impressions. The deal types are as follows:
| Y | Y | |
1037 | Video Creative Duration | The length of the video ad in intervals. For example: 0-3s, 4-6s, 7-10s, 11-15s, 16-30s, 31-45s, 46-60s, and 60s+. | Y | Y | |
1038 | Campaign Schedule Name | The name of the Campaign Schedule. | Y | Y | |
1039 | Campaign Schedule Start Date | Start date of a campaign schedule. | Y | Y | |
1040 | Campaign Schedule End Date | End date of a campaign schedule. | Y | Y | |
1041 | Campaign Start Date | Start date of the campaign. | Y | Y | |
1042 | Campaign End Date | End date of the campaign. | Y | Y | |
1043 | Package Schedule Start Date | Start date of a package schedule. | Y | Y | |
1044 | Package Schedule End Date | End date of a package schedule. | Y | Y | |
1045 | Campaign Total Budget | The total budget allocated to the campaign for the lifetime of the campaign. | Y | Y | |
1046 | Campaign Daily Budget | The daily budget assigned in the campaign properties. Inputs: Auto-Allocate, No Daily Budget (“-” null ) or specific dollar amount. | Y | Y | |
1047 | Package Total Budget | The total budget allocated to the Package for the lifetime of the Package. | Y | Y | |
1048 | Package Daily Budget | The daily budget assigned to the Package at the Package Properties level. Inputs: Auto-Allocate, No Daily Budget (“-” null) or specific dollar amount. Note: this will return (“-” null) value if there’s a Package Schedule. | Y | Y | |
1049 | Line Total Budget | The total budget allocated to the line for the entire lifetime of the line. This dimension works only when the Line dimension is selected. | Y | Y | |
1050 | Line Daily Budget | The daily budget assigned to the line in the line properties setting. This dimension is populated only for a line that does not have a line schedule and remains null for a line with a schedule. This dimension works only when the Line dimension is selected. | Y | Y | |
1051 | Campaign Daily Budget Schedule | The daily budget assigned to the campaign for a given schedule. Inputs: Auto-Allocate, No Daily Budget (“-” null ) or specific dollar amount. | Y | Y | |
1052 | Package Daily Budget Schedule | The daily budget assigned to the Package for a given schedule. Inputs: Auto-Allocate, No Daily Budget (“-” null ) or specific dollar amount. | Y | Y | |
1054 | Package Budget Distributor | This denotes “Yes” or “No” if the budget distributor is enabled. | Y | Y | 500,000 row limit per report |
1090 | Weather Humidity | The real-time or forecasted weather humidity range for the targeted location. Set minimum and maximum values, in percentages. Valid values include numbers from 0 to 100. | Y | N | |
1091 | Weather UV | The real-time or forecasted weather UV for the targeted location. Valid values include: Low, Moderate, High, Very High, Extreme, All | Y | N | |
1093 | Pollen Level | The real-time or forecasted pollen levels for the targeted location. Valid values include: Very Low, Low, Moderate, High, and Very High. Yahoo uses the highest bpi in the specified area and does not differentiate between pollen types. | Y | N | |
1094 | Air Quality | The real-time or forecasted air quality index for the targeted location. Valid values include: Poor, Low, Moderate, Good, and Excellent. Yahoo uses the breezometer air quality index (baqi) scale as a way to standardize across countries. | Y | N | |
1101 | Postal Prefix | The geographical area designated by the same initial characters in a postal code, used for targeting a postal region. Available in the UK and Canada only, regardless of whether lines are actively targeting postal prefixes or not. | Y | N | |
1106 | DOOH Venue Type | The vendor type, location of the Digital Out of Home Screen. Example: Hotel, Movie Theatre, Colleges/Universities, Subway, Buses etc. | Y | N | |
1109 | DOOH Screen Owner | The Owner of the Digital Out of Home Screen. Ex: Clear Channel Outdoor, Compass Billboards, Epic Outdoor etc. | Y | N | |
1110 | Ad Serving Cost Name | The name an advertiser gives to an ad serving cost. An ad serving cost is a variable cost that tracks expenses related to third-party storage, tracking and delivery of assets, including per-impression charges and fees. | Y | Y | 500,000 row limit per report |
1112 | Audience Measurement Cost Name | The name an advertiser gives to an audience measurement cost. An audience measurement cost is a variable cost that measures the number of people exposed to advertising across any given media. | Y | Y | 500,000 row limit per report |
1113 | Brand Safety Cost Name | The name an advertiser gives to a brand safety cost. A brand safety cost is a variable cost that tracks expenses related to inventory quality, brand safety, and fraud avoidance. | Y | Y | |
1114 | Viewability Cost Name | The name an advertiser gives to a viewability cost. A viewability cost is the cost of third-party viewability targeting services you opt in to in the Vendor Store. | Y | Y | |
1115 | Other Cost Name | The name an advertiser gives to an other cost (a custom cost that you define at the line level for margin management calculations of miscellaneous costs associated with running digital media campaigns). | Y | Y | 500,000 row limit per report |
1116 | Content Show | The name of the series where the ad played, such as The Office or Star Wars. For CTV Ads only. | Y | Y | For CTV lines only. |
1117 | Content Channel | The name of the channel where the ad played, such as ABC or ESPN. For CTV Ads only. | Y | Y | For CTV lines only. |
1118 | Content Network | The name of the network where the ad played, such as Disney. For CTV Ads only. | Y | Y | For CTV lines only. |
1119 | Content Title | The title of the show where the ad played, such as Star Wars. For CTV Ads only. | Y | Y | For CTV lines only. |
1120 | Content Genre | The genre of the content where the ad played, such as Action or Animation. For CTV Ads only. | Y | Y | For CTV lines only. |
1121 | Line Type | The media type served by the line. Valid values include: Display, Video, and Audio. | Y | Y | |
1122 | Product Ad ID | The identifier of a product in your Product Catalog Feed. The product sets, user recommendation and dot pixel custom events should use this ID. All products with duplicate IDs will be ignored. | Y | N | |
1123 | Product SKU | The retailer-defined stock-keeping unit number (SKU) for a product served in a Dynamic Product Ad (DPA). | Y | N | |
1124 | Product Ad Title | The title of the product offered in a Dynamic Product Ad (DPA). The title displayed is 20-50 characters. | Y | N | |
1125 | Product Ad Description | A short description of the product offered in a Dynamic Product Ad (DPA). The description displayed is 20-150 characters. | Y | N | |
1126 | Product Ad Status | Indicates whether an ad is active or inactive. An ad may be inactive if there are unresolved errors or if the line is new and has not yet been activated. | Y | N | |
1127 | Product Ad Image Url | The link to the image of a product served in a Dynamic Product Ad (DPA). This URL can be set in your Product Feed. | Y | N | |
1128 | Product Ad Landing Url | The destination URL of the merchant’s landing page when the product ad is clicked. This URL can be set in your Product Feed. | Y | N | |
1143 | Conversion Methodology | Provides the vendor name that sent the conversion (Apple or the Mobile Measurement Partners (MMP)). This dimension is available for both SKAdNetwork (SKAN) conversions as well as Honor Claims conversions for supported MMPs. Will return “null” if Yahoo provided the conversion. | Y | N | |
1147 | Creative Ad Title | The title in the creative. Available on Native, DCO, and DPA creatives. | Y | N | |
1148 | Creative Ad Description | Description in the creative. Available on Native, DCO, and DPA creatives. | Y | N | |
1149 | Creative Landing Page Url | The domain that corresponds to the final landing page of the Ad. | Y | N | |
1150 | HHA Provider | The household addressable supply partner (Fios, Dish Network, or DIRECTV). Returns impression data from each provider selected. | Y | N | |
1160 | Tile ID | The unique identifier assigned to a tile. | Y | N | |
1161 | Tile Carousel Card Position | Indicates where a tile falls in a carousel order. A carousel can contain a minimum of two tiles and a maximum of five tiles. Valid numbers are 2, 3, 4, or 5. | Y | N | |
1163 | Creative Click Through Url | The URL that will redirect to the landing page. This URL can be a click tracker or a landing page URL. | Y | N | |
1221 | Content Rating | The rating of the content where the ad played, such as TV-14 or PG. For CTV Ads only. | Y | Y | For CTV lines only. |
1222 | Content Language | The language of the content where the ad played, such as English or Spanish. For CTV Ads only. | Y | Y | For CTV lines only. |
1223 | Content Length | The length of the content where the ad played, in seconds. For CTV Ads only. | Y | Y | For CTV lines only. |
1224 | Content Livestream | The content streaming type where the ad played, such as live (1) or not live (0). For CTV Ads only. | Y | Y | For CTV lines only. |
Was this article helpful?
