Interface LineItemOrBuilder (0.7.0) 

public interface LineItemOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getArchived()

public abstract boolean getArchived()

Output only. The archival status of the LineItem.

bool archived = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The archived.

getAutoExtensionDays()

public abstract int getAutoExtensionDays()

Optional. Number of days to allow a LineItem to deliver past its end_time. A maximum of 7 days is allowed. This feature is only available for Ad Manager 360 accounts.

int32 auto_extension_days = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The autoExtensionDays.

getContractedUnitsBought()

public abstract long getContractedUnitsBought()

Optional. This attribute is only applicable for certain line item types and acts as an "FYI" or note, which does not impact ad-serving or other backend systems.

For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes.

For STANDARD line items, this represents the contracted quantity, which is the number of units specified in the contract that the advertiser has bought for this line item. This attribute is only available if you have this feature enabled on your network.

int64 contracted_units_bought = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The contractedUnitsBought.

getCostPerUnit()

public abstract Money getCostPerUnit()

Required. The amount of money to spend per impression or click.

.google.type.Money cost_per_unit = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.Money

The costPerUnit.

getCostPerUnitOrBuilder()

public abstract MoneyOrBuilder getCostPerUnitOrBuilder()

Required. The amount of money to spend per impression or click.

.google.type.Money cost_per_unit = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.MoneyOrBuilder

getCostType()

public abstract LineItemCostTypeEnum.LineItemCostType getCostType()

Required. The method used for billing this line item.

.google.ads.admanager.v1.LineItemCostTypeEnum.LineItemCostType cost_type = 19 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LineItemCostTypeEnum.LineItemCostType

The costType.

getCostTypeValue()

public abstract int getCostTypeValue()

Required. The method used for billing this line item.

.google.ads.admanager.v1.LineItemCostTypeEnum.LineItemCostType cost_type = 19 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for costType.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The instant at which the LineItem was created. This attribute may be null for line items created before this feature was introduced.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The instant at which the LineItem was created. This attribute may be null for line items created before this feature was introduced.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCreativePlaceholders(int index)

public abstract CreativePlaceholder getCreativePlaceholders(int index)

Required. Details about the creatives that are expected to serve through this LineItem.

repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 27 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholder

getCreativePlaceholdersCount()

public abstract int getCreativePlaceholdersCount()

Required. Details about the creatives that are expected to serve through this LineItem.

repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 27 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getCreativePlaceholdersList()

public abstract List<CreativePlaceholder> getCreativePlaceholdersList()

Required. Details about the creatives that are expected to serve through this LineItem.

repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 27 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<CreativePlaceholder>

getCreativePlaceholdersOrBuilder(int index)

public abstract CreativePlaceholderOrBuilder getCreativePlaceholdersOrBuilder(int index)

Required. Details about the creatives that are expected to serve through this LineItem.

repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 27 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholderOrBuilder

getCreativePlaceholdersOrBuilderList()

public abstract List<? extends CreativePlaceholderOrBuilder> getCreativePlaceholdersOrBuilderList()

Required. Details about the creatives that are expected to serve through this LineItem.

repeated .google.ads.admanager.v1.CreativePlaceholder creative_placeholders = 27 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.CreativePlaceholderOrBuilder>

getCreativeRotationType()

public abstract CreativeRotationTypeEnum.CreativeRotationType getCreativeRotationType()

Required. The strategy used for displaying multiple creatives that are associated with the line item.

.google.ads.admanager.v1.CreativeRotationTypeEnum.CreativeRotationType creative_rotation_type = 22 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreativeRotationTypeEnum.CreativeRotationType

The creativeRotationType.

getCreativeRotationTypeValue()

public abstract int getCreativeRotationTypeValue()

Required. The strategy used for displaying multiple creatives that are associated with the line item.

.google.ads.admanager.v1.CreativeRotationTypeEnum.CreativeRotationType creative_rotation_type = 22 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for creativeRotationType.

getDeliveryRateType()

public abstract DeliveryRateTypeEnum.DeliveryRateType getDeliveryRateType()

Non-empty default. The strategy for delivering ads over the duration of the line item. Defaults to EVENLY or FRONTLOADED depending on the network's configuration.

.google.ads.admanager.v1.DeliveryRateTypeEnum.DeliveryRateType delivery_rate_type = 23 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
DeliveryRateTypeEnum.DeliveryRateType

The deliveryRateType.

getDeliveryRateTypeValue()

public abstract int getDeliveryRateTypeValue()

Non-empty default. The strategy for delivering ads over the duration of the line item. Defaults to EVENLY or FRONTLOADED depending on the network's configuration.

.google.ads.admanager.v1.DeliveryRateTypeEnum.DeliveryRateType delivery_rate_type = 23 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for deliveryRateType.

getDiscount()

public abstract double getDiscount()

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

double discount = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The discount.

getDiscountType()

public abstract LineItemDiscountTypeEnum.LineItemDiscountType getDiscountType()

Non-empty default. The type of discount applied to the line item. Defaults to PERCENTAGE.

.google.ads.admanager.v1.LineItemDiscountTypeEnum.LineItemDiscountType discount_type = 24 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItemDiscountTypeEnum.LineItemDiscountType

The discountType.

getDiscountTypeValue()

public abstract int getDiscountTypeValue()

Non-empty default. The type of discount applied to the line item. Defaults to PERCENTAGE.

.google.ads.admanager.v1.LineItemDiscountTypeEnum.LineItemDiscountType discount_type = 24 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for discountType.

getDisplayName()

public abstract String getDisplayName()

Optional. Display name of the LineItem. This attribute has a maximum length of 255 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. Display name of the LineItem. This attribute has a maximum length of 255 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEndTime()

public abstract Timestamp getEndTime()

Optional. Time at which the LineItem will stop serving. This attribute is ignored when unlimited_end_time is true. If specified, it must be after start_time. This end time does not include auto_extension_days.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

Optional. Time at which the LineItem will stop serving. This attribute is ignored when unlimited_end_time is true. If specified, it must be after start_time. This end time does not include auto_extension_days.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getEnvironmentType()

public abstract EnvironmentTypeEnum.EnvironmentType getEnvironmentType()

Non-empty default. The environment that the line item is targeting. The default value is BROWSER. If this value is VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environment_type is also VIDEO_PLAYER.

.google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 25 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
EnvironmentTypeEnum.EnvironmentType

The environmentType.

getEnvironmentTypeValue()

public abstract int getEnvironmentTypeValue()

Non-empty default. The environment that the line item is targeting. The default value is BROWSER. If this value is VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environment_type is also VIDEO_PLAYER.

.google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 25 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for environmentType.

getExternalId()

public abstract String getExternalId()

Optional. Identifier for the LineItem that is meaningful to the publisher. This attribute has a maximum length of 255 characters.

string external_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The externalId.

getExternalIdBytes()

public abstract ByteString getExternalIdBytes()

Optional. Identifier for the LineItem that is meaningful to the publisher. This attribute has a maximum length of 255 characters.

string external_id = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for externalId.

getImpressionLimit()

public abstract Goal getImpressionLimit()

Optional. The impression limit for the LineItem. This field is meaningful only if the LineItem.line_item_type is [LineItemType.SPONSORSHIP][] and LineItem.cost_type is [CostType.CPM][].

.google.ads.admanager.v1.Goal impression_limit = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Goal

The impressionLimit.

getImpressionLimitOrBuilder()

public abstract GoalOrBuilder getImpressionLimitOrBuilder()

Optional. The impression limit for the LineItem. This field is meaningful only if the LineItem.line_item_type is [LineItemType.SPONSORSHIP][] and LineItem.cost_type is [CostType.CPM][].

.google.ads.admanager.v1.Goal impression_limit = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GoalOrBuilder

getLastModifiedByApp()

public abstract String getLastModifiedByApp()

Output only. The application that last modified this line item.

string last_modified_by_app = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The lastModifiedByApp.

getLastModifiedByAppBytes()

public abstract ByteString getLastModifiedByAppBytes()

Output only. The application that last modified this line item.

string last_modified_by_app = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for lastModifiedByApp.

getLineItemType()

public abstract LineItemTypeEnum.LineItemType getLineItemType()

Required. Determines the default priority of the LineItem for delivery. More information can be found on the Ad Manager Help Center.

.google.ads.admanager.v1.LineItemTypeEnum.LineItemType line_item_type = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LineItemTypeEnum.LineItemType

The lineItemType.

getLineItemTypeValue()

public abstract int getLineItemTypeValue()

Required. Determines the default priority of the LineItem for delivery. More information can be found on the Ad Manager Help Center.

.google.ads.admanager.v1.LineItemTypeEnum.LineItemType line_item_type = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for lineItemType.

getMissingCreatives()

public abstract boolean getMissingCreatives()

Output only. Indicates if a line item is missing any creatives for the creative_placeholders specified.

Creatives can be considered missing for several reasons:

  • Not enough creatives of a certain size have been uploaded, as determined by expectedCreativeCount. For example a line item specifies 750x350, 400x200, but only a 750x350 was uploaded. Or line item specifies 750x350 with an expected count of 2, but only one was uploaded.
  • The appliedLabels of an associated Creative do not match the effectiveAppliedLabels of the line item. For example if a line item specifies 750x350 with a foo applied label, but a 750x350 creative without an applied label was uploaded.

bool missing_creatives = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The missingCreatives.

getName()

public abstract String getName()

Identifier. The resource name of the LineItem. Format: networks/{network_code}/orders/{order_id}/lineItems/{line_item_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The resource name of the LineItem. Format: networks/{network_code}/orders/{order_id}/lineItems/{line_item_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNotes()

public abstract String getNotes()

Optional. Provides any additional notes that may annotate LineItem. This field has a maximum length of 65,535 characters.

string notes = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The notes.

getNotesBytes()

public abstract ByteString getNotesBytes()

Optional. Provides any additional notes that may annotate LineItem. This field has a maximum length of 65,535 characters.

string notes = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for notes.

getPrimaryGoal()

public abstract Goal getPrimaryGoal()

Required. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.

.google.ads.admanager.v1.Goal primary_goal = 29 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Goal

The primaryGoal.

getPrimaryGoalOrBuilder()

public abstract GoalOrBuilder getPrimaryGoalOrBuilder()

Required. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.

.google.ads.admanager.v1.Goal primary_goal = 29 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GoalOrBuilder

getPriority()

public abstract long getPriority()

Optional. Priority of the LineItem for delivery. Valid values range from 1 to 16. This field can only be changed by certain networks, otherwise a PERMISSION_DENIED error will occur.

The following list shows the default, minimum, and maximum priority values for each LineItemType: formatted as LineItemType: default priority (minimum priority, maximum priority):

  • SPONSORSHIP: 4 (2,5)
  • STANDARD: 8 (6,10)
  • NETWORK: 12 (11, 14)
  • BULK: 12 (11, 14)
  • PRICE_PRIORITY: 12 (11, 14)
  • HOUSE: 16 (15, 16)
  • CLICK_TRACKING: 16 (1, 16)
  • AD_EXCHANGE: 12 (1, 16)
  • ADSENSE: 12 (1, 16)
  • BUMPER: 16 (15, 16)

int64 priority = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The priority.

getReservationStatus()

public abstract ReservationStatusEnum.ReservationStatus getReservationStatus()

Output only. Describes whether or not inventory has been reserved for the line item.

.google.ads.admanager.v1.ReservationStatusEnum.ReservationStatus reservation_status = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ReservationStatusEnum.ReservationStatus

The reservationStatus.

getReservationStatusValue()

public abstract int getReservationStatusValue()

Output only. Describes whether or not inventory has been reserved for the line item.

.google.ads.admanager.v1.ReservationStatusEnum.ReservationStatus reservation_status = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for reservationStatus.

getStartTime()

public abstract Timestamp getStartTime()

Required. Time at which the LineItem will begin serving. This attribute must be in the future when creating a LineItem.

.google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

Required. Time at which the LineItem will begin serving. This attribute must be in the future when creating a LineItem.

.google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TimestampOrBuilder

getStatus()

public abstract ComputedStatusEnum.ComputedStatus getStatus()

Output only. The status of the LineItem.

.google.ads.admanager.v1.ComputedStatusEnum.ComputedStatus status = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ComputedStatusEnum.ComputedStatus

The status.

getStatusValue()

public abstract int getStatusValue()

Output only. The status of the LineItem.

.google.ads.admanager.v1.ComputedStatusEnum.ComputedStatus status = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getUnlimitedEndTime()

public abstract boolean getUnlimitedEndTime()

Optional. Whether the LineItem has an end_time. This attribute can be set to true for only LineItems with line_item_type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.

bool unlimited_end_time = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The unlimitedEndTime.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The instant at which the LineItem was last updated

.google.protobuf.Timestamp update_time = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The instant at which the LineItem was last updated

.google.protobuf.Timestamp update_time = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getWebPropertyCode()

public abstract String getWebPropertyCode()

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

string web_property_code = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The webPropertyCode.

getWebPropertyCodeBytes()

public abstract ByteString getWebPropertyCodeBytes()

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

string web_property_code = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for webPropertyCode.

hasCostPerUnit()

public abstract boolean hasCostPerUnit()

Required. The amount of money to spend per impression or click.

.google.type.Money cost_per_unit = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the costPerUnit field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The instant at which the LineItem was created. This attribute may be null for line items created before this feature was introduced.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEndTime()

public abstract boolean hasEndTime()

Optional. Time at which the LineItem will stop serving. This attribute is ignored when unlimited_end_time is true. If specified, it must be after start_time. This end time does not include auto_extension_days.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the endTime field is set.

hasImpressionLimit()

public abstract boolean hasImpressionLimit()

Optional. The impression limit for the LineItem. This field is meaningful only if the LineItem.line_item_type is [LineItemType.SPONSORSHIP][] and LineItem.cost_type is [CostType.CPM][].

.google.ads.admanager.v1.Goal impression_limit = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the impressionLimit field is set.

hasPrimaryGoal()

public abstract boolean hasPrimaryGoal()

Required. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.

.google.ads.admanager.v1.Goal primary_goal = 29 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the primaryGoal field is set.

hasStartTime()

public abstract boolean hasStartTime()

Required. Time at which the LineItem will begin serving. This attribute must be in the future when creating a LineItem.

.google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the startTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The instant at which the LineItem was last updated

.google.protobuf.Timestamp update_time = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.