Interface LineItemOrBuilder (0.44.0)

public interface LineItemOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBudget()

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

getDisplayName()

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

getRate()

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

getStartTime()

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