Dimensions

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, 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.

  • Publisher ID: An integer that specifies the publisher ID number.

  • Publisher: The name of the 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 dimensions. 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.

  • Campaign ID: An integer that specifies the campaign ID.

  • Campaign Name: 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

22

Postal Code

Returns the consumer’s zip or postal code.

  • Zip/Postal Code: A string that specifies the consumer’s zip code or postal code.

Y

Y

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

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:

  • Desktop

  • Digital-Out-Of-Home

  • Phone

  • Tablet

  • Unknown

Y

N

39

Targeted Audience

DEPRECATED Use 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

500,000 row limit per report

46

Pixel

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

  • Beacon ID: An integer that specifies the beacon ID of the conversion rule.

  • Beacon: A string that specifies the name of the 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, 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

55

App Name

Name of the app. Supported for both mobile and Connected TV (CTV) apps.

Y

Y

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

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.

  • 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

  • 5 : VCPM

  • 6 : ROAS

  • 7 : Maximize Viewability

  • 8 : Maximize Completion Rate

  • 9 : Viewability (hard threshold)

  • 10 : Maximize CTR

  • 11 : Completion Hard Threshold

  • 12 : AVOC Hard Threshold

  • 13 : Maximize AVOC Rate

  • 14 : Maximize GroupM viewability rate

  • 15 : eCPM

  • 16 : CPI

  • 17 : Publisher Bidder Optimization Goal

  • 18 : "Cost Per Custom Completion Goal

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

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.

  • 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

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 shows 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:

  • 0 = No impressions were seen

  • 1 = The % of users who saw the ad 1 time

  • 2-3 = The % of users who saw the ad 2-3 times

  • 4-7 = The % of users who saw the ad 4-7 times

  • 8-11 = The % of users who saw the ad 8-11 times

  • 12-14 = The % of users who saw the ad 12-14 times

  • 15+ = The % of users who saw the ad 15+ times

  • Null = The % of users who could not be counted due to GDPR, CCPA, and other privacy regulations.

Do not combine with Frequency Bucket 30d or Frequency Bucket 7d.

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 shows 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:

  • 0 = No impressions were seen

  • 1 = The % of users who saw the ad 1 time

  • 2-3 = The % of users who saw the ad 2-3 times

  • 4-7 = The % of users who saw the ad 4-7 times

  • 8-11 = The % of users who saw the ad 8-11 times

  • 12-14 = The % of users who saw the ad 12-14 times

  • 15+ = The % of users who saw the ad 15+ times

  • Null = The % of users who could not be counted due to GDPR, CCPA, and other privacy regulations.

Do not combine with Frequency Bucket 1d or Frequency Bucket 30d.

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 shows 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:

  • 0 = No impressions were seen

  • 1 = The % of users who saw the ad 1 time

  • 2-3 = The % of users who saw the ad 2-3 times

  • 4-7 = The % of users who saw the ad 4-7 times

  • 8-11 = The % of users who saw the ad 8-11 times

  • 12-14 = The % of users who saw the ad 12-14 times

  • 15+ = The % of users who saw the ad 15+ times

  • Null = The % of users who could not be counted due to GDPR, CCPA, and other privacy regulations.

Do not combine with Frequency Bucket 1d or Frequency Bucket 7d.

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.

  • 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

Y

106

Inventory Type

Returns the name of the inventory type. Options include:

  • App

  • Web

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:

  • 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

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

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

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.

  • Deal ID: An integer that specifies the deal ID.

  • Exchange Deal ID: A string that specifies the name of the deal

  • NOTE Replaces Dimension 50 which is deprecated.

Y

N

151

Dot Rule

Returns the dot rule ID.

Y

Y

153

Connected TV Device

A filter to distinguish between the 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., GROUP_1_DESKTOP, GROUP_1_MOBILE, GROUP_2_DESKTOP, GROUP_2_MOBILE, GROUP_3_DEKSTOP, GROUP_3_MOBILE.

Y

Y

159

Bid Request Ad Size

The video player size (Height x Width) in pixels.

Y

Y

165

Target Audience Id : Group B

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

Y

166

Channel Type

A filter for Connected TV (CTV) and Digital out of Home (DOOH) lines, campaigns, and impressions.

Y

Y

169

Video Ad Placement

The type of video ad placement (InStream or Outstream).

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:

  • Large

  • Medium

  • Small

  • Unknown

Y

Y

183

Site Group Name

Returns the Gemini site group ID.

Y

Y

1028

Connected TV Make

The brand name of the connected TV device. For example: Amazon, Sony, or Google.

Y

Y

1029

Connected TV Model

The model name of the connected TV device. For example: Fire TV, Playstation, or Chromecast

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:

  • No Deal: DSP did not bid with a Deal ID to win these impressions.

  • Standard Deal: DSP bid with a Deal ID to win these impressions.

  • Guaranteed Deal: DSP bid in a programmatic guaranteed deal to win these impressions.

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

1041

Campaign Start Date

The start date of the campaign.

Y

Y

1042

Campaign End Date

The end date of the campaign.

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

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

1116

Content Show

For Connected TV (CTV) ads, returns the name of a series (such as “The Office” or “Star Wars”) playing when a user views an ad.

Y

Y

For CTV lines only.

1117

Content Channel

For Connected TV (CTV) ads, returns the name of the channel (such as ABC or ESPN) on which a user views an ad.

Y

Y

For CTV lines only.

1118

Content Network

For Connected TV (CTV) ads, returns the name of the network (such as Disney) on which a user views an ad.

Y

Y

For CTV lines only.

1119

Content Title

For Connected TV (CTV) ads, returns the name of the title of the show (such as “Star Wars”) playing when a user views an ad.

Y

Y

For CTV lines only.

1120

Content Genre

For Connected TV (CTV) ads, returns the content genre (such as Action or Animation) within which a user views an ad.

Y

Y

For CTV lines only.