All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.api.ads.admanager.jaxws.v202405.DimensionAttribute Maven / Gradle / Ivy

The newest version!
// 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 DimensionAttribute. * *

The following schema fragment specifies the expected content contained within this class. *

*

 * <simpleType name="DimensionAttribute">
 *   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
 *     <enumeration value="LINE_ITEM_LABELS"/>
 *     <enumeration value="LINE_ITEM_LABEL_IDS"/>
 *     <enumeration value="LINE_ITEM_OPTIMIZABLE"/>
 *     <enumeration value="LINE_ITEM_DELIVERY_INDICATOR"/>
 *     <enumeration value="LINE_ITEM_DELIVERY_PACING"/>
 *     <enumeration value="LINE_ITEM_FREQUENCY_CAP"/>
 *     <enumeration value="LINE_ITEM_RECONCILIATION_STATUS"/>
 *     <enumeration value="LINE_ITEM_LAST_RECONCILIATION_DATE_TIME"/>
 *     <enumeration value="ADVERTISER_EXTERNAL_ID"/>
 *     <enumeration value="ADVERTISER_TYPE"/>
 *     <enumeration value="ADVERTISER_CREDIT_STATUS"/>
 *     <enumeration value="ADVERTISER_PRIMARY_CONTACT"/>
 *     <enumeration value="ORDER_START_DATE_TIME"/>
 *     <enumeration value="ORDER_END_DATE_TIME"/>
 *     <enumeration value="ORDER_EXTERNAL_ID"/>
 *     <enumeration value="ORDER_PO_NUMBER"/>
 *     <enumeration value="ORDER_IS_PROGRAMMATIC"/>
 *     <enumeration value="ORDER_AGENCY"/>
 *     <enumeration value="ORDER_AGENCY_ID"/>
 *     <enumeration value="ORDER_LABELS"/>
 *     <enumeration value="ORDER_LABEL_IDS"/>
 *     <enumeration value="ORDER_TRAFFICKER"/>
 *     <enumeration value="ORDER_TRAFFICKER_ID"/>
 *     <enumeration value="ORDER_SECONDARY_TRAFFICKERS"/>
 *     <enumeration value="ORDER_SALESPERSON"/>
 *     <enumeration value="ORDER_SECONDARY_SALESPEOPLE"/>
 *     <enumeration value="ORDER_LIFETIME_IMPRESSIONS"/>
 *     <enumeration value="ORDER_LIFETIME_CLICKS"/>
 *     <enumeration value="ORDER_BOOKED_CPM"/>
 *     <enumeration value="ORDER_BOOKED_CPC"/>
 *     <enumeration value="LINE_ITEM_START_DATE_TIME"/>
 *     <enumeration value="LINE_ITEM_END_DATE_TIME"/>
 *     <enumeration value="LINE_ITEM_EXTERNAL_ID"/>
 *     <enumeration value="LINE_ITEM_COST_TYPE"/>
 *     <enumeration value="LINE_ITEM_COST_PER_UNIT"/>
 *     <enumeration value="LINE_ITEM_CURRENCY_CODE"/>
 *     <enumeration value="LINE_ITEM_GOAL_QUANTITY"/>
 *     <enumeration value="LINE_ITEM_AVERAGE_NUMBER_OF_VIEWERS"/>
 *     <enumeration value="LINE_ITEM_SPONSORSHIP_GOAL_PERCENTAGE"/>
 *     <enumeration value="LINE_ITEM_LIFETIME_IMPRESSIONS"/>
 *     <enumeration value="LINE_ITEM_LIFETIME_CLICKS"/>
 *     <enumeration value="LINE_ITEM_PRIORITY"/>
 *     <enumeration value="LINE_ITEM_COMPUTED_STATUS"/>
 *     <enumeration value="CREATIVE_OR_CREATIVE_SET"/>
 *     <enumeration value="MASTER_COMPANION_TYPE"/>
 *     <enumeration value="LINE_ITEM_CONTRACTED_QUANTITY"/>
 *     <enumeration value="LINE_ITEM_DISCOUNT"/>
 *     <enumeration value="LINE_ITEM_NON_CPD_BOOKED_REVENUE"/>
 *     <enumeration value="ADVERTISER_LABELS"/>
 *     <enumeration value="ADVERTISER_LABEL_IDS"/>
 *     <enumeration value="CREATIVE_CLICK_THROUGH_URL"/>
 *     <enumeration value="CREATIVE_SSL_SCAN_RESULT"/>
 *     <enumeration value="CREATIVE_SSL_COMPLIANCE_OVERRIDE"/>
 *     <enumeration value="LINE_ITEM_CREATIVE_START_DATE"/>
 *     <enumeration value="LINE_ITEM_CREATIVE_END_DATE"/>
 *     <enumeration value="CONTENT_CMS_NAME"/>
 *     <enumeration value="CONTENT_CMS_VIDEO_ID"/>
 *     <enumeration value="CHILD_PARTNER_NAME"/>
 *     <enumeration value="AD_UNIT_CODE"/>
 *   </restriction>
 * </simpleType>
 * 
* */ @XmlType(name = "DimensionAttribute") @XmlEnum public enum DimensionAttribute { /** * * Represents {@link LineItem#effectiveAppliedLabels} as a comma separated list of {@link * Label#name} for {@link 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_LABELS, /** * * Represents {@link LineItem#effectiveAppliedLabels} as a comma separated list of {@link * Label#id} for {@link Dimension#LINE_ITEM_NAME}. *

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

* * */ LINE_ITEM_LABEL_IDS, /** * * Generated as {@code true} for {@link Dimension#LINE_ITEM_NAME} which is eligible for * optimization, {@code 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_OPTIMIZABLE, /** * * Indicates the progress made for the delivery of the {@link Dimension#LINE_ITEM_NAME}. * * * * * * * * * * * * * * * * * * * * * *
Progress Definition
100%The {@link LineItem} is on track to deliver in full as per * {@link LineItem#unitsBought}.
> 100%The {@link LineItem} is on track to overdeliver.
< 100%The {@link LineItem} is on track to underdeliver.
N/AThe {@link LineItem} does not have any quantity goals, or there is * insufficient information about the {@link 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_INDICATOR, /** * * Represents {@link LineItem#deliveryRateType} for {@link 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_DELIVERY_PACING, /** * * Represents {@link LineItem#frequencyCaps} as a comma separated list of "{@link * FrequencyCap#maxImpressions} impressions per/every {@link FrequencyCap#numTimeUnits} {@link * FrequencyCap#timeUnit}" (e.g. "10 impressions every day,500 impressions per lifetime") for * {@link 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_FREQUENCY_CAP, /** * * Represents the monthly reconciliation status of the line item for {@link * Dimension#LINE_ITEM_NAME} and {@link 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_RECONCILIATION_STATUS, /** * * Represents the monthly last reconciliation date time of the line item for {@link * Dimension#LINE_ITEM_NAME} and {@link 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.

* * */ LINE_ITEM_LAST_RECONCILIATION_DATE_TIME, /** * * Represents {@link Company#externalId} for {@link Dimension#ADVERTISER_NAME}. *

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

* * */ ADVERTISER_EXTERNAL_ID, /** * * Represents {@link Company#type} for {@link 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_TYPE, /** * * Represents {@link Company#creditStatus} for {@link 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_CREDIT_STATUS, /** * * Represents name and email address in the form of name(email) of primary contact for {@link * Dimension#ADVERTISER_NAME}. *

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

* * */ ADVERTISER_PRIMARY_CONTACT, /** * * Represents the start date (in YYYY-MM-DD format) for {@link 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_START_DATE_TIME, /** * * Represents the end date (in YYYY-MM-DD format) for {@link 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_END_DATE_TIME, /** * * Represents {@link Order#externalOrderId} for {@link Dimension#ORDER_NAME}. *

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

* * */ ORDER_EXTERNAL_ID, /** * * Represents {@link Order#poNumber} for {@link 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_PO_NUMBER, /** * * Represents {@link Order#orderIsProgrammatic} for {@link 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_IS_PROGRAMMATIC, /** * * Represents the name of {@link Order#agencyId} for {@link Dimension#ORDER_NAME}. *

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

* * */ ORDER_AGENCY, /** * * Represents {@link Order#agencyId} for {@link 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_AGENCY_ID, /** * * Represents {@link Order#effectiveAppliedLabels} as a comma separated list of {@link Label#name} * for {@link Dimension#ORDER_NAME}. *

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

* * */ ORDER_LABELS, /** * * Represents {@link Order#effectiveAppliedLabels} as a comma separated list of {@link Label#id} * for {@link Dimension#ORDER_NAME}. *

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

* * */ ORDER_LABEL_IDS, /** * * The name and email address in the form of name(email) of the trafficker for {@link * Dimension#ORDER_NAME} *

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

* * */ ORDER_TRAFFICKER, /** * * Represents {@link Order#traffickerId} for {@link Dimension#ORDER_NAME}. Can be used for * filtering. *

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

* * */ ORDER_TRAFFICKER_ID, /** * * The names and email addresses as a comma separated list of name(email) of the {@link * Order#secondaryTraffickerIds} for {@link Dimension#ORDER_NAME}. *

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

* * */ ORDER_SECONDARY_TRAFFICKERS, /** * * The name and email address in the form of name(email) of the {@link Order#salespersonId} for * {@link Dimension#ORDER_NAME}. *

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

* * */ ORDER_SALESPERSON, /** * * The names and email addresses as a comma separated list of name(email) of the {@link * Order#secondarySalespersonIds} for {@link Dimension#ORDER_NAME}. *

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

* * */ ORDER_SECONDARY_SALESPEOPLE, /** * * The total number of impressions delivered over the lifetime of an {@link 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_IMPRESSIONS, /** * * The total number of clicks delivered over the lifetime of an {@link 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_LIFETIME_CLICKS, /** * * The cost of booking all the CPM ads for {@link Dimension#ORDER_NAME}. *

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

* * */ ORDER_BOOKED_CPM, /** * * The cost of booking all the CPC ads for {@link Dimension#ORDER_NAME}. *

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

* * */ ORDER_BOOKED_CPC, /** * * Represents the start date (in YYYY-MM-DD format) for {@link 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_START_DATE_TIME, /** * * Represents the end date (in YYYY-MM-DD format) for {@link 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_END_DATE_TIME, /** * * Represents {@link LineItem#externalId} for {@link 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_EXTERNAL_ID, /** * * Represents {@link LineItem#costType} for {@link 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_TYPE, /** * * Represents {@link LineItem#costPerUnit} for {@link 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_COST_PER_UNIT, /** * * Represents the 3 letter currency code for {@link 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_CURRENCY_CODE, /** * * The total number of impressions, clicks or days that is reserved for {@link * 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_GOAL_QUANTITY, /** * *

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

* * */ LINE_ITEM_AVERAGE_NUMBER_OF_VIEWERS, /** * * The ratio between the goal quantity for {@link Dimension#LINE_ITEM_NAME} of {@link * LineItemType#SPONSORSHIP} and the {@link #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_SPONSORSHIP_GOAL_PERCENTAGE, /** * * The total number of impressions delivered over the lifetime of a {@link * 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_IMPRESSIONS, /** * * The total number of clicks delivered over the lifetime of a {@link 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_LIFETIME_CLICKS, /** * * Represents {@link LineItem#priority} for {@link 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_PRIORITY, /** * * Describes the computed {@link 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.

* * */ LINE_ITEM_COMPUTED_STATUS, /** * * Indicates if a creative is a regular creative or creative set. Values will be 'Creative' or * 'Creative set' *

Compatible with the "Historical" report type.

* * */ CREATIVE_OR_CREATIVE_SET, /** * * 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.

* * */ MASTER_COMPANION_TYPE, /** * * Represents the {@link LineItem#contractedUnitsBought} quantity for {@link * 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_CONTRACTED_QUANTITY, /** * * Represents the {@link LineItem#discount} for {@link Dimension#LINE_ITEM_NAME}. The number is * either a percentage or an absolute value depending on {@link LineItem#discountType}. *

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

* * */ LINE_ITEM_DISCOUNT, /** * * The cost of booking for a non-CPD {@link 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.

* * */ LINE_ITEM_NON_CPD_BOOKED_REVENUE, /** * * Represents {@link Company#appliedLabels} as a comma separated list of {@link Label#name} for * {@link Dimension#ADVERTISER_NAME}. *

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

* * */ ADVERTISER_LABELS, /** * * Represents {@link Company#appliedLabels} as a comma separated list of {@link Label#id} for * {@link Dimension#ADVERTISER_NAME}. *

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

* * */ ADVERTISER_LABEL_IDS, /** * * Represents the click-through URL for {@link Dimension#CREATIVE_NAME}. *

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

* * */ CREATIVE_CLICK_THROUGH_URL, /** * * 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_SCAN_RESULT, /** * * 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.

* * */ CREATIVE_SSL_COMPLIANCE_OVERRIDE, /** * * Represents a {@link LineItemCreativeAssociation#startDateTime} for a {@link * Dimension#LINE_ITEM_NAME} and a {@link 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_START_DATE, /** * * Represents a {@link LineItemCreativeAssociation#endDateTime} for a {@link * Dimension#LINE_ITEM_NAME} and a {@link 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.

* * */ LINE_ITEM_CREATIVE_END_DATE, /** * * Represents the {@link CmsContent#displayName} within the first element of {@link * Content#cmsContent} for {@link 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_NAME, /** * * Represents the {@link CmsContent#cmsContentId} within the first element of {@link * Content#cmsContent} for {@link 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.

* * */ CONTENT_CMS_VIDEO_ID, /** * * Breaks down reporting data by child partner name in MCM "Manage Inventory". By default, this * attribute is ordered by {@link 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.

* * */ CHILD_PARTNER_NAME, /** * * Represents {@link AdUnit#adUnitCode} for {@link 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.

* * */ AD_UNIT_CODE; public String value() { return name(); } public static DimensionAttribute fromValue(String v) { return valueOf(v); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy