Class LineItem (0.2.0)

  public 
  
 final 
  
 class 
 LineItem 
  
 extends 
  
 GeneratedMessageV3 
  
 implements 
  
 LineItemOrBuilder 
 

The LineItem resource.

Protobuf type google.ads.admanager.v1.LineItem

Implements

LineItemOrBuilder

Static Fields

ARCHIVED_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ARCHIVED_FIELD_NUMBER 
 
Field Value
Type
Description
int

AUTO_EXTENSION_DAYS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 AUTO_EXTENSION_DAYS_FIELD_NUMBER 
 
Field Value
Type
Description
int

CONTRACTED_UNITS_BOUGHT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CONTRACTED_UNITS_BOUGHT_FIELD_NUMBER 
 
Field Value
Type
Description
int

COST_PER_UNIT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 COST_PER_UNIT_FIELD_NUMBER 
 
Field Value
Type
Description
int

COST_TYPE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 COST_TYPE_FIELD_NUMBER 
 
Field Value
Type
Description
int

CREATE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CREATE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

CREATIVE_PLACEHOLDERS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CREATIVE_PLACEHOLDERS_FIELD_NUMBER 
 
Field Value
Type
Description
int

CREATIVE_ROTATION_TYPE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CREATIVE_ROTATION_TYPE_FIELD_NUMBER 
 
Field Value
Type
Description
int

DELIVERY_RATE_TYPE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DELIVERY_RATE_TYPE_FIELD_NUMBER 
 
Field Value
Type
Description
int

DISCOUNT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DISCOUNT_FIELD_NUMBER 
 
Field Value
Type
Description
int

DISCOUNT_TYPE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DISCOUNT_TYPE_FIELD_NUMBER 
 
Field Value
Type
Description
int

DISPLAY_NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DISPLAY_NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

END_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 END_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

ENVIRONMENT_TYPE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ENVIRONMENT_TYPE_FIELD_NUMBER 
 
Field Value
Type
Description
int

EXTERNAL_ID_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 EXTERNAL_ID_FIELD_NUMBER 
 
Field Value
Type
Description
int

IMPRESSION_LIMIT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 IMPRESSION_LIMIT_FIELD_NUMBER 
 
Field Value
Type
Description
int

LAST_MODIFIED_BY_APP_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 LAST_MODIFIED_BY_APP_FIELD_NUMBER 
 
Field Value
Type
Description
int

LINE_ITEM_TYPE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 LINE_ITEM_TYPE_FIELD_NUMBER 
 
Field Value
Type
Description
int

MISSING_CREATIVES_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 MISSING_CREATIVES_FIELD_NUMBER 
 
Field Value
Type
Description
int

NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

NOTES_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NOTES_FIELD_NUMBER 
 
Field Value
Type
Description
int

PRIMARY_GOAL_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 PRIMARY_GOAL_FIELD_NUMBER 
 
Field Value
Type
Description
int

PRIORITY_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 PRIORITY_FIELD_NUMBER 
 
Field Value
Type
Description
int

RESERVATION_STATUS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 RESERVATION_STATUS_FIELD_NUMBER 
 
Field Value
Type
Description
int

START_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 START_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

STATUS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 STATUS_FIELD_NUMBER 
 
Field Value
Type
Description
int

UNLIMITED_END_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 UNLIMITED_END_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

UPDATE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 UPDATE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

WEB_PROPERTY_CODE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 WEB_PROPERTY_CODE_FIELD_NUMBER 
 
Field Value
Type
Description
int

Static Methods

getDefaultInstance()

  public 
  
 static 
  
 LineItem 
  
 getDefaultInstance 
 () 
 
Returns
Type
Description

getDescriptor()

  public 
  
 static 
  
 final 
  
 Descriptors 
 . 
 Descriptor 
  
 getDescriptor 
 () 
 
Returns
Type
Description

newBuilder()

  public 
  
 static 
  
 LineItem 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(LineItem prototype)

  public 
  
 static 
  
 LineItem 
 . 
 Builder 
  
 newBuilder 
 ( 
 LineItem 
  
 prototype 
 ) 
 
Parameter
Name
Description
prototype
Returns
Type
Description

parseDelimitedFrom(InputStream input)

  public 
  
 static 
  
 LineItem 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 LineItem 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data)

  public 
  
 static 
  
 LineItem 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 ) 
 
Parameter
Name
Description
data
byte []
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 LineItem 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
byte []
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data)

  public 
  
 static 
  
 LineItem 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 LineItem 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input)

  public 
  
 static 
  
 LineItem 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 LineItem 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input)

  public 
  
 static 
  
 LineItem 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 LineItem 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data)

  public 
  
 static 
  
 LineItem 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 LineItem 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parser()

  public 
  
 static 
  
 Parser<LineItem> 
  
 parser 
 () 
 
Returns
Type
Description

Methods

equals(Object obj)

  public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 ) 
 
Parameter
Name
Description
obj
Returns
Type
Description
Overrides

getArchived()

  public 
  
 boolean 
  
 getArchived 
 () 
 

Output only. The archival status of the LineItem.

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

Returns
Type
Description

The archived.

getAutoExtensionDays()

  public 
  
 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 
  
 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

The contractedUnitsBought.

getCostPerUnit()

  public 
  
 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 
  
 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 
  
 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

getCostTypeValue()

  public 
  
 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 
  
 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

The createTime.

getCreateTimeOrBuilder()

  public 
  
 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

getCreativePlaceholders(int index)

  public 
  
 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

getCreativePlaceholdersCount()

  public 
  
 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 
  
 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

getCreativePlaceholdersOrBuilder(int index)

  public 
  
 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

getCreativePlaceholdersOrBuilderList()

  public 
  
 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 
  
 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

getCreativeRotationTypeValue()

  public 
  
 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.

getDefaultInstanceForType()

  public 
  
 LineItem 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type
Description

getDeliveryRateType()

  public 
  
 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

getDeliveryRateTypeValue()

  public 
  
 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 
  
 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

The discount.

getDiscountType()

  public 
  
 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

getDiscountTypeValue()

  public 
  
 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 
  
 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

The displayName.

getDisplayNameBytes()

  public 
  
 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

The bytes for displayName.

getEndTime()

  public 
  
 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

The endTime.

getEndTimeOrBuilder()

  public 
  
 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

getEnvironmentType()

  public 
  
 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

getEnvironmentTypeValue()

  public 
  
 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 
  
 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

The externalId.

getExternalIdBytes()

  public 
  
 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

The bytes for externalId.

getImpressionLimit()

  public 
  
 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

The impressionLimit.

getImpressionLimitOrBuilder()

  public 
  
 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

getLastModifiedByApp()

  public 
  
 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

The lastModifiedByApp.

getLastModifiedByAppBytes()

  public 
  
 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

The bytes for lastModifiedByApp.

getLineItemType()

  public 
  
 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

The lineItemType.

getLineItemTypeValue()

  public 
  
 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 
  
 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

The missingCreatives.

getName()

  public 
  
 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

The name.

getNameBytes()

  public 
  
 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

The bytes for name.

getNotes()

  public 
  
 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

The notes.

getNotesBytes()

  public 
  
 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

The bytes for notes.

getParserForType()

  public 
  
 Parser<LineItem> 
  
 getParserForType 
 () 
 
Returns
Type
Description
Overrides

getPrimaryGoal()

  public 
  
 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

The primaryGoal.

getPrimaryGoalOrBuilder()

  public 
  
 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

getPriority()

  public 
  
 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

The priority.

getReservationStatus()

  public 
  
 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

getReservationStatusValue()

  public 
  
 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.

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type
Description
int
Overrides

getStartTime()

  public 
  
 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

The startTime.

getStartTimeOrBuilder()

  public 
  
 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

getStatus()

  public 
  
 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

getStatusValue()

  public 
  
 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 
  
 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

The unlimitedEndTime.

getUpdateTime()

  public 
  
 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

The updateTime.

getUpdateTimeOrBuilder()

  public 
  
 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

getWebPropertyCode()

  public 
  
 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

The webPropertyCode.

getWebPropertyCodeBytes()

  public 
  
 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

The bytes for webPropertyCode.

hasCostPerUnit()

  public 
  
 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

Whether the costPerUnit field is set.

hasCreateTime()

  public 
  
 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

Whether the createTime field is set.

hasEndTime()

  public 
  
 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

Whether the endTime field is set.

hasImpressionLimit()

  public 
  
 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

Whether the impressionLimit field is set.

hasPrimaryGoal()

  public 
  
 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

Whether the primaryGoal field is set.

hasStartTime()

  public 
  
 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

Whether the startTime field is set.

hasUpdateTime()

  public 
  
 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

Whether the updateTime field is set.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type
Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessageV3 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
Overrides

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

newBuilderForType()

  public 
  
 LineItem 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type
Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

  protected 
  
 LineItem 
 . 
 Builder 
  
 newBuilderForType 
 ( 
 GeneratedMessageV3 
 . 
 BuilderParent 
  
 parent 
 ) 
 
Parameter
Name
Description
parent
Returns
Type
Description
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

  protected 
  
 Object 
  
 newInstance 
 ( 
 GeneratedMessageV3 
 . 
 UnusedPrivateParameter 
  
 unused 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Overrides

toBuilder()

  public 
  
 LineItem 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type
Description

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name
Description
Overrides
Exceptions
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: