Dimensions Cheat Sheet

📘

If a filter is not listed, then it is not supported by that dimension.

Dimension

Dimension-Specific Column(s)

Mandatory Filters

Optional Filters

day

date

start_date, end_date

campaign, platform, country, site

week

date, date_end_period

start_date, end_date

campaign, platform, country, site

month

date, date_end_period

start_date, end_date

campaign, platform, country, site

by_hour_of_day

See callout below.

hour_of_day

start_date, end_date

campaign, platform, country, site

campaign_hour_breakdown

See callout below.

date, campaign, campaign_name

start_date, end_date

Pass a date and time, for this dimension.

platform, country, site, exclude_empty_campaigns

To exclude empty campaigns, pass exclude_empty_campaigns=true.

content_provider_breakdown

(By Advertiser)
Network accounts only

content_provider, content_provider_name

start_date, end_date

platform, country, site

content_provider_country_breakdown

Network accounts only

content_provider, content_provider_name,
country, country_name

start_date, end_date

campaign_breakdown

campaign, campaign_name, campaign_learning_state

start_date, end_date

platform, country, site, exclude_empty_campaigns

To exclude empty campaigns, pass exclude_empty_campaigns=true.

site_breakdown

site, site_name, blocking_level

start_date, end_date

campaign

country_breakdown

country, country_name

start_date, end_date

campaign

region_breakdown

region, country

start_date, end_date

campaign

dma_breakdown

dma, country

start_date, end_date

campaign

platform_breakdown

platform, platform_name

start_date, end_date

campaign

os_family_breakdown

platform, platform_name, os_family

start_date, end_date

platform, os_family, campaign

os_version_breakdown

platform, platform_name, os_version

start_date, end_date

platform, os_version, campaign

browser_breakdown

platform, platform_name, browser

start_date, end_date

platform, browser, campaign

campaign_day_breakdown

date, campaign, campaign_name

start_date, end_date

platform, country, site, exclude_empty_campaigns

To exclude empty campaigns, pass exclude_empty_campaigns=true. See callout below.

campaign_site_day_breakdown

date, campaign, campaign_name, site, site_name

start_date, end_date

The reporting interval must be 90 days or less.

campaign, exclude_empty_campaigns

To exclude empty campaigns, pass exclude_empty_campaigns=true. See callout below.

user_segment_breakdown

(By Marketplace Audience)

data_partner_audience_id, partner_name, audience_name,
audience_description

start_date, end_date

campaign, partner_name

Tip: Always include a campaign filter.

contextual_breakdown

data_partner_audience_id,
partner_name, audience_name,
audience_description

start_date, end_date

campaign

🚧

exclude_empty_campaigns

By default, the following dimensions return all campaigns:

  • campaign_breakdown
  • campaign_hour_breakdown
  • campaign_day_breakdown
  • campaign_site_day_breakdown

To exclude empty campaigns (impressions = 0), pass exclude_empty_campaigns=true.

For more detail, see this announcement.

🚧

by_hour_of_day

To fetch data by hour, aggregated for a given date range, use the by_hour_of_day dimension. You can optionally filter on a given campaign. E.g.:

.../dimensions/by_hour_of_day?start_date=2021-10-01&end_date=2021-10-07&campaign=123 (the end_date is inclusive)

  • The report returns 24 rows, with aggregated data for each hour of the day.
  • Reporting data is retained for 90 days.

For more detail, see this announcement.

🚧

campaign_hour_breakdown

When using the campaign_hour_breakdown dimension, pass a date and time for the reporting interval. (The values passed should reflect the time zone of that account.) E.g.

.../dimensions/campaign_hour_breakdown?start_date=2021-10-01T13:00:00&end_date=2021-10-02T12:59:59

  • The report returns 1 row per campaign/date/hour in the reporting interval.
  • Reporting data is retained for 90 days.

For more detail, see this announcement.

📘

user_segment_breakdown

  1. The purpose of theuser_segment_breakdown dimension is twofold:
    • For a campaign that targets 3rd Party Audience Segments (aka Marketplace Audiences), this dimension shows performance stats per targeted audience.
    • For a campaign that does not target any audiences at all (i.e. a "Run On Network" or "RON" campaign), this dimension shows performance stats across all relevant audience segments - so that you can decide which audiences are good candidates for targeting.
  2. This dimension should be run against a single campaign (by applying the campaign filter).
  3. If audience targeting was applied for any of the other audience types (e.g. Custom Audiences, Lookalike Audiences, First Party Audiences, etc), then the user_segment_breakdown dimension will not show any data for the selected campaign. (This rule applies regardless of any 3rd Party Audience targeting for that campaign.)
  4. The above audience targeting types are sometimes loosely referred to as First Party Audiences - because the data belongs to the advertiser. However, in our API docs, we use the term First Party Audiences to refer specifically to DMP integration.

📘

Columns

For an explanation of each dimension-specific column, see Dimension Columns below.