Class LineItem (0.44.0)

Version latest

• 0.44.0 (latest)
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.29.0
• 0.27.0
• 0.26.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class LineItem extends GeneratedMessage 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > LineItem

Implements

LineItemOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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
LineItem

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static LineItem.Builder newBuilder()

Returns
Type	Description
LineItem.Builder

newBuilder(LineItem prototype)

public static LineItem.Builder newBuilder(LineItem prototype)

Parameter
Name	Description
prototype	LineItem

Returns
Type	Description
LineItem.Builder

parseDelimitedFrom(InputStream input)

public static LineItem parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
LineItem

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LineItem parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LineItem

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static LineItem parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
LineItem

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LineItem parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LineItem

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LineItem parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
LineItem

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LineItem parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LineItem

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LineItem parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
LineItem

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LineItem parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LineItem

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static LineItem parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
LineItem

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LineItem parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LineItem

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static LineItem parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
LineItem

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LineItem parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LineItem

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<LineItem> parser()

Returns
Type	Description
Parser<LineItem>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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
CustomFieldValue

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
List<CustomFieldValue>

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
CustomFieldValueOrBuilder

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
LineItem

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
String	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
ByteString	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
Timestamp	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
TimestampOrBuilder

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
Goal	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
GoalOrBuilder

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
LineItemTypeEnum.LineItemType	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
String	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
ByteString	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
String	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
ByteString	The bytes for order.

getParserForType()

public Parser<LineItem> getParserForType()

Returns
Type	Description
Parser<LineItem>

Overrides

GeneratedMessage.getParserForType()

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

GeneratedMessage.getSerializedSize()

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
Timestamp	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
TimestampOrBuilder

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
boolean	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
boolean	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
boolean	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
boolean	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
boolean	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
boolean	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
boolean	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
boolean	Whether the startTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public LineItem.Builder newBuilderForType()

Returns
Type	Description
LineItem.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected LineItem.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
LineItem.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public LineItem.Builder toBuilder()

Returns
Type	Description
LineItem.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException