Class LineItem (0.41.0)

  public 
  
 final 
  
 class 
 LineItem 
  
 extends 
  
 GeneratedMessageV3 
  
 implements 
  
 LineItemOrBuilder 
 

A LineItem contains information about how specific ad creatives are intended to serve to your website or app along with pricing and other delivery details.

Protobuf type google.ads.admanager.v1.LineItem

Implements

LineItemOrBuilder

Static Fields

BUDGET_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 BUDGET_FIELD_NUMBER 
 
Field Value
Type
Description
int

CUSTOM_FIELD_VALUES_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CUSTOM_FIELD_VALUES_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

GOAL_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 GOAL_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

NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

ORDER_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ORDER_FIELD_NUMBER 
 
Field Value
Type
Description
int

RATE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 RATE_FIELD_NUMBER 
 
Field Value
Type
Description
int

START_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 START_TIME_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

getBudget()

  public 
  
 Money 
  
 getBudget 
 () 
 

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

optional .google.type.Money budget = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description
com.google.type.Money

The budget.

getBudgetOrBuilder()

  public 
  
 MoneyOrBuilder 
  
 getBudgetOrBuilder 
 () 
 

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

optional .google.type.Money budget = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description
com.google.type.MoneyOrBuilder

getCustomFieldValues(int index)

  public 
  
 CustomFieldValue 
  
 getCustomFieldValues 
 ( 
 int 
  
 index 
 ) 
 

Optional. The values of the custom fields associated with this line item.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 59 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getCustomFieldValuesCount()

  public 
  
 int 
  
 getCustomFieldValuesCount 
 () 
 

Optional. The values of the custom fields associated with this line item.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 59 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getCustomFieldValuesList()

  public 
  
 List<CustomFieldValue> 
  
 getCustomFieldValuesList 
 () 
 

Optional. The values of the custom fields associated with this line item.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 59 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getCustomFieldValuesOrBuilder(int index)

  public 
  
 CustomFieldValueOrBuilder 
  
 getCustomFieldValuesOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

Optional. The values of the custom fields associated with this line item.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 59 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getCustomFieldValuesOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 CustomFieldValueOrBuilder 
>  
 getCustomFieldValuesOrBuilderList 
 () 
 

Optional. The values of the custom fields associated with this line item.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 59 [(.google.api.field_behavior) = OPTIONAL];

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

getDefaultInstanceForType()

  public 
  
 LineItem 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type
Description

getDisplayName()

  public 
  
 String 
  
 getDisplayName 
 () 
 

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

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

The displayName.

getDisplayNameBytes()

  public 
  
 ByteString 
  
 getDisplayNameBytes 
 () 
 

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

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

The bytes for displayName.

getEndTime()

  public 
  
 Timestamp 
  
 getEndTime 
 () 
 

Output only. The timestamp when the LineItem will stop serving. This attribute is read-only and includes auto extension days.

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

Returns
Type
Description

The endTime.

getEndTimeOrBuilder()

  public 
  
 TimestampOrBuilder 
  
 getEndTimeOrBuilder 
 () 
 

Output only. The timestamp when the LineItem will stop serving. This attribute is read-only and includes auto extension days.

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

Returns
Type
Description

getGoal()

  public 
  
 Goal 
  
 getGoal 
 () 
 

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

optional .google.ads.admanager.v1.Goal goal = 76 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The goal.

getGoalOrBuilder()

  public 
  
 GoalOrBuilder 
  
 getGoalOrBuilder 
 () 
 

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

optional .google.ads.admanager.v1.Goal goal = 76 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getLineItemType()

  public 
  
 LineItemTypeEnum 
 . 
 LineItemType 
  
 getLineItemType 
 () 
 

Required. 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 at https://support.google.com/admanager/answer/177279 .

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

Returns
Type
Description

The lineItemType.

getLineItemTypeValue()

  public 
  
 int 
  
 getLineItemTypeValue 
 () 
 

Required. 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 at https://support.google.com/admanager/answer/177279 .

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

Returns
Type
Description
int

The enum numeric value on the wire for lineItemType.

getName()

  public 
  
 String 
  
 getName 
 () 
 

Identifier. The resource name of the LineItem . Format: networks/{network_code}/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}/lineItems/{line_item_id}

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

Returns
Type
Description

The bytes for name.

getOrder()

  public 
  
 String 
  
 getOrder 
 () 
 

Output only. The ID of the Order to which the LineItem belongs. This attribute is required. Format: networks/{network_code}/orders/{order}

optional string order = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type
Description

The order.

getOrderBytes()

  public 
  
 ByteString 
  
 getOrderBytes 
 () 
 

Output only. The ID of the Order to which the LineItem belongs. This attribute is required. Format: networks/{network_code}/orders/{order}

optional string order = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type
Description

The bytes for order.

getParserForType()

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

getRate()

  public 
  
 Money 
  
 getRate 
 () 
 

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

optional .google.type.Money rate = 20 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description
com.google.type.Money

The rate.

getRateOrBuilder()

  public 
  
 MoneyOrBuilder 
  
 getRateOrBuilder 
 () 
 

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

optional .google.type.Money rate = 20 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description
com.google.type.MoneyOrBuilder

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type
Description
int
Overrides

getStartTime()

  public 
  
 Timestamp 
  
 getStartTime 
 () 
 

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

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

Returns
Type
Description

The startTime.

getStartTimeOrBuilder()

  public 
  
 TimestampOrBuilder 
  
 getStartTimeOrBuilder 
 () 
 

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

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

Returns
Type
Description

hasBudget()

  public 
  
 boolean 
  
 hasBudget 
 () 
 

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

optional .google.type.Money budget = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

Whether the budget field is set.

hasDisplayName()

  public 
  
 boolean 
  
 hasDisplayName 
 () 
 

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

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

Whether the displayName field is set.

hasEndTime()

  public 
  
 boolean 
  
 hasEndTime 
 () 
 

Output only. The timestamp when the LineItem will stop serving. This attribute is read-only and includes auto extension days.

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

Returns
Type
Description

Whether the endTime field is set.

hasGoal()

  public 
  
 boolean 
  
 hasGoal 
 () 
 

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

optional .google.ads.admanager.v1.Goal goal = 76 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the goal field is set.

hasLineItemType()

  public 
  
 boolean 
  
 hasLineItemType 
 () 
 

Required. 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 at https://support.google.com/admanager/answer/177279 .

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

Returns
Type
Description

Whether the lineItemType field is set.

hasOrder()

  public 
  
 boolean 
  
 hasOrder 
 () 
 

Output only. The ID of the Order to which the LineItem belongs. This attribute is required. Format: networks/{network_code}/orders/{order}

optional string order = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type
Description

Whether the order field is set.

hasRate()

  public 
  
 boolean 
  
 hasRate 
 () 
 

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

optional .google.type.Money rate = 20 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

Whether the rate field is set.

hasStartTime()

  public 
  
 boolean 
  
 hasStartTime 
 () 
 

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

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

Returns
Type
Description

Whether the startTime 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
Create a Mobile Website
View Site in Mobile | Classic
Share by: