Dimensions

This article describes the dimensions of data returned by the Oath Ad Platforms 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 Oath Ad Platforms 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 Oath Ad Platforms 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.

Table 10 DSP Reporting Dimensions by Dimension Type ID
Dimension Type ID Dimension Type Description Seat Access GAN Access
1 Publisher

Returns two dimensions: the ID and name of the publisher.

  • Publisher ID: An integer that specifies the publisher ID number.
  • Publisher: The name of publisher, the supply source that maintains the website or other inventory type with ad space for sale to advertisers
Y N
3 Layout

Returns two dimensions: the ID and name of the layout.

  • Layout ID: An integer that specifies the layout ID.
  • Layout: A string that specifies the name of the layout expressed in terms of its dimesnions. For example, 300x250.
Y Y
4 Advertiser

Returns two dimensions: the ID and name of the advertiser.

  • Advertiser ID: An integer that specifies the advertiser ID number.
  • Advertiser: A string that specifies the name of the advertiser.
Y Y
5 Campaign

Returns two dimensions: the ID and name of the campaign.

  • Order ID: An integer that specifies the campaign ID.
  • Order: A string that specifies the name of the campaign.
Y Y
6 Line

Returns two dimensions: the ID and name of the line.

  • Line ID: An integer that specifies the line ID.
  • Line: A string that specifies the name of the line.
Y Y
7 Ad

Returns two dimensions: the ID and name of the ad.

  • Ad ID: An integer that specifies the ad ID.
  • Ad: A string that specifies the name of the ad.
Y Y
8 Creative

Returns two dimensions: the ID and name of the creative.

  • Creative ID: An integer that specifies the the creative ID.
  • Creative Name: A string that specifies the creative name.
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.

  • Country ID: An integer that specifies the country ID.
  • Country: A string that specifies the name of the consumer’s 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.

  • City ID: An integer that specifies the city ID of the consumer’s city.
  • City: A string that specifies the name of the consumer’s city.
Y N
23 Device Category

Returns two dimensions: the ID and name of device category.

  • Device Category ID: An integer that specifies the device category ID.
  • Device Category Name: A string that specifies the name of the mobile operating system.
Y N
25 Browser Type

Returns two dimensions: the ID and name of the browser type.

  • Browser Type ID: An integer that specifies the ID of the browser type.
  • Browser Type Name: A string that specifies the name of the consumer’s browser.
Y N
26 Desktop OS

Returns two dimensions: the ID and name of the consumer’s operating system.

  • OS ID: An integer that specifies the OS ID.
  • OS Name: A string that specifies the OS name.

Possible values:

  • Mac OS X
  • Windows
  • Linux
  • Unknown
Y N
27 Age

Returns two dimensions: the ID and age range.

  • Age ID: An integer that specifies the age ID.
  • Age: A string that specifies the name of the age group expressed as an range of ages. For example, 25-34.

Possible values:

  • 0 : 18-20
  • 1 : 21-24
  • 2 : 25-34
  • 3 : 35-44
  • 4 : 45-49
  • 5 : 50-54
  • 6 : 55-64
  • 7 : 65+
  • 9 : UNKNOWN
Y N
28 Gender

Returns two dimensions: the ID and name of the gender.

  • Gender ID: An integer that specifies the gender ID.
  • Gender: A string that specifies the gender of the segment.

Possible values:

  • 0 : Unknown
  • 1 : Male
  • 2 : Female
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:

  • Desktop
  • Phone
  • Tablet
  • Unknown
Y N
39 Targeted Audience

Deprecated.

Use the Target Segment dimension type (104) instead.

Y N
42 Advertiser Sub-Category

Returns two dimensions: the ID and name of the advertiser subcategory in the IAB Taxonomy.

  • Advertiser Sub-Category ID: An integer that specifies the advertiser subcategory ID.
  • Advertiser Sub-Category: A string that specifies the name of the advertiser subcategory.
Y N
46 Pixel

Returns two dimensions: the ID and name of a conversion pixel.

  • Pixel ID: An integer that specifies the pixel ID of the conversion pixel.
  • Pixel: A string that specifies the name of the 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, att.yahoo.com or tw.finance.yahoo.com.

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.

  • Deal ID: An integer that specifies the deal ID.
  • Exchange Deal ID: A string that specifies the name of the deal
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.

  • Media Type ID: An integer that specifies the media type ID.
  • Media Type: A string that specifies the media type name.

Possible values:

  • 1 : Display
  • 2 : Video
  • Native
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.

  • Goal Type: An integer that specifies the goal type ID.
  • Goal: A string that specifies the goal type name.

Possible values:

  • 1 : None
  • 2 : CPC
  • 3 : CPA
  • 4 : CPCV
  • VCPM
  • ROAS
  • Maximize Viewability
  • Maximize Completion Rate
  • Viewability
  • Maximize CTR
  • 16 : CPI
Y N
73 Line Billing Method

Returns two dimensions: the ID and the name of the Line Billing Method.

  • Line Billing Method: An integer that specifies the line billing method ID.
  • Line Billing Method: A string that specifies the line billing method name.

Possible values:

  • Default
  • 1 : Profit Margin
  • 2 : CPM Price
  • 3 : CPC
  • CPCV
Y N
75 Market Area

Returns two dimensions: the ID and name of the Nielsen Designated Marketing Area.

  • Market Area ID: An integer that specifies the ID of the DMA.
  • Market Area: A string that specifies the name of the DMA.
Y N
103 Pixel Parameter Returns the Pixel Query String, the parameters passed to a pixel query. Y N
104 Target Segment

Returns two dimensions: the ID and name of the targeted segment.

  • Target Segment ID: An integer that specifies the ID of the targeted segment.
  • Target Segment: A string that specifies the name of the targeted segment.
Y N
106 Inventory Type

Returns the name of the inventory type. Options include:

  • App
  • Web
Y N