enum DimensionAttribute (v202511)

DimensionAttribute provides additional fields associated with a Dimension . It can only be selected with its corresponding Dimension . For example, DimensionAttribute.ORDER_PO_NUMBER can only be used if the ReportQuery.dimensions contains Dimension.ORDER_NAME .


Namespace
https://www.google.com/apis/ads/publisher/v202511

Enumeration
Description
LINE_ITEM_LABELS
Represents LineItem.effectiveAppliedLabels as a comma separated list of Label.name for Dimension.LINE_ITEM_NAME .

Corresponds to "Line item labels" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

LINE_ITEM_LABEL_IDS
Represents LineItem.effectiveAppliedLabels as a comma separated list of Label.id for Dimension.LINE_ITEM_NAME .

Compatible with any of the following report types: Historical, Reach.

LINE_ITEM_OPTIMIZABLE
Generated as true for Dimension.LINE_ITEM_NAME which is eligible for optimization, false otherwise. Can be used for filtering.

Corresponds to "Optimizable" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

LINE_ITEM_DELIVERY_INDICATOR
Indicates the progress made for the delivery of the Dimension.LINE_ITEM_NAME .
Progress Definition
100% The LineItem is on track to deliver in full as per LineItem.unitsBought .
> 100% The LineItem is on track to overdeliver.
< 100% The LineItem is on track to underdeliver.
N/A The LineItem does not have any quantity goals, or there is insufficient information about the LineItem .

Corresponds to "Delivery Indicator" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach, Real-time video.

LINE_ITEM_DELIVERY_PACING
Represents LineItem.deliveryRateType for Dimension.LINE_ITEM_NAME .

Corresponds to "Delivery pacing" 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_FREQUENCY_CAP
Represents LineItem.frequencyCaps as a comma separated list of " FrequencyCap.maxImpressions impressions per/every FrequencyCap.numTimeUnits FrequencyCap.timeUnit " (e.g. "10 impressions every day,500 impressions per lifetime") for Dimension.LINE_ITEM_NAME .

Corresponds to "Frequency cap" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

LINE_ITEM_RECONCILIATION_STATUS
Represents the monthly reconciliation status of the line item for Dimension.LINE_ITEM_NAME and Dimension.MONTH_YEAR .

Corresponds to "Line item reconciliation status" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach.

LINE_ITEM_LAST_RECONCILIATION_DATE_TIME
Represents the monthly last reconciliation date time of the line item for Dimension.LINE_ITEM_NAME and Dimension.MONTH_YEAR .

Corresponds to "Line item last reconciliation time" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach.

ADVERTISER_EXTERNAL_ID
Represents Company.externalId for Dimension.ADVERTISER_NAME .

Corresponds to "External advertiser ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ADVERTISER_TYPE
Represents Company.type for Dimension.ADVERTISER_NAME . Can be used for filtering.

Corresponds to "Advertiser type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.

ADVERTISER_CREDIT_STATUS
Represents Company.creditStatus for Dimension.ADVERTISER_NAME . Can be used for filtering.

Corresponds to "Advertiser credit status" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.

ADVERTISER_PRIMARY_CONTACT
Represents name and email address in the form of name(email) of primary contact for Dimension.ADVERTISER_NAME .

Corresponds to "Advertiser primary contact" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ORDER_START_DATE_TIME
Represents the start date (in YYYY-MM-DD format) for Dimension.ORDER_NAME . Can be used for filtering.

Corresponds to "Order start date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.

ORDER_END_DATE_TIME
Represents the end date (in YYYY-MM-DD format) for Dimension.ORDER_NAME . Can be used for filtering.

Corresponds to "Order end date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.

ORDER_EXTERNAL_ID
Represents Order.externalOrderId for Dimension.ORDER_NAME .

Corresponds to "External order ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ORDER_PO_NUMBER
Represents Order.poNumber for Dimension.ORDER_NAME . Can be used for filtering.

Corresponds to "Order PO number" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.

ORDER_IS_PROGRAMMATIC
Represents Order.orderIsProgrammatic for Dimension.ORDER_NAME . Can be used for filtering.

Corresponds to "Programmatic order" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ORDER_AGENCY
Represents the name of Order.agencyId for Dimension.ORDER_NAME .

Corresponds to "Agency" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ORDER_AGENCY_ID
Represents Order.agencyId for Dimension.ORDER_NAME . Can be used for filtering.

Corresponds to "Agency ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ORDER_LABELS
Represents Order.effectiveAppliedLabels as a comma separated list of Label.name for Dimension.ORDER_NAME .

Corresponds to "Order labels" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ORDER_LABEL_IDS
Represents Order.effectiveAppliedLabels as a comma separated list of Label.id for Dimension.ORDER_NAME .

Compatible with any of the following report types: Historical, Reach.

ORDER_TRAFFICKER
The name and email address in the form of name(email) of the trafficker for Dimension.ORDER_NAME

Corresponds to "Trafficker" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ORDER_TRAFFICKER_ID
Represents Order.traffickerId for Dimension.ORDER_NAME . Can be used for filtering.

Compatible with any of the following report types: Historical, Reach.

ORDER_SECONDARY_TRAFFICKERS
The names and email addresses as a comma separated list of name(email) of the Order.secondaryTraffickerIds for Dimension.ORDER_NAME .

Corresponds to "Secondary traffickers" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ORDER_SALESPERSON
The name and email address in the form of name(email) of the Order.salespersonId for Dimension.ORDER_NAME .

Corresponds to "Salesperson" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ORDER_SECONDARY_SALESPEOPLE
The names and email addresses as a comma separated list of name(email) of the Order.secondarySalespersonIds for Dimension.ORDER_NAME .

Corresponds to "Secondary salespeople" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ORDER_LIFETIME_IMPRESSIONS
The total number of impressions delivered over the lifetime of an Dimension.ORDER_NAME .

Corresponds to "Order lifetime impressions" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.

ORDER_LIFETIME_CLICKS
The total number of clicks delivered over the lifetime of an Dimension.ORDER_NAME .

Corresponds to "Order lifetime clicks" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.

ORDER_BOOKED_CPM
The cost of booking all the CPM ads for Dimension.ORDER_NAME .

Corresponds to "Booked CPM" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ORDER_BOOKED_CPC
The cost of booking all the CPC ads for Dimension.ORDER_NAME .

Corresponds to "Booked CPC" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

LINE_ITEM_START_DATE_TIME
Represents the start date (in YYYY-MM-DD format) for Dimension.LINE_ITEM_NAME . Can be used for filtering.

Corresponds to "Line item start date" 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_END_DATE_TIME
Represents the end date (in YYYY-MM-DD format) for Dimension.LINE_ITEM_NAME . Can be used for filtering.

Corresponds to "Line item end date" 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_EXTERNAL_ID
Represents LineItem.externalId for Dimension.LINE_ITEM_NAME . Can be used for filtering.

Corresponds to "External Line Item ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

LINE_ITEM_COST_TYPE
Represents LineItem.costType for Dimension.LINE_ITEM_NAME . Can be used for filtering.

Corresponds to "Cost 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_COST_PER_UNIT
Represents LineItem.costPerUnit for Dimension.LINE_ITEM_NAME .

Corresponds to "Rate" 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_CURRENCY_CODE
Represents the 3 letter currency code for Dimension.LINE_ITEM_NAME .

Corresponds to "Currency code" 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_GOAL_QUANTITY
The total number of impressions, clicks or days that is reserved for Dimension.LINE_ITEM_NAME .

Corresponds to "Goal quantity" 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_AVERAGE_NUMBER_OF_VIEWERS

Corresponds to "Nielsen Average Number Of Viewers" in the Ad Manager UI. Compatible with the "Reach" report type.

LINE_ITEM_SPONSORSHIP_GOAL_PERCENTAGE
The ratio between the goal quantity for Dimension.LINE_ITEM_NAME of LineItemType.SPONSORSHIP and the LINE_ITEM_GOAL_QUANTITY . Represented as a number between 0..100.

Corresponds to "Sponsorship goal (%)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

LINE_ITEM_LIFETIME_IMPRESSIONS
The total number of impressions delivered over the lifetime of a Dimension.LINE_ITEM_NAME .

Corresponds to "Line item lifetime impressions" 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_LIFETIME_CLICKS
The total number of clicks delivered over the lifetime of a Dimension.LINE_ITEM_NAME .

Corresponds to "Line item lifetime clicks" 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_PRIORITY
Represents LineItem.priority for Dimension.LINE_ITEM_NAME as a value between 1 and 16. Can be used for filtering.

Corresponds to "Line item priority" 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_COMPUTED_STATUS
Describes the computed LineItem status that is derived from the current state of the line item.

Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.

CREATIVE_OR_CREATIVE_SET
Indicates if a creative is a regular creative or creative set. Values will be 'Creative' or 'Creative set'

Compatible with the "Historical" report type.

MASTER_COMPANION_TYPE
The type of creative in a creative set - master or companion.

Corresponds to "Master or Companion" in the Ad Manager UI. Compatible with the "Historical" report type.

LINE_ITEM_CONTRACTED_QUANTITY
Represents the LineItem.contractedUnitsBought quantity for Dimension.LINE_ITEM_NAME .

Corresponds to "Contracted quantity" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

LINE_ITEM_DISCOUNT
Represents the LineItem.discount for Dimension.LINE_ITEM_NAME . The number is either a percentage or an absolute value depending on LineItem.discountType .

Corresponds to "Discount" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

LINE_ITEM_NON_CPD_BOOKED_REVENUE
The cost of booking for a non-CPD Dimension.LINE_ITEM_NAME .

Corresponds to "Booked revenue (exclude CPD)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ADVERTISER_LABELS
Represents Company.appliedLabels as a comma separated list of Label.name for Dimension.ADVERTISER_NAME .

Corresponds to "Advertiser labels" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.

ADVERTISER_LABEL_IDS
Represents Company.appliedLabels as a comma separated list of Label.id for Dimension.ADVERTISER_NAME .

Compatible with any of the following report types: Historical, Reach.

CREATIVE_CLICK_THROUGH_URL
Represents the click-through URL for Dimension.CREATIVE_NAME .

Corresponds to "Click-through URL" in the Ad Manager UI. Compatible with the "Historical" report type.

CREATIVE_SSL_SCAN_RESULT
Represents whether a creative is SSL-compliant.

Corresponds to "Creative SSL scan result" in the Ad Manager UI. Compatible with the "Historical" report type.

CREATIVE_SSL_COMPLIANCE_OVERRIDE
Represents whether a creative's SSL status was overridden.

Corresponds to "Creative SSL compliance override" in the Ad Manager UI. Compatible with the "Historical" report type.

LINE_ITEM_CREATIVE_START_DATE
Represents a LineItemCreativeAssociation.startDateTime for a Dimension.LINE_ITEM_NAME and a Dimension.CREATIVE_NAME . Includes the date without the time.

Corresponds to "Creative start date" in the Ad Manager UI. Compatible with the "Historical" report type.

LINE_ITEM_CREATIVE_END_DATE
Represents a LineItemCreativeAssociation.endDateTime for a Dimension.LINE_ITEM_NAME and a Dimension.CREATIVE_NAME . Includes the date without the time.

Corresponds to "Creative end date" in the Ad Manager UI. Compatible with the "Historical" report type.

CONTENT_CMS_NAME
Represents the CmsContent.displayName within the first element of Content.cmsContent for Dimension.CONTENT_NAME .

Corresponds to "Content source name" in the Ad Manager UI. Compatible with any of the following report types: Historical, YouTube consolidated.

CONTENT_CMS_VIDEO_ID
Represents the CmsContent.cmsContentId within the first element of Content.cmsContent for Dimension.CONTENT_NAME .

Corresponds to "ID of the video in the content source" in the Ad Manager UI. Compatible with any of the following report types: Historical, YouTube consolidated.

CHILD_PARTNER_NAME
Breaks down reporting data by child partner name in MCM "Manage Inventory". By default, this attribute is ordered by Dimension.CHILD_NETWORK_CODE .

This dimension only works for MCM "Manage Inventory" parent publishers.

Corresponds to "Child partner name" in the Ad Manager UI. Compatible with the "Historical" report type.

AD_UNIT_CODE
Represents AdUnit.adUnitCode for Dimension.AD_UNIT_NAME .

Corresponds to "Ad unit code" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Ad speed, Real-time video.

Design a Mobile Site
View Site in Mobile | Classic
Share by: