Dimensions¶
This article describes the dimensions of data returned by the Verizon Media 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 Verizon Media 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 Verizon Media DSP platform.
Seat Access
GAN Access
The table lists DSP Reporting API dimension types by dimension type ID, shows 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.
|
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 |
|
23 |
Device Category |
Returns two dimensions: the ID and name of device category.
|
Y |
N |
|
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:
|
Y |
N |
|
28 |
Gender |
Returns two dimensions: the ID and name of the gender.
Possible values:
|
Y |
N |
|
31 |
Ad Position |
Returns the location on the page where the ad is displayed. |
Y |
N |
|
34 |
Device Type |
Returns the device type used by the consumer. Possible values:
|
Y |
N |
|
39 |
Targeted Audience |
DEPRECATED Use |
Y |
N |
|
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 ID and name of a conversion pixel.
|
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 |
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 |
|
56 |
Seat |
Returns the seat ID. Advertisers with the appropriate privileges may access and return advertising data from multiple seats. To learn more, see seats. |
Y |
Y |
|
63 |
Media Type |
Returns two dimensions: the media type ID and name.
Possible values:
|
Y |
N |
|
64 |
Advertiser Group |
Returns an advertiser group, a logical grouping of advertisers as defined by a seat. Available only if the seat has at least one advertiser group registered. |
Y |
N |
|
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 |
|
75 |
Market Area |
Returns two dimensions: the ID and name of the Nielsen Designated Marketing Area.
|
Y |
N |
|
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:
|
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 |
|
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 |
|
155 |
Supply Group |
Returns the gemini supply group, i.e., |
Y |
Y |
|
165 |
Target Audience Id : Group B |
Returns two dimensions: the ID and name of the targeted segment.
|
Y |
Y |
|
174 |
Creative Format |
Returns the creative format ID. |
Y |
Y |
|
175 |
Site Name |
Returns the Gemini site name ID. |
Y |
Y |
|
183 |
Site Group Name |
Returns the Gemini site group ID. |
Y |
Y |