Web Service: ForecastService
Port ForecastServiceInterfacePort Port typeSource code
- getAvailabilityForecastDetailSource code
- getAvailabilityForecastByIdDetailSource code
- getDeliveryForecastDetailSource code
- getDeliveryForecastByIdsDetailSource code
- getTrafficDataDetailSource code
Operations
- getAvailabilityForecastDescription:Gets the availability forecast for a {@link ProspectiveLineItem}. An availability forecast reports the maximum number of available units that the line item can book, and the total number of units matching the line item's targeting.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getAvailabilityForecastRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getAvailabilityForecastGets the availability forecast for a {@link ProspectiveLineItem}. An availability forecast reports the maximum number of available units that the line item can book, and the total number of units matching the line item's targeting.
- lineItem - optional; type ProspectiveLineItemRepresents a prospective line item to be forecasted.
- lineItem - optional; type LineItem - extension of type LineItemSummary{@link LineItem} is an advertiser's commitment to purchase a specific number of ad impressions, clicks, or time.The {@code LineItemSummary} represents the base class from which a {@code LineItem} is derived.
- orderId - optional; type longThe ID of the {@link Order} to which the {@code LineItem} belongs. This attribute is required.
- id - optional; type longUniquely identifies the {@code LineItem}. This attribute is read-only and is assigned by Google when a line item is created.
- name - optional; type stringThe name of the line item. This attribute is required and has a maximum length of 255 characters.
- externalId - optional; type stringAn identifier for the {@code LineItem} that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
- orderName - optional; type stringThe name of the {@link Order}. This value is read-only.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time on which the {@code LineItem} is enabled to begin serving. This attribute is required and must be in the future. - date - optional; type Date
- startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }Specifies whether to start serving to the {@code LineItem} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time on which the {@code LineItem} will stop serving. This attribute is required unless {@link LineItem#unlimitedEndDateTime} is set to {@code true}. If specified, it must be after the {@link LineItem#startDateTime}. This end date and time does not include auto extension days. - date - optional; type Date
- autoExtensionDays - optional; type intThe number of days to allow a line item to deliver past its {@link #endDateTime}. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.
- unlimitedEndDateTime - optional; type booleanSpecifies whether or not the {@code LineItem} has an end time. This attribute is optional and defaults to false. It can be be set to {@code true} for only line items of type {@link LineItemType#SPONSORSHIP}, {@link LineItemType#NETWORK}, {@link LineItemType#PRICE_PRIORITY} and {@link LineItemType#HOUSE}.
- creativeRotationType - optional; type CreativeRotationType - type string with restriction - enum { 'EVEN', 'OPTIMIZED', 'MANUAL', 'SEQUENTIAL' }The strategy used for displaying multiple {@link Creative} objects that are associated with the {@code LineItem}. This attribute is required.
- deliveryRateType - optional; type DeliveryRateType - type string with restriction - enum { 'EVENLY', 'FRONTLOADED', 'AS_FAST_AS_POSSIBLE' }The strategy for delivering ads over the course of the line item's duration. This attribute is optional and defaults to {@link DeliveryRateType#EVENLY} or {@link DeliveryRateType#FRONTLOADED} depending on the network's configuration.
- deliveryForecastSource - optional; type DeliveryForecastSource - type string with restriction - enum { 'HISTORICAL', 'FORECASTING', 'CUSTOM_PACING_CURVE', 'UNKNOWN' }Strategy for choosing forecasted traffic shapes to pace line items. This field is optional and defaults to {@link DeliveryForecastSource#HISTORICAL}.
- customPacingCurve - optional; type CustomPacingCurveA curve consisting of {@link CustomPacingGoal} objects that is used to pace line item delivery.
- customPacingGoalUnit - optional; type CustomPacingGoalUnit - type string with restriction - enum { 'ABSOLUTE', 'MILLI_PERCENT', 'UNKNOWN' }The unit of the {@link CustomPacingGoalDto#amount} values.
- customPacingGoals - optional, unbounded; type CustomPacingGoalThe list of goals that make up the custom pacing curve.An interval of a {@link CustomPacingCurve}. A custom pacing goal contains a start time and an amount. The goal will apply until either the next custom pacing goal's {@code getStartTime} or the line item's end time if it is the last goal.
- startDateTime - optional; type DateTimeThe start date and time of the goal. This field is required unless {@code useLineItemStartDateTime} is true.Represents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
- date - optional; type Date
- useLineItemStartDateTime - optional; type booleanWhether the {@link LineItem#startDateTime} should be used for the start date and time of this goal. This field is not persisted and if it is set to true, the {@code startDateTime} field will be populated by the line item's start time.
- amount - optional; type long
- startDateTime - optional; type DateTime
The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is {@link DeliveryForecastSource#CUSTOM_PACING_CURVE}. - customPacingGoalUnit - optional; type CustomPacingGoalUnit - type string with restriction - enum { 'ABSOLUTE', 'MILLI_PERCENT', 'UNKNOWN' }
- roadblockingType - optional; type RoadblockingType - type string with restriction - enum { 'ONLY_ONE', 'ONE_OR_MORE', 'AS_MANY_AS_POSSIBLE', 'ALL_ROADBLOCK', 'CREATIVE_SET' }The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional and defaults to {@link RoadblockingType#ONE_OR_MORE}.
- skippableAdType - optional; type SkippableAdType - type string with restriction - enum { 'UNKNOWN', 'DISABLED', 'ENABLED', 'INSTREAM_SELECT', 'ANY' }The nature of the line item's creatives' skippability. This attribute is optional, only applicable for video line items, and defaults to {@link SkippableAdType#NOT_SKIPPABLE}.
- frequencyCaps - optional, unbounded; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The set of frequency capping units for this {@code LineItem}. This attribute is optional. - maxImpressions - optional; type int
- lineItemType - optional; type LineItemType - type string with restriction - enum { 'SPONSORSHIP', 'STANDARD', 'NETWORK', 'BULK', 'PRICE_PRIORITY', 'HOUSE', 'LEGACY_DFP', 'CLICK_TRACKING', 'ADSENSE', 'AD_EXCHANGE', 'BUMPER', 'ADMOB', 'PREFERRED_DEAL', 'UNKNOWN' }Indicates the line item type of a {@code LineItem}. This attribute is required.
The line item type determines the default priority of the line item. More information can be found on the Ad Manager Help Center.
- priority - optional; type intThe priority for the line item. Valid values range from 1 to 16. This field is optional and defaults to the default priority of the {@link LineItemType}.
The following table shows the default, minimum, and maximum priority values are for each line item type:
LineItemType - default priority (minimum priority, maximum priority) {@link LineItemType#SPONSORSHIP} 4 (2, 5) {@link LineItemType#STANDARD} 8 (6, 10) {@link LineItemType#NETWORK} 12 (11, 14) {@link LineItemType#BULK} 12 (11, 14) {@link LineItemType#PRICE_PRIORITY} 12 (11, 14) {@link LineItemType#HOUSE} 16 (15, 16) {@link LineItemType#CLICK_TRACKING} 16 (1, 16) {@link LineItemType#AD_EXCHANGE} 12 (1, 16) {@link LineItemType#ADSENSE} 12 (1, 16) {@link LineItemType#BUMPER} 16 (15, 16) This field can only be edited by certain networks, otherwise a {@link PermissionError} will occur.
- costPerUnit - optional; type MoneyThe amount of money to spend per impression or click. This attribute is required for creating a {@code LineItem}.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- valueCostPerUnit - optional; type MoneyAn amount to help the adserver rank inventory. {@link LineItem#valueCostPerUnit} artificially raises the value of inventory over the {@link LineItem#costPerUnit} but avoids raising the actual {@link LineItem#costPerUnit}. This attribute is optional and defaults to a {@link Money} object in the local currency with {@link Money#microAmount} 0.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- costType - optional; type CostType - type string with restriction - enum { 'CPA', 'CPC', 'CPD', 'CPM', 'VCPM', 'CPM_IN_TARGET', 'UNKNOWN' }The method used for billing this {@code LineItem}. This attribute is required.
- discountType - optional; type LineItemDiscountType - type string with restriction - enum { 'ABSOLUTE_VALUE', 'PERCENTAGE' }The type of discount being applied to a {@code LineItem}, either percentage based or absolute. This attribute is optional and defaults to {@link LineItemDiscountType#PERCENTAGE}.
- discount - optional; type doubleThe number here is either a percentage or an absolute value depending on the {@code LineItemDiscountType}. If the {@code LineItemDiscountType} is {@link LineItemDiscountType#PERCENTAGE}, then only non-fractional values are supported.
- contractedUnitsBought - optional; type longThis attribute is only applicable for certain {@link #lineItemType line item types} and acts as an "FYI" or note, which does not impact adserving or other backend systems.
For {@link LineItemType#SPONSORSHIP} line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only.
For {@link LineItemType#STANDARD} line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this {@code LineItem}. This field is just a "FYI" for traffickers to manually intervene with the {@code LineItem} when needed. This attribute is only available for {@link LineItemType#STANDARD} line items if you have this feature enabled on your network.
- creativePlaceholders - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholder... is recursiveThe companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
Details about the creatives that are expected to serve through this {@code LineItem}. This attribute is required and replaces the {@code creativeSizes} attribute. - size - optional; type Size
- activityAssociations - optional, unbounded; type LineItemActivityAssociationA {@code LineItemActivityAssociation} associates a {@link LineItem} with an {@link Activity} so that the conversions of the {@link Activity} can be counted against the {@link LineItem}.
- activityId - optional; type intThe ID of the {@link Activity} to which the {@link LineItem} should be associated. This attribute is required.
- clickThroughConversionCost - optional; type MoneyThe amount of money to attribute per click through conversion. This attribute is required for creating a {@code LineItemActivityAssociation}. The currency code is readonly and should match the {@link LineItem}.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- viewThroughConversionCost - optional; type MoneyThe amount of money to attribute per view through conversion. This attribute is required for creating a {@code LineItemActivityAssociation}. The currency code is readonly and should match the {@link LineItem}.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
This attribute is required and meaningful only if the {@link LineItem#costType} is {@link CostType.CPA}. - activityId - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment that the {@code LineItem} is targeting. The default value is {@link EnvironmentType#BROWSER}. If this value is {@link EnvironmentType#VIDEO_PLAYER}, then this line item can only target {@code AdUnits} that have {@code AdUnitSizes} whose {@code environmentType} is also {@code VIDEO_PLAYER}.
- allowedFormats - optional, unbounded; type AllowedFormats - type string with restriction - enum { 'AUDIO', 'UNKNOWN' }The set of {@link allowedFormats} that this programmatic line item can have. If the set is empty, this line item allows all formats.
- companionDeliveryOption - optional; type CompanionDeliveryOption - type string with restriction - enum { 'OPTIONAL', 'AT_LEAST_ONE', 'ALL', 'UNKNOWN' }The delivery option for companions. Setting this field is only meaningful if the following conditions are met:
- The Guaranteed roadblocks feature is enabled on your network.
- One of the following is true (both cannot be true, these are mutually exclusive).
- The {@link #environmentType} is {@link EnvironmentType#VIDEO_PLAYER}.
- The {@link #roadblockingType} is {@link RoadblockingType#CREATIVE_SET}.
This field is optional and defaults to {@link CompanionDeliveryOption#OPTIONAL} if the above conditions are met. In all other cases it defaults to {@link CompanionDeliveryOption#UNKNOWN} and is not meaningful.
- allowOverbook - optional; type booleanThe flag indicates whether overbooking should be allowed when creating or updating reservations of line item types {@link LineItemType#SPONSORSHIP} and {@link LineItemType#STANDARD}. When true, operations on this line item will never trigger a {@link ForecastError}, which corresponds to an overbook warning in the UI. The default value is false.
Note: this field will not persist on the line item itself, and the value will only affect the current request.
- skipInventoryCheck - optional; type booleanThe flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false.
Note: this field will not persist on the line item itself, and the value will only affect the current request.
- skipCrossSellingRuleWarningChecks - optional; type booleanTrue to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false.
- reserveAtCreation - optional; type booleanThe flag indicates whether inventory should be reserved when creating a line item of types {@link LineItemType#SPONSORSHIP} and {@link LineItemType#STANDARD} in an unapproved {@link Order}. The default value is false.
- stats - optional; type StatsContains trafficking statistics for the line item. This attribute is readonly and is populated by Google. This will be {@code null} in case there are no statistics for a line item yet.{@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
- impressionsDelivered - optional; type longThe number of impressions delivered.
- clicksDelivered - optional; type longThe number of clicks delivered.
- videoCompletionsDelivered - optional; type longThe number of video completions delivered.
- videoStartsDelivered - optional; type longThe number of video starts delivered.
- viewableImpressionsDelivered - optional; type longThe number of viewable impressions delivered.
- impressionsDelivered - optional; type long
- deliveryIndicator - optional; type DeliveryIndicatorIndicates the delivery performance of the {@link LineItem}.
- expectedDeliveryPercentage - optional; type doubleHow much the {@code LineItem} was expected to deliver as a percentage of {@link LineItem#primaryGoal}.
- actualDeliveryPercentage - optional; type doubleHow much the line item actually delivered as a percentage of {@link LineItem#primaryGoal}.
Indicates how well the line item has been performing. This attribute is readonly and is populated by Google. This will be {@code null} if the delivery indicator information is not available due to one of the following reasons:- The line item is not delivering.
- The line item has an unlimited goal or cap.
- The line item has a percentage based goal or cap.
- expectedDeliveryPercentage - optional; type double
- deliveryData - optional; type DeliveryDataHolds the number of clicks or impressions, determined by {@link LineItem#costType}, delivered for a single line item for the last 7 days
- units - optional, unbounded; type longClicks or impressions delivered for the last 7 days.
Delivery data provides the number of clicks or impressions delivered for a {@link LineItem} in the last 7 days. This attribute is readonly and is populated by Google. This will be {@code null} if the delivery data cannot be computed due to one of the following reasons:- The line item is not deliverable.
- The line item has completed delivering more than 7 days ago.
- The line item has an absolute-based goal. {@link LineItem#deliveryIndicator} should be used to track its progress in this case.
- units - optional, unbounded; type long
- budget - optional; type MoneyThe amount of money allocated to the {@code LineItem}. This attribute is readonly and is populated by Google. The currency code is readonly.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- status - optional; type ComputedStatus - type string with restriction - enum { 'DELIVERY_EXTENDED', 'DELIVERING', 'READY', 'PAUSED', 'INACTIVE', 'PAUSED_INVENTORY_RELEASED', 'PENDING_APPROVAL', 'COMPLETED', 'DISAPPROVED', 'DRAFT', 'CANCELED' }The status of the {@code LineItem}. This attribute is readonly.
- reservationStatus - optional; type LineItemSummary.ReservationStatus - type string with restriction - enum { 'RESERVED', 'UNRESERVED' }Describes whether or not inventory has been reserved for the {@code LineItem}. This attribute is readonly and is assigned by Google.
- isArchived - optional; type booleanThe archival status of the {@code LineItem}. This attribute is readonly.
- webPropertyCode - optional; type stringThe web property code used for dynamic allocation line items. This web property is only required with line item types {@link LineItemType#AD_EXCHANGE} and {@link LineItemType#ADSENSE}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of labels applied directly to this line item. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google. - labelId - optional; type long
- disableSameAdvertiserCompetitiveExclusion - optional; type booleanIf a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to {@code true} will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.
- lastModifiedByApp - optional; type stringThe application that last modified this line item. This attribute is read only and is assigned by Google.
- notes - optional; type stringProvides any additional notes that may annotate the {@code LineItem}. This attribute is optional and has a maximum length of 65,535 characters.
- competitiveConstraintScope - optional; type CompetitiveConstraintScope - type string with restriction - enum { 'POD', 'STREAM', 'UNKNOWN' }The {@code CompetitiveConstraintScope} for the competitive exclusion labels assigned to this line item. This field is optional, defaults to {@link CompetitiveConstraintScope#POD}, and only applies to video line items.
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this line item was last modified. - date - optional; type Date
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
This attribute may be {@code null} for line items created before this feature was introduced. - date - optional; type Date
- customFieldValues - optional, unbounded; type BaseCustomFieldValueThe value of a {@link CustomField} for a particular entity.
- customFieldId - optional; type longId of the {@code CustomField} to which this value belongs. This attribute is required.
The values of the custom fields associated with this line item. - customFieldId - optional; type long
- isMissingCreatives - optional; type booleanIndicates if a {@code LineItem} is missing any {@link Creative creatives} for the {@code creativePlaceholders} specified.
{@link Creative Creatives} can be considered missing for several reasons including:
- Not enough {@link Creative creatives} of a certain size have been uploaded, as determined by {@link CreativePlaceholder#expectedCreativeCount}. For example a {@code LineItem} specifies 750x350, 400x200 but only a 750x350 was uploaded. Or {@code LineItem} specifies 750x350 with an expected count of 2, but only one was uploaded.
- The {@link Creative#appliedLabels} of an associated {@code Creative} do not match the {@link CreativePlaceholder#effectiveAppliedLabels} of the {@code LineItem}. For example {@code LineItem} specifies 750x350 with a Foo {@code AppliedLabel} but a 750x350 creative without a {@code AppliedLabel} was uploaded.
- programmaticCreativeSource - optional; type ProgrammaticCreativeSource - type string with restriction - enum { 'PUBLISHER', 'ADVERTISER', 'UNKNOWN' }Indicates the {@link ProgrammaticCreativeSource} of the programmatic line item. This is a read-only field. Any changes must be made on the {@link ProposalLineItem}.
- thirdPartyMeasurementSettings - optional; type ThirdPartyMeasurementSettingsContains third party auto-pixeling settings for cross-sell Partners.
- viewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }A field to determine the type of ThirdPartyViewabilityIntegrationPartner. This field default is NONE.
- viewabilityClientId - optional; type stringThe third party partner id for YouTube viewability verification.
- viewabilityReportingId - optional; type stringThe reporting id that maps viewability partner data with a campaign (or a group of related campaigns) specific data.
- publisherViewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }A field to determine the type of publisher's viewability partner. This field default is NONE.
- publisherViewabilityClientId - optional; type stringThe third party partner id for YouTube viewability verification for publisher.
- publisherViewabilityReportingId - optional; type stringThe reporting id that maps viewability partner data with a campaign (or a group of related campaigns) specific data for publisher.
- brandLiftPartner - optional; type ThirdPartyBrandLiftIntegrationPartner - type string with restriction - enum { 'UNKNOWN', 'NONE', 'KANTAR_MILLWARD_BROWN', 'DYNATA', 'INTAGE', 'MACROMILL' }A field to determine the type of ThirdPartyBrandLiftIntegrationPartner. This field default is NONE.
- brandLiftClientId - optional; type stringThe third party partner id for YouTube brand lift verification.
- brandLiftReportingId - optional; type stringThe reporting id that maps brand lift partner data with a campaign (or a group of related campaigns) specific data.
- reachPartner - optional; type ThirdPartyReachIntegrationPartner - type string with restriction - enum { 'NONE', 'COMSCORE', 'NIELSEN', 'KANTAR_MILLWARD_BROWN', 'VIDEO_RESEARCH', 'GEMIUS', 'VIDEO_AMP', 'ISPOT_TV', 'AUDIENCE_PROJECT', 'UNKNOWN' }A field to determine the type of advertiser's ThirdPartyReachIntegrationPartner. This field default is UNKNOWN.
- reachClientId - optional; type stringThe third party partner id for YouTube reach verification for advertiser.
- reachReportingId - optional; type stringThe reporting id that maps reach partner data with a campaign (or a group of related campaigns) specific data for advertiser.
- publisherReachPartner - optional; type ThirdPartyReachIntegrationPartner - type string with restriction - enum { 'NONE', 'COMSCORE', 'NIELSEN', 'KANTAR_MILLWARD_BROWN', 'VIDEO_RESEARCH', 'GEMIUS', 'VIDEO_AMP', 'ISPOT_TV', 'AUDIENCE_PROJECT', 'UNKNOWN' }A field to determine the type of publisher's ThirdPartyReachIntegrationPartner. This field default is UNKNOWN.
- publisherReachClientId - optional; type stringThe third party partner id for YouTube reach verification for publisher.
- publisherReachReportingId - optional; type stringThe reporting id that maps reach partner data with a campaign (or a group of related campaigns) specific data for publisher.
- viewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }
- youtubeKidsRestricted - optional; type booleanDesignates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the Ad Manager Help Center for more information.
- videoMaxDuration - optional; type longThe max duration of a video creative associated with this {@code LineItem} in milliseconds.
This attribute is only meaningful for video line items. For version v202011 and earlier, this attribute is optional and defaults to 0. For version v202102 and later, this attribute is required for video line items and must be greater than 0.
- primaryGoal - optional; type GoalDefines the criteria a {@link LineItem} needs to satisfy to meet its delivery goal.
- goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }The type of the goal for the {@code LineItem}. It defines the period over which the goal for {@code LineItem} should be reached.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The type of the goal unit for the {@code LineItem}.
- units - optional; type longIf this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the {@code LineItem}. If the line item is of type {@link LineItemType#SPONSORSHIP}, it represents the percentage of available impressions reserved. If the line item is of type {@link LineItemType#BULK} or {@link LineItemType#PRICE_PRIORITY}, it represents the number of remaining impressions reserved. If the line item is of type {@link LineItemType#NETWORK} or {@link LineItemType#HOUSE}, it represents the percentage of remaining impressions reserved.
If this is a secondary goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see {@link LineItem#secondaryGoals}.
The primary goal that this {@code LineItem} is associated with, which is used in its pacing and budgeting. - goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }
- secondaryGoals - optional, unbounded; type GoalDefines the criteria a {@link LineItem} needs to satisfy to meet its delivery goal.
- goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }The type of the goal for the {@code LineItem}. It defines the period over which the goal for {@code LineItem} should be reached.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The type of the goal unit for the {@code LineItem}.
- units - optional; type longIf this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the {@code LineItem}. If the line item is of type {@link LineItemType#SPONSORSHIP}, it represents the percentage of available impressions reserved. If the line item is of type {@link LineItemType#BULK} or {@link LineItemType#PRICE_PRIORITY}, it represents the number of remaining impressions reserved. If the line item is of type {@link LineItemType#NETWORK} or {@link LineItemType#HOUSE}, it represents the percentage of remaining impressions reserved.
If this is a secondary goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see {@link LineItem#secondaryGoals}.
The secondary goals that this {@code LineItem} is associated with. It is required and meaningful only if the {@link LineItem#costType} is {@link CostType.CPA} or if the {@link LineItem#lineItemType} is {@link LineItemType#SPONSORSHIP} and {@link LineItem#costType} is {@link CostType.CPM}. - goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }
- grpSettings - optional; type GrpSettings{@code GrpSettings} contains information for a line item that will have a target demographic when serving. This information will be used to set up tracking and enable reporting on the demographic information.
- minTargetAge - optional; type longSpecifies the minimum target age (in years) of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- maxTargetAge - optional; type longSpecifies the maximum target age (in years) of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- targetGender - optional; type GrpTargetGender - type string with restriction - enum { 'UNKNOWN', 'MALE', 'FEMALE', 'BOTH' }Specifies the target gender of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- provider - optional; type GrpProvider - type string with restriction - enum { 'UNKNOWN', 'NIELSEN' }Specifies the GRP provider of the {@link LineItem}.
- inTargetRatioEstimateMilliPercent - optional; type longEstimate for the in-target ratio given the line item's audience targeting. This field is only applicable if {@link #provider} is Nielsen, {@link LineItem#primaryGoal#unitType} is in-target impressions, and {@link LineItem#CostType} is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.
- nielsenCtvPacingType - optional; type NielsenCtvPacingType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'COVIEW', 'STRICT_COVIEW' }Specifies which pacing computation to apply in pacing to impressions from connected devices. This field is required if {@code enableNielsenCoViewingSupport} is true.
- pacingDeviceCategorizationType - optional; type PacingDeviceCategorizationType - type string with restriction - enum { 'UNKNOWN', 'GOOGLE', 'NIELSEN' }Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.
- applyTrueCoview - optional; type booleanSpecifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if NielsenCtvPacingType is not NONE.
Contains the information for a line item which has a target GRP demographic. - minTargetAge - optional; type long
- dealInfo - optional; type LineItemDealInfoDtoData transfer object for the exchange deal info of a line item.
- externalDealId - optional; type longThe external deal ID shared between seller and buyer. This field is only present if the deal has been finalized. This attribute is read-only and is assigned by Google.
The deal information associated with this line item, if it is programmatic. - externalDealId - optional; type long
- viewabilityProviderCompanyIds - optional, unbounded; type longOptional IDs of the {@link Company} that provide ad verification for this line item. {@link Company.Type#VIEWABILITY_PROVIDER}.
- childContentEligibility - optional; type ChildContentEligibility - type string with restriction - enum { 'UNKNOWN', 'DISALLOWED', 'ALLOWED' }Child content eligibility designation for this line item.
This field is optional and defaults to {@link ChildContentEligibility#DISALLOWED}.
- customVastExtension - optional; type stringCustom XML to be rendered in a custom VAST response at serving time.
- targeting - optional; type TargetingContains the targeting criteria for the ad campaign. This attribute is required.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- creativeTargetings - optional, unbounded; type CreativeTargetingRepresents the creative targeting criteria for a {@link LineItem}.
- name - optional; type stringThe name of this creative targeting. This attribute is required.
- targeting - optional; type TargetingThe {@link Targeting} criteria of this creative targeting. This attribute is required.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
A list of {@link CreativeTargeting} objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a creative placeholder's {@link CreativePlaceholder#targetingName} field by referencing the creative targeting's {@link CreativeTargeting#name name}. It also needs to be re-specified in the {@link LineItemCreativeAssociation#targetingName} field when associating a line item with a creative that fits into that placeholder. - name - optional; type string
The target of the forecast. If {@link LineItem#id} is null or no line item exists with that ID, then a forecast is computed for the subject, predicting what would happen if it were added to the network. If a line item already exists with {@link LineItem#id}, the forecast is computed for the subject, predicting what would happen if the existing line item's settings were modified to match the subject. - orderId - optional; type long
- proposalLineItem - optional; type ProposalLineItemA {@code ProposalLineItem} is added to a programmatic {@link Proposal} and is similar to a delivery {@link LineItem}. It contains delivery details including information like impression goal or quantity, start and end times, and targeting.
- id - optional; type longThe unique ID of the {@code ProposalLineItem}. This attribute is read-only.
- proposalId - optional; type longThe unique ID of the {@link Proposal}, to which the {@code ProposalLineItem} belongs. This attribute is required for creation and then is readonly. This attribute is required.
- name - optional; type stringThe name of the {@code ProposalLineItem} which should be unique under the same {@link Proposal}. This attribute has a maximum length of 255 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. This attribute is required.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time at which the line item associated with the {@code ProposalLineItem} is enabled to begin serving. This attribute is optional during creation, but required and must be in the future when it turns into a line item. The {@link DateTime#timeZoneID} is required if start date time is not {@code null}. This attribute becomes readonly once the {@code ProposalLineItem} has started delivering. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time at which the line item associated with the {@code ProposalLineItem} stops beening served. This attribute is optional during creation, but required and must be after the {@link #startDateTime}. The {@link DateTime#timeZoneID} is required if end date time is not {@code null}. - date - optional; type Date
- internalNotes - optional; type stringProvides any additional notes that may annotate the {@code ProposalLineItem}. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- isArchived - optional; type booleanThe archival status of the {@code ProposalLineItem}. This attribute is read-only.
- goal - optional; type GoalDefines the criteria a {@link LineItem} needs to satisfy to meet its delivery goal.
- goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }The type of the goal for the {@code LineItem}. It defines the period over which the goal for {@code LineItem} should be reached.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The type of the goal unit for the {@code LineItem}.
- units - optional; type longIf this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the {@code LineItem}. If the line item is of type {@link LineItemType#SPONSORSHIP}, it represents the percentage of available impressions reserved. If the line item is of type {@link LineItemType#BULK} or {@link LineItemType#PRICE_PRIORITY}, it represents the number of remaining impressions reserved. If the line item is of type {@link LineItemType#NETWORK} or {@link LineItemType#HOUSE}, it represents the percentage of remaining impressions reserved.
If this is a secondary goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see {@link LineItem#secondaryGoals}.
The goal(i.e. contracted quantity, quantity or limit) that this {@code ProposalLineItem} is associated with, which is used in its pacing and budgeting. {@link Goal#units} must be greater than 0 when the proposal line item turns into a line item, {@link Goal#goalType} and {@link Goal#unitType} are readonly. For a Preferred deal {@code ProposalLineItem}, the goal type can only be {@link GoalType#NONE}. This attribute is required. - goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }
- secondaryGoals - optional, unbounded; type GoalDefines the criteria a {@link LineItem} needs to satisfy to meet its delivery goal.
- goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }The type of the goal for the {@code LineItem}. It defines the period over which the goal for {@code LineItem} should be reached.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The type of the goal unit for the {@code LineItem}.
- units - optional; type longIf this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the {@code LineItem}. If the line item is of type {@link LineItemType#SPONSORSHIP}, it represents the percentage of available impressions reserved. If the line item is of type {@link LineItemType#BULK} or {@link LineItemType#PRICE_PRIORITY}, it represents the number of remaining impressions reserved. If the line item is of type {@link LineItemType#NETWORK} or {@link LineItemType#HOUSE}, it represents the percentage of remaining impressions reserved.
If this is a secondary goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see {@link LineItem#secondaryGoals}.
The secondary goals that this {@code ProposalLineItem} is associated with. For a programmatic line item with the properties {@link RateType#CPM} and {@link LineItemType#SPONSORSHIP}, this field will have one goal which describes the impressions cap. For other cases, this field is an empty list. - goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }
- contractedUnitsBought - optional; type longThe contracted number of daily minimum impressions used for {@link LineItemType#SPONSORSHIP} {@code ProposalLineItem} deals with a rate type of {@link RateType#CPD}.
This attribute is required for percentage-based-goal {@link ProposalLineItem proposal line items}. It does not impact ad-serving and is for reporting purposes only.
- deliveryRateType - optional; type DeliveryRateType - type string with restriction - enum { 'EVENLY', 'FRONTLOADED', 'AS_FAST_AS_POSSIBLE' }The strategy for delivering ads over the course of the {@code ProposalLineItem}'s duration. This attribute is required. For a Preferred deal {@code ProposalLineItem}, the value can only be {@link DeliveryRateType#FRONTLOADED}.
- roadblockingType - optional; type RoadblockingType - type string with restriction - enum { 'ONLY_ONE', 'ONE_OR_MORE', 'AS_MANY_AS_POSSIBLE', 'ALL_ROADBLOCK', 'CREATIVE_SET' }The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional during creation and defaults to the {@link Product#roadblockingType product's roadblocking type}, or {@link RoadblockingType#ONE_OR_MORE} if not specified by the product.
- companionDeliveryOption - optional; type CompanionDeliveryOption - type string with restriction - enum { 'OPTIONAL', 'AT_LEAST_ONE', 'ALL', 'UNKNOWN' }The delivery option for companions. This is only valid if the roadblocking type is {@link RoadblockingType#CREATIVE_SET}. The default value for roadblocking creatives is {@link CompanionDeliveryOption#OPTIONAL}. The default value in other cases is {@link CompanionDeliveryOption#UNKNOWN}. Providing something other than {@link CompanionDeliveryOption#UNKNOWN} will cause an error.
- videoMaxDuration - optional; type longThe max duration of a video creative associated with this {@code ProposalLineItem} in milliseconds. This attribute is optional, defaults to the {@link Product#videoMaxDuration} on the {@link Product} it was created with, and only meaningful if this is a video proposal line item.
- videoCreativeSkippableAdType - optional; type SkippableAdType - type string with restriction - enum { 'UNKNOWN', 'DISABLED', 'ENABLED', 'INSTREAM_SELECT', 'ANY' }The proposal line item's creatives' skippability. This attribute is optional, only applicable for video proposal line items, and defaults to {@link SkippableAdType#NOT_SKIPPABLE}.
- frequencyCaps - optional, unbounded; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The set of frequency capping units for this {@code ProposalLineItem}. This attribute is optional during creation and defaults to the {@link Product#frequencyCaps product's frequency caps} if {@link Product#allowFrequencyCapsCustomization} is {@code false}. - maxImpressions - optional; type int
- dfpLineItemId - optional; type longThe unique ID of corresponding {@link LineItem}. This will be {@code null} if the {@link Proposal} has not been pushed to Ad Manager. This attribute is read-only.
- lineItemType - optional; type LineItemType - type string with restriction - enum { 'SPONSORSHIP', 'STANDARD', 'NETWORK', 'BULK', 'PRICE_PRIORITY', 'HOUSE', 'LEGACY_DFP', 'CLICK_TRACKING', 'ADSENSE', 'AD_EXCHANGE', 'BUMPER', 'ADMOB', 'PREFERRED_DEAL', 'UNKNOWN' }The corresponding {@link LineItemType} of the {@code ProposalLineItem}. For a programmatic {@code ProposalLineItem}, the value can only be one of:
- {@link LineItemType#SPONSORSHIP}
- {@link LineItemType#STANDARD}
- {@link LineItemType#PREFERRED_DEAL}
- lineItemPriority - optional; type intThe priority for the corresponding {@link LineItem} of the {@code ProposalLineItem}. This attribute is optional during creation and defaults to the default priority of the {@link #lineItemType}. For forecasting, this attribute is optional and has a default value assigned by Google. See {@link LineItem#priority} for more information.
- rateType - optional; type RateType - type string with restriction - enum { 'CPM', 'CPD', 'VCPM', 'CPM_IN_TARGET', 'UNKNOWN' }The method used for billing the {@code ProposalLineItem}. This attribute is read-only. This attribute is required.
- creativePlaceholders - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholder... is recursiveThe companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
Details about the creatives that are expected to serve through the {@code ProposalLineItem}. This attribute is optional during creation and defaults to the {@link Product#creativePlaceholders product's creative placeholders}. This attribute is required. - size - optional; type Size
- targeting - optional; type TargetingContains the targeting criteria for the {@code ProposalLineItem}. This attribute is required.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- customFieldValues - optional, unbounded; type BaseCustomFieldValueThe value of a {@link CustomField} for a particular entity.
- customFieldId - optional; type longId of the {@code CustomField} to which this value belongs. This attribute is required.
The values of the custom fields associated with the {@code ProposalLineItem}. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. - customFieldId - optional; type long
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of labels applied directly to the {@code ProposalLineItem}. This attribute is optional. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only. - labelId - optional; type long
- disableSameAdvertiserCompetitiveExclusion - optional; type booleanIf a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to {@code true} will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.
This attribute is optional and defaults to false.
- isSold - optional; type booleanIndicates whether this {@code ProposalLineItem} has been sold. This attribute is read-only.
- netRate - optional; type MoneyRepresents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
The amount of money to spend per impression or click in proposal currency. It supports precision of 4 decimal places in terms of the fundamental currency unit, so the {@link Money#getAmountInMicros} must be multiples of 100. It doesn't include agency commission.For example, if {@link Proposal#currencyCode} is 'USD', then $123.4567 could be represented as 123456700, but further precision is not supported.
The field {@link ProposalLineItem#netRate} is required, and used to calculate {@link ProposalLineItem#netCost} if unspecified.
- currencyCode - optional; type string
- netCost - optional; type MoneyRepresents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
The cost of the {@code ProposalLineItem} in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the {@link Money#getAmountInMicros} must be multiples of 10000. It doesn't include agency commission.For example, if {@link Proposal#currencyCode} is 'USD', then $123.45 could be represented as 123450000, but further precision is not supported.
The field {@link ProposalLineItem#netRate} is required, and used to calculate {@link ProposalLineItem#netCost} if unspecified.
- currencyCode - optional; type string
- deliveryIndicator - optional; type DeliveryIndicatorIndicates the delivery performance of the {@link LineItem}.
- expectedDeliveryPercentage - optional; type doubleHow much the {@code LineItem} was expected to deliver as a percentage of {@link LineItem#primaryGoal}.
- actualDeliveryPercentage - optional; type doubleHow much the line item actually delivered as a percentage of {@link LineItem#primaryGoal}.
Indicates how well the line item generated from this proposal line item has been performing. This will be {@code null} if the delivery indicator information is not available due to one of the following reasons:- The proposal line item has not pushed to Ad Manager.
- The line item is not delivering.
- The line item has an unlimited goal or cap.
- The line item has a percentage based goal or cap.
- expectedDeliveryPercentage - optional; type double
- deliveryData - optional; type DeliveryDataHolds the number of clicks or impressions, determined by {@link LineItem#costType}, delivered for a single line item for the last 7 days
- units - optional, unbounded; type longClicks or impressions delivered for the last 7 days.
Delivery data provides the number of clicks or impressions delivered for the {@link LineItem} generated from this proposal line item in the last 7 days. This will be {@code null} if the delivery data cannot be computed due to one of the following reasons:- The proposal line item has not pushed to Ad Manager.
- The line item is not deliverable.
- The line item has completed delivering more than 7 days ago.
- The line item has an absolute-based goal. {@link ProposalLineItem#deliveryIndicator} should be used to track its progress in this case. This attribute is read-only.
- units - optional, unbounded; type long
- computedStatus - optional; type ComputedStatus - type string with restriction - enum { 'DELIVERY_EXTENDED', 'DELIVERING', 'READY', 'PAUSED', 'INACTIVE', 'PAUSED_INVENTORY_RELEASED', 'PENDING_APPROVAL', 'COMPLETED', 'DISAPPROVED', 'DRAFT', 'CANCELED' }The status of the {@link LineItem} generated from this proposal line item. This will be {@code null} if the proposal line item has not pushed to Ad Manager. This attribute is read-only.
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code ProposalLineItem} was last modified.This attribute is assigned by Google when a {@code ProposalLineItem} is updated. This attribute is read-only.
- date - optional; type Date
- reservationStatus - optional; type ReservationStatus - type string with restriction - enum { 'RESERVED', 'NOT_RESERVED', 'RELEASED', 'CHECK_LINE_ITEM_RESERVATION_STATUS', 'UNKNOWN' }The reservation status of the {@link ProposalLineItem}. This attribute is read-only.
- lastReservationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The last {@link DateTime} when the {@link ProposalLineItem} reserved inventory. This attribute is read-only. - date - optional; type Date
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment that the {@code ProposalLineItem} is targeting. The default value is {@link EnvironmentType#BROWSER}. If this value is {@link EnvironmentType#VIDEO_PLAYER}, then this {@code ProposalLineItem} can only target {@link AdUnit ad units} that have {@link AdUnitSize sizes} whose {@link AdUnitSize#environmentType} is also {@link EnvironmentType#VIDEO_PLAYER}.
This field is read-only and set to {@link Product#environmentType} of the product this proposal line item was created from.
- allowedFormats - optional, unbounded; type AllowedFormats - type string with restriction - enum { 'AUDIO', 'UNKNOWN' }The set of {@link AllowedFormats} that this proposal line item can have. If the set is empty, this proposal line item allows all formats.
- additionalTerms - optional; type stringAdditional terms shown to the buyer in Marketplace.
- programmaticCreativeSource - optional; type ProgrammaticCreativeSource - type string with restriction - enum { 'PUBLISHER', 'ADVERTISER', 'UNKNOWN' }Indicates the {@link ProgrammaticCreativeSource} of the programmatic line item.
- grpSettings - optional; type GrpSettings{@code GrpSettings} contains information for a line item that will have a target demographic when serving. This information will be used to set up tracking and enable reporting on the demographic information.
- minTargetAge - optional; type longSpecifies the minimum target age (in years) of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- maxTargetAge - optional; type longSpecifies the maximum target age (in years) of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- targetGender - optional; type GrpTargetGender - type string with restriction - enum { 'UNKNOWN', 'MALE', 'FEMALE', 'BOTH' }Specifies the target gender of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- provider - optional; type GrpProvider - type string with restriction - enum { 'UNKNOWN', 'NIELSEN' }Specifies the GRP provider of the {@link LineItem}.
- inTargetRatioEstimateMilliPercent - optional; type longEstimate for the in-target ratio given the line item's audience targeting. This field is only applicable if {@link #provider} is Nielsen, {@link LineItem#primaryGoal#unitType} is in-target impressions, and {@link LineItem#CostType} is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.
- nielsenCtvPacingType - optional; type NielsenCtvPacingType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'COVIEW', 'STRICT_COVIEW' }Specifies which pacing computation to apply in pacing to impressions from connected devices. This field is required if {@code enableNielsenCoViewingSupport} is true.
- pacingDeviceCategorizationType - optional; type PacingDeviceCategorizationType - type string with restriction - enum { 'UNKNOWN', 'GOOGLE', 'NIELSEN' }Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.
- applyTrueCoview - optional; type booleanSpecifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if NielsenCtvPacingType is not NONE.
Contains the information for a proposal line item which has a target GRP demographic. - minTargetAge - optional; type long
- estimatedMinimumImpressions - optional; type longThe estimated minimum impressions that should be delivered for a proposal line item.
- thirdPartyMeasurementSettings - optional; type ThirdPartyMeasurementSettingsContains third party measurement settings for cross-sell PartnersContains third party auto-pixeling settings for cross-sell Partners.
- viewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }A field to determine the type of ThirdPartyViewabilityIntegrationPartner. This field default is NONE.
- viewabilityClientId - optional; type stringThe third party partner id for YouTube viewability verification.
- viewabilityReportingId - optional; type stringThe reporting id that maps viewability partner data with a campaign (or a group of related campaigns) specific data.
- publisherViewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }A field to determine the type of publisher's viewability partner. This field default is NONE.
- publisherViewabilityClientId - optional; type stringThe third party partner id for YouTube viewability verification for publisher.
- publisherViewabilityReportingId - optional; type stringThe reporting id that maps viewability partner data with a campaign (or a group of related campaigns) specific data for publisher.
- brandLiftPartner - optional; type ThirdPartyBrandLiftIntegrationPartner - type string with restriction - enum { 'UNKNOWN', 'NONE', 'KANTAR_MILLWARD_BROWN', 'DYNATA', 'INTAGE', 'MACROMILL' }A field to determine the type of ThirdPartyBrandLiftIntegrationPartner. This field default is NONE.
- brandLiftClientId - optional; type stringThe third party partner id for YouTube brand lift verification.
- brandLiftReportingId - optional; type stringThe reporting id that maps brand lift partner data with a campaign (or a group of related campaigns) specific data.
- reachPartner - optional; type ThirdPartyReachIntegrationPartner - type string with restriction - enum { 'NONE', 'COMSCORE', 'NIELSEN', 'KANTAR_MILLWARD_BROWN', 'VIDEO_RESEARCH', 'GEMIUS', 'VIDEO_AMP', 'ISPOT_TV', 'AUDIENCE_PROJECT', 'UNKNOWN' }A field to determine the type of advertiser's ThirdPartyReachIntegrationPartner. This field default is UNKNOWN.
- reachClientId - optional; type stringThe third party partner id for YouTube reach verification for advertiser.
- reachReportingId - optional; type stringThe reporting id that maps reach partner data with a campaign (or a group of related campaigns) specific data for advertiser.
- publisherReachPartner - optional; type ThirdPartyReachIntegrationPartner - type string with restriction - enum { 'NONE', 'COMSCORE', 'NIELSEN', 'KANTAR_MILLWARD_BROWN', 'VIDEO_RESEARCH', 'GEMIUS', 'VIDEO_AMP', 'ISPOT_TV', 'AUDIENCE_PROJECT', 'UNKNOWN' }A field to determine the type of publisher's ThirdPartyReachIntegrationPartner. This field default is UNKNOWN.
- publisherReachClientId - optional; type stringThe third party partner id for YouTube reach verification for publisher.
- publisherReachReportingId - optional; type stringThe reporting id that maps reach partner data with a campaign (or a group of related campaigns) specific data for publisher.
- viewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }
- makegoodInfo - optional; type ProposalLineItemMakegoodInfoMakegood info for this proposal line item. Immutable once created.
Null if this proposal line item is not a makegood.
Makegood info for a {@link ProposalLineItemDto}.- originalProposalLineItemId - optional; type longThe ID of the original proposal line item on which this makegood is based. This attribute is read-only.
- reason - optional; type stringThe publisher-provided reason why this makegood was initiated. This is free form text.
The following predefined values can be used to render predefined options in the UI.
UNDERDELIVERY: 'Impression underdelivery', SECONDARY_DELIVERY_TERMS: 'Did not meet secondary delivery terms ', PERFORMANCE: 'Performance issues',
- originalProposalLineItemId - optional; type long
- hasMakegood - optional; type booleanWhether this proposal line item has an associated makegood. This attribute is read-only.
- canCreateMakegood - optional; type booleanWhether a new makegood associated with this line item can be created. This attribute is read-only.
- pauseRole - optional; type NegotiationRole - type string with restriction - enum { 'BUYER', 'SELLER', 'UNKNOWN' }The {@link NegotiationRole} that paused the proposal line item, i.e. {@link NegotiationRole#seller} or {@link NegotiationRole#buyer}, or {@code null} when the proposal is not paused. This attribute is read-only.
- pauseReason - optional; type stringThe reason for pausing the {@link ProposalLineItem}, provided by the {@link pauseRole}. It is {@code null} when the {@link ProposalLineItem} is not paused. This attribute is read-only.
The target of the forecast if this prospective line item is a proposal line item.If {@link ProposalLineItem#id} is null or no proposal line item exists with that ID, then a forecast is computed for the subject, predicting what would happen if it were added to the network. If a proposal line item already exists with {@link ProposalLineItem#id}, the forecast is computed for the subject, predicting what would happen if the existing proposal line item's settings were modified to match the subject.
A proposal line item can optionally correspond to an order {@link LineItem}, in which case, by forecasting a proposal line item, the corresponding line item is implicitly ignored in the forecasting.
Either {@link #lineItem} or {@link #proposalLineItem} should be specified but not both.
- id - optional; type long
- advertiserId - optional; type longWhen set, the line item is assumed to be from this advertiser, and unified blocking rules will apply accordingly. If absent, line items without an existing order won't be subject to unified blocking rules.
- lineItem - optional; type LineItem - extension of type LineItemSummary
- forecastOptions - optional; type AvailabilityForecastOptionsForecasting options for line item availability forecasts.
- includeTargetingCriteriaBreakdown - optional; type booleanWhen specified, forecast result for the availability line item will also include breakdowns by its targeting in {@link AvailabilityForecast#targetingCriteriaBreakdowns}.
- includeContendingLineItems - optional; type booleanWhen specified, the forecast result for the availability line item will also include contending line items in {@link AvailabilityForecast#contendingLineItems}.
- breakdown - optional; type ForecastBreakdownOptionsConfiguration of forecast breakdown.
- timeWindows - optional, unbounded; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The boundaries of time windows to configure time breakdown.By default, the time window of the forecasted {@link LineItem} is assumed if none are explicitly specified in this field. But if set, at least two {@link DateTime}s are needed to define the boundaries of minimally one time window.
Also, the time boundaries are required to be in the same time zone, in strictly ascending order.
- date - optional; type Date
- targets - optional, unbounded; type ForecastBreakdownTargetFor each time window, these are the breakdown targets. If none specified, the targeting of the forecasted {@link LineItem} is assumed.Specifies inventory targeted by a breakdown entry.
- name - optional; type stringAn optional name for this breakdown target, to be populated in the corresponding {@link ForecastBreakdownEntry#name} field.
- targeting - optional; type TargetingIf specified, the targeting for this breakdown.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- creative - optional; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholder... is recursiveThe companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
If specified, restrict the breakdown to only inventory matching this creative. - size - optional; type Size
- name - optional; type string
- timeWindows - optional, unbounded; type DateTime
- includeTargetingCriteriaBreakdown - optional; type boolean
Output:getAvailabilityForecastResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getAvailabilityForecastResponse- rval - optional; type AvailabilityForecastDescribes predicted inventory availability for a {@link ProspectiveLineItem}.
Inventory has three threshold values along a line of possible inventory. From least to most, these are:
- Available units -- How many units can be booked without affecting any other line items. Booking more than this number can cause lower and same priority line items to underdeliver.
- Possible units -- How many units can be booked without affecting any higher priority line items. Booking more than this number can cause the line item to underdeliver.
- Matched (forecast) units -- How many units satisfy all specified criteria.
Underdelivery is caused by overbooking. However, if more impressions are served than are predicted, the extra available inventory might enable all inventory guarantees to be met without overbooking.
- lineItemId - optional; type longUniquely identifies this availability forecast. This value is read-only and is assigned by Google when the forecast is created. The attribute will be either the ID of the {@link LineItem} object it represents, or {@code null} if the forecast represents a prospective line item.
- orderId - optional; type longThe unique ID for the {@link Order} object that this line item belongs to, or {@code null} if the forecast represents a prospective line item without an {@link LineItem#orderId} set.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The unit with which the goal or cap of the {@link LineItem} is defined. Will be the same value as {@link Goal#unitType} for both a set line item or a prospective one.
- availableUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that can be booked without affecting the delivery of any reserved line items. Exceeding this value will not cause an overbook, but lower priority line items may not run.
- deliveredUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that have already been served if the reservation is already running.
- matchedUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that match the specified targeting and delivery settings.
- possibleUnits - optional; type longThe maximum number of units, defined by {@link Goal#unitType}, that could be booked by taking inventory away from lower priority line items and some same priority line items.
Please note: booking this number may cause lower priority line items and some same priority line items to underdeliver.
- reservedUnits - optional; type longThe number of reserved units, defined by {@link Goal#unitType}, requested. This can be an absolute or percentage value.
- breakdowns - optional, unbounded; type ForecastBreakdownThe breakdowns for each time window defined in {@link ForecastBreakdownOptions#timeWindows}.
If no breakdown was requested through {@link AvailabilityForecastOptions#breakdown}, this field will be empty. If targeting breakdown was requested by {@link ForecastBreakdownOptions#targets} with no time breakdown, this list will contain a single {@link ForecastBreakdown} corresponding to the time window of the forecasted {@link LineItem}. Otherwise, each time window defined by {@link ForecastBreakdownOptions#timeWindows} will correspond to one {@link ForecastBreakdown} in the same order. Targeting breakdowns for every time window are returned in {@link ForecastBreakdown#breakdownEntries}. Some examples: For a targeting breakdown in the form of {@code ForecastBreakdownOptions{targets=[IU=A, {IU=B, creative=1x1}]}}, the {@link #breakdowns} field may look like: {@code [ForecastBreakdown{breakdownEntries=[availableUnits=10, availableUnits=20]}]} where the entries correspond to {@code {IU=A}} and {@code {IU=B, creative=1x1}} respectively. For a time breakdown in the form of {@code ForecastBreakdownOptions{timeWindows=[1am, 2am, 3am]}}, the {@code breakdowns} field may look like:
{@code [ ForecastBreakdown{startTime=1am, endTime=2am, breakdownEntries=[availableUnits=10]}, ForecastBreakdown{startTime=2am, endTime=3am, breakdownEntries=[availableUnits=20]} ] }where the two {@link #ForecastBreakdown} correspond to the [1am, 2am) and [2am, 3am) time windows respecively. For a two-dimensional breakdown in the form of {@code ForecastBreakdownOptions{timeWindows=[1am, 2am, 3am], targets=[IU=A, IU=B]}, the {@code breakdowns} field may look like:{@code [ ForecastBreakdown{startTime=1am, endTime=2am, breakdownEntries=[availableUnits=10, availableUnits=100]}, ForecastBreakdown{startTime=2am, endTime=3am, breakdownEntries=[availableUnits=20, availableUnits=200]} ] }where the first ForecastBreakdown respresents the [1am, 2am) time window with two entries for the IU A and IU B respectively; and the second ForecastBreakdown represents the [2am, 3am) time window also with two entries corresponding to the two IUs.Represents the breakdown entries for a list of targetings and/or creatives.- startTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The starting time of the represented breakdown. - date - optional; type Date
- endTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end time of the represented breakdown. - date - optional; type Date
- breakdownEntries - optional, unbounded; type ForecastBreakdownEntryThe forecast breakdown entries in the same order as in the {@link ForecastBreakdownOptions#targets} field.A single forecast breakdown entry.
- name - optional; type stringThe optional name of this entry, as specified in the corresponding {@link ForecastBreakdownTarget#name} field.
- forecast - optional; type BreakdownForecastRepresents a single delivery data point, with both available and forecast number.
- matched - optional; type long
- available - optional; type long
- possible - optional; type long
The forecast of this entry.
- name - optional; type string
- startTime - optional; type DateTime
- targetingCriteriaBreakdowns - optional, unbounded; type TargetingCriteriaBreakdownThe forecast result broken down by the targeting of the forecasted line item.A single targeting criteria breakdown result.
- targetingDimension - optional; type TargetingDimension - type string with restriction - enum { 'CUSTOM_CRITERIA', 'GEOGRAPHY', 'BROWSER', 'BROWSER_LANGUAGE', 'BANDWIDTH_GROUP', 'OPERATING_SYSTEM', 'USER_DOMAIN', 'CONTENT', 'VIDEO_POSITION', 'AD_SIZE', 'AD_UNIT', 'PLACEMENT', 'MOBILE_CARRIER', 'DEVICE_CAPABILITY', 'DEVICE_CATEGORY', 'DEVICE_MANUFACTURER', 'MOBILE_APPLICATION', 'FORECASTED_CREATIVE_RESTRICTION', 'VERTICAL', 'CONTENT_LABEL', 'UNKNOWN' }The dimension of this breakdown
- targetingCriteriaId - optional; type longThe unique ID of the targeting criteria.
- targetingCriteriaName - optional; type stringThe name of the targeting criteria.
- excluded - optional; type booleanWhen true, the breakdown is negative.
- availableUnits - optional; type longThe available units for this breakdown.
- matchedUnits - optional; type longThe matched units for this breakdown.
- targetingDimension - optional; type TargetingDimension - type string with restriction - enum { 'CUSTOM_CRITERIA', 'GEOGRAPHY', 'BROWSER', 'BROWSER_LANGUAGE', 'BANDWIDTH_GROUP', 'OPERATING_SYSTEM', 'USER_DOMAIN', 'CONTENT', 'VIDEO_POSITION', 'AD_SIZE', 'AD_UNIT', 'PLACEMENT', 'MOBILE_CARRIER', 'DEVICE_CAPABILITY', 'DEVICE_CATEGORY', 'DEVICE_MANUFACTURER', 'MOBILE_APPLICATION', 'FORECASTED_CREATIVE_RESTRICTION', 'VERTICAL', 'CONTENT_LABEL', 'UNKNOWN' }
- contendingLineItems - optional, unbounded; type ContendingLineItemList of {@link ContendingLineItem contending line items} for this forecast.Describes contending line items for a {@link Forecast}.
- lineItemId - optional; type longThe {@link LineItem#id Id} of the contending line item.
- contendingImpressions - optional; type longNumber of impressions contended for by both the forecasted line item and this line item, but served to this line item in the forecast simulation.
- lineItemId - optional; type long
- alternativeUnitTypeForecasts - optional, unbounded; type AlternativeUnitTypeForecastA view of the forecast in terms of an alternative unit type.
For example, a forecast for an impressions goal may include this to express the matched, available, and possible viewable impressions.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The alternative unit type being presented.
- matchedUnits - optional; type longThe number of units, defined by {@link #unitType}, that match the specified targeting and delivery settings.
- availableUnits - optional; type longThe number of units, defined by {@link #unitType}, that can be booked without affecting the delivery of any reserved line items. Exceeding this value will not cause an overbook, but lower-priority line items may not run.
- possibleUnits - optional; type longThe maximum number of units, defined by {@link #unitType}, that could be booked by taking inventory away from lower-priority line items.
Views of this forecast, with alternative unit types. - unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - lineItem - optional; type ProspectiveLineItem
- getAvailabilityForecastByIdDescription:Gets an {@link AvailabilityForecast} for an existing {@link LineItem} object. An availability forecast reports the maximum number of available units that the line item can be booked with, and also the total number of units matching the line item's targeting.
Only line items having type {@link LineItemType#SPONSORSHIP} or {@link LineItemType#STANDARD} are valid. Other types will result in {@link ReservationDetailsError.Reason#LINE_ITEM_TYPE_NOT_ALLOWED}.
Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getAvailabilityForecastByIdRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getAvailabilityForecastByIdGets an {@link AvailabilityForecast} for an existing {@link LineItem} object. An availability forecast reports the maximum number of available units that the line item can be booked with, and also the total number of units matching the line item's targeting.Only line items having type {@link LineItemType#SPONSORSHIP} or {@link LineItemType#STANDARD} are valid. Other types will result in {@link ReservationDetailsError.Reason#LINE_ITEM_TYPE_NOT_ALLOWED}.
- lineItemId - optional; type long
- forecastOptions - optional; type AvailabilityForecastOptionsForecasting options for line item availability forecasts.
- includeTargetingCriteriaBreakdown - optional; type booleanWhen specified, forecast result for the availability line item will also include breakdowns by its targeting in {@link AvailabilityForecast#targetingCriteriaBreakdowns}.
- includeContendingLineItems - optional; type booleanWhen specified, the forecast result for the availability line item will also include contending line items in {@link AvailabilityForecast#contendingLineItems}.
- breakdown - optional; type ForecastBreakdownOptionsConfiguration of forecast breakdown.
- timeWindows - optional, unbounded; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The boundaries of time windows to configure time breakdown.By default, the time window of the forecasted {@link LineItem} is assumed if none are explicitly specified in this field. But if set, at least two {@link DateTime}s are needed to define the boundaries of minimally one time window.
Also, the time boundaries are required to be in the same time zone, in strictly ascending order.
- date - optional; type Date
- targets - optional, unbounded; type ForecastBreakdownTargetFor each time window, these are the breakdown targets. If none specified, the targeting of the forecasted {@link LineItem} is assumed.Specifies inventory targeted by a breakdown entry.
- name - optional; type stringAn optional name for this breakdown target, to be populated in the corresponding {@link ForecastBreakdownEntry#name} field.
- targeting - optional; type TargetingIf specified, the targeting for this breakdown.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- creative - optional; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholder... is recursiveThe companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
If specified, restrict the breakdown to only inventory matching this creative. - size - optional; type Size
- name - optional; type string
- timeWindows - optional, unbounded; type DateTime
- includeTargetingCriteriaBreakdown - optional; type boolean
Output:getAvailabilityForecastByIdResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getAvailabilityForecastByIdResponse- rval - optional; type AvailabilityForecastDescribes predicted inventory availability for a {@link ProspectiveLineItem}.
Inventory has three threshold values along a line of possible inventory. From least to most, these are:
- Available units -- How many units can be booked without affecting any other line items. Booking more than this number can cause lower and same priority line items to underdeliver.
- Possible units -- How many units can be booked without affecting any higher priority line items. Booking more than this number can cause the line item to underdeliver.
- Matched (forecast) units -- How many units satisfy all specified criteria.
Underdelivery is caused by overbooking. However, if more impressions are served than are predicted, the extra available inventory might enable all inventory guarantees to be met without overbooking.
- lineItemId - optional; type longUniquely identifies this availability forecast. This value is read-only and is assigned by Google when the forecast is created. The attribute will be either the ID of the {@link LineItem} object it represents, or {@code null} if the forecast represents a prospective line item.
- orderId - optional; type longThe unique ID for the {@link Order} object that this line item belongs to, or {@code null} if the forecast represents a prospective line item without an {@link LineItem#orderId} set.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The unit with which the goal or cap of the {@link LineItem} is defined. Will be the same value as {@link Goal#unitType} for both a set line item or a prospective one.
- availableUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that can be booked without affecting the delivery of any reserved line items. Exceeding this value will not cause an overbook, but lower priority line items may not run.
- deliveredUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that have already been served if the reservation is already running.
- matchedUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that match the specified targeting and delivery settings.
- possibleUnits - optional; type longThe maximum number of units, defined by {@link Goal#unitType}, that could be booked by taking inventory away from lower priority line items and some same priority line items.
Please note: booking this number may cause lower priority line items and some same priority line items to underdeliver.
- reservedUnits - optional; type longThe number of reserved units, defined by {@link Goal#unitType}, requested. This can be an absolute or percentage value.
- breakdowns - optional, unbounded; type ForecastBreakdownThe breakdowns for each time window defined in {@link ForecastBreakdownOptions#timeWindows}.
If no breakdown was requested through {@link AvailabilityForecastOptions#breakdown}, this field will be empty. If targeting breakdown was requested by {@link ForecastBreakdownOptions#targets} with no time breakdown, this list will contain a single {@link ForecastBreakdown} corresponding to the time window of the forecasted {@link LineItem}. Otherwise, each time window defined by {@link ForecastBreakdownOptions#timeWindows} will correspond to one {@link ForecastBreakdown} in the same order. Targeting breakdowns for every time window are returned in {@link ForecastBreakdown#breakdownEntries}. Some examples: For a targeting breakdown in the form of {@code ForecastBreakdownOptions{targets=[IU=A, {IU=B, creative=1x1}]}}, the {@link #breakdowns} field may look like: {@code [ForecastBreakdown{breakdownEntries=[availableUnits=10, availableUnits=20]}]} where the entries correspond to {@code {IU=A}} and {@code {IU=B, creative=1x1}} respectively. For a time breakdown in the form of {@code ForecastBreakdownOptions{timeWindows=[1am, 2am, 3am]}}, the {@code breakdowns} field may look like:
{@code [ ForecastBreakdown{startTime=1am, endTime=2am, breakdownEntries=[availableUnits=10]}, ForecastBreakdown{startTime=2am, endTime=3am, breakdownEntries=[availableUnits=20]} ] }where the two {@link #ForecastBreakdown} correspond to the [1am, 2am) and [2am, 3am) time windows respecively. For a two-dimensional breakdown in the form of {@code ForecastBreakdownOptions{timeWindows=[1am, 2am, 3am], targets=[IU=A, IU=B]}, the {@code breakdowns} field may look like:{@code [ ForecastBreakdown{startTime=1am, endTime=2am, breakdownEntries=[availableUnits=10, availableUnits=100]}, ForecastBreakdown{startTime=2am, endTime=3am, breakdownEntries=[availableUnits=20, availableUnits=200]} ] }where the first ForecastBreakdown respresents the [1am, 2am) time window with two entries for the IU A and IU B respectively; and the second ForecastBreakdown represents the [2am, 3am) time window also with two entries corresponding to the two IUs.Represents the breakdown entries for a list of targetings and/or creatives.- startTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The starting time of the represented breakdown. - date - optional; type Date
- endTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end time of the represented breakdown. - date - optional; type Date
- breakdownEntries - optional, unbounded; type ForecastBreakdownEntryThe forecast breakdown entries in the same order as in the {@link ForecastBreakdownOptions#targets} field.A single forecast breakdown entry.
- name - optional; type stringThe optional name of this entry, as specified in the corresponding {@link ForecastBreakdownTarget#name} field.
- forecast - optional; type BreakdownForecastRepresents a single delivery data point, with both available and forecast number.
- matched - optional; type long
- available - optional; type long
- possible - optional; type long
The forecast of this entry.
- name - optional; type string
- startTime - optional; type DateTime
- targetingCriteriaBreakdowns - optional, unbounded; type TargetingCriteriaBreakdownThe forecast result broken down by the targeting of the forecasted line item.A single targeting criteria breakdown result.
- targetingDimension - optional; type TargetingDimension - type string with restriction - enum { 'CUSTOM_CRITERIA', 'GEOGRAPHY', 'BROWSER', 'BROWSER_LANGUAGE', 'BANDWIDTH_GROUP', 'OPERATING_SYSTEM', 'USER_DOMAIN', 'CONTENT', 'VIDEO_POSITION', 'AD_SIZE', 'AD_UNIT', 'PLACEMENT', 'MOBILE_CARRIER', 'DEVICE_CAPABILITY', 'DEVICE_CATEGORY', 'DEVICE_MANUFACTURER', 'MOBILE_APPLICATION', 'FORECASTED_CREATIVE_RESTRICTION', 'VERTICAL', 'CONTENT_LABEL', 'UNKNOWN' }The dimension of this breakdown
- targetingCriteriaId - optional; type longThe unique ID of the targeting criteria.
- targetingCriteriaName - optional; type stringThe name of the targeting criteria.
- excluded - optional; type booleanWhen true, the breakdown is negative.
- availableUnits - optional; type longThe available units for this breakdown.
- matchedUnits - optional; type longThe matched units for this breakdown.
- targetingDimension - optional; type TargetingDimension - type string with restriction - enum { 'CUSTOM_CRITERIA', 'GEOGRAPHY', 'BROWSER', 'BROWSER_LANGUAGE', 'BANDWIDTH_GROUP', 'OPERATING_SYSTEM', 'USER_DOMAIN', 'CONTENT', 'VIDEO_POSITION', 'AD_SIZE', 'AD_UNIT', 'PLACEMENT', 'MOBILE_CARRIER', 'DEVICE_CAPABILITY', 'DEVICE_CATEGORY', 'DEVICE_MANUFACTURER', 'MOBILE_APPLICATION', 'FORECASTED_CREATIVE_RESTRICTION', 'VERTICAL', 'CONTENT_LABEL', 'UNKNOWN' }
- contendingLineItems - optional, unbounded; type ContendingLineItemList of {@link ContendingLineItem contending line items} for this forecast.Describes contending line items for a {@link Forecast}.
- lineItemId - optional; type longThe {@link LineItem#id Id} of the contending line item.
- contendingImpressions - optional; type longNumber of impressions contended for by both the forecasted line item and this line item, but served to this line item in the forecast simulation.
- lineItemId - optional; type long
- alternativeUnitTypeForecasts - optional, unbounded; type AlternativeUnitTypeForecastA view of the forecast in terms of an alternative unit type.
For example, a forecast for an impressions goal may include this to express the matched, available, and possible viewable impressions.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The alternative unit type being presented.
- matchedUnits - optional; type longThe number of units, defined by {@link #unitType}, that match the specified targeting and delivery settings.
- availableUnits - optional; type longThe number of units, defined by {@link #unitType}, that can be booked without affecting the delivery of any reserved line items. Exceeding this value will not cause an overbook, but lower-priority line items may not run.
- possibleUnits - optional; type longThe maximum number of units, defined by {@link #unitType}, that could be booked by taking inventory away from lower-priority line items.
Views of this forecast, with alternative unit types. - unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - getDeliveryForecastDescription:Gets the delivery forecast for a list of {@link ProspectiveLineItem} objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getDeliveryForecastRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getDeliveryForecastGets the delivery forecast for a list of {@link ProspectiveLineItem} objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.
- lineItems - optional, unbounded; type ProspectiveLineItemRepresents a prospective line item to be forecasted.
- lineItem - optional; type LineItem - extension of type LineItemSummary{@link LineItem} is an advertiser's commitment to purchase a specific number of ad impressions, clicks, or time.The {@code LineItemSummary} represents the base class from which a {@code LineItem} is derived.
- orderId - optional; type longThe ID of the {@link Order} to which the {@code LineItem} belongs. This attribute is required.
- id - optional; type longUniquely identifies the {@code LineItem}. This attribute is read-only and is assigned by Google when a line item is created.
- name - optional; type stringThe name of the line item. This attribute is required and has a maximum length of 255 characters.
- externalId - optional; type stringAn identifier for the {@code LineItem} that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
- orderName - optional; type stringThe name of the {@link Order}. This value is read-only.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time on which the {@code LineItem} is enabled to begin serving. This attribute is required and must be in the future. - date - optional; type Date
- startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }Specifies whether to start serving to the {@code LineItem} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time on which the {@code LineItem} will stop serving. This attribute is required unless {@link LineItem#unlimitedEndDateTime} is set to {@code true}. If specified, it must be after the {@link LineItem#startDateTime}. This end date and time does not include auto extension days. - date - optional; type Date
- autoExtensionDays - optional; type intThe number of days to allow a line item to deliver past its {@link #endDateTime}. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.
- unlimitedEndDateTime - optional; type booleanSpecifies whether or not the {@code LineItem} has an end time. This attribute is optional and defaults to false. It can be be set to {@code true} for only line items of type {@link LineItemType#SPONSORSHIP}, {@link LineItemType#NETWORK}, {@link LineItemType#PRICE_PRIORITY} and {@link LineItemType#HOUSE}.
- creativeRotationType - optional; type CreativeRotationType - type string with restriction - enum { 'EVEN', 'OPTIMIZED', 'MANUAL', 'SEQUENTIAL' }The strategy used for displaying multiple {@link Creative} objects that are associated with the {@code LineItem}. This attribute is required.
- deliveryRateType - optional; type DeliveryRateType - type string with restriction - enum { 'EVENLY', 'FRONTLOADED', 'AS_FAST_AS_POSSIBLE' }The strategy for delivering ads over the course of the line item's duration. This attribute is optional and defaults to {@link DeliveryRateType#EVENLY} or {@link DeliveryRateType#FRONTLOADED} depending on the network's configuration.
- deliveryForecastSource - optional; type DeliveryForecastSource - type string with restriction - enum { 'HISTORICAL', 'FORECASTING', 'CUSTOM_PACING_CURVE', 'UNKNOWN' }Strategy for choosing forecasted traffic shapes to pace line items. This field is optional and defaults to {@link DeliveryForecastSource#HISTORICAL}.
- customPacingCurve - optional; type CustomPacingCurveA curve consisting of {@link CustomPacingGoal} objects that is used to pace line item delivery.
- customPacingGoalUnit - optional; type CustomPacingGoalUnit - type string with restriction - enum { 'ABSOLUTE', 'MILLI_PERCENT', 'UNKNOWN' }The unit of the {@link CustomPacingGoalDto#amount} values.
- customPacingGoals - optional, unbounded; type CustomPacingGoalThe list of goals that make up the custom pacing curve.An interval of a {@link CustomPacingCurve}. A custom pacing goal contains a start time and an amount. The goal will apply until either the next custom pacing goal's {@code getStartTime} or the line item's end time if it is the last goal.
- startDateTime - optional; type DateTimeThe start date and time of the goal. This field is required unless {@code useLineItemStartDateTime} is true.Represents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
- date - optional; type Date
- useLineItemStartDateTime - optional; type booleanWhether the {@link LineItem#startDateTime} should be used for the start date and time of this goal. This field is not persisted and if it is set to true, the {@code startDateTime} field will be populated by the line item's start time.
- amount - optional; type long
- startDateTime - optional; type DateTime
The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is {@link DeliveryForecastSource#CUSTOM_PACING_CURVE}. - customPacingGoalUnit - optional; type CustomPacingGoalUnit - type string with restriction - enum { 'ABSOLUTE', 'MILLI_PERCENT', 'UNKNOWN' }
- roadblockingType - optional; type RoadblockingType - type string with restriction - enum { 'ONLY_ONE', 'ONE_OR_MORE', 'AS_MANY_AS_POSSIBLE', 'ALL_ROADBLOCK', 'CREATIVE_SET' }The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional and defaults to {@link RoadblockingType#ONE_OR_MORE}.
- skippableAdType - optional; type SkippableAdType - type string with restriction - enum { 'UNKNOWN', 'DISABLED', 'ENABLED', 'INSTREAM_SELECT', 'ANY' }The nature of the line item's creatives' skippability. This attribute is optional, only applicable for video line items, and defaults to {@link SkippableAdType#NOT_SKIPPABLE}.
- frequencyCaps - optional, unbounded; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The set of frequency capping units for this {@code LineItem}. This attribute is optional. - maxImpressions - optional; type int
- lineItemType - optional; type LineItemType - type string with restriction - enum { 'SPONSORSHIP', 'STANDARD', 'NETWORK', 'BULK', 'PRICE_PRIORITY', 'HOUSE', 'LEGACY_DFP', 'CLICK_TRACKING', 'ADSENSE', 'AD_EXCHANGE', 'BUMPER', 'ADMOB', 'PREFERRED_DEAL', 'UNKNOWN' }Indicates the line item type of a {@code LineItem}. This attribute is required.
The line item type determines the default priority of the line item. More information can be found on the Ad Manager Help Center.
- priority - optional; type intThe priority for the line item. Valid values range from 1 to 16. This field is optional and defaults to the default priority of the {@link LineItemType}.
The following table shows the default, minimum, and maximum priority values are for each line item type:
LineItemType - default priority (minimum priority, maximum priority) {@link LineItemType#SPONSORSHIP} 4 (2, 5) {@link LineItemType#STANDARD} 8 (6, 10) {@link LineItemType#NETWORK} 12 (11, 14) {@link LineItemType#BULK} 12 (11, 14) {@link LineItemType#PRICE_PRIORITY} 12 (11, 14) {@link LineItemType#HOUSE} 16 (15, 16) {@link LineItemType#CLICK_TRACKING} 16 (1, 16) {@link LineItemType#AD_EXCHANGE} 12 (1, 16) {@link LineItemType#ADSENSE} 12 (1, 16) {@link LineItemType#BUMPER} 16 (15, 16) This field can only be edited by certain networks, otherwise a {@link PermissionError} will occur.
- costPerUnit - optional; type MoneyThe amount of money to spend per impression or click. This attribute is required for creating a {@code LineItem}.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- valueCostPerUnit - optional; type MoneyAn amount to help the adserver rank inventory. {@link LineItem#valueCostPerUnit} artificially raises the value of inventory over the {@link LineItem#costPerUnit} but avoids raising the actual {@link LineItem#costPerUnit}. This attribute is optional and defaults to a {@link Money} object in the local currency with {@link Money#microAmount} 0.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- costType - optional; type CostType - type string with restriction - enum { 'CPA', 'CPC', 'CPD', 'CPM', 'VCPM', 'CPM_IN_TARGET', 'UNKNOWN' }The method used for billing this {@code LineItem}. This attribute is required.
- discountType - optional; type LineItemDiscountType - type string with restriction - enum { 'ABSOLUTE_VALUE', 'PERCENTAGE' }The type of discount being applied to a {@code LineItem}, either percentage based or absolute. This attribute is optional and defaults to {@link LineItemDiscountType#PERCENTAGE}.
- discount - optional; type doubleThe number here is either a percentage or an absolute value depending on the {@code LineItemDiscountType}. If the {@code LineItemDiscountType} is {@link LineItemDiscountType#PERCENTAGE}, then only non-fractional values are supported.
- contractedUnitsBought - optional; type longThis attribute is only applicable for certain {@link #lineItemType line item types} and acts as an "FYI" or note, which does not impact adserving or other backend systems.
For {@link LineItemType#SPONSORSHIP} line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only.
For {@link LineItemType#STANDARD} line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this {@code LineItem}. This field is just a "FYI" for traffickers to manually intervene with the {@code LineItem} when needed. This attribute is only available for {@link LineItemType#STANDARD} line items if you have this feature enabled on your network.
- creativePlaceholders - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholder... is recursiveThe companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
Details about the creatives that are expected to serve through this {@code LineItem}. This attribute is required and replaces the {@code creativeSizes} attribute. - size - optional; type Size
- activityAssociations - optional, unbounded; type LineItemActivityAssociationA {@code LineItemActivityAssociation} associates a {@link LineItem} with an {@link Activity} so that the conversions of the {@link Activity} can be counted against the {@link LineItem}.
- activityId - optional; type intThe ID of the {@link Activity} to which the {@link LineItem} should be associated. This attribute is required.
- clickThroughConversionCost - optional; type MoneyThe amount of money to attribute per click through conversion. This attribute is required for creating a {@code LineItemActivityAssociation}. The currency code is readonly and should match the {@link LineItem}.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- viewThroughConversionCost - optional; type MoneyThe amount of money to attribute per view through conversion. This attribute is required for creating a {@code LineItemActivityAssociation}. The currency code is readonly and should match the {@link LineItem}.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
This attribute is required and meaningful only if the {@link LineItem#costType} is {@link CostType.CPA}. - activityId - optional; type int
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment that the {@code LineItem} is targeting. The default value is {@link EnvironmentType#BROWSER}. If this value is {@link EnvironmentType#VIDEO_PLAYER}, then this line item can only target {@code AdUnits} that have {@code AdUnitSizes} whose {@code environmentType} is also {@code VIDEO_PLAYER}.
- allowedFormats - optional, unbounded; type AllowedFormats - type string with restriction - enum { 'AUDIO', 'UNKNOWN' }The set of {@link allowedFormats} that this programmatic line item can have. If the set is empty, this line item allows all formats.
- companionDeliveryOption - optional; type CompanionDeliveryOption - type string with restriction - enum { 'OPTIONAL', 'AT_LEAST_ONE', 'ALL', 'UNKNOWN' }The delivery option for companions. Setting this field is only meaningful if the following conditions are met:
- The Guaranteed roadblocks feature is enabled on your network.
- One of the following is true (both cannot be true, these are mutually exclusive).
- The {@link #environmentType} is {@link EnvironmentType#VIDEO_PLAYER}.
- The {@link #roadblockingType} is {@link RoadblockingType#CREATIVE_SET}.
This field is optional and defaults to {@link CompanionDeliveryOption#OPTIONAL} if the above conditions are met. In all other cases it defaults to {@link CompanionDeliveryOption#UNKNOWN} and is not meaningful.
- allowOverbook - optional; type booleanThe flag indicates whether overbooking should be allowed when creating or updating reservations of line item types {@link LineItemType#SPONSORSHIP} and {@link LineItemType#STANDARD}. When true, operations on this line item will never trigger a {@link ForecastError}, which corresponds to an overbook warning in the UI. The default value is false.
Note: this field will not persist on the line item itself, and the value will only affect the current request.
- skipInventoryCheck - optional; type booleanThe flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false.
Note: this field will not persist on the line item itself, and the value will only affect the current request.
- skipCrossSellingRuleWarningChecks - optional; type booleanTrue to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false.
- reserveAtCreation - optional; type booleanThe flag indicates whether inventory should be reserved when creating a line item of types {@link LineItemType#SPONSORSHIP} and {@link LineItemType#STANDARD} in an unapproved {@link Order}. The default value is false.
- stats - optional; type StatsContains trafficking statistics for the line item. This attribute is readonly and is populated by Google. This will be {@code null} in case there are no statistics for a line item yet.{@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
- impressionsDelivered - optional; type longThe number of impressions delivered.
- clicksDelivered - optional; type longThe number of clicks delivered.
- videoCompletionsDelivered - optional; type longThe number of video completions delivered.
- videoStartsDelivered - optional; type longThe number of video starts delivered.
- viewableImpressionsDelivered - optional; type longThe number of viewable impressions delivered.
- impressionsDelivered - optional; type long
- deliveryIndicator - optional; type DeliveryIndicatorIndicates the delivery performance of the {@link LineItem}.
- expectedDeliveryPercentage - optional; type doubleHow much the {@code LineItem} was expected to deliver as a percentage of {@link LineItem#primaryGoal}.
- actualDeliveryPercentage - optional; type doubleHow much the line item actually delivered as a percentage of {@link LineItem#primaryGoal}.
Indicates how well the line item has been performing. This attribute is readonly and is populated by Google. This will be {@code null} if the delivery indicator information is not available due to one of the following reasons:- The line item is not delivering.
- The line item has an unlimited goal or cap.
- The line item has a percentage based goal or cap.
- expectedDeliveryPercentage - optional; type double
- deliveryData - optional; type DeliveryDataHolds the number of clicks or impressions, determined by {@link LineItem#costType}, delivered for a single line item for the last 7 days
- units - optional, unbounded; type longClicks or impressions delivered for the last 7 days.
Delivery data provides the number of clicks or impressions delivered for a {@link LineItem} in the last 7 days. This attribute is readonly and is populated by Google. This will be {@code null} if the delivery data cannot be computed due to one of the following reasons:- The line item is not deliverable.
- The line item has completed delivering more than 7 days ago.
- The line item has an absolute-based goal. {@link LineItem#deliveryIndicator} should be used to track its progress in this case.
- units - optional, unbounded; type long
- budget - optional; type MoneyThe amount of money allocated to the {@code LineItem}. This attribute is readonly and is populated by Google. The currency code is readonly.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- status - optional; type ComputedStatus - type string with restriction - enum { 'DELIVERY_EXTENDED', 'DELIVERING', 'READY', 'PAUSED', 'INACTIVE', 'PAUSED_INVENTORY_RELEASED', 'PENDING_APPROVAL', 'COMPLETED', 'DISAPPROVED', 'DRAFT', 'CANCELED' }The status of the {@code LineItem}. This attribute is readonly.
- reservationStatus - optional; type LineItemSummary.ReservationStatus - type string with restriction - enum { 'RESERVED', 'UNRESERVED' }Describes whether or not inventory has been reserved for the {@code LineItem}. This attribute is readonly and is assigned by Google.
- isArchived - optional; type booleanThe archival status of the {@code LineItem}. This attribute is readonly.
- webPropertyCode - optional; type stringThe web property code used for dynamic allocation line items. This web property is only required with line item types {@link LineItemType#AD_EXCHANGE} and {@link LineItemType#ADSENSE}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of labels applied directly to this line item. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google. - labelId - optional; type long
- disableSameAdvertiserCompetitiveExclusion - optional; type booleanIf a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to {@code true} will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.
- lastModifiedByApp - optional; type stringThe application that last modified this line item. This attribute is read only and is assigned by Google.
- notes - optional; type stringProvides any additional notes that may annotate the {@code LineItem}. This attribute is optional and has a maximum length of 65,535 characters.
- competitiveConstraintScope - optional; type CompetitiveConstraintScope - type string with restriction - enum { 'POD', 'STREAM', 'UNKNOWN' }The {@code CompetitiveConstraintScope} for the competitive exclusion labels assigned to this line item. This field is optional, defaults to {@link CompetitiveConstraintScope#POD}, and only applies to video line items.
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this line item was last modified. - date - optional; type Date
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
This attribute may be {@code null} for line items created before this feature was introduced. - date - optional; type Date
- customFieldValues - optional, unbounded; type BaseCustomFieldValueThe value of a {@link CustomField} for a particular entity.
- customFieldId - optional; type longId of the {@code CustomField} to which this value belongs. This attribute is required.
The values of the custom fields associated with this line item. - customFieldId - optional; type long
- isMissingCreatives - optional; type booleanIndicates if a {@code LineItem} is missing any {@link Creative creatives} for the {@code creativePlaceholders} specified.
{@link Creative Creatives} can be considered missing for several reasons including:
- Not enough {@link Creative creatives} of a certain size have been uploaded, as determined by {@link CreativePlaceholder#expectedCreativeCount}. For example a {@code LineItem} specifies 750x350, 400x200 but only a 750x350 was uploaded. Or {@code LineItem} specifies 750x350 with an expected count of 2, but only one was uploaded.
- The {@link Creative#appliedLabels} of an associated {@code Creative} do not match the {@link CreativePlaceholder#effectiveAppliedLabels} of the {@code LineItem}. For example {@code LineItem} specifies 750x350 with a Foo {@code AppliedLabel} but a 750x350 creative without a {@code AppliedLabel} was uploaded.
- programmaticCreativeSource - optional; type ProgrammaticCreativeSource - type string with restriction - enum { 'PUBLISHER', 'ADVERTISER', 'UNKNOWN' }Indicates the {@link ProgrammaticCreativeSource} of the programmatic line item. This is a read-only field. Any changes must be made on the {@link ProposalLineItem}.
- thirdPartyMeasurementSettings - optional; type ThirdPartyMeasurementSettingsContains third party auto-pixeling settings for cross-sell Partners.
- viewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }A field to determine the type of ThirdPartyViewabilityIntegrationPartner. This field default is NONE.
- viewabilityClientId - optional; type stringThe third party partner id for YouTube viewability verification.
- viewabilityReportingId - optional; type stringThe reporting id that maps viewability partner data with a campaign (or a group of related campaigns) specific data.
- publisherViewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }A field to determine the type of publisher's viewability partner. This field default is NONE.
- publisherViewabilityClientId - optional; type stringThe third party partner id for YouTube viewability verification for publisher.
- publisherViewabilityReportingId - optional; type stringThe reporting id that maps viewability partner data with a campaign (or a group of related campaigns) specific data for publisher.
- brandLiftPartner - optional; type ThirdPartyBrandLiftIntegrationPartner - type string with restriction - enum { 'UNKNOWN', 'NONE', 'KANTAR_MILLWARD_BROWN', 'DYNATA', 'INTAGE', 'MACROMILL' }A field to determine the type of ThirdPartyBrandLiftIntegrationPartner. This field default is NONE.
- brandLiftClientId - optional; type stringThe third party partner id for YouTube brand lift verification.
- brandLiftReportingId - optional; type stringThe reporting id that maps brand lift partner data with a campaign (or a group of related campaigns) specific data.
- reachPartner - optional; type ThirdPartyReachIntegrationPartner - type string with restriction - enum { 'NONE', 'COMSCORE', 'NIELSEN', 'KANTAR_MILLWARD_BROWN', 'VIDEO_RESEARCH', 'GEMIUS', 'VIDEO_AMP', 'ISPOT_TV', 'AUDIENCE_PROJECT', 'UNKNOWN' }A field to determine the type of advertiser's ThirdPartyReachIntegrationPartner. This field default is UNKNOWN.
- reachClientId - optional; type stringThe third party partner id for YouTube reach verification for advertiser.
- reachReportingId - optional; type stringThe reporting id that maps reach partner data with a campaign (or a group of related campaigns) specific data for advertiser.
- publisherReachPartner - optional; type ThirdPartyReachIntegrationPartner - type string with restriction - enum { 'NONE', 'COMSCORE', 'NIELSEN', 'KANTAR_MILLWARD_BROWN', 'VIDEO_RESEARCH', 'GEMIUS', 'VIDEO_AMP', 'ISPOT_TV', 'AUDIENCE_PROJECT', 'UNKNOWN' }A field to determine the type of publisher's ThirdPartyReachIntegrationPartner. This field default is UNKNOWN.
- publisherReachClientId - optional; type stringThe third party partner id for YouTube reach verification for publisher.
- publisherReachReportingId - optional; type stringThe reporting id that maps reach partner data with a campaign (or a group of related campaigns) specific data for publisher.
- viewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }
- youtubeKidsRestricted - optional; type booleanDesignates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the Ad Manager Help Center for more information.
- videoMaxDuration - optional; type longThe max duration of a video creative associated with this {@code LineItem} in milliseconds.
This attribute is only meaningful for video line items. For version v202011 and earlier, this attribute is optional and defaults to 0. For version v202102 and later, this attribute is required for video line items and must be greater than 0.
- primaryGoal - optional; type GoalDefines the criteria a {@link LineItem} needs to satisfy to meet its delivery goal.
- goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }The type of the goal for the {@code LineItem}. It defines the period over which the goal for {@code LineItem} should be reached.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The type of the goal unit for the {@code LineItem}.
- units - optional; type longIf this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the {@code LineItem}. If the line item is of type {@link LineItemType#SPONSORSHIP}, it represents the percentage of available impressions reserved. If the line item is of type {@link LineItemType#BULK} or {@link LineItemType#PRICE_PRIORITY}, it represents the number of remaining impressions reserved. If the line item is of type {@link LineItemType#NETWORK} or {@link LineItemType#HOUSE}, it represents the percentage of remaining impressions reserved.
If this is a secondary goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see {@link LineItem#secondaryGoals}.
The primary goal that this {@code LineItem} is associated with, which is used in its pacing and budgeting. - goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }
- secondaryGoals - optional, unbounded; type GoalDefines the criteria a {@link LineItem} needs to satisfy to meet its delivery goal.
- goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }The type of the goal for the {@code LineItem}. It defines the period over which the goal for {@code LineItem} should be reached.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The type of the goal unit for the {@code LineItem}.
- units - optional; type longIf this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the {@code LineItem}. If the line item is of type {@link LineItemType#SPONSORSHIP}, it represents the percentage of available impressions reserved. If the line item is of type {@link LineItemType#BULK} or {@link LineItemType#PRICE_PRIORITY}, it represents the number of remaining impressions reserved. If the line item is of type {@link LineItemType#NETWORK} or {@link LineItemType#HOUSE}, it represents the percentage of remaining impressions reserved.
If this is a secondary goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see {@link LineItem#secondaryGoals}.
The secondary goals that this {@code LineItem} is associated with. It is required and meaningful only if the {@link LineItem#costType} is {@link CostType.CPA} or if the {@link LineItem#lineItemType} is {@link LineItemType#SPONSORSHIP} and {@link LineItem#costType} is {@link CostType.CPM}. - goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }
- grpSettings - optional; type GrpSettings{@code GrpSettings} contains information for a line item that will have a target demographic when serving. This information will be used to set up tracking and enable reporting on the demographic information.
- minTargetAge - optional; type longSpecifies the minimum target age (in years) of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- maxTargetAge - optional; type longSpecifies the maximum target age (in years) of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- targetGender - optional; type GrpTargetGender - type string with restriction - enum { 'UNKNOWN', 'MALE', 'FEMALE', 'BOTH' }Specifies the target gender of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- provider - optional; type GrpProvider - type string with restriction - enum { 'UNKNOWN', 'NIELSEN' }Specifies the GRP provider of the {@link LineItem}.
- inTargetRatioEstimateMilliPercent - optional; type longEstimate for the in-target ratio given the line item's audience targeting. This field is only applicable if {@link #provider} is Nielsen, {@link LineItem#primaryGoal#unitType} is in-target impressions, and {@link LineItem#CostType} is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.
- nielsenCtvPacingType - optional; type NielsenCtvPacingType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'COVIEW', 'STRICT_COVIEW' }Specifies which pacing computation to apply in pacing to impressions from connected devices. This field is required if {@code enableNielsenCoViewingSupport} is true.
- pacingDeviceCategorizationType - optional; type PacingDeviceCategorizationType - type string with restriction - enum { 'UNKNOWN', 'GOOGLE', 'NIELSEN' }Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.
- applyTrueCoview - optional; type booleanSpecifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if NielsenCtvPacingType is not NONE.
Contains the information for a line item which has a target GRP demographic. - minTargetAge - optional; type long
- dealInfo - optional; type LineItemDealInfoDtoData transfer object for the exchange deal info of a line item.
- externalDealId - optional; type longThe external deal ID shared between seller and buyer. This field is only present if the deal has been finalized. This attribute is read-only and is assigned by Google.
The deal information associated with this line item, if it is programmatic. - externalDealId - optional; type long
- viewabilityProviderCompanyIds - optional, unbounded; type longOptional IDs of the {@link Company} that provide ad verification for this line item. {@link Company.Type#VIEWABILITY_PROVIDER}.
- childContentEligibility - optional; type ChildContentEligibility - type string with restriction - enum { 'UNKNOWN', 'DISALLOWED', 'ALLOWED' }Child content eligibility designation for this line item.
This field is optional and defaults to {@link ChildContentEligibility#DISALLOWED}.
- customVastExtension - optional; type stringCustom XML to be rendered in a custom VAST response at serving time.
- targeting - optional; type TargetingContains the targeting criteria for the ad campaign. This attribute is required.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- creativeTargetings - optional, unbounded; type CreativeTargetingRepresents the creative targeting criteria for a {@link LineItem}.
- name - optional; type stringThe name of this creative targeting. This attribute is required.
- targeting - optional; type TargetingThe {@link Targeting} criteria of this creative targeting. This attribute is required.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
A list of {@link CreativeTargeting} objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a creative placeholder's {@link CreativePlaceholder#targetingName} field by referencing the creative targeting's {@link CreativeTargeting#name name}. It also needs to be re-specified in the {@link LineItemCreativeAssociation#targetingName} field when associating a line item with a creative that fits into that placeholder. - name - optional; type string
The target of the forecast. If {@link LineItem#id} is null or no line item exists with that ID, then a forecast is computed for the subject, predicting what would happen if it were added to the network. If a line item already exists with {@link LineItem#id}, the forecast is computed for the subject, predicting what would happen if the existing line item's settings were modified to match the subject. - orderId - optional; type long
- proposalLineItem - optional; type ProposalLineItemA {@code ProposalLineItem} is added to a programmatic {@link Proposal} and is similar to a delivery {@link LineItem}. It contains delivery details including information like impression goal or quantity, start and end times, and targeting.
- id - optional; type longThe unique ID of the {@code ProposalLineItem}. This attribute is read-only.
- proposalId - optional; type longThe unique ID of the {@link Proposal}, to which the {@code ProposalLineItem} belongs. This attribute is required for creation and then is readonly. This attribute is required.
- name - optional; type stringThe name of the {@code ProposalLineItem} which should be unique under the same {@link Proposal}. This attribute has a maximum length of 255 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. This attribute is required.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time at which the line item associated with the {@code ProposalLineItem} is enabled to begin serving. This attribute is optional during creation, but required and must be in the future when it turns into a line item. The {@link DateTime#timeZoneID} is required if start date time is not {@code null}. This attribute becomes readonly once the {@code ProposalLineItem} has started delivering. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time at which the line item associated with the {@code ProposalLineItem} stops beening served. This attribute is optional during creation, but required and must be after the {@link #startDateTime}. The {@link DateTime#timeZoneID} is required if end date time is not {@code null}. - date - optional; type Date
- internalNotes - optional; type stringProvides any additional notes that may annotate the {@code ProposalLineItem}. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- isArchived - optional; type booleanThe archival status of the {@code ProposalLineItem}. This attribute is read-only.
- goal - optional; type GoalDefines the criteria a {@link LineItem} needs to satisfy to meet its delivery goal.
- goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }The type of the goal for the {@code LineItem}. It defines the period over which the goal for {@code LineItem} should be reached.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The type of the goal unit for the {@code LineItem}.
- units - optional; type longIf this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the {@code LineItem}. If the line item is of type {@link LineItemType#SPONSORSHIP}, it represents the percentage of available impressions reserved. If the line item is of type {@link LineItemType#BULK} or {@link LineItemType#PRICE_PRIORITY}, it represents the number of remaining impressions reserved. If the line item is of type {@link LineItemType#NETWORK} or {@link LineItemType#HOUSE}, it represents the percentage of remaining impressions reserved.
If this is a secondary goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see {@link LineItem#secondaryGoals}.
The goal(i.e. contracted quantity, quantity or limit) that this {@code ProposalLineItem} is associated with, which is used in its pacing and budgeting. {@link Goal#units} must be greater than 0 when the proposal line item turns into a line item, {@link Goal#goalType} and {@link Goal#unitType} are readonly. For a Preferred deal {@code ProposalLineItem}, the goal type can only be {@link GoalType#NONE}. This attribute is required. - goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }
- secondaryGoals - optional, unbounded; type GoalDefines the criteria a {@link LineItem} needs to satisfy to meet its delivery goal.
- goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }The type of the goal for the {@code LineItem}. It defines the period over which the goal for {@code LineItem} should be reached.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The type of the goal unit for the {@code LineItem}.
- units - optional; type longIf this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved for the {@code LineItem}. If the line item is of type {@link LineItemType#SPONSORSHIP}, it represents the percentage of available impressions reserved. If the line item is of type {@link LineItemType#BULK} or {@link LineItemType#PRICE_PRIORITY}, it represents the number of remaining impressions reserved. If the line item is of type {@link LineItemType#NETWORK} or {@link LineItemType#HOUSE}, it represents the percentage of remaining impressions reserved.
If this is a secondary goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see {@link LineItem#secondaryGoals}.
The secondary goals that this {@code ProposalLineItem} is associated with. For a programmatic line item with the properties {@link RateType#CPM} and {@link LineItemType#SPONSORSHIP}, this field will have one goal which describes the impressions cap. For other cases, this field is an empty list. - goalType - optional; type GoalType - type string with restriction - enum { 'NONE', 'LIFETIME', 'DAILY', 'UNKNOWN' }
- contractedUnitsBought - optional; type longThe contracted number of daily minimum impressions used for {@link LineItemType#SPONSORSHIP} {@code ProposalLineItem} deals with a rate type of {@link RateType#CPD}.
This attribute is required for percentage-based-goal {@link ProposalLineItem proposal line items}. It does not impact ad-serving and is for reporting purposes only.
- deliveryRateType - optional; type DeliveryRateType - type string with restriction - enum { 'EVENLY', 'FRONTLOADED', 'AS_FAST_AS_POSSIBLE' }The strategy for delivering ads over the course of the {@code ProposalLineItem}'s duration. This attribute is required. For a Preferred deal {@code ProposalLineItem}, the value can only be {@link DeliveryRateType#FRONTLOADED}.
- roadblockingType - optional; type RoadblockingType - type string with restriction - enum { 'ONLY_ONE', 'ONE_OR_MORE', 'AS_MANY_AS_POSSIBLE', 'ALL_ROADBLOCK', 'CREATIVE_SET' }The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional during creation and defaults to the {@link Product#roadblockingType product's roadblocking type}, or {@link RoadblockingType#ONE_OR_MORE} if not specified by the product.
- companionDeliveryOption - optional; type CompanionDeliveryOption - type string with restriction - enum { 'OPTIONAL', 'AT_LEAST_ONE', 'ALL', 'UNKNOWN' }The delivery option for companions. This is only valid if the roadblocking type is {@link RoadblockingType#CREATIVE_SET}. The default value for roadblocking creatives is {@link CompanionDeliveryOption#OPTIONAL}. The default value in other cases is {@link CompanionDeliveryOption#UNKNOWN}. Providing something other than {@link CompanionDeliveryOption#UNKNOWN} will cause an error.
- videoMaxDuration - optional; type longThe max duration of a video creative associated with this {@code ProposalLineItem} in milliseconds. This attribute is optional, defaults to the {@link Product#videoMaxDuration} on the {@link Product} it was created with, and only meaningful if this is a video proposal line item.
- videoCreativeSkippableAdType - optional; type SkippableAdType - type string with restriction - enum { 'UNKNOWN', 'DISABLED', 'ENABLED', 'INSTREAM_SELECT', 'ANY' }The proposal line item's creatives' skippability. This attribute is optional, only applicable for video proposal line items, and defaults to {@link SkippableAdType#NOT_SKIPPABLE}.
- frequencyCaps - optional, unbounded; type FrequencyCapRepresents a limit on the number of times a single viewer can be exposed to the same {@link LineItem} in a specified time period.
- maxImpressions - optional; type intThe maximum number of impressions than can be served to a user within a specified time period.
- numTimeUnits - optional; type intThe number of {@code FrequencyCap#timeUnit} to represent the total time period.
- timeUnit - optional; type TimeUnit - type string with restriction - enum { 'MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH', 'LIFETIME', 'POD', 'STREAM', 'UNKNOWN' }The unit of time for specifying the time period.
The set of frequency capping units for this {@code ProposalLineItem}. This attribute is optional during creation and defaults to the {@link Product#frequencyCaps product's frequency caps} if {@link Product#allowFrequencyCapsCustomization} is {@code false}. - maxImpressions - optional; type int
- dfpLineItemId - optional; type longThe unique ID of corresponding {@link LineItem}. This will be {@code null} if the {@link Proposal} has not been pushed to Ad Manager. This attribute is read-only.
- lineItemType - optional; type LineItemType - type string with restriction - enum { 'SPONSORSHIP', 'STANDARD', 'NETWORK', 'BULK', 'PRICE_PRIORITY', 'HOUSE', 'LEGACY_DFP', 'CLICK_TRACKING', 'ADSENSE', 'AD_EXCHANGE', 'BUMPER', 'ADMOB', 'PREFERRED_DEAL', 'UNKNOWN' }The corresponding {@link LineItemType} of the {@code ProposalLineItem}. For a programmatic {@code ProposalLineItem}, the value can only be one of:
- {@link LineItemType#SPONSORSHIP}
- {@link LineItemType#STANDARD}
- {@link LineItemType#PREFERRED_DEAL}
- lineItemPriority - optional; type intThe priority for the corresponding {@link LineItem} of the {@code ProposalLineItem}. This attribute is optional during creation and defaults to the default priority of the {@link #lineItemType}. For forecasting, this attribute is optional and has a default value assigned by Google. See {@link LineItem#priority} for more information.
- rateType - optional; type RateType - type string with restriction - enum { 'CPM', 'CPD', 'VCPM', 'CPM_IN_TARGET', 'UNKNOWN' }The method used for billing the {@code ProposalLineItem}. This attribute is read-only. This attribute is required.
- creativePlaceholders - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholder... is recursiveThe companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
Details about the creatives that are expected to serve through the {@code ProposalLineItem}. This attribute is optional during creation and defaults to the {@link Product#creativePlaceholders product's creative placeholders}. This attribute is required. - size - optional; type Size
- targeting - optional; type TargetingContains the targeting criteria for the {@code ProposalLineItem}. This attribute is required.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- customFieldValues - optional, unbounded; type BaseCustomFieldValueThe value of a {@link CustomField} for a particular entity.
- customFieldId - optional; type longId of the {@code CustomField} to which this value belongs. This attribute is required.
The values of the custom fields associated with the {@code ProposalLineItem}. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. - customFieldId - optional; type long
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of labels applied directly to the {@code ProposalLineItem}. This attribute is optional. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only. - labelId - optional; type long
- disableSameAdvertiserCompetitiveExclusion - optional; type booleanIf a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to {@code true} will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.
This attribute is optional and defaults to false.
- isSold - optional; type booleanIndicates whether this {@code ProposalLineItem} has been sold. This attribute is read-only.
- netRate - optional; type MoneyRepresents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
The amount of money to spend per impression or click in proposal currency. It supports precision of 4 decimal places in terms of the fundamental currency unit, so the {@link Money#getAmountInMicros} must be multiples of 100. It doesn't include agency commission.For example, if {@link Proposal#currencyCode} is 'USD', then $123.4567 could be represented as 123456700, but further precision is not supported.
The field {@link ProposalLineItem#netRate} is required, and used to calculate {@link ProposalLineItem#netCost} if unspecified.
- currencyCode - optional; type string
- netCost - optional; type MoneyRepresents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
The cost of the {@code ProposalLineItem} in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the {@link Money#getAmountInMicros} must be multiples of 10000. It doesn't include agency commission.For example, if {@link Proposal#currencyCode} is 'USD', then $123.45 could be represented as 123450000, but further precision is not supported.
The field {@link ProposalLineItem#netRate} is required, and used to calculate {@link ProposalLineItem#netCost} if unspecified.
- currencyCode - optional; type string
- deliveryIndicator - optional; type DeliveryIndicatorIndicates the delivery performance of the {@link LineItem}.
- expectedDeliveryPercentage - optional; type doubleHow much the {@code LineItem} was expected to deliver as a percentage of {@link LineItem#primaryGoal}.
- actualDeliveryPercentage - optional; type doubleHow much the line item actually delivered as a percentage of {@link LineItem#primaryGoal}.
Indicates how well the line item generated from this proposal line item has been performing. This will be {@code null} if the delivery indicator information is not available due to one of the following reasons:- The proposal line item has not pushed to Ad Manager.
- The line item is not delivering.
- The line item has an unlimited goal or cap.
- The line item has a percentage based goal or cap.
- expectedDeliveryPercentage - optional; type double
- deliveryData - optional; type DeliveryDataHolds the number of clicks or impressions, determined by {@link LineItem#costType}, delivered for a single line item for the last 7 days
- units - optional, unbounded; type longClicks or impressions delivered for the last 7 days.
Delivery data provides the number of clicks or impressions delivered for the {@link LineItem} generated from this proposal line item in the last 7 days. This will be {@code null} if the delivery data cannot be computed due to one of the following reasons:- The proposal line item has not pushed to Ad Manager.
- The line item is not deliverable.
- The line item has completed delivering more than 7 days ago.
- The line item has an absolute-based goal. {@link ProposalLineItem#deliveryIndicator} should be used to track its progress in this case. This attribute is read-only.
- units - optional, unbounded; type long
- computedStatus - optional; type ComputedStatus - type string with restriction - enum { 'DELIVERY_EXTENDED', 'DELIVERING', 'READY', 'PAUSED', 'INACTIVE', 'PAUSED_INVENTORY_RELEASED', 'PENDING_APPROVAL', 'COMPLETED', 'DISAPPROVED', 'DRAFT', 'CANCELED' }The status of the {@link LineItem} generated from this proposal line item. This will be {@code null} if the proposal line item has not pushed to Ad Manager. This attribute is read-only.
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code ProposalLineItem} was last modified.This attribute is assigned by Google when a {@code ProposalLineItem} is updated. This attribute is read-only.
- date - optional; type Date
- reservationStatus - optional; type ReservationStatus - type string with restriction - enum { 'RESERVED', 'NOT_RESERVED', 'RELEASED', 'CHECK_LINE_ITEM_RESERVATION_STATUS', 'UNKNOWN' }The reservation status of the {@link ProposalLineItem}. This attribute is read-only.
- lastReservationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The last {@link DateTime} when the {@link ProposalLineItem} reserved inventory. This attribute is read-only. - date - optional; type Date
- environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }The environment that the {@code ProposalLineItem} is targeting. The default value is {@link EnvironmentType#BROWSER}. If this value is {@link EnvironmentType#VIDEO_PLAYER}, then this {@code ProposalLineItem} can only target {@link AdUnit ad units} that have {@link AdUnitSize sizes} whose {@link AdUnitSize#environmentType} is also {@link EnvironmentType#VIDEO_PLAYER}.
This field is read-only and set to {@link Product#environmentType} of the product this proposal line item was created from.
- allowedFormats - optional, unbounded; type AllowedFormats - type string with restriction - enum { 'AUDIO', 'UNKNOWN' }The set of {@link AllowedFormats} that this proposal line item can have. If the set is empty, this proposal line item allows all formats.
- additionalTerms - optional; type stringAdditional terms shown to the buyer in Marketplace.
- programmaticCreativeSource - optional; type ProgrammaticCreativeSource - type string with restriction - enum { 'PUBLISHER', 'ADVERTISER', 'UNKNOWN' }Indicates the {@link ProgrammaticCreativeSource} of the programmatic line item.
- grpSettings - optional; type GrpSettings{@code GrpSettings} contains information for a line item that will have a target demographic when serving. This information will be used to set up tracking and enable reporting on the demographic information.
- minTargetAge - optional; type longSpecifies the minimum target age (in years) of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- maxTargetAge - optional; type longSpecifies the maximum target age (in years) of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- targetGender - optional; type GrpTargetGender - type string with restriction - enum { 'UNKNOWN', 'MALE', 'FEMALE', 'BOTH' }Specifies the target gender of the {@link LineItem}. This field is only applicable if {@link #provider} is not null.
- provider - optional; type GrpProvider - type string with restriction - enum { 'UNKNOWN', 'NIELSEN' }Specifies the GRP provider of the {@link LineItem}.
- inTargetRatioEstimateMilliPercent - optional; type longEstimate for the in-target ratio given the line item's audience targeting. This field is only applicable if {@link #provider} is Nielsen, {@link LineItem#primaryGoal#unitType} is in-target impressions, and {@link LineItem#CostType} is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.
- nielsenCtvPacingType - optional; type NielsenCtvPacingType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'COVIEW', 'STRICT_COVIEW' }Specifies which pacing computation to apply in pacing to impressions from connected devices. This field is required if {@code enableNielsenCoViewingSupport} is true.
- pacingDeviceCategorizationType - optional; type PacingDeviceCategorizationType - type string with restriction - enum { 'UNKNOWN', 'GOOGLE', 'NIELSEN' }Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.
- applyTrueCoview - optional; type booleanSpecifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if NielsenCtvPacingType is not NONE.
Contains the information for a proposal line item which has a target GRP demographic. - minTargetAge - optional; type long
- estimatedMinimumImpressions - optional; type longThe estimated minimum impressions that should be delivered for a proposal line item.
- thirdPartyMeasurementSettings - optional; type ThirdPartyMeasurementSettingsContains third party measurement settings for cross-sell PartnersContains third party auto-pixeling settings for cross-sell Partners.
- viewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }A field to determine the type of ThirdPartyViewabilityIntegrationPartner. This field default is NONE.
- viewabilityClientId - optional; type stringThe third party partner id for YouTube viewability verification.
- viewabilityReportingId - optional; type stringThe reporting id that maps viewability partner data with a campaign (or a group of related campaigns) specific data.
- publisherViewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }A field to determine the type of publisher's viewability partner. This field default is NONE.
- publisherViewabilityClientId - optional; type stringThe third party partner id for YouTube viewability verification for publisher.
- publisherViewabilityReportingId - optional; type stringThe reporting id that maps viewability partner data with a campaign (or a group of related campaigns) specific data for publisher.
- brandLiftPartner - optional; type ThirdPartyBrandLiftIntegrationPartner - type string with restriction - enum { 'UNKNOWN', 'NONE', 'KANTAR_MILLWARD_BROWN', 'DYNATA', 'INTAGE', 'MACROMILL' }A field to determine the type of ThirdPartyBrandLiftIntegrationPartner. This field default is NONE.
- brandLiftClientId - optional; type stringThe third party partner id for YouTube brand lift verification.
- brandLiftReportingId - optional; type stringThe reporting id that maps brand lift partner data with a campaign (or a group of related campaigns) specific data.
- reachPartner - optional; type ThirdPartyReachIntegrationPartner - type string with restriction - enum { 'NONE', 'COMSCORE', 'NIELSEN', 'KANTAR_MILLWARD_BROWN', 'VIDEO_RESEARCH', 'GEMIUS', 'VIDEO_AMP', 'ISPOT_TV', 'AUDIENCE_PROJECT', 'UNKNOWN' }A field to determine the type of advertiser's ThirdPartyReachIntegrationPartner. This field default is UNKNOWN.
- reachClientId - optional; type stringThe third party partner id for YouTube reach verification for advertiser.
- reachReportingId - optional; type stringThe reporting id that maps reach partner data with a campaign (or a group of related campaigns) specific data for advertiser.
- publisherReachPartner - optional; type ThirdPartyReachIntegrationPartner - type string with restriction - enum { 'NONE', 'COMSCORE', 'NIELSEN', 'KANTAR_MILLWARD_BROWN', 'VIDEO_RESEARCH', 'GEMIUS', 'VIDEO_AMP', 'ISPOT_TV', 'AUDIENCE_PROJECT', 'UNKNOWN' }A field to determine the type of publisher's ThirdPartyReachIntegrationPartner. This field default is UNKNOWN.
- publisherReachClientId - optional; type stringThe third party partner id for YouTube reach verification for publisher.
- publisherReachReportingId - optional; type stringThe reporting id that maps reach partner data with a campaign (or a group of related campaigns) specific data for publisher.
- viewabilityPartner - optional; type ThirdPartyViewabilityIntegrationPartner - type string with restriction - enum { 'NONE', 'MOAT', 'DOUBLE_VERIFY', 'INTEGRAL_AD_SCIENCE', 'COMSCORE', 'TELEMETRY', 'UNKNOWN' }
- makegoodInfo - optional; type ProposalLineItemMakegoodInfoMakegood info for this proposal line item. Immutable once created.
Null if this proposal line item is not a makegood.
Makegood info for a {@link ProposalLineItemDto}.- originalProposalLineItemId - optional; type longThe ID of the original proposal line item on which this makegood is based. This attribute is read-only.
- reason - optional; type stringThe publisher-provided reason why this makegood was initiated. This is free form text.
The following predefined values can be used to render predefined options in the UI.
UNDERDELIVERY: 'Impression underdelivery', SECONDARY_DELIVERY_TERMS: 'Did not meet secondary delivery terms ', PERFORMANCE: 'Performance issues',
- originalProposalLineItemId - optional; type long
- hasMakegood - optional; type booleanWhether this proposal line item has an associated makegood. This attribute is read-only.
- canCreateMakegood - optional; type booleanWhether a new makegood associated with this line item can be created. This attribute is read-only.
- pauseRole - optional; type NegotiationRole - type string with restriction - enum { 'BUYER', 'SELLER', 'UNKNOWN' }The {@link NegotiationRole} that paused the proposal line item, i.e. {@link NegotiationRole#seller} or {@link NegotiationRole#buyer}, or {@code null} when the proposal is not paused. This attribute is read-only.
- pauseReason - optional; type stringThe reason for pausing the {@link ProposalLineItem}, provided by the {@link pauseRole}. It is {@code null} when the {@link ProposalLineItem} is not paused. This attribute is read-only.
The target of the forecast if this prospective line item is a proposal line item.If {@link ProposalLineItem#id} is null or no proposal line item exists with that ID, then a forecast is computed for the subject, predicting what would happen if it were added to the network. If a proposal line item already exists with {@link ProposalLineItem#id}, the forecast is computed for the subject, predicting what would happen if the existing proposal line item's settings were modified to match the subject.
A proposal line item can optionally correspond to an order {@link LineItem}, in which case, by forecasting a proposal line item, the corresponding line item is implicitly ignored in the forecasting.
Either {@link #lineItem} or {@link #proposalLineItem} should be specified but not both.
- id - optional; type long
- advertiserId - optional; type longWhen set, the line item is assumed to be from this advertiser, and unified blocking rules will apply accordingly. If absent, line items without an existing order won't be subject to unified blocking rules.
- lineItem - optional; type LineItem - extension of type LineItemSummary
- forecastOptions - optional; type DeliveryForecastOptionsForecasting options for line item delivery forecasts.
- ignoredLineItemIds - optional, unbounded; type longLine item IDs to be ignored while performing the delivery simulation.
- ignoredLineItemIds - optional, unbounded; type long
Output:getDeliveryForecastResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getDeliveryForecastResponse- rval - optional; type DeliveryForecastThe forecast of delivery for a list of {@link ProspectiveLineItem} objects to be reserved at the same time.
- lineItemDeliveryForecasts - optional, unbounded; type LineItemDeliveryForecastThe delivery forecasts of the forecasted line items.The forecasted delivery of a {@link ProspectiveLineItem}.
- lineItemId - optional; type longUniquely identifies this line item delivery forecast. This value is read-only and will be either the ID of the {@link LineItem} object it represents, or {@code null} if the forecast represents a prospective line item.
- orderId - optional; type longThe unique ID for the {@link Order} object that this line item belongs to, or {@code null} if the forecast represents a prospective line item without an {@link LineItem#orderId} set.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The unit with which the goal or cap of the {@link LineItem} is defined. Will be the same value as {@link Goal#unitType} for both a set line item or a prospective one.
- predictedDeliveryUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that will be delivered by the line item. Delivery of existing line items that are of same or lower priorities may be impacted.
- deliveredUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that have already been served if the reservation is already running.
- matchedUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that match the specified {@link LineItem#targeting} and delivery settings.
- lineItemId - optional; type long
- lineItemDeliveryForecasts - optional, unbounded; type LineItemDeliveryForecast
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - lineItems - optional, unbounded; type ProspectiveLineItem
- getDeliveryForecastByIdsDescription:Gets the delivery forecast for a list of existing {@link LineItem} objects in a single delivery simulation. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getDeliveryForecastByIdsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getDeliveryForecastByIdsGets the delivery forecast for a list of existing {@link LineItem} objects in a single delivery simulation. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.
- lineItemIds - optional, unbounded; type long
- forecastOptions - optional; type DeliveryForecastOptionsForecasting options for line item delivery forecasts.
- ignoredLineItemIds - optional, unbounded; type longLine item IDs to be ignored while performing the delivery simulation.
- ignoredLineItemIds - optional, unbounded; type long
Output:getDeliveryForecastByIdsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getDeliveryForecastByIdsResponse- rval - optional; type DeliveryForecastThe forecast of delivery for a list of {@link ProspectiveLineItem} objects to be reserved at the same time.
- lineItemDeliveryForecasts - optional, unbounded; type LineItemDeliveryForecastThe delivery forecasts of the forecasted line items.The forecasted delivery of a {@link ProspectiveLineItem}.
- lineItemId - optional; type longUniquely identifies this line item delivery forecast. This value is read-only and will be either the ID of the {@link LineItem} object it represents, or {@code null} if the forecast represents a prospective line item.
- orderId - optional; type longThe unique ID for the {@link Order} object that this line item belongs to, or {@code null} if the forecast represents a prospective line item without an {@link LineItem#orderId} set.
- unitType - optional; type UnitType - type string with restriction - enum { 'IMPRESSIONS', 'CLICKS', 'CLICK_THROUGH_CPA_CONVERSIONS', 'VIEW_THROUGH_CPA_CONVERSIONS', 'TOTAL_CPA_CONVERSIONS', 'VIEWABLE_IMPRESSIONS', 'IN_TARGET_IMPRESSIONS', 'UNKNOWN' }The unit with which the goal or cap of the {@link LineItem} is defined. Will be the same value as {@link Goal#unitType} for both a set line item or a prospective one.
- predictedDeliveryUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that will be delivered by the line item. Delivery of existing line items that are of same or lower priorities may be impacted.
- deliveredUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that have already been served if the reservation is already running.
- matchedUnits - optional; type longThe number of units, defined by {@link Goal#unitType}, that match the specified {@link LineItem#targeting} and delivery settings.
- lineItemId - optional; type long
- lineItemDeliveryForecasts - optional, unbounded; type LineItemDeliveryForecast
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - getTrafficDataDescription:Returns forecasted and historical traffic data for the segment of traffic specified by the provided request.
Calling this endpoint programmatically is only available for Ad Manager 360 networks.
Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getTrafficDataRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getTrafficDataReturns forecasted and historical traffic data for the segment of traffic specified by the provided request.Calling this endpoint programmatically is only available for Ad Manager 360 networks.
- trafficDataRequest - optional; type TrafficDataRequestDefines a segment of traffic for which traffic data should be returned.
- targeting - optional; type TargetingContains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
The {@link TargetingDto} that defines a segment of traffic. This attribute is required. - geoTargeting - optional; type GeoTargeting
- requestedDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The date range for which traffic data are requested. This range may cover historical dates, future dates, or both.The data returned are not guaranteed to cover the entire requested date range. If sufficient data are not available to cover the entire requested date range, a response may be returned with a later start date, earlier end date, or both. This attribute is required.
- startDate - optional; type Date
- targeting - optional; type Targeting
Output:getTrafficDataResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getTrafficDataResponse- rval - optional; type TrafficDataResponseContains forecasted and historical traffic volume data describing a segment of traffic.
- historicalTimeSeries - optional; type TimeSeriesRepresents a chronological sequence of daily values.
- timeSeriesDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The date range of the time series. - startDate - optional; type Date
- values - optional, unbounded; type longThe daily values constituting the time series.
The number of time series values must equal the number of days spanned by the time series date range, inclusive. E.g.: {@code timeSeriesDateRange} of 2001-08-15 to 2001-08-17 should contain one value for the 15th, one value for the 16th, and one value for the 17th.
Time series of historical traffic ad opportunity counts.This may be null if the requested date range did not contain any historical dates, or if no historical data are available for the requested traffic segment. This attribute is read-only.
- timeSeriesDateRange - optional; type DateRange
- forecastedTimeSeries - optional; type TimeSeriesRepresents a chronological sequence of daily values.
- timeSeriesDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The date range of the time series. - startDate - optional; type Date
- values - optional, unbounded; type longThe daily values constituting the time series.
The number of time series values must equal the number of days spanned by the time series date range, inclusive. E.g.: {@code timeSeriesDateRange} of 2001-08-15 to 2001-08-17 should contain one value for the 15th, one value for the 16th, and one value for the 17th.
Time series of forecasted traffic ad opportunity counts.This may be null if the requested date range did not contain any future dates, or if no forecasted data are available for the requested traffic segment. This attribute is read-only.
- timeSeriesDateRange - optional; type DateRange
- forecastedAssignedTimeSeries - optional; type TimeSeriesRepresents a chronological sequence of daily values.
- timeSeriesDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The date range of the time series. - startDate - optional; type Date
- values - optional, unbounded; type longThe daily values constituting the time series.
The number of time series values must equal the number of days spanned by the time series date range, inclusive. E.g.: {@code timeSeriesDateRange} of 2001-08-15 to 2001-08-17 should contain one value for the 15th, one value for the 16th, and one value for the 17th.
Time series of future traffic volumes forecasted to be sold.This may be null if the requested date range did not contain any future dates, or if no sell-through data are available for the requested traffic segment. This attribute is read-only.
- timeSeriesDateRange - optional; type DateRange
- overallDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The overall date range spanned by the union of all time series in the response.This is a summary field for convenience. The value will be set such that the start date is equal to the earliest start date of all time series included, and the end date is equal to the latest end date of all time series included.
If all time series fields are null, this field will also be null. This attribute is read-only.
- startDate - optional; type Date
- historicalTimeSeries - optional; type TimeSeries
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - trafficDataRequest - optional; type TrafficDataRequest
Port type ForecastServiceInterfaceSource code
WSDL source code
About wsdl-viewer.xsl
Author: tomi vanek
Download athttp://tomi.vanek.sk/xml/wsdl-viewer.xsl.
The transformation was inspired by the article
Uche Ogbuji: WSDL processing with XSLT