com.google.api.ads.dfp.axis.v201203

Class LineItemSummary

java.lang.Object

com.google.api.ads.dfp.axis.v201203.LineItemSummary

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LineItem

public class LineItemSummary
extends Object
implements Serializable

The LineItemSummary represents the base class from which a LineItem is derived.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LineItemSummary()
LineItemSummary(Long orderId, Long id, String name, String externalId, String orderName, DateTime startDateTime, StartDateTimeType startDateTimeType, DateTime endDateTime, Integer autoExtensionDays, Boolean unlimitedEndDateTime, CreativeRotationType creativeRotationType, DeliveryRateType deliveryRateType, RoadblockingType roadblockingType, FrequencyCap[] frequencyCaps, LineItemType lineItemType, Integer priority, UnitType unitType, LineItemSummaryDuration duration, Long unitsBought, Money costPerUnit, Money valueCostPerUnit, CostType costType, LineItemDiscountType discountType, Double discount, Long contractedUnitsBought, CreativePlaceholder[] creativePlaceholders, TargetPlatform targetPlatform, EnvironmentType environmentType, CompanionDeliveryOption companionDeliveryOption, CreativePersistenceType creativePersistenceType, Boolean allowOverbook, Boolean reserveAtCreation, Stats stats, DeliveryIndicator deliveryIndicator, DeliveryData deliveryData, Money budget, ComputedStatus status, LineItemSummaryReservationStatus reservationStatus, Boolean isArchived, String webPropertyCode, AppliedLabel[] appliedLabels, AppliedLabel[] effectiveAppliedLabels, Boolean disableSameAdvertiserCompetitiveExclusion, String lastModifiedByApp, String notes, DateTime lastModifiedDateTime, String lineItemSummaryType)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAllowOverbook() Gets the allowOverbook value for this LineItemSummary.
AppliedLabel[]	getAppliedLabels() Gets the appliedLabels value for this LineItemSummary.
AppliedLabel	getAppliedLabels(int i)
Integer	getAutoExtensionDays() Gets the autoExtensionDays value for this LineItemSummary.
Money	getBudget() Gets the budget value for this LineItemSummary.
CompanionDeliveryOption	getCompanionDeliveryOption() Gets the companionDeliveryOption value for this LineItemSummary.
Long	getContractedUnitsBought() Gets the contractedUnitsBought value for this LineItemSummary.
Money	getCostPerUnit() Gets the costPerUnit value for this LineItemSummary.
CostType	getCostType() Gets the costType value for this LineItemSummary.
CreativePersistenceType	getCreativePersistenceType() Gets the creativePersistenceType value for this LineItemSummary.
CreativePlaceholder[]	getCreativePlaceholders() Gets the creativePlaceholders value for this LineItemSummary.
CreativePlaceholder	getCreativePlaceholders(int i)
CreativeRotationType	getCreativeRotationType() Gets the creativeRotationType value for this LineItemSummary.
DeliveryData	getDeliveryData() Gets the deliveryData value for this LineItemSummary.
DeliveryIndicator	getDeliveryIndicator() Gets the deliveryIndicator value for this LineItemSummary.
DeliveryRateType	getDeliveryRateType() Gets the deliveryRateType value for this LineItemSummary.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Boolean	getDisableSameAdvertiserCompetitiveExclusion() Gets the disableSameAdvertiserCompetitiveExclusion value for this LineItemSummary.
Double	getDiscount() Gets the discount value for this LineItemSummary.
LineItemDiscountType	getDiscountType() Gets the discountType value for this LineItemSummary.
LineItemSummaryDuration	getDuration() Gets the duration value for this LineItemSummary.
AppliedLabel[]	getEffectiveAppliedLabels() Gets the effectiveAppliedLabels value for this LineItemSummary.
AppliedLabel	getEffectiveAppliedLabels(int i)
DateTime	getEndDateTime() Gets the endDateTime value for this LineItemSummary.
EnvironmentType	getEnvironmentType() Gets the environmentType value for this LineItemSummary.
String	getExternalId() Gets the externalId value for this LineItemSummary.
FrequencyCap[]	getFrequencyCaps() Gets the frequencyCaps value for this LineItemSummary.
FrequencyCap	getFrequencyCaps(int i)
Long	getId() Gets the id value for this LineItemSummary.
Boolean	getIsArchived() Gets the isArchived value for this LineItemSummary.
String	getLastModifiedByApp() Gets the lastModifiedByApp value for this LineItemSummary.
DateTime	getLastModifiedDateTime() Gets the lastModifiedDateTime value for this LineItemSummary.
String	getLineItemSummaryType() Gets the lineItemSummaryType value for this LineItemSummary.
LineItemType	getLineItemType() Gets the lineItemType value for this LineItemSummary.
String	getName() Gets the name value for this LineItemSummary.
String	getNotes() Gets the notes value for this LineItemSummary.
Long	getOrderId() Gets the orderId value for this LineItemSummary.
String	getOrderName() Gets the orderName value for this LineItemSummary.
Integer	getPriority() Gets the priority value for this LineItemSummary.
LineItemSummaryReservationStatus	getReservationStatus() Gets the reservationStatus value for this LineItemSummary.
Boolean	getReserveAtCreation() Gets the reserveAtCreation value for this LineItemSummary.
RoadblockingType	getRoadblockingType() Gets the roadblockingType value for this LineItemSummary.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
DateTime	getStartDateTime() Gets the startDateTime value for this LineItemSummary.
StartDateTimeType	getStartDateTimeType() Gets the startDateTimeType value for this LineItemSummary.
Stats	getStats() Gets the stats value for this LineItemSummary.
ComputedStatus	getStatus() Gets the status value for this LineItemSummary.
TargetPlatform	getTargetPlatform() Gets the targetPlatform value for this LineItemSummary.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
Long	getUnitsBought() Gets the unitsBought value for this LineItemSummary.
UnitType	getUnitType() Gets the unitType value for this LineItemSummary.
Boolean	getUnlimitedEndDateTime() Gets the unlimitedEndDateTime value for this LineItemSummary.
Money	getValueCostPerUnit() Gets the valueCostPerUnit value for this LineItemSummary.
String	getWebPropertyCode() Gets the webPropertyCode value for this LineItemSummary.
int	hashCode()
void	setAllowOverbook(Boolean allowOverbook) Sets the allowOverbook value for this LineItemSummary.
void	setAppliedLabels(AppliedLabel[] appliedLabels) Sets the appliedLabels value for this LineItemSummary.
void	setAppliedLabels(int i, AppliedLabel _value)
void	setAutoExtensionDays(Integer autoExtensionDays) Sets the autoExtensionDays value for this LineItemSummary.
void	setBudget(Money budget) Sets the budget value for this LineItemSummary.
void	setCompanionDeliveryOption(CompanionDeliveryOption companionDeliveryOption) Sets the companionDeliveryOption value for this LineItemSummary.
void	setContractedUnitsBought(Long contractedUnitsBought) Sets the contractedUnitsBought value for this LineItemSummary.
void	setCostPerUnit(Money costPerUnit) Sets the costPerUnit value for this LineItemSummary.
void	setCostType(CostType costType) Sets the costType value for this LineItemSummary.
void	setCreativePersistenceType(CreativePersistenceType creativePersistenceType) Sets the creativePersistenceType value for this LineItemSummary.
void	setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders) Sets the creativePlaceholders value for this LineItemSummary.
void	setCreativePlaceholders(int i, CreativePlaceholder _value)
void	setCreativeRotationType(CreativeRotationType creativeRotationType) Sets the creativeRotationType value for this LineItemSummary.
void	setDeliveryData(DeliveryData deliveryData) Sets the deliveryData value for this LineItemSummary.
void	setDeliveryIndicator(DeliveryIndicator deliveryIndicator) Sets the deliveryIndicator value for this LineItemSummary.
void	setDeliveryRateType(DeliveryRateType deliveryRateType) Sets the deliveryRateType value for this LineItemSummary.
void	setDisableSameAdvertiserCompetitiveExclusion(Boolean disableSameAdvertiserCompetitiveExclusion) Sets the disableSameAdvertiserCompetitiveExclusion value for this LineItemSummary.
void	setDiscount(Double discount) Sets the discount value for this LineItemSummary.
void	setDiscountType(LineItemDiscountType discountType) Sets the discountType value for this LineItemSummary.
void	setDuration(LineItemSummaryDuration duration) Sets the duration value for this LineItemSummary.
void	setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels) Sets the effectiveAppliedLabels value for this LineItemSummary.
void	setEffectiveAppliedLabels(int i, AppliedLabel _value)
void	setEndDateTime(DateTime endDateTime) Sets the endDateTime value for this LineItemSummary.
void	setEnvironmentType(EnvironmentType environmentType) Sets the environmentType value for this LineItemSummary.
void	setExternalId(String externalId) Sets the externalId value for this LineItemSummary.
void	setFrequencyCaps(FrequencyCap[] frequencyCaps) Sets the frequencyCaps value for this LineItemSummary.
void	setFrequencyCaps(int i, FrequencyCap _value)
void	setId(Long id) Sets the id value for this LineItemSummary.
void	setIsArchived(Boolean isArchived) Sets the isArchived value for this LineItemSummary.
void	setLastModifiedByApp(String lastModifiedByApp) Sets the lastModifiedByApp value for this LineItemSummary.
void	setLastModifiedDateTime(DateTime lastModifiedDateTime) Sets the lastModifiedDateTime value for this LineItemSummary.
void	setLineItemSummaryType(String lineItemSummaryType) Sets the lineItemSummaryType value for this LineItemSummary.
void	setLineItemType(LineItemType lineItemType) Sets the lineItemType value for this LineItemSummary.
void	setName(String name) Sets the name value for this LineItemSummary.
void	setNotes(String notes) Sets the notes value for this LineItemSummary.
void	setOrderId(Long orderId) Sets the orderId value for this LineItemSummary.
void	setOrderName(String orderName) Sets the orderName value for this LineItemSummary.
void	setPriority(Integer priority) Sets the priority value for this LineItemSummary.
void	setReservationStatus(LineItemSummaryReservationStatus reservationStatus) Sets the reservationStatus value for this LineItemSummary.
void	setReserveAtCreation(Boolean reserveAtCreation) Sets the reserveAtCreation value for this LineItemSummary.
void	setRoadblockingType(RoadblockingType roadblockingType) Sets the roadblockingType value for this LineItemSummary.
void	setStartDateTime(DateTime startDateTime) Sets the startDateTime value for this LineItemSummary.
void	setStartDateTimeType(StartDateTimeType startDateTimeType) Sets the startDateTimeType value for this LineItemSummary.
void	setStats(Stats stats) Sets the stats value for this LineItemSummary.
void	setStatus(ComputedStatus status) Sets the status value for this LineItemSummary.
void	setTargetPlatform(TargetPlatform targetPlatform) Sets the targetPlatform value for this LineItemSummary.
void	setUnitsBought(Long unitsBought) Sets the unitsBought value for this LineItemSummary.
void	setUnitType(UnitType unitType) Sets the unitType value for this LineItemSummary.
void	setUnlimitedEndDateTime(Boolean unlimitedEndDateTime) Sets the unlimitedEndDateTime value for this LineItemSummary.
void	setValueCostPerUnit(Money valueCostPerUnit) Sets the valueCostPerUnit value for this LineItemSummary.
void	setWebPropertyCode(String webPropertyCode) Sets the webPropertyCode value for this LineItemSummary.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LineItemSummary

public LineItemSummary()

LineItemSummary

public LineItemSummary(Long orderId,
               Long id,
               String name,
               String externalId,
               String orderName,
               DateTime startDateTime,
               StartDateTimeType startDateTimeType,
               DateTime endDateTime,
               Integer autoExtensionDays,
               Boolean unlimitedEndDateTime,
               CreativeRotationType creativeRotationType,
               DeliveryRateType deliveryRateType,
               RoadblockingType roadblockingType,
               FrequencyCap[] frequencyCaps,
               LineItemType lineItemType,
               Integer priority,
               UnitType unitType,
               LineItemSummaryDuration duration,
               Long unitsBought,
               Money costPerUnit,
               Money valueCostPerUnit,
               CostType costType,
               LineItemDiscountType discountType,
               Double discount,
               Long contractedUnitsBought,
               CreativePlaceholder[] creativePlaceholders,
               TargetPlatform targetPlatform,
               EnvironmentType environmentType,
               CompanionDeliveryOption companionDeliveryOption,
               CreativePersistenceType creativePersistenceType,
               Boolean allowOverbook,
               Boolean reserveAtCreation,
               Stats stats,
               DeliveryIndicator deliveryIndicator,
               DeliveryData deliveryData,
               Money budget,
               ComputedStatus status,
               LineItemSummaryReservationStatus reservationStatus,
               Boolean isArchived,
               String webPropertyCode,
               AppliedLabel[] appliedLabels,
               AppliedLabel[] effectiveAppliedLabels,
               Boolean disableSameAdvertiserCompetitiveExclusion,
               String lastModifiedByApp,
               String notes,
               DateTime lastModifiedDateTime,
               String lineItemSummaryType)

Method Detail

getOrderId

public Long getOrderId()

Gets the orderId value for this LineItemSummary.

Returns:

orderId * The ID of the Order to which the LineItem belongs. This attribute is required.

setOrderId

public void setOrderId(Long orderId)

Sets the orderId value for this LineItemSummary.

Parameters:

orderId - * The ID of the Order to which the LineItem belongs. This attribute is required.

getId

public Long getId()

Gets the id value for this LineItemSummary.

Returns:

id * Uniquely identifies the LineItem. This attribute is read-only and is assigned by Google when a line item is created.

setId

public void setId(Long id)

Sets the id value for this LineItemSummary.

Parameters:

id - * Uniquely identifies the LineItem. This attribute is read-only and is assigned by Google when a line item is created.

getName

public String getName()

Gets the name value for this LineItemSummary.

Returns:

name * The name of the line item. This attribute is required and has a maximum length of 127 characters.

setName

public void setName(String name)

Sets the name value for this LineItemSummary.

Parameters:

name - * The name of the line item. This attribute is required and has a maximum length of 127 characters.

getExternalId

public String getExternalId()

Gets the externalId value for this LineItemSummary.

Returns:

externalId * An identifier for the LineItem that is meaningful to the publisher. This attribute is optional and has a maximum length of 63 characters.

setExternalId

public void setExternalId(String externalId)

Sets the externalId value for this LineItemSummary.

Parameters:

externalId - * An identifier for the LineItem that is meaningful to the publisher. This attribute is optional and has a maximum length of 63 characters.

getOrderName

public String getOrderName()

Gets the orderName value for this LineItemSummary.

Returns:

orderName * The name of the Order. This value is read-only.

setOrderName

public void setOrderName(String orderName)

Sets the orderName value for this LineItemSummary.

Parameters:

orderName - * The name of the Order. This value is read-only.

getStartDateTime

public DateTime getStartDateTime()

Gets the startDateTime value for this LineItemSummary.

Returns:

startDateTime * The date and time on which the LineItem is enabled to begin serving. This attribute is required and must be in the future.

setStartDateTime

public void setStartDateTime(DateTime startDateTime)

Sets the startDateTime value for this LineItemSummary.

Parameters:

startDateTime - * The date and time on which the LineItem is enabled to begin serving. This attribute is required and must be in the future.

getStartDateTimeType

public StartDateTimeType getStartDateTimeType()

Gets the startDateTimeType value for this LineItemSummary.

Returns:

startDateTimeType * Specifies whether to start serving to the LineItem right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.

setStartDateTimeType

public void setStartDateTimeType(StartDateTimeType startDateTimeType)

Sets the startDateTimeType value for this LineItemSummary.

Parameters:

startDateTimeType - * Specifies whether to start serving to the LineItem right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.

getEndDateTime

public DateTime getEndDateTime()

Gets the endDateTime value for this LineItemSummary.

Returns:

endDateTime * The date and time on which the LineItem stops serving. This attribute is required unless unlimitedEndDateTime is set to true. If specified, it must be after the startDateTime.

setEndDateTime

public void setEndDateTime(DateTime endDateTime)

Sets the endDateTime value for this LineItemSummary.

Parameters:

endDateTime - * The date and time on which the LineItem stops serving. This attribute is required unless unlimitedEndDateTime is set to true. If specified, it must be after the startDateTime.

getAutoExtensionDays

public Integer getAutoExtensionDays()

Gets the autoExtensionDays value for this LineItemSummary.

Returns:

autoExtensionDays * The number of days to allow a line item to deliver past its endDateTime. A maximum of 7 days is allowed. This is a premium feature available for LineItemType.STANDARD line items.

setAutoExtensionDays

public void setAutoExtensionDays(Integer autoExtensionDays)

Sets the autoExtensionDays value for this LineItemSummary.

Parameters:

autoExtensionDays - * The number of days to allow a line item to deliver past its endDateTime. A maximum of 7 days is allowed. This is a premium feature available for LineItemType.STANDARD line items.

getUnlimitedEndDateTime

public Boolean getUnlimitedEndDateTime()

Gets the unlimitedEndDateTime value for this LineItemSummary.

Returns:

unlimitedEndDateTime * Specifies whether or not the LineItem has an end time. This attribute is optional and defaults to false. It can be be set to true for only line items of type LineItemType.SPONSORSHIP, LineItemType.NETWORK, LineItemType.PRICE_PRIORITY and LineItemType.HOUSE.

setUnlimitedEndDateTime

public void setUnlimitedEndDateTime(Boolean unlimitedEndDateTime)

Sets the unlimitedEndDateTime value for this LineItemSummary.

Parameters:

unlimitedEndDateTime - * Specifies whether or not the LineItem has an end time. This attribute is optional and defaults to false. It can be be set to true for only line items of type LineItemType.SPONSORSHIP, LineItemType.NETWORK, LineItemType.PRICE_PRIORITY and LineItemType.HOUSE.

getCreativeRotationType

public CreativeRotationType getCreativeRotationType()

Gets the creativeRotationType value for this LineItemSummary.

Returns:

creativeRotationType * The strategy used for displaying multiple Creative objects that are associated with the LineItem. This attribute is required.

setCreativeRotationType

public void setCreativeRotationType(CreativeRotationType creativeRotationType)

Sets the creativeRotationType value for this LineItemSummary.

Parameters:

creativeRotationType - * The strategy used for displaying multiple Creative objects that are associated with the LineItem. This attribute is required.

getDeliveryRateType

public DeliveryRateType getDeliveryRateType()

Gets the deliveryRateType value for this LineItemSummary.

Returns:

deliveryRateType * The strategy for delivering ads over the course of the line item's duration. This attribute is optional and defaults to DeliveryRateType.EVENLY.

setDeliveryRateType

public void setDeliveryRateType(DeliveryRateType deliveryRateType)

Sets the deliveryRateType value for this LineItemSummary.

Parameters:

deliveryRateType - * The strategy for delivering ads over the course of the line item's duration. This attribute is optional and defaults to DeliveryRateType.EVENLY.

getRoadblockingType

public RoadblockingType getRoadblockingType()

Gets the roadblockingType value for this LineItemSummary.

Returns:

roadblockingType * 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 RoadblockingType.ONE_OR_MORE.

setRoadblockingType

public void setRoadblockingType(RoadblockingType roadblockingType)

Sets the roadblockingType value for this LineItemSummary.

Parameters:

roadblockingType - * 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 RoadblockingType.ONE_OR_MORE.

getFrequencyCaps

public FrequencyCap[] getFrequencyCaps()

Gets the frequencyCaps value for this LineItemSummary.

Returns:

frequencyCaps * The set of frequency capping units for this LineItem. This attribute is optional.

setFrequencyCaps

public void setFrequencyCaps(FrequencyCap[] frequencyCaps)

Sets the frequencyCaps value for this LineItemSummary.

Parameters:

frequencyCaps - * The set of frequency capping units for this LineItem. This attribute is optional.

getFrequencyCaps

public FrequencyCap getFrequencyCaps(int i)

setFrequencyCaps

public void setFrequencyCaps(int i,
                    FrequencyCap _value)

getLineItemType

public LineItemType getLineItemType()

Gets the lineItemType value for this LineItemSummary.

Returns:

lineItemType * Indicates the line item type of a LineItem. This attribute is required.

setLineItemType

public void setLineItemType(LineItemType lineItemType)

Sets the lineItemType value for this LineItemSummary.

Parameters:

lineItemType - * Indicates the line item type of a LineItem. This attribute is required.

getPriority

public Integer getPriority()

Gets the priority value for this LineItemSummary.

Returns:

priority * The priority for the line item. The priority is a value between 1 and 16. If not specified, the default priority of the LineItemType will be assigned. The following default, minimum and maximum priority values is allowed for each line item type:

LineItemType	Default Priority	Minimum Priority	Maximum priority
LineItemType.SPONSORSHIP	4	2	5
LineItemType.STANDARD	8	6	10
LineItemType.NETWORK	12	11	14
LineItemType.BULK	12	11	14
LineItemType.PRICE_PRIORITY	12	11	14
LineItemType.HOUSE	16	15	16
LineItemType.CLICK_TRACKING	16	1	16
LineItemType.AD_EXCHANGE	12	1	16
LineItemType.ADSENSE	12	1	16
LineItemType.BUMPER	16	15	16

This field can only be edited by certain networks, otherwise a PermissionError will occur.

setPriority

public void setPriority(Integer priority)

Sets the priority value for this LineItemSummary.

Parameters:

priority - * The priority for the line item. The priority is a value between 1 and 16. If not specified, the default priority of the LineItemType will be assigned. The following default, minimum and maximum priority values is allowed for each line item type:

LineItemType	Default Priority	Minimum Priority	Maximum priority
LineItemType.SPONSORSHIP	4	2	5
LineItemType.STANDARD	8	6	10
LineItemType.NETWORK	12	11	14
LineItemType.BULK	12	11	14
LineItemType.PRICE_PRIORITY	12	11	14
LineItemType.HOUSE	16	15	16
LineItemType.CLICK_TRACKING	16	1	16
LineItemType.AD_EXCHANGE	12	1	16
LineItemType.ADSENSE	12	1	16
LineItemType.BUMPER	16	15	16

This field can only be edited by certain networks, otherwise a PermissionError will occur.

getUnitType

public UnitType getUnitType()

Gets the unitType value for this LineItemSummary.

Returns:

unitType * The unit with which the goal or cap of the LineItem is defined. If this attribute is not explicitly set, Google derives this attribute from costType. If costType is CostType.CPC, then UnitType.CLICKS is assumed, otherwise UnitType.IMPRESSIONS is assumed.

setUnitType

public void setUnitType(UnitType unitType)

Sets the unitType value for this LineItemSummary.

Parameters:

unitType - * The unit with which the goal or cap of the LineItem is defined. If this attribute is not explicitly set, Google derives this attribute from costType. If costType is CostType.CPC, then UnitType.CLICKS is assumed, otherwise UnitType.IMPRESSIONS is assumed.

getDuration

public LineItemSummaryDuration getDuration()

Gets the duration value for this LineItemSummary.

Returns:

duration * The period over which the goal or cap for LineItem should be reached. This attribute is optional. For each line item type, the following are the valid and default values:

LineItemType	Valid duration values	Default duration value
SPONSORSHIP	DAILY	DAILY
STANDARD	LIFETIME	LIFETIME
NETWORK	DAILY	DAILY
BULK	LIFETIME	LIFETIME
PRICE_PRIORITY	DAILY, LIFETIME	LIFETIME
HOUSE	DAILY	DAILY

setDuration

public void setDuration(LineItemSummaryDuration duration)

Sets the duration value for this LineItemSummary.

Parameters:

duration - * The period over which the goal or cap for LineItem should be reached. This attribute is optional. For each line item type, the following are the valid and default values:

LineItemType	Valid duration values	Default duration value
SPONSORSHIP	DAILY	DAILY
STANDARD	LIFETIME	LIFETIME
NETWORK	DAILY	DAILY
BULK	LIFETIME	LIFETIME
PRICE_PRIORITY	DAILY, LIFETIME	LIFETIME
HOUSE	DAILY	DAILY

getUnitsBought

public Long getUnitsBought()

Gets the unitsBought value for this LineItemSummary.

Returns:

unitsBought * The total number of impressions or clicks that will be reserved for the LineItem. If the line item is of type LineItemType.SPONSORSHIP, then it represents the percentage of available impressions reserved. This attribute is required and must be greater than 0.

setUnitsBought

public void setUnitsBought(Long unitsBought)

Sets the unitsBought value for this LineItemSummary.

Parameters:

unitsBought - * The total number of impressions or clicks that will be reserved for the LineItem. If the line item is of type LineItemType.SPONSORSHIP, then it represents the percentage of available impressions reserved. This attribute is required and must be greater than 0.

getCostPerUnit

public Money getCostPerUnit()

Gets the costPerUnit value for this LineItemSummary.

Returns:

costPerUnit * The amount of money to spend per impression or click. This attribute is required for creating a LineItem. The currency code is readonly.

setCostPerUnit

public void setCostPerUnit(Money costPerUnit)

Sets the costPerUnit value for this LineItemSummary.

Parameters:

costPerUnit - * The amount of money to spend per impression or click. This attribute is required for creating a LineItem. The currency code is readonly.

getValueCostPerUnit

public Money getValueCostPerUnit()

Gets the valueCostPerUnit value for this LineItemSummary.

Returns:

valueCostPerUnit * An amount to help the adserver rank inventory. valueCostPerUnit artificially raises the value of inventory over the costPerUnit but avoids raising the actual costPerUnit. This attribute is optional and defaults to a Money object in the local currency with Money.microAmount 0. The currency code is readonly.

setValueCostPerUnit

public void setValueCostPerUnit(Money valueCostPerUnit)

Sets the valueCostPerUnit value for this LineItemSummary.

Parameters:

valueCostPerUnit - * An amount to help the adserver rank inventory. valueCostPerUnit artificially raises the value of inventory over the costPerUnit but avoids raising the actual costPerUnit. This attribute is optional and defaults to a Money object in the local currency with Money.microAmount 0. The currency code is readonly.

getCostType

public CostType getCostType()

Gets the costType value for this LineItemSummary.

Returns:

costType * The method used for billing this LineItem. This attribute is required.

setCostType

public void setCostType(CostType costType)

Sets the costType value for this LineItemSummary.

Parameters:

costType - * The method used for billing this LineItem. This attribute is required.

getDiscountType

public LineItemDiscountType getDiscountType()

Gets the discountType value for this LineItemSummary.

Returns:

discountType * The type of discount being applied to a LineItem, either percentage based or absolute. This attribute is optional and defaults to LineItemDiscountType.PERCENTAGE.

setDiscountType

public void setDiscountType(LineItemDiscountType discountType)

Sets the discountType value for this LineItemSummary.

Parameters:

discountType - * The type of discount being applied to a LineItem, either percentage based or absolute. This attribute is optional and defaults to LineItemDiscountType.PERCENTAGE.

getDiscount

public Double getDiscount()

Gets the discount value for this LineItemSummary.

Returns:

discount * The number here is either a percentage or an absolute value depending on the LineItemDiscountType. If the LineItemDiscountType is LineItemDiscountType.PERCENTAGE, then only non-fractional values are supported.

setDiscount

public void setDiscount(Double discount)

Sets the discount value for this LineItemSummary.

Parameters:

discount - * The number here is either a percentage or an absolute value depending on the LineItemDiscountType. If the LineItemDiscountType is LineItemDiscountType.PERCENTAGE, then only non-fractional values are supported.

getContractedUnitsBought

public Long getContractedUnitsBought()

Gets the contractedUnitsBought value for this LineItemSummary.

Returns:

contractedUnitsBought * Number of units as specified in the contract that the advertiser has bought for this LineItem. This field is just a "FYI" for the trafficker to manually intervene with the LineItem when needed, it doesn't impact adserving or other backend systems. The default value is 0, which means contracted units bought is not set

setContractedUnitsBought

public void setContractedUnitsBought(Long contractedUnitsBought)

Sets the contractedUnitsBought value for this LineItemSummary.

Parameters:

contractedUnitsBought - * Number of units as specified in the contract that the advertiser has bought for this LineItem. This field is just a "FYI" for the trafficker to manually intervene with the LineItem when needed, it doesn't impact adserving or other backend systems. The default value is 0, which means contracted units bought is not set

getCreativePlaceholders

public CreativePlaceholder[] getCreativePlaceholders()

Gets the creativePlaceholders value for this LineItemSummary.

Returns:

creativePlaceholders * Details about the creatives that are expected to serve through this LineItem. This attribute is required and replaces the creativeSizes attribute.

setCreativePlaceholders

public void setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders)

Sets the creativePlaceholders value for this LineItemSummary.

Parameters:

creativePlaceholders - * Details about the creatives that are expected to serve through this LineItem. This attribute is required and replaces the creativeSizes attribute.

getCreativePlaceholders

public CreativePlaceholder getCreativePlaceholders(int i)

setCreativePlaceholders

public void setCreativePlaceholders(int i,
                           CreativePlaceholder _value)

getTargetPlatform

public TargetPlatform getTargetPlatform()

Gets the targetPlatform value for this LineItemSummary.

Returns:

targetPlatform * The platform that the LineItem is targeting, the default value is TargetPlatform.WEB. Line items will only serve to ad units that have the same AdUnit.targetPlatform.

setTargetPlatform

public void setTargetPlatform(TargetPlatform targetPlatform)

Sets the targetPlatform value for this LineItemSummary.

Parameters:

targetPlatform - * The platform that the LineItem is targeting, the default value is TargetPlatform.WEB. Line items will only serve to ad units that have the same AdUnit.targetPlatform.

getEnvironmentType

public EnvironmentType getEnvironmentType()

Gets the environmentType value for this LineItemSummary.

Returns:

environmentType * The environment that the LineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.

setEnvironmentType

public void setEnvironmentType(EnvironmentType environmentType)

Sets the environmentType value for this LineItemSummary.

Parameters:

environmentType - * The environment that the LineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.

getCompanionDeliveryOption

public CompanionDeliveryOption getCompanionDeliveryOption()

Gets the companionDeliveryOption value for this LineItemSummary.

Returns:

companionDeliveryOption * The delivery option for companions. This is only valid if the environment type is EnvironmentType.VIDEO_PLAYER or the roadblocking type is RoadblockingType#CREATIVE_SET. The default value for video environments or roadblocking creatives is CompanionDeliveryOption.OPTIONAL. The default value in other cases is CompanionDeliveryOption.UNKNOWN. Providing something other than CompanionDeliveryOption.UNKNOWN will cause an error.

setCompanionDeliveryOption

public void setCompanionDeliveryOption(CompanionDeliveryOption companionDeliveryOption)

Sets the companionDeliveryOption value for this LineItemSummary.

Parameters:

companionDeliveryOption - * The delivery option for companions. This is only valid if the environment type is EnvironmentType.VIDEO_PLAYER or the roadblocking type is RoadblockingType#CREATIVE_SET. The default value for video environments or roadblocking creatives is CompanionDeliveryOption.OPTIONAL. The default value in other cases is CompanionDeliveryOption.UNKNOWN. Providing something other than CompanionDeliveryOption.UNKNOWN will cause an error.

getCreativePersistenceType

public CreativePersistenceType getCreativePersistenceType()

Gets the creativePersistenceType value for this LineItemSummary.

Returns:

creativePersistenceType * Specifies options to prevent ads from replacing or appearing with this LineItem.

setCreativePersistenceType

public void setCreativePersistenceType(CreativePersistenceType creativePersistenceType)

Sets the creativePersistenceType value for this LineItemSummary.

Parameters:

creativePersistenceType - * Specifies options to prevent ads from replacing or appearing with this LineItem.

getAllowOverbook

public Boolean getAllowOverbook()

Gets the allowOverbook value for this LineItemSummary.

Returns:

allowOverbook * The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types LineItemType.SPONSORSHIP and LineItemType.STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false.

setAllowOverbook

public void setAllowOverbook(Boolean allowOverbook)

Sets the allowOverbook value for this LineItemSummary.

Parameters:

allowOverbook - * The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types LineItemType.SPONSORSHIP and LineItemType.STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false.

getReserveAtCreation

public Boolean getReserveAtCreation()

Gets the reserveAtCreation value for this LineItemSummary.

Returns:

reserveAtCreation * The flag indicates whether inventory should be reserved when creating a line item of types LineItemType.SPONSORSHIP and LineItemType.STANDARD in an unapproved Order. The default value is false.

setReserveAtCreation

public void setReserveAtCreation(Boolean reserveAtCreation)

Sets the reserveAtCreation value for this LineItemSummary.

Parameters:

reserveAtCreation - * The flag indicates whether inventory should be reserved when creating a line item of types LineItemType.SPONSORSHIP and LineItemType.STANDARD in an unapproved Order. The default value is false.

getStats

public Stats getStats()

Gets the stats value for this LineItemSummary.

Returns:

stats * Contains trafficking statistics for the line item. This attribute is readonly and is populated by Google. This will be null in case there are no statistics for a line item yet.

setStats

public void setStats(Stats stats)

Sets the stats value for this LineItemSummary.

Parameters:

stats - * Contains trafficking statistics for the line item. This attribute is readonly and is populated by Google. This will be null in case there are no statistics for a line item yet.

getDeliveryIndicator

public DeliveryIndicator getDeliveryIndicator()

Gets the deliveryIndicator value for this LineItemSummary.

Returns:

deliveryIndicator * Indicates how well the line item has been performing. This attribute is readonly and is populated by Google. This will be null if the delivery indicator information is not available due to one of the following reasons:

1. The line item is not delivering.
2. The line item has an unlimited goal or cap.
3. The line item has a percentage based goal or cap.

setDeliveryIndicator

public void setDeliveryIndicator(DeliveryIndicator deliveryIndicator)

Sets the deliveryIndicator value for this LineItemSummary.

Parameters:

deliveryIndicator - * Indicates how well the line item has been performing. This attribute is readonly and is populated by Google. This will be null if the delivery indicator information is not available due to one of the following reasons:

1. The line item is not delivering.
2. The line item has an unlimited goal or cap.
3. The line item has a percentage based goal or cap.

getDeliveryData

public DeliveryData getDeliveryData()

Gets the deliveryData value for this LineItemSummary.

Returns:

deliveryData * Delivery data provides the number of clicks or impressions delivered for a LineItem in the last 7 days. This attribute is readonly and is populated by Google. This will be null if the delivery data cannot be computed due to one of the following reasons:

1. The line item is not deliverable.
2. The line item has completed delivering more than 7 days ago.
3. The line item has an absolute-based goal. deliveryIndicator should be used to track its progress in this case.

setDeliveryData

public void setDeliveryData(DeliveryData deliveryData)

Sets the deliveryData value for this LineItemSummary.

Parameters:

deliveryData - * Delivery data provides the number of clicks or impressions delivered for a LineItem in the last 7 days. This attribute is readonly and is populated by Google. This will be null if the delivery data cannot be computed due to one of the following reasons:

1. The line item is not deliverable.
2. The line item has completed delivering more than 7 days ago.
3. The line item has an absolute-based goal. deliveryIndicator should be used to track its progress in this case.

getBudget

public Money getBudget()

Gets the budget value for this LineItemSummary.

Returns:

budget * The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.

setBudget

public void setBudget(Money budget)

Sets the budget value for this LineItemSummary.

Parameters:

budget - * The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.

getStatus

public ComputedStatus getStatus()

Gets the status value for this LineItemSummary.

Returns:

status * The status of the LineItem. This attribute is readonly.

setStatus

public void setStatus(ComputedStatus status)

Sets the status value for this LineItemSummary.

Parameters:

status - * The status of the LineItem. This attribute is readonly.

getReservationStatus

public LineItemSummaryReservationStatus getReservationStatus()

Gets the reservationStatus value for this LineItemSummary.

Returns:

reservationStatus * Describes whether or not inventory has been reserved for the LineItem. This attribute is readonly and is assigned by Google.

setReservationStatus

public void setReservationStatus(LineItemSummaryReservationStatus reservationStatus)

Sets the reservationStatus value for this LineItemSummary.

Parameters:

reservationStatus - * Describes whether or not inventory has been reserved for the LineItem. This attribute is readonly and is assigned by Google.

getIsArchived

public Boolean getIsArchived()

Gets the isArchived value for this LineItemSummary.

Returns:

isArchived * The archival status of the Order. This attribute is readonly.

setIsArchived

public void setIsArchived(Boolean isArchived)

Sets the isArchived value for this LineItemSummary.

Parameters:

isArchived - * The archival status of the Order. This attribute is readonly.

getWebPropertyCode

public String getWebPropertyCode()

Gets the webPropertyCode value for this LineItemSummary.

Returns:

webPropertyCode * The web property code used for dynamic allocation line items. This web property is only required with line item types LineItemType.AD_EXCHANGE and LineItemType.ADSENSE.

setWebPropertyCode

public void setWebPropertyCode(String webPropertyCode)

Sets the webPropertyCode value for this LineItemSummary.

Parameters:

webPropertyCode - * The web property code used for dynamic allocation line items. This web property is only required with line item types LineItemType.AD_EXCHANGE and LineItemType.ADSENSE.

getAppliedLabels

public AppliedLabel[] getAppliedLabels()

Gets the appliedLabels value for this LineItemSummary.

Returns:

appliedLabels * The set of labels applied directly to this line item.

setAppliedLabels

public void setAppliedLabels(AppliedLabel[] appliedLabels)

Sets the appliedLabels value for this LineItemSummary.

Parameters:

appliedLabels - * The set of labels applied directly to this line item.

getAppliedLabels

public AppliedLabel getAppliedLabels(int i)

setAppliedLabels

public void setAppliedLabels(int i,
                    AppliedLabel _value)

getEffectiveAppliedLabels

public AppliedLabel[] getEffectiveAppliedLabels()

Gets the effectiveAppliedLabels value for this LineItemSummary.

Returns:

effectiveAppliedLabels * Contains the set of labels applied directly to the line item as well as those 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.

setEffectiveAppliedLabels

public void setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels)

Sets the effectiveAppliedLabels value for this LineItemSummary.

Parameters:

effectiveAppliedLabels - * Contains the set of labels applied directly to the line item as well as those 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.

getEffectiveAppliedLabels

public AppliedLabel getEffectiveAppliedLabels(int i)

setEffectiveAppliedLabels

public void setEffectiveAppliedLabels(int i,
                             AppliedLabel _value)

getDisableSameAdvertiserCompetitiveExclusion

public Boolean getDisableSameAdvertiserCompetitiveExclusion()

Gets the disableSameAdvertiserCompetitiveExclusion value for this LineItemSummary.

Returns:

disableSameAdvertiserCompetitiveExclusion * If 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 true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.

setDisableSameAdvertiserCompetitiveExclusion

public void setDisableSameAdvertiserCompetitiveExclusion(Boolean disableSameAdvertiserCompetitiveExclusion)

Sets the disableSameAdvertiserCompetitiveExclusion value for this LineItemSummary.

Parameters:

disableSameAdvertiserCompetitiveExclusion - * If 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 true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.

getLastModifiedByApp

public String getLastModifiedByApp()

Gets the lastModifiedByApp value for this LineItemSummary.

Returns:

lastModifiedByApp * The application that last modified this line item. This attribute is read only and is assigned by Google.

setLastModifiedByApp

public void setLastModifiedByApp(String lastModifiedByApp)

Sets the lastModifiedByApp value for this LineItemSummary.

Parameters:

lastModifiedByApp - * The application that last modified this line item. This attribute is read only and is assigned by Google.

getNotes

public String getNotes()

Gets the notes value for this LineItemSummary.

Returns:

notes * Provides any additional notes that may annotate the LineItem. This attribute is optional and has a maximum length of 65,535 characters.

setNotes

public void setNotes(String notes)

Sets the notes value for this LineItemSummary.

Parameters:

notes - * Provides any additional notes that may annotate the LineItem. This attribute is optional and has a maximum length of 65,535 characters.

getLastModifiedDateTime

public DateTime getLastModifiedDateTime()

Gets the lastModifiedDateTime value for this LineItemSummary.

Returns:

lastModifiedDateTime * The date and time this line item was last modified.

setLastModifiedDateTime

public void setLastModifiedDateTime(DateTime lastModifiedDateTime)

Sets the lastModifiedDateTime value for this LineItemSummary.

Parameters:

lastModifiedDateTime - * The date and time this line item was last modified.

getLineItemSummaryType

public String getLineItemSummaryType()

Gets the lineItemSummaryType value for this LineItemSummary.

Returns:

lineItemSummaryType * Indicates that this instance is a subtype of LineItemSummary. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

setLineItemSummaryType

public void setLineItemSummaryType(String lineItemSummaryType)

Sets the lineItemSummaryType value for this LineItemSummary.

Parameters:

lineItemSummaryType - * Indicates that this instance is a subtype of LineItemSummary. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                Class _javaType,
                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                    Class _javaType,
                                                    QName _xmlType)

Get Custom Deserializer