public class LineItemSummary extends Object implements Serializable
LineItemSummary represents the base class from which
a LineItem is derived.| 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,
DeliveryForecastSource deliveryForecastSource,
RoadblockingType roadblockingType,
FrequencyCap[] frequencyCaps,
LineItemType lineItemType,
Integer priority,
Money costPerUnit,
Money valueCostPerUnit,
CostType costType,
LineItemDiscountType discountType,
Double discount,
Long contractedUnitsBought,
CreativePlaceholder[] creativePlaceholders,
LineItemActivityAssociation[] activityAssociations,
EnvironmentType environmentType,
CompanionDeliveryOption companionDeliveryOption,
Boolean allowOverbook,
Boolean skipInventoryCheck,
Boolean skipCrossSellingRuleWarningChecks,
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,
DateTime creationDateTime,
Boolean isPrioritizedPreferredDealsEnabled,
Integer adExchangeAuctionOpeningPriority,
BaseCustomFieldValue[] customFieldValues,
Boolean isSetTopBoxEnabled,
Boolean isMissingCreatives,
SetTopBoxInfo setTopBoxDisplayInfo,
ProgrammaticCreativeSource programmaticCreativeSource,
Long videoMaxDuration,
Goal primaryGoal,
Goal[] secondaryGoals,
GrpSettings grpSettings,
Long viewabilityProviderCompanyId,
UserConsentEligibility userConsentEligibility,
ChildContentEligibility childContentEligibility) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
LineItemActivityAssociation[] |
getActivityAssociations()
Gets the activityAssociations value for this LineItemSummary.
|
LineItemActivityAssociation |
getActivityAssociations(int i) |
Integer |
getAdExchangeAuctionOpeningPriority()
Gets the adExchangeAuctionOpeningPriority value for this LineItemSummary.
|
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.
|
ChildContentEligibility |
getChildContentEligibility()
Gets the childContentEligibility 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.
|
DateTime |
getCreationDateTime()
Gets the creationDateTime 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.
|
BaseCustomFieldValue[] |
getCustomFieldValues()
Gets the customFieldValues value for this LineItemSummary.
|
BaseCustomFieldValue |
getCustomFieldValues(int i) |
DeliveryData |
getDeliveryData()
Gets the deliveryData value for this LineItemSummary.
|
DeliveryForecastSource |
getDeliveryForecastSource()
Gets the deliveryForecastSource 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.
|
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) |
GrpSettings |
getGrpSettings()
Gets the grpSettings value for this LineItemSummary.
|
Long |
getId()
Gets the id value for this LineItemSummary.
|
Boolean |
getIsArchived()
Gets the isArchived value for this LineItemSummary.
|
Boolean |
getIsMissingCreatives()
Gets the isMissingCreatives value for this LineItemSummary.
|
Boolean |
getIsPrioritizedPreferredDealsEnabled()
Gets the isPrioritizedPreferredDealsEnabled value for this LineItemSummary.
|
Boolean |
getIsSetTopBoxEnabled()
Gets the isSetTopBoxEnabled value for this LineItemSummary.
|
String |
getLastModifiedByApp()
Gets the lastModifiedByApp value for this LineItemSummary.
|
DateTime |
getLastModifiedDateTime()
Gets the lastModifiedDateTime 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.
|
Goal |
getPrimaryGoal()
Gets the primaryGoal value for this LineItemSummary.
|
Integer |
getPriority()
Gets the priority value for this LineItemSummary.
|
ProgrammaticCreativeSource |
getProgrammaticCreativeSource()
Gets the programmaticCreativeSource 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.
|
Goal[] |
getSecondaryGoals()
Gets the secondaryGoals value for this LineItemSummary.
|
Goal |
getSecondaryGoals(int i) |
static org.apache.axis.encoding.Serializer |
getSerializer(String mechType,
Class _javaType,
QName _xmlType)
Get Custom Serializer
|
SetTopBoxInfo |
getSetTopBoxDisplayInfo()
Gets the setTopBoxDisplayInfo value for this LineItemSummary.
|
Boolean |
getSkipCrossSellingRuleWarningChecks()
Gets the skipCrossSellingRuleWarningChecks value for this LineItemSummary.
|
Boolean |
getSkipInventoryCheck()
Gets the skipInventoryCheck value for this LineItemSummary.
|
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.
|
static org.apache.axis.description.TypeDesc |
getTypeDesc()
Return type metadata object
|
Boolean |
getUnlimitedEndDateTime()
Gets the unlimitedEndDateTime value for this LineItemSummary.
|
UserConsentEligibility |
getUserConsentEligibility()
Gets the userConsentEligibility value for this LineItemSummary.
|
Money |
getValueCostPerUnit()
Gets the valueCostPerUnit value for this LineItemSummary.
|
Long |
getVideoMaxDuration()
Gets the videoMaxDuration value for this LineItemSummary.
|
Long |
getViewabilityProviderCompanyId()
Gets the viewabilityProviderCompanyId value for this LineItemSummary.
|
String |
getWebPropertyCode()
Gets the webPropertyCode value for this LineItemSummary.
|
int |
hashCode() |
void |
setActivityAssociations(int i,
LineItemActivityAssociation _value) |
void |
setActivityAssociations(LineItemActivityAssociation[] activityAssociations)
Sets the activityAssociations value for this LineItemSummary.
|
void |
setAdExchangeAuctionOpeningPriority(Integer adExchangeAuctionOpeningPriority)
Sets the adExchangeAuctionOpeningPriority value for this LineItemSummary.
|
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 |
setChildContentEligibility(ChildContentEligibility childContentEligibility)
Sets the childContentEligibility 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 |
setCreationDateTime(DateTime creationDateTime)
Sets the creationDateTime 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 |
setCustomFieldValues(BaseCustomFieldValue[] customFieldValues)
Sets the customFieldValues value for this LineItemSummary.
|
void |
setCustomFieldValues(int i,
BaseCustomFieldValue _value) |
void |
setDeliveryData(DeliveryData deliveryData)
Sets the deliveryData value for this LineItemSummary.
|
void |
setDeliveryForecastSource(DeliveryForecastSource deliveryForecastSource)
Sets the deliveryForecastSource 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 |
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 |
setGrpSettings(GrpSettings grpSettings)
Sets the grpSettings value for this LineItemSummary.
|
void |
setId(Long id)
Sets the id value for this LineItemSummary.
|
void |
setIsArchived(Boolean isArchived)
Sets the isArchived value for this LineItemSummary.
|
void |
setIsMissingCreatives(Boolean isMissingCreatives)
Sets the isMissingCreatives value for this LineItemSummary.
|
void |
setIsPrioritizedPreferredDealsEnabled(Boolean isPrioritizedPreferredDealsEnabled)
Sets the isPrioritizedPreferredDealsEnabled value for this LineItemSummary.
|
void |
setIsSetTopBoxEnabled(Boolean isSetTopBoxEnabled)
Sets the isSetTopBoxEnabled 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 |
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 |
setPrimaryGoal(Goal primaryGoal)
Sets the primaryGoal value for this LineItemSummary.
|
void |
setPriority(Integer priority)
Sets the priority value for this LineItemSummary.
|
void |
setProgrammaticCreativeSource(ProgrammaticCreativeSource programmaticCreativeSource)
Sets the programmaticCreativeSource 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 |
setSecondaryGoals(Goal[] secondaryGoals)
Sets the secondaryGoals value for this LineItemSummary.
|
void |
setSecondaryGoals(int i,
Goal _value) |
void |
setSetTopBoxDisplayInfo(SetTopBoxInfo setTopBoxDisplayInfo)
Sets the setTopBoxDisplayInfo value for this LineItemSummary.
|
void |
setSkipCrossSellingRuleWarningChecks(Boolean skipCrossSellingRuleWarningChecks)
Sets the skipCrossSellingRuleWarningChecks value for this LineItemSummary.
|
void |
setSkipInventoryCheck(Boolean skipInventoryCheck)
Sets the skipInventoryCheck 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 |
setUnlimitedEndDateTime(Boolean unlimitedEndDateTime)
Sets the unlimitedEndDateTime value for this LineItemSummary.
|
void |
setUserConsentEligibility(UserConsentEligibility userConsentEligibility)
Sets the userConsentEligibility value for this LineItemSummary.
|
void |
setValueCostPerUnit(Money valueCostPerUnit)
Sets the valueCostPerUnit value for this LineItemSummary.
|
void |
setVideoMaxDuration(Long videoMaxDuration)
Sets the videoMaxDuration value for this LineItemSummary.
|
void |
setViewabilityProviderCompanyId(Long viewabilityProviderCompanyId)
Sets the viewabilityProviderCompanyId value for this LineItemSummary.
|
void |
setWebPropertyCode(String webPropertyCode)
Sets the webPropertyCode value for this LineItemSummary.
|
String |
toString() |
public 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, DeliveryForecastSource deliveryForecastSource, RoadblockingType roadblockingType, FrequencyCap[] frequencyCaps, LineItemType lineItemType, Integer priority, Money costPerUnit, Money valueCostPerUnit, CostType costType, LineItemDiscountType discountType, Double discount, Long contractedUnitsBought, CreativePlaceholder[] creativePlaceholders, LineItemActivityAssociation[] activityAssociations, EnvironmentType environmentType, CompanionDeliveryOption companionDeliveryOption, Boolean allowOverbook, Boolean skipInventoryCheck, Boolean skipCrossSellingRuleWarningChecks, 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, DateTime creationDateTime, Boolean isPrioritizedPreferredDealsEnabled, Integer adExchangeAuctionOpeningPriority, BaseCustomFieldValue[] customFieldValues, Boolean isSetTopBoxEnabled, Boolean isMissingCreatives, SetTopBoxInfo setTopBoxDisplayInfo, ProgrammaticCreativeSource programmaticCreativeSource, Long videoMaxDuration, Goal primaryGoal, Goal[] secondaryGoals, GrpSettings grpSettings, Long viewabilityProviderCompanyId, UserConsentEligibility userConsentEligibility, ChildContentEligibility childContentEligibility)
public Long getOrderId()
Order to which the LineItem belongs.
This
attribute is required.public void setOrderId(Long orderId)
orderId - * The ID of the Order to which the LineItem belongs.
This
attribute is required.public Long getId()
LineItem. This attribute is
read-only and is
assigned by Google when a line item is created.public void setId(Long id)
id - * Uniquely identifies the LineItem. This attribute is
read-only and is
assigned by Google when a line item is created.public String getName()
public void setName(String name)
name - * The name of the line item. This attribute is required and has
a maximum
length of 255 characters.public String getExternalId()
LineItem that is meaningful to
the publisher.
This attribute is optional and has a maximum length
of 255 characters.public void setExternalId(String externalId)
externalId - * An identifier for the LineItem that is meaningful to
the publisher.
This attribute is optional and has a maximum length
of 255 characters.public String getOrderName()
Order. This value is read-only.public void setOrderName(String orderName)
orderName - * The name of the Order. This value is read-only.public DateTime getStartDateTime()
LineItem is enabled
to begin
serving. This attribute is required and must be in
the future.public void setStartDateTime(DateTime startDateTime)
startDateTime - * The date and time on which the LineItem is enabled
to begin
serving. This attribute is required and must be in
the future.public StartDateTimeType getStartDateTimeType()
LineItem
right away, in
an hour, etc. This attribute is optional and defaults
to
StartDateTimeType.USE_START_DATE_TIME.public void setStartDateTimeType(StartDateTimeType startDateTimeType)
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.public DateTime getEndDateTime()
LineItem will stop serving.
This
attribute is required unless unlimitedEndDateTime
is set
to true. If specified, it must be after the
startDateTime. This end date and time does not include
auto extension days.public void setEndDateTime(DateTime endDateTime)
endDateTime - * The date and time on which the LineItem will stop serving.
This
attribute is required unless unlimitedEndDateTime
is set
to true. If specified, it must be after the
startDateTime. This end date and time does not include
auto extension days.public Integer getAutoExtensionDays()
endDateTime. A maximum
of 7 days is allowed. This is feature is only available
for Ad Manager 360 accounts.public void setAutoExtensionDays(Integer autoExtensionDays)
autoExtensionDays - * The number of days to allow a line item to deliver past its
endDateTime. A maximum
of 7 days is allowed. This is feature is only available
for Ad Manager 360 accounts.public Boolean getUnlimitedEndDateTime()
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.public void setUnlimitedEndDateTime(Boolean unlimitedEndDateTime)
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.public CreativeRotationType getCreativeRotationType()
Creative
objects that are
associated with the LineItem. This attribute
is required.public void setCreativeRotationType(CreativeRotationType creativeRotationType)
creativeRotationType - * The strategy used for displaying multiple Creative
objects that are
associated with the LineItem. This attribute
is required.public DeliveryRateType getDeliveryRateType()
DeliveryRateType.EVENLY
or
DeliveryRateType.FRONTLOADED depending on
the network's configuration.public void setDeliveryRateType(DeliveryRateType deliveryRateType)
deliveryRateType - * The strategy for delivering ads over the course of the line
item's duration. This attribute is
optional and defaults to DeliveryRateType.EVENLY
or
DeliveryRateType.FRONTLOADED depending on
the network's configuration.public DeliveryForecastSource getDeliveryForecastSource()
DeliveryForecastSource.HISTORICAL.public void setDeliveryForecastSource(DeliveryForecastSource deliveryForecastSource)
deliveryForecastSource - * Strategy for choosing forecasted traffic shapes to pace line
items. This field is optional and
defaults to DeliveryForecastSource.HISTORICAL.public RoadblockingType getRoadblockingType()
RoadblockingType.ONE_OR_MORE.public void setRoadblockingType(RoadblockingType roadblockingType)
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.public FrequencyCap[] getFrequencyCaps()
LineItem.
This
attribute is optional.public void setFrequencyCaps(FrequencyCap[] frequencyCaps)
frequencyCaps - * The set of frequency capping units for this LineItem.
This
attribute is optional.public FrequencyCap getFrequencyCaps(int i)
public void setFrequencyCaps(int i,
FrequencyCap _value)
public LineItemType getLineItemType()
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.public void setLineItemType(LineItemType lineItemType)
lineItemType - * Indicates the line item type of a 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.public Integer getPriority()
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) | |
|---|---|
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.
public void setPriority(Integer priority)
priority - * The priority for the line item. Valid values range from 1 to
16. This
field is optional and defaults to the default priority
of the
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) | |
|---|---|
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.
public Money getCostPerUnit()
LineItem.public void setCostPerUnit(Money costPerUnit)
costPerUnit - * The amount of money to spend per impression or click. This
attribute is
required for creating a LineItem.public Money getValueCostPerUnit()
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.public void setValueCostPerUnit(Money valueCostPerUnit)
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.public CostType getCostType()
LineItem. This attribute
is
required.public void setCostType(CostType costType)
costType - * The method used for billing this LineItem. This attribute
is
required.public LineItemDiscountType getDiscountType()
LineItem, either
percentage
based or absolute. This attribute is optional and
defaults to
LineItemDiscountType.PERCENTAGE.public void setDiscountType(LineItemDiscountType discountType)
discountType - * The type of discount being applied to a LineItem, either
percentage
based or absolute. This attribute is optional and
defaults to
LineItemDiscountType.PERCENTAGE.public Double getDiscount()
LineItemDiscountType. If the LineItemDiscountType
is
LineItemDiscountType.PERCENTAGE, then only
non-fractional values
are supported.public void setDiscount(Double discount)
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.public Long getContractedUnitsBought()
line item types
and acts as an "FYI" or note, which does not impact
adserving or other backend systems.
For LineItemType.SPONSORSHIP line items, this
represents the minimum quantity,
which is a lifetime impression volume goal for reporting
purposes only.
For 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 LineItem. This field is just a "FYI"
for traffickers to manually intervene
with the LineItem when needed. This attribute
is only available for
LineItemType.STANDARD line items if you have
this feature enabled on your network.
public void setContractedUnitsBought(Long contractedUnitsBought)
contractedUnitsBought - * This attribute is only applicable for certain line item types
and acts as an "FYI" or note, which does not impact
adserving or other backend systems.
For LineItemType.SPONSORSHIP line items, this
represents the minimum quantity,
which is a lifetime impression volume goal for reporting
purposes only.
For 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 LineItem. This field is just a "FYI"
for traffickers to manually intervene
with the LineItem when needed. This attribute
is only available for
LineItemType.STANDARD line items if you have
this feature enabled on your network.
public CreativePlaceholder[] getCreativePlaceholders()
LineItem. This attribute is required and replaces
the
creativeSizes attribute.public void setCreativePlaceholders(CreativePlaceholder[] creativePlaceholders)
creativePlaceholders - * Details about the creatives that are expected to serve through
this
LineItem. This attribute is required and replaces
the
creativeSizes attribute.public CreativePlaceholder getCreativePlaceholders(int i)
public void setCreativePlaceholders(int i,
CreativePlaceholder _value)
public LineItemActivityAssociation[] getActivityAssociations()
costType is CostType.CPA.public void setActivityAssociations(LineItemActivityAssociation[] activityAssociations)
activityAssociations - * This attribute is required and meaningful only if the costType is CostType.CPA.public LineItemActivityAssociation getActivityAssociations(int i)
public void setActivityAssociations(int i,
LineItemActivityAssociation _value)
public EnvironmentType getEnvironmentType()
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.public void setEnvironmentType(EnvironmentType environmentType)
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.public CompanionDeliveryOption getCompanionDeliveryOption()
This field is optional and defaults to
CompanionDeliveryOption.OPTIONAL if the above
conditions are met.
In all other cases it defaults to CompanionDeliveryOption.UNKNOWN
and is not meaningful.
public void setCompanionDeliveryOption(CompanionDeliveryOption companionDeliveryOption)
companionDeliveryOption - * The delivery option for companions. Setting this field is only
meaningful
if the following conditions are met:
This field is optional and defaults to
CompanionDeliveryOption.OPTIONAL if the above
conditions are met.
In all other cases it defaults to CompanionDeliveryOption.UNKNOWN
and is not meaningful.
public Boolean getAllowOverbook()
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.
Note: this field will not persist on the line item itself, and the value will only affect the current request.
public void setAllowOverbook(Boolean allowOverbook)
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.
Note: this field will not persist on the line item itself, and the value will only affect the current request.
public Boolean getSkipInventoryCheck()
Note: this field will not persist on the line item itself, and the value will only affect the current request.
public void setSkipInventoryCheck(Boolean skipInventoryCheck)
skipInventoryCheck - * The 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.
public Boolean getSkipCrossSellingRuleWarningChecks()
public void setSkipCrossSellingRuleWarningChecks(Boolean skipCrossSellingRuleWarningChecks)
skipCrossSellingRuleWarningChecks - * True 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.public Boolean getReserveAtCreation()
LineItemType.SPONSORSHIP
and
LineItemType.STANDARD in an unapproved Order. The default
value is false.public void setReserveAtCreation(Boolean reserveAtCreation)
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.public Stats getStats()
null in case
there are no statistics for a line item yet.public void setStats(Stats stats)
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.public DeliveryIndicator getDeliveryIndicator()
null if the
delivery indicator information is not available due
to one of the following
reasons:
public void setDeliveryIndicator(DeliveryIndicator deliveryIndicator)
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:
public DeliveryData getDeliveryData()
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:
deliveryIndicator should be used
to track its
progress in this case.public void setDeliveryData(DeliveryData deliveryData)
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:
deliveryIndicator should be used
to track its
progress in this case.public Money getBudget()
LineItem. This
attribute is
readonly and is populated by Google. The currency
code is readonly.public void setBudget(Money budget)
budget - * The amount of money allocated to the LineItem. This
attribute is
readonly and is populated by Google. The currency
code is readonly.public ComputedStatus getStatus()
LineItem. This attribute is readonly.public void setStatus(ComputedStatus status)
status - * The status of the LineItem. This attribute is readonly.public LineItemSummaryReservationStatus getReservationStatus()
LineItem. This attribute is readonly and is assigned by Google.public void setReservationStatus(LineItemSummaryReservationStatus reservationStatus)
reservationStatus - * Describes whether or not inventory has been reserved for the
LineItem. This attribute is readonly and is assigned by Google.public Boolean getIsArchived()
LineItem. This attribute
is readonly.public void setIsArchived(Boolean isArchived)
isArchived - * The archival status of the LineItem. This attribute
is readonly.public String getWebPropertyCode()
LineItemType.AD_EXCHANGE and LineItemType.ADSENSE.public void setWebPropertyCode(String webPropertyCode)
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.public AppliedLabel[] getAppliedLabels()
public void setAppliedLabels(AppliedLabel[] appliedLabels)
appliedLabels - * The set of labels applied directly to this line item.public AppliedLabel getAppliedLabels(int i)
public void setAppliedLabels(int i,
AppliedLabel _value)
public AppliedLabel[] getEffectiveAppliedLabels()
public void setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels)
effectiveAppliedLabels - * 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.public AppliedLabel getEffectiveAppliedLabels(int i)
public void setEffectiveAppliedLabels(int i,
AppliedLabel _value)
public Boolean getDisableSameAdvertiserCompetitiveExclusion()
true will allow line items from the same
advertiser to serve
regardless of the other competitive exclusion labels
being applied.public void setDisableSameAdvertiserCompetitiveExclusion(Boolean disableSameAdvertiserCompetitiveExclusion)
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.public String getLastModifiedByApp()
public void setLastModifiedByApp(String lastModifiedByApp)
lastModifiedByApp - * The application that last modified this line item. This attribute
is read only
and is assigned by Google.public String getNotes()
LineItem. This
attribute is optional and has a maximum length of
65,535 characters.public void setNotes(String notes)
notes - * Provides any additional notes that may annotate the LineItem. This
attribute is optional and has a maximum length of
65,535 characters.public DateTime getLastModifiedDateTime()
public void setLastModifiedDateTime(DateTime lastModifiedDateTime)
lastModifiedDateTime - * The date and time this line item was last modified.public DateTime getCreationDateTime()
null for line items created before
this feature was introduced.public void setCreationDateTime(DateTime creationDateTime)
creationDateTime - * This attribute may be null for line items created before
this feature was introduced.public Boolean getIsPrioritizedPreferredDealsEnabled()
public void setIsPrioritizedPreferredDealsEnabled(Boolean isPrioritizedPreferredDealsEnabled)
isPrioritizedPreferredDealsEnabled - * Whether an AdExchange line item has prioritized preferred deals
enabled. This attribute is
optional and defaults to false.public Integer getAdExchangeAuctionOpeningPriority()
public void setAdExchangeAuctionOpeningPriority(Integer adExchangeAuctionOpeningPriority)
adExchangeAuctionOpeningPriority - * The priority at which an Ad Exchange line item enters the open
Ad Exchange auction if the
preferred deal fails to transact. This attribute is
optional. If prioritized preferred deals
are enabled, it defaults to 12. Otherwise, it is ignored.public BaseCustomFieldValue[] getCustomFieldValues()
public void setCustomFieldValues(BaseCustomFieldValue[] customFieldValues)
customFieldValues - * The values of the custom fields associated with this line item.public BaseCustomFieldValue getCustomFieldValues(int i)
public void setCustomFieldValues(int i,
BaseCustomFieldValue _value)
public Boolean getIsSetTopBoxEnabled()
LineItem is a set-top
box enabled line item.
Set-top box line items only support the following
creative sizes: 1920x1080 and 640x480.
This attribute is read-only after creation.
public void setIsSetTopBoxEnabled(Boolean isSetTopBoxEnabled)
isSetTopBoxEnabled - * Flag that specifies whether this LineItem is a set-top
box enabled line item.
Set-top box line items only support the following
creative sizes: 1920x1080 and 640x480.
This attribute is read-only after creation.
public Boolean getIsMissingCreatives()
LineItem is missing any creatives for the creativePlaceholders specified.
Creatives can be considered missing
for several reasons including:
creatives of a certain
size have been uploaded, as determined
by CreativePlaceholder.expectedCreativeCount.
For example a LineItem
specifies 750x350, 400x200 but only a 750x350 was
uploaded. Or LineItem specifies
750x350 with an expected count of 2, but only one
was uploaded.
Creative.appliedLabels of an associated
Creative do not match the
CreativePlaceholder.effectiveAppliedLabels
of the LineItem. For example
LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative
without a AppliedLabel was uploaded.
public void setIsMissingCreatives(Boolean isMissingCreatives)
isMissingCreatives - * Indicates if a LineItem is missing any creatives for the creativePlaceholders specified.
Creatives can be considered missing
for several reasons including:
creatives of a certain
size have been uploaded, as determined
by CreativePlaceholder.expectedCreativeCount.
For example a LineItem
specifies 750x350, 400x200 but only a 750x350 was
uploaded. Or LineItem specifies
750x350 with an expected count of 2, but only one
was uploaded.
Creative.appliedLabels of an associated
Creative do not match the
CreativePlaceholder.effectiveAppliedLabels
of the LineItem. For example
LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative
without a AppliedLabel was uploaded.
public SetTopBoxInfo getSetTopBoxDisplayInfo()
isSetTopBoxEnabled is true.public void setSetTopBoxDisplayInfo(SetTopBoxInfo setTopBoxDisplayInfo)
setTopBoxDisplayInfo - * Additional information for set-top box enabled line items.
This attribute is optional and only
meaningful when isSetTopBoxEnabled is true.public ProgrammaticCreativeSource getProgrammaticCreativeSource()
ProgrammaticCreativeSource of the programmatic
line item.
This is a read-only field. Any changes must be made
on the ProposalLineItem.public void setProgrammaticCreativeSource(ProgrammaticCreativeSource programmaticCreativeSource)
programmaticCreativeSource - * Indicates the ProgrammaticCreativeSource of the programmatic
line item.
This is a read-only field. Any changes must be made
on the ProposalLineItem.public Long getVideoMaxDuration()
LineItem in
milliseconds. This attribute is optional, defaults
to 0, and only meaningful if this is
a video line item.public void setVideoMaxDuration(Long videoMaxDuration)
videoMaxDuration - * The max duration of a video creative associated with this LineItem in
milliseconds. This attribute is optional, defaults
to 0, and only meaningful if this is
a video line item.public Goal getPrimaryGoal()
LineItem is associated with,
which is used in its pacing and
budgeting.public void setPrimaryGoal(Goal primaryGoal)
primaryGoal - * The primary goal that this LineItem is associated with,
which is used in its pacing and
budgeting.public Goal[] getSecondaryGoals()
LineItem is associated
with. It is required and
meaningful only if the costType is
CostType.CPA or if the lineItemType is LineItemType.SPONSORSHIP
and costType is
CostType.CPM.public void setSecondaryGoals(Goal[] secondaryGoals)
secondaryGoals - * The secondary goals that this LineItem is associated
with. It is required and
meaningful only if the costType is
CostType.CPA or if the lineItemType is LineItemType.SPONSORSHIP
and costType is
CostType.CPM.public Goal getSecondaryGoals(int i)
public void setSecondaryGoals(int i,
Goal _value)
public GrpSettings getGrpSettings()
public void setGrpSettings(GrpSettings grpSettings)
grpSettings - * Contains the information for a line item which has a target
GRP demographic.public Long getViewabilityProviderCompanyId()
Company that provides ad verification
for this line item. An error
will be thrown if the company that the ID refernces
is not of type
Company.Type#VIEWABILITY_PROVIDER.public void setViewabilityProviderCompanyId(Long viewabilityProviderCompanyId)
viewabilityProviderCompanyId - * Optional ID of the Company that provides ad verification
for this line item. An error
will be thrown if the company that the ID refernces
is not of type
Company.Type#VIEWABILITY_PROVIDER.public UserConsentEligibility getUserConsentEligibility()
UserConsentEligibility.NONE.
This field has no effect on serving enforcement unless
you opt to "Limit line items" in the
network's EU User Consent settings. See the
Ad
Manager Help Center
for more information.public void setUserConsentEligibility(UserConsentEligibility userConsentEligibility)
userConsentEligibility - * User consent eligibility designation for this line item. This
field is optional and defaults to
UserConsentEligibility.NONE.
This field has no effect on serving enforcement unless
you opt to "Limit line items" in the
network's EU User Consent settings. See the
Ad
Manager Help Center
for more information.public ChildContentEligibility getChildContentEligibility()
This field is optional and defaults to ChildContentEligibility.DISALLOWED.
public void setChildContentEligibility(ChildContentEligibility childContentEligibility)
childContentEligibility - * Child content eligibility designation for this line item.
This field is optional and defaults to ChildContentEligibility.DISALLOWED.
public static org.apache.axis.description.TypeDesc getTypeDesc()
public static org.apache.axis.encoding.Serializer getSerializer(String mechType, Class _javaType, QName _xmlType)
Copyright © 2019. All rights reserved.