com.google.api.ads.admanager.jaxws.v202405.Dimension Maven / Gradle / Ivy
Show all versions of dfp-appengine Show documentation
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.api.ads.admanager.jaxws.v202405;
import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlType;
/**
* Java class for Dimension.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <simpleType name="Dimension">
* <restriction base="{http://www.w3.org/2001/XMLSchema}string">
* <enumeration value="MONTH_AND_YEAR"/>
* <enumeration value="WEEK"/>
* <enumeration value="DATE"/>
* <enumeration value="DAY"/>
* <enumeration value="HOUR"/>
* <enumeration value="DATE_PT"/>
* <enumeration value="WEEK_PT"/>
* <enumeration value="MONTH_YEAR_PT"/>
* <enumeration value="DAY_OF_WEEK_PT"/>
* <enumeration value="LINE_ITEM_ID"/>
* <enumeration value="LINE_ITEM_NAME"/>
* <enumeration value="LINE_ITEM_TYPE"/>
* <enumeration value="ORDER_ID"/>
* <enumeration value="ORDER_NAME"/>
* <enumeration value="ORDER_DELIVERY_STATUS"/>
* <enumeration value="ADVERTISER_ID"/>
* <enumeration value="ADVERTISER_NAME"/>
* <enumeration value="AD_NETWORK_ID"/>
* <enumeration value="AD_NETWORK_NAME"/>
* <enumeration value="SALESPERSON_ID"/>
* <enumeration value="SALESPERSON_NAME"/>
* <enumeration value="CREATIVE_ID"/>
* <enumeration value="CREATIVE_NAME"/>
* <enumeration value="CREATIVE_TYPE"/>
* <enumeration value="CREATIVE_BILLING_TYPE"/>
* <enumeration value="CUSTOM_EVENT_ID"/>
* <enumeration value="CUSTOM_EVENT_NAME"/>
* <enumeration value="CUSTOM_EVENT_TYPE"/>
* <enumeration value="CREATIVE_SIZE"/>
* <enumeration value="AD_UNIT_ID"/>
* <enumeration value="AD_UNIT_NAME"/>
* <enumeration value="PARENT_AD_UNIT_ID"/>
* <enumeration value="PARENT_AD_UNIT_NAME"/>
* <enumeration value="PLACEMENT_ID"/>
* <enumeration value="PLACEMENT_NAME"/>
* <enumeration value="PLACEMENT_STATUS"/>
* <enumeration value="TARGETING"/>
* <enumeration value="BROWSER_NAME"/>
* <enumeration value="DEVICE_CATEGORY_ID"/>
* <enumeration value="DEVICE_CATEGORY_NAME"/>
* <enumeration value="COUNTRY_CRITERIA_ID"/>
* <enumeration value="COUNTRY_CODE"/>
* <enumeration value="COUNTRY_NAME"/>
* <enumeration value="REGION_CRITERIA_ID"/>
* <enumeration value="REGION_NAME"/>
* <enumeration value="CITY_CRITERIA_ID"/>
* <enumeration value="CITY_NAME"/>
* <enumeration value="METRO_CRITERIA_ID"/>
* <enumeration value="METRO_NAME"/>
* <enumeration value="POSTAL_CODE_CRITERIA_ID"/>
* <enumeration value="POSTAL_CODE"/>
* <enumeration value="CUSTOM_TARGETING_VALUE_ID"/>
* <enumeration value="CUSTOM_CRITERIA"/>
* <enumeration value="CONTENT_ID"/>
* <enumeration value="CONTENT_NAME"/>
* <enumeration value="CONTENT_BUNDLE_ID"/>
* <enumeration value="CONTENT_BUNDLE_NAME"/>
* <enumeration value="VIDEO_METADATA_KEY_ID"/>
* <enumeration value="VIDEO_METADATA_KEY_NAME"/>
* <enumeration value="CMS_METADATA"/>
* <enumeration value="VIDEO_FALLBACK_POSITION"/>
* <enumeration value="POSITION_OF_POD"/>
* <enumeration value="POSITION_IN_POD"/>
* <enumeration value="CUSTOM_SPOT_ID"/>
* <enumeration value="CUSTOM_SPOT_NAME"/>
* <enumeration value="VIDEO_REDIRECT_THIRD_PARTY"/>
* <enumeration value="VIDEO_BREAK_TYPE"/>
* <enumeration value="VIDEO_BREAK_TYPE_NAME"/>
* <enumeration value="VIDEO_VAST_VERSION"/>
* <enumeration value="VIDEO_AD_REQUEST_DURATION_ID"/>
* <enumeration value="VIDEO_AD_REQUEST_DURATION"/>
* <enumeration value="VIDEO_PLACEMENT_NAME"/>
* <enumeration value="PARTNER_MANAGEMENT_PARTNER_ID"/>
* <enumeration value="PARTNER_MANAGEMENT_PARTNER_NAME"/>
* <enumeration value="PARTNER_MANAGEMENT_PARTNER_LABEL_ID"/>
* <enumeration value="PARTNER_MANAGEMENT_PARTNER_LABEL_NAME"/>
* <enumeration value="PARTNER_MANAGEMENT_ASSIGNMENT_ID"/>
* <enumeration value="PARTNER_MANAGEMENT_ASSIGNMENT_NAME"/>
* <enumeration value="INVENTORY_SHARE_ASSIGNMENT_ID"/>
* <enumeration value="INVENTORY_SHARE_ASSIGNMENT_NAME"/>
* <enumeration value="INVENTORY_SHARE_OUTCOME"/>
* <enumeration value="GRP_DEMOGRAPHICS"/>
* <enumeration value="AD_REQUEST_AD_UNIT_SIZES"/>
* <enumeration value="AD_REQUEST_CUSTOM_CRITERIA"/>
* <enumeration value="IS_FIRST_LOOK_DEAL"/>
* <enumeration value="IS_ADX_DIRECT"/>
* <enumeration value="YIELD_GROUP_ID"/>
* <enumeration value="YIELD_GROUP_NAME"/>
* <enumeration value="YIELD_PARTNER"/>
* <enumeration value="YIELD_PARTNER_TAG"/>
* <enumeration value="EXCHANGE_BIDDING_DEAL_ID"/>
* <enumeration value="EXCHANGE_BIDDING_DEAL_TYPE"/>
* <enumeration value="CLASSIFIED_ADVERTISER_ID"/>
* <enumeration value="CLASSIFIED_ADVERTISER_NAME"/>
* <enumeration value="CLASSIFIED_BRAND_ID"/>
* <enumeration value="CLASSIFIED_BRAND_NAME"/>
* <enumeration value="MEDIATION_TYPE"/>
* <enumeration value="NATIVE_TEMPLATE_ID"/>
* <enumeration value="NATIVE_TEMPLATE_NAME"/>
* <enumeration value="NATIVE_STYLE_ID"/>
* <enumeration value="NATIVE_STYLE_NAME"/>
* <enumeration value="CHILD_NETWORK_CODE"/>
* <enumeration value="MOBILE_APP_RESOLVED_ID"/>
* <enumeration value="MOBILE_APP_NAME"/>
* <enumeration value="MOBILE_DEVICE_NAME"/>
* <enumeration value="MOBILE_INVENTORY_TYPE"/>
* <enumeration value="OPERATING_SYSTEM_VERSION_ID"/>
* <enumeration value="OPERATING_SYSTEM_VERSION_NAME"/>
* <enumeration value="REQUEST_TYPE"/>
* <enumeration value="AD_UNIT_STATUS"/>
* <enumeration value="MASTER_COMPANION_CREATIVE_ID"/>
* <enumeration value="MASTER_COMPANION_CREATIVE_NAME"/>
* <enumeration value="AUDIENCE_SEGMENT_ID"/>
* <enumeration value="AUDIENCE_SEGMENT_NAME"/>
* <enumeration value="AUDIENCE_SEGMENT_DATA_PROVIDER_NAME"/>
* <enumeration value="WEB_PROPERTY_CODE"/>
* <enumeration value="BUYING_AGENCY_NAME"/>
* <enumeration value="BUYER_NETWORK_ID"/>
* <enumeration value="BUYER_NETWORK_NAME"/>
* <enumeration value="BIDDER_ID"/>
* <enumeration value="BIDDER_NAME"/>
* <enumeration value="ADVERTISER_DOMAIN_NAME"/>
* <enumeration value="AD_EXCHANGE_OPTIMIZATION_TYPE"/>
* <enumeration value="ADVERTISER_VERTICAL_NAME"/>
* <enumeration value="NIELSEN_SEGMENT"/>
* <enumeration value="NIELSEN_DEMOGRAPHICS"/>
* <enumeration value="NIELSEN_RESTATEMENT_DATE"/>
* <enumeration value="NIELSEN_DEVICE_ID"/>
* <enumeration value="NIELSEN_DEVICE_NAME"/>
* <enumeration value="PROGRAMMATIC_BUYER_ID"/>
* <enumeration value="PROGRAMMATIC_BUYER_NAME"/>
* <enumeration value="REQUESTED_AD_SIZES"/>
* <enumeration value="CREATIVE_SIZE_DELIVERED"/>
* <enumeration value="PROGRAMMATIC_CHANNEL_ID"/>
* <enumeration value="PROGRAMMATIC_CHANNEL_NAME"/>
* <enumeration value="CLASSIFIED_YIELD_PARTNER_NAME"/>
* <enumeration value="DP_DATE"/>
* <enumeration value="DP_WEEK"/>
* <enumeration value="DP_MONTH_YEAR"/>
* <enumeration value="DP_COUNTRY_CRITERIA_ID"/>
* <enumeration value="DP_COUNTRY_NAME"/>
* <enumeration value="DP_INVENTORY_TYPE"/>
* <enumeration value="DP_CREATIVE_SIZE"/>
* <enumeration value="DP_BRAND_NAME"/>
* <enumeration value="DP_ADVERTISER_NAME"/>
* <enumeration value="DP_ADX_BUYER_NETWORK_NAME"/>
* <enumeration value="DP_MOBILE_DEVICE_NAME"/>
* <enumeration value="DP_DEVICE_CATEGORY_NAME"/>
* <enumeration value="DP_TAG_ID"/>
* <enumeration value="DP_DEAL_ID"/>
* <enumeration value="DP_APP_ID"/>
* <enumeration value="CUSTOM_DIMENSION"/>
* <enumeration value="DEMAND_CHANNEL_ID"/>
* <enumeration value="DEMAND_CHANNEL_NAME"/>
* <enumeration value="DOMAIN"/>
* <enumeration value="SERVING_RESTRICTION_ID"/>
* <enumeration value="SERVING_RESTRICTION_NAME"/>
* <enumeration value="UNIFIED_PRICING_RULE_ID"/>
* <enumeration value="UNIFIED_PRICING_RULE_NAME"/>
* <enumeration value="FIRST_LOOK_PRICING_RULE_ID"/>
* <enumeration value="FIRST_LOOK_PRICING_RULE_NAME"/>
* <enumeration value="BID_RANGE"/>
* <enumeration value="BID_REJECTION_REASON"/>
* <enumeration value="BID_REJECTION_REASON_NAME"/>
* <enumeration value="AD_TECHNOLOGY_PROVIDER_DOMAIN"/>
* <enumeration value="PROGRAMMATIC_DEAL_ID"/>
* <enumeration value="PROGRAMMATIC_DEAL_NAME"/>
* <enumeration value="AD_TECHNOLOGY_PROVIDER_ID"/>
* <enumeration value="AD_TECHNOLOGY_PROVIDER_NAME"/>
* <enumeration value="TCF_VENDOR_ID"/>
* <enumeration value="TCF_VENDOR_NAME"/>
* <enumeration value="SITE_NAME"/>
* <enumeration value="CHANNEL_NAME"/>
* <enumeration value="URL_ID"/>
* <enumeration value="URL_NAME"/>
* <enumeration value="VIDEO_AD_DURATION"/>
* <enumeration value="VIDEO_AD_TYPE_ID"/>
* <enumeration value="VIDEO_AD_TYPE_NAME"/>
* <enumeration value="AD_EXCHANGE_PRODUCT_CODE"/>
* <enumeration value="AD_EXCHANGE_PRODUCT_NAME"/>
* <enumeration value="DYNAMIC_ALLOCATION_ID"/>
* <enumeration value="DYNAMIC_ALLOCATION_NAME"/>
* <enumeration value="AD_TYPE_ID"/>
* <enumeration value="AD_TYPE_NAME"/>
* <enumeration value="AD_LOCATION_ID"/>
* <enumeration value="AD_LOCATION_NAME"/>
* <enumeration value="TARGETING_TYPE_CODE"/>
* <enumeration value="TARGETING_TYPE_NAME"/>
* <enumeration value="BRANDING_TYPE_CODE"/>
* <enumeration value="BRANDING_TYPE_NAME"/>
* <enumeration value="BANDWIDTH_ID"/>
* <enumeration value="BANDWIDTH_NAME"/>
* <enumeration value="CARRIER_ID"/>
* <enumeration value="CARRIER_NAME"/>
* </restriction>
* </simpleType>
*
*
*/
@XmlType(name = "Dimension")
@XmlEnum
public enum Dimension {
/**
*
* Breaks down reporting data by month and year in the network time zone. Can be used to filter on
* month using ISO 4601 format 'YYYY-MM'.
* Corresponds to "Month and year" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Partner finance, YouTube consolidated.
*
*
*/
MONTH_AND_YEAR,
/**
*
* Breaks down reporting data by week of the year in the network time zone. Cannot be used for
* filtering.
* Corresponds to "Week" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, YouTube consolidated.
*
*
*/
WEEK,
/**
*
* Breaks down reporting data by date in the network time zone. Can be used to filter by date
* using ISO 8601's format 'YYYY-MM-DD'".
* Corresponds to "Date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video, YouTube consolidated.
*
*
*/
DATE,
/**
*
* Breaks down reporting data by day of the week in the network time zone. Can
* be used to filter by day of the week using the index of the day (from 1 for
* Monday is 1 to 7 for Sunday).
* Corresponds to "Day of week" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, YouTube consolidated.
*
*
*/
DAY,
/**
*
* Breaks down reporting data by hour of the day in the network time zone. Can
* be used to filter by hour of the day (from 0 to 23).
* Corresponds to "Hour" in the Ad Manager UI. Compatible with any of the following report types: Historical, Real-time video.
*
*
*/
HOUR,
/**
*
* Breaks down reporting data by date in the PT time zone. Can be used to filter by date
* using ISO 8601's format 'YYYY-MM-DD'". Can only be used when time zone type is PACIFIC.
* Compatible with the "Historical" report type.
*
*
*/
DATE_PT,
/**
*
* Breaks down reporting data by week of the year in the PT time zone. Cannot be used for
* filtering. Can only be used when time zone type is PACIFIC.
* Compatible with the "Historical" report type.
*
*
*/
WEEK_PT,
/**
*
* Breaks down reporting data by month and year in the PT time zone. Can be used to filter on
* month using ISO 4601 format 'YYYY-MM'. Can only be used when time zone type is PACIFIC.
* Compatible with the "Historical" report type.
*
*
*/
MONTH_YEAR_PT,
/**
*
* Breaks down reporting data by day of the week in the PT time zone. Can
* be used to filter by day of the week using the index of the day (from 1 for
* Monday is 1 to 7 for Sunday). Can only be used when time zone type is PACIFIC.
* Compatible with the "Historical" report type.
*
*
*/
DAY_OF_WEEK_PT,
/**
*
* Breaks down reporting data by {@link LineItem#id}. Can be used to
* filter by {@link LineItem#id}.
* Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.
*
*
*/
LINE_ITEM_ID,
/**
*
* Breaks down reporting data by line item. {@link LineItem#name} and
* {@link LineItem#id} are automatically included as columns in the report.
* Can be used to filter by {@link LineItem#name}.
* Corresponds to "Line item" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.
*
*
*/
LINE_ITEM_NAME,
/**
*
* Breaks down reporting data by {@link LineItem#lineItemType}. Can be used
* to filter by line item type using {@link LineItemType} enumeration names.
* Corresponds to "Line item type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.
*
*
*/
LINE_ITEM_TYPE,
/**
*
* Breaks down reporting data by {@link Order#id}. Can be used to filter by
* {@link Order#id}.
* Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.
*
*
*/
ORDER_ID,
/**
*
* Breaks down reporting data by order. {@link Order#name} and
* {@link Order#id} are automatically included as columns in the report. Can
* be used to filter by {@link Order#name}.
* Corresponds to "Order" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.
*
*
*/
ORDER_NAME,
/**
*
* Delivery status of the order. Not available as a dimension to report on,
* but exists as a dimension in order to filter on it using PQL.
* Valid values are 'STARTED', 'NOT_STARTED' and 'COMPLETED'.
* Compatible with the "Historical" report type.
*
*
*/
ORDER_DELIVERY_STATUS,
/**
*
* Breaks down reporting data by advertising company {@link Company#id}. Can
* be used to filter by {@link Company#id}.
* Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.
*
*
*/
ADVERTISER_ID,
/**
*
* Breaks down reporting data by advertising company. {@link Company#name} and
* {@link Company#id} are automatically included as columns in the report.
* Can be used to filter by {@link Company#name}.
* Corresponds to "Advertiser" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.
*
*
*/
ADVERTISER_NAME,
/**
*
* The network that provided the ad for SDK ad mediation.
*
* If selected for a report, that report will include only SDK mediation ads and will not
* contain non-SDK mediation ads.
*
*
SDK mediation ads are ads for mobile devices. They have a list of ad networks which can
* provide ads to serve. Not every ad network will have an ad to serve so the device will try each
* network one-by-one until it finds an ad network with an ad to serve. The ad network that ends
* up serving the ad will appear here. Note that this id does not correlate to anything in the
* companies table and is not the same id as is served by {@link #ADVERTISER_ID}.
*
Compatible with the "Historical" report type.
*
*
*/
AD_NETWORK_ID,
/**
*
* The name of the network defined in {@link #AD_NETWORK_ID}.
* Corresponds to "Ad network name" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
AD_NETWORK_NAME,
/**
*
* Breaks down reporting data by salesperson {@link User#id}. Can be used to
* filter by {@link User#id}.
* Compatible with any of the following report types: Historical, Future sell-through, Reach.
*
*
*/
SALESPERSON_ID,
/**
*
* Breaks down reporting data by salesperson. {@link User#name} and
* {@link User#id} of the salesperson are automatically included as columns in
* the report. Can be used to filter by {@link User#name}.
* Corresponds to "Salesperson" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach.
*
*
*/
SALESPERSON_NAME,
/**
*
* Breaks down reporting data by {@link Creative#id} or creative set id
* (master's {@link Creative#id}) if the creative is part of a creative set.
* Can be used to filter by {@link Creative#id}.
* Compatible with any of the following report types: Historical, Ad speed, Real-time video.
*
*
*/
CREATIVE_ID,
/**
*
* Breaks down reporting data by creative. {@link Creative#name} and
* {@link Creative#id} are automatically included as columns in the report.
* Can be used to filter by {@link Creative#name}.
* Corresponds to "Creative" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed, Real-time video.
*
*
*/
CREATIVE_NAME,
/**
*
* Breaks down reporting data by creative type.
* Corresponds to "Creative type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.
*
*
*/
CREATIVE_TYPE,
/**
*
* Breaks down reporting data by creative billing type.
* Corresponds to "Creative billing type" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
CREATIVE_BILLING_TYPE,
/**
*
* Breaks down reporting data by custom event ID.
* Compatible with the "Historical" report type.
*
*
*/
CUSTOM_EVENT_ID,
/**
*
* Breaks down reporting data by custom event name.
* Corresponds to "Custom event" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
CUSTOM_EVENT_NAME,
/**
*
* Breaks down reporting data by custom event type (timer/exit/counter).
* Corresponds to "Custom event type" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
CUSTOM_EVENT_TYPE,
/**
*
* Breaks down reporting data by {@link Creative#size}. Cannot be used for
* filtering.
* Corresponds to "Creative size" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
CREATIVE_SIZE,
/**
*
* Breaks down reporting data by {@link AdUnit#id}. Can be used to filter by
* {@link AdUnit#id}. {@link #AD_UNIT_NAME}, i.e. {@link AdUnit#name}, is
* automatically included as a dimension in the report.
* Compatible with any of the following report types: Historical, Future sell-through, Ad speed, Real-time video.
*
*
*/
AD_UNIT_ID,
/**
*
* Breaks down reporting data by ad unit. {@link AdUnit#name} and
* {@link AdUnit#id} are automatically included as columns in the report. Can
* be used to filter by {@link AdUnit#name}.
* Corresponds to "Ad unit" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Ad speed, Real-time video.
*
*
*/
AD_UNIT_NAME,
/**
*
* Used to filter on all the descendants of an ad unit by {@link AdUnit#id}. Not available as a
* dimension to report on.
* Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.
*
*
*/
PARENT_AD_UNIT_ID,
/**
*
* Used to filter on all the descendants of an ad unit by {@link AdUnit#name}. Not available as a
* dimension to report on.
* Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.
*
*
*/
PARENT_AD_UNIT_NAME,
/**
*
* Breaks down reporting data by {@link Placement#id}. Can be used to filter
* by {@link Placement#id}.
* Compatible with any of the following report types: Historical, Future sell-through, Reach.
*
*
*/
PLACEMENT_ID,
/**
*
* Breaks down reporting data by placement. {@link Placement#name} and
* {@link Placement#id} are automatically included as columns in the report.
* Can be used to filter by {@link Placement#name}.
* Corresponds to "Placement" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach.
*
*
*/
PLACEMENT_NAME,
/**
*
* Status of the placement. Not available as a dimension to report on, but
* exists as a dimension in order to filter on it using PQL. Can be used to
* filter on {@link Placement#status} by using {@link InventoryStatus}
* enumeration names.
* Compatible with any of the following report types: Historical, Future sell-through.
*
*
*/
PLACEMENT_STATUS,
/**
*
* Breaks down reporting data by criteria predefined by Ad Manager like the
* operating system, browser etc. Cannot be used for filtering.
* Corresponds to "Targeting" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
TARGETING,
/**
*
* Breaks down reporting data by browser criteria predefined by Ad Manager.
* Corresponds to "Browser" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
BROWSER_NAME,
/**
*
* The ID of the device category to which an ad is being targeted.
*
* Can be used to filter by device category ID.
* Compatible with any of the following report types: Historical, Ad speed, Real-time video.
*
*
*/
DEVICE_CATEGORY_ID,
/**
*
* The category of device (smartphone, feature phone, tablet, or desktop) to which an ad is being
* targeted.
*
* Can be used to filter by device category name.
* Corresponds to "Device category" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed, Real-time video.
*
*
*/
DEVICE_CATEGORY_NAME,
/**
*
* Breaks down reporting data by country criteria ID. Can be used to filter by
* country criteria ID.
* Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, YouTube consolidated.
*
*
*/
COUNTRY_CRITERIA_ID,
/**
*
* Breaks down reporting data by country code.
* Compatible with the "Historical" report type.
*
*
*/
COUNTRY_CODE,
/**
*
* Breaks down reporting data by country name. The country name and the
* country criteria ID are automatically included as columns in the report.
* Can be used to filter by country name using the US English name.
* Corresponds to "Country" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, YouTube consolidated.
*
*
*/
COUNTRY_NAME,
/**
*
* Breaks down reporting data by region criteria ID. Can be used to filter by
* region criteria ID.
* Compatible with the "Historical" report type.
*
*
*/
REGION_CRITERIA_ID,
/**
*
* Breaks down reporting data by region name. The region name and the region
* criteria ID are automatically included as columns in the report. Can be
* used to filter by region name using the US English name.
* Corresponds to "Region" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
REGION_NAME,
/**
*
* Breaks down reporting data by city criteria ID. Can be used to filter by
* city criteria ID.
* Compatible with the "Historical" report type.
*
*
*/
CITY_CRITERIA_ID,
/**
*
* Breaks down reporting data by city name. The city name and the city
* criteria ID are automatically included as columns in the report. Can be
* used to filter by city name using the US English name.
* Corresponds to "City" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
CITY_NAME,
/**
*
* Breaks down reporting data by metro criteria ID. Can be used to filter by
* metro criteria ID.
* Compatible with the "Historical" report type.
*
*
*/
METRO_CRITERIA_ID,
/**
*
* Breaks down reporting data by metro name. The metro name and the metro
* criteria ID are automatically included as columns in the report. Can be
* used to filter by metro name using the US English name.
* Corresponds to "Metro" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
METRO_NAME,
/**
*
* Breaks down reporting data by postal code criteria ID. Can be used to
* filter by postal code criteria ID.
* Compatible with the "Historical" report type.
*
*
*/
POSTAL_CODE_CRITERIA_ID,
/**
*
* Breaks down reporting data by postal code. The postal code and the postal
* code criteria ID are automatically included as columns in the report. Can
* be used to filter by postal code.
* Corresponds to "Postal code" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
POSTAL_CODE,
/**
*
* Breaks down reporting data by {@link CustomTargetingValue#id}. Can be used
* to filter by {@link CustomTargetingValue#id}.
* Compatible with the "Historical" report type.
*
*
*/
CUSTOM_TARGETING_VALUE_ID,
/**
*
* Breaks down reporting data by custom criteria. The {@link CustomTargetingValue} is
* displayed in the form:
*
* -
* car=honda when value match type is
* {@link CustomTargetingValue.MatchType#EXACT}
*
* -
* car~honda when value match type is
* {@link CustomTargetingValue.MatchType#BROAD}
*
* -
* car=*honda when value match type is
* {@link CustomTargetingValue.MatchType#PREFIX}
*
* -
* car~*honda when value match type is
* {@link CustomTargetingValue.MatchType#BROAD_PREFIX}
*
*
* {@link #CUSTOM_TARGETING_VALUE_ID}, i.e. {@link CustomTargetingValue#id} is
* automatically included as a column in the report.
* Cannot be used for filtering; use {@link #CUSTOM_TARGETING_VALUE_ID} instead.
*
* When using this {@code Dimension}, metrics for freeform key values are only
* reported on when they are registered with {@code CustomTargetingService}.
*
Corresponds to "Key-values" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
CUSTOM_CRITERIA,
/**
*
* Breaks down reporting data by {@link Content#id}. Can be used to filter by
* {@link Content#id}.
* Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated.
*
*
*/
CONTENT_ID,
/**
*
* Breaks down reporting data by content. {@link Content#name} and
* {@link Content#id} are automatically included as columns in the report. Can
* be used to filter by {@link Content#name}.
* Corresponds to "Content" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated.
*
*
*/
CONTENT_NAME,
/**
*
* Breaks down reporting data by {@link ContentBundle#id}. Can be used to filter
* by {@link ContentBundle#id}.
* Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated.
*
*
*/
CONTENT_BUNDLE_ID,
/**
*
* Breaks down reporting data by content bundle. {@link ContentBundle#name} and
* {@link ContentBundle#id} are automatically included as columns in the
* report. Can be used to filter by {@link ContentBundle#name}.
* Corresponds to "Content bundle" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated.
*
*
*/
CONTENT_BUNDLE_NAME,
/**
*
* Breaks down reporting data by {@link CustomTargetingKey#id}.
*
*
*/
VIDEO_METADATA_KEY_ID,
/**
*
* Breaks down reporting data by custom targeting key. {@link CustomTargetingKey#name} and {@link
* CustomTargetingKey#id} are automatically included as columns in the report.
*
*
*/
VIDEO_METADATA_KEY_NAME,
/**
*
* Breaks down reporting data by CMS metadata.
* To use this dimension in API, a list of cms metadata key IDs must be specified in
* {@link ReportQuery#cmsMetadataKeyIds}.
*
* This dimension can be used as a filter in the {@link Statement} in PQL syntax:
* CMS_METADATA_KEY[keyId]_ID =
* {@link CmsMetadataValue#cmsMetadataValueId CMS metadata value ID}
*
* For example: WHERE CMS_METADATA_KEY[4242]_ID = 53423
*
*
*/
CMS_METADATA,
/**
*
* Breaks down reporting data by the fallback position of the video ad, i.e.,
* {@code NON_FALLBACK}, {@code FALLBACK_POSITION_1}, {@code FALLBACK_POSITION_2}, etc. Can be
* used for filtering.
*
Corresponds to "Fallback position" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
VIDEO_FALLBACK_POSITION,
/**
*
* Breaks down reporting data by the position of the video ad within the video stream, i.e.,
* {@code UNKNOWN_POSITION}, {@code PREROLL}, {@code POSTROLL}, {@code UNKNOWN_MIDROLL},
* {@code MIDROLL_1}, {@code MIDROLL_2}, etc. {@code UNKNOWN_MIDROLL} represents a midroll, but
* which specific midroll is unknown. Can be used for filtering.
* Corresponds to "Position of pod" in the Ad Manager UI. Compatible with any of the following report types: Historical, Real-time video.
*
*
*/
POSITION_OF_POD,
/**
*
* Breaks down reporting data by the position of the video ad within the pod, i.e.,
* {@code UNKNOWN_POSITION}, {@code POSITION_1}, {@code POSITION_2}, etc.
* Can be used for filtering.
* Corresponds to "Position in pod" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
POSITION_IN_POD,
/**
*
* Breaks down reporting data by {@link AdSpot#id}. Can be used to filter by
* {@link AdSpot#id}.
* Compatible with the "Historical" report type.
*
*
*/
CUSTOM_SPOT_ID,
/**
*
* Breaks down reporting data by content. {@link AdSpot#name} and
* {@link AdSpot#id} are automatically included as columns in the report. Can
* be used to filter by {@link AdSpot#name}.
* Corresponds to "Custom spot" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
CUSTOM_SPOT_NAME,
/**
*
* Breaks down reporting data by video redirect vendor.
* Corresponds to "Video redirect third party" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
VIDEO_REDIRECT_THIRD_PARTY,
/**
*
* The filter to break down reporting data by video break type.
* Not available as a dimension to report on.
* Compatible with the "Historical" report type.
*
*
*/
VIDEO_BREAK_TYPE,
/**
*
* The filter to break down reporting data by video break type.
* Can only be used with the following string values:
* "Unknown", "Single ad video request", "Optimized pod video request".
* Not available as a dimension to report on.
* Compatible with the "Historical" report type.
*
*
*/
VIDEO_BREAK_TYPE_NAME,
/**
*
* Breaks down reporting data by vast version type name.
* Corresponds to "VAST version" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
VIDEO_VAST_VERSION,
/**
*
* Breaks down reporting data by video request duration bucket.
* Compatible with the "Historical" report type.
*
*
*/
VIDEO_AD_REQUEST_DURATION_ID,
/**
*
* Breaks down reporting data by video request duration bucket name.
* Corresponds to "Video ad request duration" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
VIDEO_AD_REQUEST_DURATION,
/**
*
* Breaks down reporting data by video placement.
* Corresponds to "Video placement" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
VIDEO_PLACEMENT_NAME,
/**
*
* Breaks down reporting data by partner {@link Company#id}.
* Compatible with any of the following report types: Historical, Partner finance.
*
*
*/
PARTNER_MANAGEMENT_PARTNER_ID,
/**
*
* Breaks down reporting data by partner {@link Company#name} and {@link Company#id} are
* automatically included as columns in the report.
* Corresponds to "Partner" in the Ad Manager UI. Compatible with any of the following report types: Historical, Partner finance.
*
*
*/
PARTNER_MANAGEMENT_PARTNER_NAME,
/**
*
* Breaks down reporting data by partner label {@link Label#id}.
* Compatible with any of the following report types: Historical, Partner finance.
*
*
*/
PARTNER_MANAGEMENT_PARTNER_LABEL_ID,
/**
*
* Breaks down reporting data by partner label. {@link Label#name} and {@link Label#id} are
* automatically included as columns in the report.
* Corresponds to "Partner label" in the Ad Manager UI. Compatible with any of the following report types: Historical, Partner finance.
*
*
*/
PARTNER_MANAGEMENT_PARTNER_LABEL_NAME,
/**
*
* Breaks down reporting data by partner assignment id.
* Compatible with any of the following report types: Historical, Partner finance.
*
*
*/
PARTNER_MANAGEMENT_ASSIGNMENT_ID,
/**
*
* Breaks down reporting data by partner assignment name. PartnerAssignment name and id are
* automatically included as columns in the report.
* Corresponds to "Assignment" in the Ad Manager UI. Compatible with any of the following report types: Historical, Partner finance.
*
*
*/
PARTNER_MANAGEMENT_ASSIGNMENT_NAME,
/**
*
* Breaks down reporting data by inventory sharing assignment ID.
* Compatible with the "Historical" report type.
*
*
*/
INVENTORY_SHARE_ASSIGNMENT_ID,
/**
*
* Breaks down reporting data by inventory sharing assignment name.
* Corresponds to "Inventory share assignment" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
INVENTORY_SHARE_ASSIGNMENT_NAME,
/**
*
* Breaks down reporting data by inventory sharing outcome.
* Corresponds to "Inventory share outcome" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
INVENTORY_SHARE_OUTCOME,
/**
*
* Breaks down reporting data by gender and age group, i.e., MALE_13_TO_17, MALE_18_TO_24,
* MALE_25_TO_34, MALE_35_TO_44, MALE_45_TO_54, MALE_55_TO_64, MALE_65_PLUS, FEMALE_13_TO_17,
* FEMALE_18_TO_24, FEMALE_25_TO_34, FEMALE_35_TO_44, FEMALE_45_TO_54, FEMALE_55_TO_64,
* FEMALE_65_PLUS, UNKNOWN_0_TO_17 and UNKNOWN. Whenever this dimension is selected, {@link
* #COUNTRY_NAME} must be selected.
*
* This dimension is supported only for GRP columns.
*
Can correspond to any of the following in the Ad Manager UI: Demographics, comScore vCE demographics. Compatible with the "Reach" report type.
*
*
*/
GRP_DEMOGRAPHICS,
/**
*
* Breaks down reporting data by the ad unit sizes specified in ad requests.
*
* Formatted as comma separated values, e.g. "300x250,300x250v,300x60".
*
*
This dimension is supported only for sell-through columns.
*
Corresponds to "Ad request sizes" in the Ad Manager UI. Compatible with the "Future sell-through" report type.
*
*
*/
AD_REQUEST_AD_UNIT_SIZES,
/**
*
* Breaks down reporting data by the custom criteria specified in ad requests.
*
* Formatted as comma separated
* {@link CustomTargetingKey key}-{@link CustomTargetingValue values}, where a key-value is
* formatted as {@code key1=value_1|...|value_n,key2=value_1|...|value_n,...}.
*
*
This dimension is supported only for sell-through columns.
*
Corresponds to "Key-values" in the Ad Manager UI. Compatible with the "Future sell-through" report type.
*
*
*/
AD_REQUEST_CUSTOM_CRITERIA,
/**
*
* Break down the report by a boolean indicator. It's TRUE for Ad Exchange traffic fulfilled by
* First Look Deals. It can be used both as a dimension or dimension filter. As a filter, it can
* only be used with the string values "true" and "false".
* Corresponds to "Is First Look" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
IS_FIRST_LOOK_DEAL,
/**
*
* Break down the report by a boolean indicator. It's TRUE for AdX Direct traffic. It can be used
* both as a dimension or dimension filter. As a filter, it can only be used with the string
* values "true" and "false".
* Corresponds to "Is AdX Direct" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
IS_ADX_DIRECT,
/**
*
* Breaks down reporting data by yield group ID.
* Compatible with the "Historical" report type.
*
*
*/
YIELD_GROUP_ID,
/**
*
* Breaks down reporting data by yield group name.
* Corresponds to "Yield group" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
YIELD_GROUP_NAME,
/**
*
* Breaks down reporting data by yield partner.
* Corresponds to "Yield partner" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
YIELD_PARTNER,
/**
*
* Breaks down reporting data by the tag of a yield partner in a yield group.
* Corresponds to "Yield partner tag" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
YIELD_PARTNER_TAG,
/**
*
* The ID of an exchange bidding deal.
* Corresponds to "Exchange bidding deal id" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
EXCHANGE_BIDDING_DEAL_ID,
/**
*
* The type of an exchange bidding deal.
* Corresponds to "Exchange bidding deal type" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
EXCHANGE_BIDDING_DEAL_TYPE,
/**
*
* The ID of a classified advertiser.
* Compatible with the "Ad speed" report type.
*
*
*/
CLASSIFIED_ADVERTISER_ID,
/**
*
* The name of a classified advertiser.
* Corresponds to "Advertiser (classified)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.
*
*
*/
CLASSIFIED_ADVERTISER_NAME,
/**
*
* The ID of a classified brand.
* Compatible with the "Ad speed" report type.
*
*
*/
CLASSIFIED_BRAND_ID,
/**
*
* The name of a classified brand.
* Corresponds to "Brand (classified)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.
*
*
*/
CLASSIFIED_BRAND_NAME,
/**
*
* Breaks down reporting data by mediation type. A mediation type can be web, mobile app or
* video.
* Corresponds to "Mediation type" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
MEDIATION_TYPE,
/**
*
* Breaks down reporting data by native template (also known as creative template) ID.
* Compatible with the "Historical" report type.
*
*
*/
NATIVE_TEMPLATE_ID,
/**
*
* Breaks down reporting data by native template (also known as creative template) name.
* Corresponds to "Native ad format name" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
NATIVE_TEMPLATE_NAME,
/**
*
* Breaks down reporting data by native style ID.
* Compatible with the "Historical" report type.
*
*
*/
NATIVE_STYLE_ID,
/**
*
* Breaks down reporting data by native style name.
* Corresponds to "Native style name" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
NATIVE_STYLE_NAME,
/**
*
* Breaks down reporting data by child network code in MCM "Manage Inventory".
*
* This dimension only works for MCM "Manage Inventory" parent publishers.
*
Corresponds to "Child network code" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
CHILD_NETWORK_CODE,
/**
*
* Breaks down reporting data by mobile app ID received in the ad request (which may be made up).
* If app ID is not available, '(Not applicable)' will be returned. Special values like 'null' and
* 'unidentified' will be reported as '(Not applicable)'. Can be used for filtering.
* Corresponds to "App ID" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
MOBILE_APP_RESOLVED_ID,
/**
*
* Breaks down reporting data by mobile app name. Can be used for filtering.
* Corresponds to "App names" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
MOBILE_APP_NAME,
/**
*
* Breaks down reporting data by device name. Can be used for filtering.
* Corresponds to "Devices" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
MOBILE_DEVICE_NAME,
/**
*
* Breaks down reporting data by inventory type. Can be used for filtering.
* Corresponds to "Inventory types" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.
*
*
*/
MOBILE_INVENTORY_TYPE,
/**
*
* Breaks down reporting data by OS version id.
* Compatible with the "Historical" report type.
*
*
*/
OPERATING_SYSTEM_VERSION_ID,
/**
*
* Breaks down reporting data by OS version name.
* Corresponds to "Operating system" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
OPERATING_SYSTEM_VERSION_NAME,
/**
*
* Breaks down reporting data by request type. Can be used for filtering.
* Corresponds to "Request type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.
*
*
*/
REQUEST_TYPE,
/**
*
* Status of the ad unit. Not available as a dimension to report on,
* but exists as a dimension in order to filter on it using PQL.
* Valid values correspond to {@link InventoryStatus}.
* Compatible with any of the following report types: Historical, Future sell-through, Ad speed, Real-time video.
*
*
*/
AD_UNIT_STATUS,
/**
*
* Breaks down reporting data by {@link Creative#id}. This includes regular creatives,
* and master and companions in case of creative sets.
* Compatible with the "Historical" report type.
*
*
*/
MASTER_COMPANION_CREATIVE_ID,
/**
*
* Breaks down reporting data by creative. This includes regular creatives,
* and master and companions in case of creative sets.
* Corresponds to "Master and Companion creative" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
MASTER_COMPANION_CREATIVE_NAME,
/**
*
* Breaks down reporting data by billable audience segment ID.
* Compatible with the "Historical" report type.
*
*
*/
AUDIENCE_SEGMENT_ID,
/**
*
* Breaks down reporting data by billable audience segment name.
* Corresponds to "Audience segment (billable)" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
AUDIENCE_SEGMENT_NAME,
/**
*
* Breaks down reporting data by audience segment data provider name.
* Corresponds to "Data partner" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
AUDIENCE_SEGMENT_DATA_PROVIDER_NAME,
/**
*
* Breaks down data by web property code.
* Compatible with the "Historical" report type.
*
*
*/
WEB_PROPERTY_CODE,
/**
*
* Breaks down reporting data by agency.
* Corresponds to "Buying agency" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
BUYING_AGENCY_NAME,
/**
*
* Breaks down reporting data by buyer network Id.
* Compatible with the "Historical" report type.
*
*
*/
BUYER_NETWORK_ID,
/**
*
* Breaks down reporting data by buyer network name.
* Corresponds to "Buyer network" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
BUYER_NETWORK_NAME,
/**
*
* Breaks down reporting data by Bidder ID.
* Compatible with the "Historical" report type.
*
*
*/
BIDDER_ID,
/**
*
* Breaks down reporting data by Bidder name.
* Corresponds to "Bidder" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
BIDDER_NAME,
/**
*
* Breaks down reporting data by advertiser domain.
* Corresponds to "Advertiser domain" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
ADVERTISER_DOMAIN_NAME,
/**
*
* Breaks down reporting data by optimization type.
* Corresponds to "Optimization type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.
*
*
*/
AD_EXCHANGE_OPTIMIZATION_TYPE,
/**
*
* Breaks down reporting data by advertiser vertical.
* Corresponds to "Advertiser vertical" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
ADVERTISER_VERTICAL_NAME,
/**
*
* Campaign date segment of Nielsen Digital Ad Ratings reporting.
* Corresponds to "Nielsen Digital Ad Ratings segment" in the Ad Manager UI. Compatible with the "Reach" report type.
*
*
*/
NIELSEN_SEGMENT,
/**
*
* Breaks down reporting data by gender and age group, i.e., MALE_18_TO_20, MALE_21_TO_24,
* MALE_25_TO_29, MALE_30_TO_35, MALE_35_TO_39, MALE_40_TO_44, MALE_45_TO_49, MALE_50_TO_54,
* MALE_55_TO_64, MALE_65_PLUS, FEMALE_18_TO_20, FEMALE_21_TO_24, FEMALE_25_TO_29,
* FEMALE_30_TO_34, FEMALE_35_TO_39, FEMALE_40_TO_44, FEMALE_45_TO_49, FEMALE_50_TO_54,
* FEMALE_55_TO_64, FEMALE_65_PLUS, and OTHER.
*
*
*/
NIELSEN_DEMOGRAPHICS,
/**
*
* Data restatement date of Nielsen Digital Ad Ratings data.
* Corresponds to "Nielsen Digital Ad Ratings restatement date" in the Ad Manager UI. Compatible with the "Reach" report type.
*
*
*/
NIELSEN_RESTATEMENT_DATE,
/**
*
* Breaks down reporting data by device type, i.e., Computer, Mobile and other types.
*
*
* This dimension is supported only for Nielsen columns.
*
Compatible with the "Reach" report type.
*
*
*/
NIELSEN_DEVICE_ID,
/**
*
* Breaks down reporting data by device type, i.e., Computer, Mobile and other types.
*
*
* This dimension is supported only for Nielsen columns.
*
Corresponds to "Nielsen Digital Ad Ratings device" in the Ad Manager UI. Compatible with the "Reach" report type.
*
*
*/
NIELSEN_DEVICE_NAME,
/**
*
* Breaks down reporting data by {@link ProposalMarketplaceInfo#buyerAccountId}.
* Compatible with any of the following report types: Historical, Reach.
*
*
*/
PROGRAMMATIC_BUYER_ID,
/**
*
* Breaks down reporting data by programmatic buyer name.
* Corresponds to "Programmatic buyer" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
PROGRAMMATIC_BUYER_NAME,
/**
*
* Breaks down reporting data by requested ad size(s).
* This can be a chain of sizes or a single size.
* Corresponds to "Requested ad sizes" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
REQUESTED_AD_SIZES,
/**
*
* Breaks down reporting data by the creative size the ad was delivered to.
* Corresponds to "Creative size (delivered)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.
*
*
*/
CREATIVE_SIZE_DELIVERED,
/**
*
* Breaks down reporting data by the type of transaction that occurred in Ad Exchange.
* Compatible with the "Historical" report type.
*
*
*/
PROGRAMMATIC_CHANNEL_ID,
/**
*
* Breaks down reporting data by the type of transaction that occurred in Ad Exchange.
* Corresponds to "Programmatic channel" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.
*
*
*/
PROGRAMMATIC_CHANNEL_NAME,
/**
*
* Breaks down data by detected yield partner name.
* Corresponds to "Yield partner (classified)" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
CLASSIFIED_YIELD_PARTNER_NAME,
/**
*
* Breaks down Demand reporting data by date in the network time zone. Can be used to
* filter by date using ISO 8601's format 'YYYY-MM-DD'".
* Corresponds to "Date" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_DATE,
/**
*
* Breaks down Demand reporting data by week of the year in the network time zone. Cannot be used
* for filtering.
* Corresponds to "Week" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_WEEK,
/**
*
* Breaks down Demand reporting data by month and year in the network time zone. Cannot be used to
* filter.
* Corresponds to "Month and year" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_MONTH_YEAR,
/**
*
* Breaks down Demand reporting data by country criteria ID. Can be used to filter by
* country criteria ID.
* Compatible with the "Ad Connector" report type.
*
*
*/
DP_COUNTRY_CRITERIA_ID,
/**
*
* Breaks down Demand reporting data by country name. The country name and the
* country criteria ID are automatically included as columns in the report.
* Can be used to filter by country name using the US English name.
* Corresponds to "Country" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_COUNTRY_NAME,
/**
*
* Breaks down Demand reporting data by inventory type.
* Corresponds to "Inventory type" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_INVENTORY_TYPE,
/**
*
* Breaks down Demand reporting data by the creative size the ad was delivered to.
* Corresponds to "Creative size" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_CREATIVE_SIZE,
/**
*
* Breaks down Demand reporting data by the brand name that bids on ads.
* Corresponds to "Brand" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_BRAND_NAME,
/**
*
* Breaks down Demand reporting data by the advertiser name that bid on ads.
* Corresponds to "Advertiser" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_ADVERTISER_NAME,
/**
*
* Breaks down Demand reporting data by Ad Exchange ad network name. Example:
* Google Adwords.
* Corresponds to "Buyer network" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_ADX_BUYER_NETWORK_NAME,
/**
*
* Breaks down reporting data by device name.
* Corresponds to "Device" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_MOBILE_DEVICE_NAME,
/**
*
* Breaks down reporting data by the category of device (smartphone, feature phone, tablet,
* or desktop).
* Corresponds to "Device category" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_DEVICE_CATEGORY_NAME,
/**
*
* Breaks down reporting data by the tag id provided by the publisher in the ad request.
* Corresponds to "Tag ID" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_TAG_ID,
/**
*
* Breaks down reporting data by the deal id provided by the publisher in the ad request.
* Corresponds to "Deal IDs" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_DEAL_ID,
/**
*
* Breaks down reporting data by mobile app ID.
* Corresponds to "App ID" in the Ad Manager UI. Compatible with the "Ad Connector" report type.
*
*
*/
DP_APP_ID,
/**
*
* Breaks down reporting data by the {@link CustomTargetingKey}s marked as dimensions in inventory
* key-values setup. To use this dimension, a list of custom targeting key IDs must be specified
* in {@link ReportQuery#customDimensionKeyIds}.
*
*
*/
CUSTOM_DIMENSION,
/**
*
* Breaks down reporting data by demand channels.
* Compatible with any of the following report types: Historical, Reach, Ad speed.
*
*
*/
DEMAND_CHANNEL_ID,
/**
*
* Breaks down reporting data by demand channel name.
* Corresponds to "Demand channel" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach, Ad speed.
*
*
*/
DEMAND_CHANNEL_NAME,
/**
*
* Breaks down reporting data by top private domain.
* Corresponds to "Domain" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
DOMAIN,
/**
*
* Breaks down reporting data by serving restriction id.
* Compatible with the "Historical" report type.
*
*
*/
SERVING_RESTRICTION_ID,
/**
*
* Breaks down reporting data by serving restriction name.
* Corresponds to "Serving restriction" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
SERVING_RESTRICTION_NAME,
/**
*
* Breaks down reporting data by unified pricing rule id.
* Compatible with the "Historical" report type.
*
*
*/
UNIFIED_PRICING_RULE_ID,
/**
*
* Breaks down reporting data by unified pricing rule name.
* Corresponds to "Unified pricing rule" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
UNIFIED_PRICING_RULE_NAME,
/**
*
* Breaks down reporting data by first price pricing rule id.
* Compatible with the "Historical" report type.
*
*
*/
FIRST_LOOK_PRICING_RULE_ID,
/**
*
* Breaks down reporting data by first price pricing rule name.
* Corresponds to "First look pricing rule" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
FIRST_LOOK_PRICING_RULE_NAME,
/**
*
* Breaks down reporting data by the range within which the bid falls, divided into $0.10 buckets.
* Corresponds to "Bid range" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
BID_RANGE,
/**
*
* Breaks down reporting data by the ID of the reason the bid lost or did not participate in the
* auction.
* Compatible with the "Historical" report type.
*
*
*/
BID_REJECTION_REASON,
/**
*
* Breaks down reporting data by the reason the bid lost or did not participate in the auction.
* Corresponds to "Bid rejection reason" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
BID_REJECTION_REASON_NAME,
/**
*
* Breaks down reporting data by the domain of the ad technology provider (ATP) associated with
* the bid.
* Corresponds to "Ad technology provider domain" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
AD_TECHNOLOGY_PROVIDER_DOMAIN,
/**
*
* Breaks down reporting data by programmatic deal ID.
* Corresponds to "Programmatic deal ID" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
PROGRAMMATIC_DEAL_ID,
/**
*
* Breaks down reporting data by programmatic deal name.
* Corresponds to "Programmatic deal name" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
PROGRAMMATIC_DEAL_NAME,
/**
*
* Breaks down reporting data by the ID of the ad technology provider (ATP) associated with the
* bid.
* Corresponds to "Ad technology provider ID" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
AD_TECHNOLOGY_PROVIDER_ID,
/**
*
* Breaks down reporting data by the ad technology provider (ATP) associated with the bid.
* Corresponds to "Ad technology provider" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
AD_TECHNOLOGY_PROVIDER_NAME,
/**
*
* Breaks down reporting data by the ID of the ad technology provider as it appears on the Global
* Vendor List (GVL).
* Corresponds to "TCF vendor ID" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
TCF_VENDOR_ID,
/**
*
* Breaks down reporting data by the name of the ad technology provider as it appears on the
* Global Vendor List (GVL).
* Corresponds to "TCF vendor" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
TCF_VENDOR_NAME,
/**
*
* Breaks down reporting data by site.
* Corresponds to "Site" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
SITE_NAME,
/**
*
* Breaks down reporting data by channels.
* Corresponds to "Channel" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
CHANNEL_NAME,
/**
*
* Breaks down reporting data by URL ID.
* Compatible with the "Historical" report type.
*
*
*/
URL_ID,
/**
*
* Breaks down reporting data by URL name.
* Corresponds to "URL" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
URL_NAME,
/**
*
* Breaks down reporting data by video ad duration.
* Corresponds to "Video ad duration" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
VIDEO_AD_DURATION,
/**
*
* Breaks down reporting data by video ad type Id.
* Compatible with the "Historical" report type.
*
*
*/
VIDEO_AD_TYPE_ID,
/**
*
* Breaks down reporting data by video ad type.
* Corresponds to "Video ad type" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
VIDEO_AD_TYPE_NAME,
/**
*
* Breaks down reporting data by Ad Exchange product code.
* Compatible with the "Historical" report type.
*
*
*/
AD_EXCHANGE_PRODUCT_CODE,
/**
*
* Breaks down reporting data by Ad Exchange product.
* Corresponds to "Ad Exchange product" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
AD_EXCHANGE_PRODUCT_NAME,
/**
*
* Breaks down reporting data by Dynamic allocation ID.
* Compatible with the "Historical" report type.
*
*
*/
DYNAMIC_ALLOCATION_ID,
/**
*
* Breaks down reporting data by Dynamic allocation.
* Corresponds to "Dynamic allocation" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
DYNAMIC_ALLOCATION_NAME,
/**
*
* Breaks down reporting data by Ad type ID.
* Compatible with the "Historical" report type.
*
*
*/
AD_TYPE_ID,
/**
*
* Breaks down reporting data by Ad type.
* Corresponds to "Ad type" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
AD_TYPE_NAME,
/**
*
* Breaks down reporting data by Ad location ID.
* Compatible with the "Historical" report type.
*
*
*/
AD_LOCATION_ID,
/**
*
* Breaks down reporting data by Ad location.
* Corresponds to "Ad location" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
AD_LOCATION_NAME,
/**
*
* Breaks down reporting data by Targeting type code.
* Compatible with the "Historical" report type.
*
*
*/
TARGETING_TYPE_CODE,
/**
*
* Breaks down reporting data by Targeting type.
* Corresponds to "Targeting type" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
TARGETING_TYPE_NAME,
/**
*
* Breaks down reporting data by Branding type code.
* Compatible with the "Historical" report type.
*
*
*/
BRANDING_TYPE_CODE,
/**
*
* Breaks down reporting data by Branding type.
* Corresponds to "Branding type" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
BRANDING_TYPE_NAME,
/**
*
* Breaks down reporting data by Bandwidth Id.
* Compatible with the "Historical" report type.
*
*
*/
BANDWIDTH_ID,
/**
*
* Breaks down reporting data by Bandwidth name.
* Corresponds to "Bandwidth" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
BANDWIDTH_NAME,
/**
*
* Breaks down reporting data by Carrier Id.
* Compatible with the "Historical" report type.
*
*
*/
CARRIER_ID,
/**
*
* Breaks down reporting data by Carrier name.
* Corresponds to "Carrier" in the Ad Manager UI. Compatible with the "Historical" report type.
*
*
*/
CARRIER_NAME;
public String value() {
return name();
}
public static Dimension fromValue(String v) {
return valueOf(v);
}
}