Class LineItem.Builder (0.54.0)

public static final class LineItem.Builder extends GeneratedMessage.Builder<LineItem.Builder> 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 Methods

getDescriptor()

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

Methods

addAllAllowedFormats(Iterable<? extends LineItemAllowedFormatEnum.LineItemAllowedFormat> values)

public LineItem.Builder addAllAllowedFormats(Iterable<? extends LineItemAllowedFormatEnum.LineItemAllowedFormat> values)

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat>

The allowedFormats to add.

Returns
Type Description
LineItem.Builder

This builder for chaining.

addAllAllowedFormatsValue(Iterable<Integer> values)

public LineItem.Builder addAllAllowedFormatsValue(Iterable<Integer> values)

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for allowedFormats to add.

Returns
Type Description
LineItem.Builder

This builder for chaining.

addAllAppliedLabels(Iterable<? extends AppliedLabel> values)

public LineItem.Builder addAllAppliedLabels(Iterable<? extends AppliedLabel> values)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.AppliedLabel>
Returns
Type Description
LineItem.Builder

addAllCreativePlaceholders(Iterable<? extends CreativePlaceholder> values)

public LineItem.Builder addAllCreativePlaceholders(Iterable<? extends CreativePlaceholder> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.CreativePlaceholder>
Returns
Type Description
LineItem.Builder

addAllCreativeTargetings(Iterable<? extends CreativeTargeting> values)

public LineItem.Builder addAllCreativeTargetings(Iterable<? extends CreativeTargeting> values)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.CreativeTargeting>
Returns
Type Description
LineItem.Builder

addAllCustomFieldValues(Iterable<? extends CustomFieldValue> values)

public LineItem.Builder addAllCustomFieldValues(Iterable<? extends CustomFieldValue> values)

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
values Iterable<? extends com.google.ads.admanager.v1.CustomFieldValue>
Returns
Type Description
LineItem.Builder

addAllEffectiveAppliedLabels(Iterable<? extends AppliedLabel> values)

public LineItem.Builder addAllEffectiveAppliedLabels(Iterable<? extends AppliedLabel> values)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.AppliedLabel>
Returns
Type Description
LineItem.Builder

addAllFrequencyCaps(Iterable<? extends FrequencyCap> values)

public LineItem.Builder addAllFrequencyCaps(Iterable<? extends FrequencyCap> values)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.FrequencyCap>
Returns
Type Description
LineItem.Builder

addAllSecondaryGoals(Iterable<? extends Goal> values)

public LineItem.Builder addAllSecondaryGoals(Iterable<? extends Goal> values)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.Goal>
Returns
Type Description
LineItem.Builder

addAllViewabilityProviderCompanies(Iterable<String> values)

public LineItem.Builder addAllViewabilityProviderCompanies(Iterable<String> values)

Optional. Optional IDs of the Company that provide ad verification for this line item.

repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The viewabilityProviderCompanies to add.

Returns
Type Description
LineItem.Builder

This builder for chaining.

addAllowedFormats(LineItemAllowedFormatEnum.LineItemAllowedFormat value)

public LineItem.Builder addAllowedFormats(LineItemAllowedFormatEnum.LineItemAllowedFormat value)

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LineItemAllowedFormatEnum.LineItemAllowedFormat

The allowedFormats to add.

Returns
Type Description
LineItem.Builder

This builder for chaining.

addAllowedFormatsValue(int value)

public LineItem.Builder addAllowedFormatsValue(int value)

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for allowedFormats to add.

Returns
Type Description
LineItem.Builder

This builder for chaining.

addAppliedLabels(AppliedLabel value)

public LineItem.Builder addAppliedLabels(AppliedLabel value)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AppliedLabel
Returns
Type Description
LineItem.Builder

addAppliedLabels(AppliedLabel.Builder builderForValue)

public LineItem.Builder addAppliedLabels(AppliedLabel.Builder builderForValue)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AppliedLabel.Builder
Returns
Type Description
LineItem.Builder

addAppliedLabels(int index, AppliedLabel value)

public LineItem.Builder addAppliedLabels(int index, AppliedLabel value)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
LineItem.Builder

addAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public LineItem.Builder addAppliedLabels(int index, AppliedLabel.Builder builderForValue)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
LineItem.Builder

addAppliedLabelsBuilder()

public AppliedLabel.Builder addAppliedLabelsBuilder()

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AppliedLabel.Builder

addAppliedLabelsBuilder(int index)

public AppliedLabel.Builder addAppliedLabelsBuilder(int index)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

addCreativePlaceholders(CreativePlaceholder value)

public LineItem.Builder addCreativePlaceholders(CreativePlaceholder value)

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

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

Parameter
Name Description
value CreativePlaceholder
Returns
Type Description
LineItem.Builder

addCreativePlaceholders(CreativePlaceholder.Builder builderForValue)

public LineItem.Builder addCreativePlaceholders(CreativePlaceholder.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue CreativePlaceholder.Builder
Returns
Type Description
LineItem.Builder

addCreativePlaceholders(int index, CreativePlaceholder value)

public LineItem.Builder addCreativePlaceholders(int index, CreativePlaceholder value)

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

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

Parameters
Name Description
index int
value CreativePlaceholder
Returns
Type Description
LineItem.Builder

addCreativePlaceholders(int index, CreativePlaceholder.Builder builderForValue)

public LineItem.Builder addCreativePlaceholders(int index, CreativePlaceholder.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue CreativePlaceholder.Builder
Returns
Type Description
LineItem.Builder

addCreativePlaceholdersBuilder()

public CreativePlaceholder.Builder addCreativePlaceholdersBuilder()

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

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

Returns
Type Description
CreativePlaceholder.Builder

addCreativePlaceholdersBuilder(int index)

public CreativePlaceholder.Builder addCreativePlaceholdersBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholder.Builder

addCreativeTargetings(CreativeTargeting value)

public LineItem.Builder addCreativeTargetings(CreativeTargeting value)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CreativeTargeting
Returns
Type Description
LineItem.Builder

addCreativeTargetings(CreativeTargeting.Builder builderForValue)

public LineItem.Builder addCreativeTargetings(CreativeTargeting.Builder builderForValue)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue CreativeTargeting.Builder
Returns
Type Description
LineItem.Builder

addCreativeTargetings(int index, CreativeTargeting value)

public LineItem.Builder addCreativeTargetings(int index, CreativeTargeting value)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value CreativeTargeting
Returns
Type Description
LineItem.Builder

addCreativeTargetings(int index, CreativeTargeting.Builder builderForValue)

public LineItem.Builder addCreativeTargetings(int index, CreativeTargeting.Builder builderForValue)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue CreativeTargeting.Builder
Returns
Type Description
LineItem.Builder

addCreativeTargetingsBuilder()

public CreativeTargeting.Builder addCreativeTargetingsBuilder()

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeTargeting.Builder

addCreativeTargetingsBuilder(int index)

public CreativeTargeting.Builder addCreativeTargetingsBuilder(int index)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CreativeTargeting.Builder

addCustomFieldValues(CustomFieldValue value)

public LineItem.Builder addCustomFieldValues(CustomFieldValue value)

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
value CustomFieldValue
Returns
Type Description
LineItem.Builder

addCustomFieldValues(CustomFieldValue.Builder builderForValue)

public LineItem.Builder addCustomFieldValues(CustomFieldValue.Builder builderForValue)

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
builderForValue CustomFieldValue.Builder
Returns
Type Description
LineItem.Builder

addCustomFieldValues(int index, CustomFieldValue value)

public LineItem.Builder addCustomFieldValues(int index, CustomFieldValue value)

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];

Parameters
Name Description
index int
value CustomFieldValue
Returns
Type Description
LineItem.Builder

addCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

public LineItem.Builder addCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue CustomFieldValue.Builder
Returns
Type Description
LineItem.Builder

addCustomFieldValuesBuilder()

public CustomFieldValue.Builder addCustomFieldValuesBuilder()

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
CustomFieldValue.Builder

addCustomFieldValuesBuilder(int index)

public CustomFieldValue.Builder addCustomFieldValuesBuilder(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.Builder

addEffectiveAppliedLabels(AppliedLabel value)

public LineItem.Builder addEffectiveAppliedLabels(AppliedLabel value)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value AppliedLabel
Returns
Type Description
LineItem.Builder

addEffectiveAppliedLabels(AppliedLabel.Builder builderForValue)

public LineItem.Builder addEffectiveAppliedLabels(AppliedLabel.Builder builderForValue)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue AppliedLabel.Builder
Returns
Type Description
LineItem.Builder

addEffectiveAppliedLabels(int index, AppliedLabel value)

public LineItem.Builder addEffectiveAppliedLabels(int index, AppliedLabel value)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
LineItem.Builder

addEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public LineItem.Builder addEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
LineItem.Builder

addEffectiveAppliedLabelsBuilder()

public AppliedLabel.Builder addEffectiveAppliedLabelsBuilder()

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AppliedLabel.Builder

addEffectiveAppliedLabelsBuilder(int index)

public AppliedLabel.Builder addEffectiveAppliedLabelsBuilder(int index)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

addFrequencyCaps(FrequencyCap value)

public LineItem.Builder addFrequencyCaps(FrequencyCap value)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FrequencyCap
Returns
Type Description
LineItem.Builder

addFrequencyCaps(FrequencyCap.Builder builderForValue)

public LineItem.Builder addFrequencyCaps(FrequencyCap.Builder builderForValue)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue FrequencyCap.Builder
Returns
Type Description
LineItem.Builder

addFrequencyCaps(int index, FrequencyCap value)

public LineItem.Builder addFrequencyCaps(int index, FrequencyCap value)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value FrequencyCap
Returns
Type Description
LineItem.Builder

addFrequencyCaps(int index, FrequencyCap.Builder builderForValue)

public LineItem.Builder addFrequencyCaps(int index, FrequencyCap.Builder builderForValue)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue FrequencyCap.Builder
Returns
Type Description
LineItem.Builder

addFrequencyCapsBuilder()

public FrequencyCap.Builder addFrequencyCapsBuilder()

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FrequencyCap.Builder

addFrequencyCapsBuilder(int index)

public FrequencyCap.Builder addFrequencyCapsBuilder(int index)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FrequencyCap.Builder

addSecondaryGoals(Goal value)

public LineItem.Builder addSecondaryGoals(Goal value)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Goal
Returns
Type Description
LineItem.Builder

addSecondaryGoals(Goal.Builder builderForValue)

public LineItem.Builder addSecondaryGoals(Goal.Builder builderForValue)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Goal.Builder
Returns
Type Description
LineItem.Builder

addSecondaryGoals(int index, Goal value)

public LineItem.Builder addSecondaryGoals(int index, Goal value)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Goal
Returns
Type Description
LineItem.Builder

addSecondaryGoals(int index, Goal.Builder builderForValue)

public LineItem.Builder addSecondaryGoals(int index, Goal.Builder builderForValue)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Goal.Builder
Returns
Type Description
LineItem.Builder

addSecondaryGoalsBuilder()

public Goal.Builder addSecondaryGoalsBuilder()

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Goal.Builder

addSecondaryGoalsBuilder(int index)

public Goal.Builder addSecondaryGoalsBuilder(int index)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Goal.Builder

addViewabilityProviderCompanies(String value)

public LineItem.Builder addViewabilityProviderCompanies(String value)

Optional. Optional IDs of the Company that provide ad verification for this line item.

repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The viewabilityProviderCompanies to add.

Returns
Type Description
LineItem.Builder

This builder for chaining.

addViewabilityProviderCompaniesBytes(ByteString value)

public LineItem.Builder addViewabilityProviderCompaniesBytes(ByteString value)

Optional. Optional IDs of the Company that provide ad verification for this line item.

repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the viewabilityProviderCompanies to add.

Returns
Type Description
LineItem.Builder

This builder for chaining.

build()

public LineItem build()
Returns
Type Description
LineItem

buildPartial()

public LineItem buildPartial()
Returns
Type Description
LineItem

clear()

public LineItem.Builder clear()
Returns
Type Description
LineItem.Builder
Overrides

clearAllowOverbook()

public LineItem.Builder clearAllowOverbook()

Input only. The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types SPONSORSHIP and STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool allow_overbook = 28 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearAllowedFormats()

public LineItem.Builder clearAllowedFormats()

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearAppliedLabels()

public LineItem.Builder clearAppliedLabels()

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

clearArchived()

public LineItem.Builder clearArchived()

Output only. The archival status of the LineItem.

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

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearAutoExtensionDays()

public LineItem.Builder clearAutoExtensionDays()

Optional. The number of days to allow a line item to deliver past its target_end_time. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.

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

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearBudget()

public LineItem.Builder clearBudget()

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
LineItem.Builder

clearChildContentEligibility()

public LineItem.Builder clearChildContentEligibility()

Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.

optional .google.ads.admanager.v1.ChildContentEligibilityEnum.ChildContentEligibility child_content_eligibility = 86 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearCompanionDeliveryOption()

public LineItem.Builder clearCompanionDeliveryOption()

Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:

  • The "Guaranteed roadblocks" feature is enabled on your network.
  • One of the following is true (both cannot be true, these are mutually exclusive).
  • The environmentType is VIDEO_PLAYER.
  • The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.

optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption companion_delivery_option = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearCompetitiveConstraintScope()

public LineItem.Builder clearCompetitiveConstraintScope()

Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.

optional .google.ads.admanager.v1.ExclusionScopeEnum.ExclusionScope competitive_constraint_scope = 56 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearContractedUnitsBought()

public LineItem.Builder clearContractedUnitsBought()

Optional. This attribute is only applicable for certain line item types and acts as an "FYI" or note, which does not impact adserving or other backend systems. For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a "FYI" for traffickers to manually intervene with the LineItem when needed. This attribute is only available for STANDARD line items if you have this feature enabled on your network.

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

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearCostType()

public LineItem.Builder clearCostType()

Required. The method used for billing this LineItem.

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

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearCreateTime()

public LineItem.Builder clearCreateTime()

Output only. The time this line item was created.

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

Returns
Type Description
LineItem.Builder

clearCreativePlaceholders()

public LineItem.Builder clearCreativePlaceholders()

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

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

Returns
Type Description
LineItem.Builder

clearCreativeRotationType()

public LineItem.Builder clearCreativeRotationType()

Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.

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

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearCreativeTargetings()

public LineItem.Builder clearCreativeTargetings()

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

clearCustomFieldValues()

public LineItem.Builder clearCustomFieldValues()

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
LineItem.Builder

clearCustomPacingCurve()

public LineItem.Builder clearCustomPacingCurve()

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.

optional .google.ads.admanager.v1.CustomPacingCurve custom_pacing_curve = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

clearCustomVastExtension()

public LineItem.Builder clearCustomVastExtension()

Optional. Custom XML to be rendered in a custom VAST response at serving time.

optional string custom_vast_extension = 88 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearDealInfo()

public LineItem.Builder clearDealInfo()

Optional. The deal information associated with this line item, if it is programmatic.

optional .google.ads.admanager.v1.LineItemDealInfo deal_info = 79 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

clearDeliveryForecastSource()

public LineItem.Builder clearDeliveryForecastSource()

Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.

optional .google.ads.admanager.v1.LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource delivery_forecast_source = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearDeliveryIndicator()

public LineItem.Builder clearDeliveryIndicator()

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:

  • The line item is not delivering.
  • The line item has an unlimited goal or cap.
  • The line item has a percentage based goal or cap.

optional .google.ads.admanager.v1.DeliveryIndicator delivery_indicator = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItem.Builder

clearDeliveryRateType()

public LineItem.Builder clearDeliveryRateType()

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

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearDiscount()

public LineItem.Builder clearDiscount()

Optional. Discount information for the line item.

optional .google.ads.admanager.v1.LineItemDiscount discount = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

clearDisplayName()

public LineItem.Builder clearDisplayName()

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

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

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearEffectiveAppliedLabels()

public LineItem.Builder clearEffectiveAppliedLabels()

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItem.Builder

clearEndTime()

public LineItem.Builder clearEndTime()

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

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

Returns
Type Description
LineItem.Builder

clearEndTimeUnlimited()

public LineItem.Builder clearEndTimeUnlimited()

Optional. Non-empty default. Specifies whether or not the LineItem has an end time. This attribute defaults to false. It can be be set to true for only line items of type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.

optional bool end_time_unlimited = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearEnvironmentType()

public LineItem.Builder clearEnvironmentType()

Optional. Non-empty default. The environment that the LineItem 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 environmentType is also VIDEO_PLAYER.

optional .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearExternalLineItemId()

public LineItem.Builder clearExternalLineItemId()

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

optional string external_line_item_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearFrequencyCaps()

public LineItem.Builder clearFrequencyCaps()

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

clearGoal()

public LineItem.Builder clearGoal()

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
LineItem.Builder

clearGrpSettings()

public LineItem.Builder clearGrpSettings()

Optional. Contains the information for a line item which has a target GRP demographic.

optional .google.ads.admanager.v1.GrpSettings grp_settings = 78 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

clearLineItemType()

public LineItem.Builder clearLineItemType()

Required. Indicates the line item type of a LineItem. 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
LineItem.Builder

This builder for chaining.

clearMaxVideoCreativeDuration()

public LineItem.Builder clearMaxVideoCreativeDuration()

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

optional .google.protobuf.Duration max_video_creative_duration = 75 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

clearMissingCreatives()

public LineItem.Builder clearMissingCreatives()

Output only. Indicates if a LineItem is missing any Creative creatives for the creativePlaceholders specified. Creative Creatives can be considered missing for several reasons including:

  • Not enough Creative creatives of a certain size have been uploaded, as determined by expected_creative_count. For example a LineItem specifies 750x350, 400x200 but only a 750x350 was uploaded. Or LineItem specifies 750x350 with an expected count of 2, but only one was uploaded.
  • The [Creative.applied_labels][] of an associated Creative don't match the CreativePlaceholder.applied_labels of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.

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

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearName()

public LineItem.Builder clearName()

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
LineItem.Builder

This builder for chaining.

clearNotes()

public LineItem.Builder clearNotes()

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

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

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearOrder()

public LineItem.Builder clearOrder()

Required. Immutable. The ID of the Order to which the LineItem belongs. Format: networks/{network_code}/orders/{order}

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

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearOrderDisplayName()

public LineItem.Builder clearOrderDisplayName()

Output only. The name of the Order.

optional string order_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearPriority()

public LineItem.Builder clearPriority()

Optional. Non-empty default. The priority for the line item. Valid values range from 1 to 16. This field defaults to the default priority of the LineItemType. The following list shows the default, minimum, and maximum priority values are for each line item type:

  • 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)
  • ADMOB: 21 (1, 16)
  • PREFERRED_DEAL: 12 (12, 12) This field can only be edited by certain networks, otherwise a PermissionError will occur.

optional int32 priority = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearRate()

public LineItem.Builder clearRate()

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
LineItem.Builder

clearRepeatedCreativeServingEnabled()

public LineItem.Builder clearRepeatedCreativeServingEnabled()

Optional. Indicates whether repeated creative serving is enabled for this line item.

optional bool repeated_creative_serving_enabled = 90 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearReservationStatus()

public LineItem.Builder clearReservationStatus()

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

optional .google.ads.admanager.v1.LineItemReservationStatusEnum.LineItemReservationStatus reservation_status = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearReserveOnCreation()

public LineItem.Builder clearReserveOnCreation()

Input only. The flag indicates whether inventory should be reserved when creating a line item of types SPONSORSHIP and STANDARD in an unapproved Order. The default value is false.

optional bool reserve_on_creation = 31 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearRoadblockingType()

public LineItem.Builder clearRoadblockingType()

Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearSameAdvertiserExceptionEnabled()

public LineItem.Builder clearSameAdvertiserExceptionEnabled()

Optional. If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.

optional bool same_advertiser_exception_enabled = 52 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearSecondaryGoals()

public LineItem.Builder clearSecondaryGoals()

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

clearSkipCrossSellingRuleWarningChecks()

public LineItem.Builder clearSkipCrossSellingRuleWarningChecks()

Input only. True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool skip_cross_selling_rule_warning_checks = 30 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearSkipInventoryCheck()

public LineItem.Builder clearSkipInventoryCheck()

Input only. The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool skip_inventory_check = 29 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearSkippableAdType()

public LineItem.Builder clearSkippableAdType()

Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.

optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearSponsorshipExclusivityEnabled()

public LineItem.Builder clearSponsorshipExclusivityEnabled()

Optional. Whether the line item is enabled for sponsorship exclusivity. If true, only exclusive sponsorships can be served on inventory targeted by this LineItem. This control should only be available for 100% video sponsorships.

optional bool sponsorship_exclusivity_enabled = 89 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearStartTime()

public LineItem.Builder clearStartTime()

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
LineItem.Builder

clearStats()

public LineItem.Builder clearStats()

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.

optional .google.ads.admanager.v1.LineItemStats stats = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItem.Builder

clearStatus()

public LineItem.Builder clearStatus()

Output only. The status of the LineItem.

optional .google.ads.admanager.v1.LineItemComputedStatusEnum.LineItemComputedStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearTargetEndTime()

public LineItem.Builder clearTargetEndTime()

Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.

optional .google.protobuf.Timestamp target_end_time = 95 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

clearTargeting()

public LineItem.Builder clearTargeting()

Required. Contains the targeting criteria for the ad campaign.

optional .google.ads.admanager.v1.Targeting targeting = 93 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LineItem.Builder

clearThirdPartyMeasurementSettings()

public LineItem.Builder clearThirdPartyMeasurementSettings()

Optional. Third party auto-pixeling settings for cross-sell Partners.

optional .google.ads.admanager.v1.ThirdPartyMeasurementSettings third_party_measurement_settings = 67 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

clearUpdateSource()

public LineItem.Builder clearUpdateSource()

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

optional string update_source = 53 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearUpdateTime()

public LineItem.Builder clearUpdateTime()

Output only. The time this line item was last modified.

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

Returns
Type Description
LineItem.Builder

clearValueCpm()

public LineItem.Builder clearValueCpm()

Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.

optional .google.type.Money value_cpm = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItem.Builder

clearViewabilityProviderCompanies()

public LineItem.Builder clearViewabilityProviderCompanies()

Optional. Optional IDs of the Company that provide ad verification for this line item.

repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearWebPropertyCode()

public LineItem.Builder clearWebPropertyCode()

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.

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

Returns
Type Description
LineItem.Builder

This builder for chaining.

clearYoutubeKidsRestricted()

public LineItem.Builder clearYoutubeKidsRestricted()

Optional. Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the help center article for more information: https://support.google.com/yt-partner-sales/answer/10015534.

optional bool youtube_kids_restricted = 74 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItem.Builder

This builder for chaining.

getAllowOverbook()

public boolean getAllowOverbook()

Input only. The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types SPONSORSHIP and STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool allow_overbook = 28 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

The allowOverbook.

getAllowedFormats(int index)

public LineItemAllowedFormatEnum.LineItemAllowedFormat getAllowedFormats(int index)

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
LineItemAllowedFormatEnum.LineItemAllowedFormat

The allowedFormats at the given index.

getAllowedFormatsCount()

public int getAllowedFormatsCount()

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of allowedFormats.

getAllowedFormatsList()

public List<LineItemAllowedFormatEnum.LineItemAllowedFormat> getAllowedFormatsList()

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<LineItemAllowedFormat>

A list containing the allowedFormats.

getAllowedFormatsValue(int index)

public int getAllowedFormatsValue(int index)

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of allowedFormats at the given index.

getAllowedFormatsValueList()

public List<Integer> getAllowedFormatsValueList()

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for allowedFormats.

getAppliedLabels(int index)

public AppliedLabel getAppliedLabels(int index)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel

getAppliedLabelsBuilder(int index)

public AppliedLabel.Builder getAppliedLabelsBuilder(int index)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

getAppliedLabelsBuilderList()

public List<AppliedLabel.Builder> getAppliedLabelsBuilderList()

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getAppliedLabelsCount()

public int getAppliedLabelsCount()

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAppliedLabelsList()

public List<AppliedLabel> getAppliedLabelsList()

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AppliedLabel>

getAppliedLabelsOrBuilder(int index)

public AppliedLabelOrBuilder getAppliedLabelsOrBuilder(int index)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabelOrBuilder

getAppliedLabelsOrBuilderList()

public List<? extends AppliedLabelOrBuilder> getAppliedLabelsOrBuilderList()

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

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

getArchived()

public boolean getArchived()

Output only. The archival status of the LineItem.

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

Returns
Type Description
boolean

The archived.

getAutoExtensionDays()

public int getAutoExtensionDays()

Optional. The number of days to allow a line item to deliver past its target_end_time. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.

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

Returns
Type Description
int

The autoExtensionDays.

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.

getBudgetBuilder()

public Money.Builder getBudgetBuilder()

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

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

getChildContentEligibility()

public ChildContentEligibilityEnum.ChildContentEligibility getChildContentEligibility()

Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.

optional .google.ads.admanager.v1.ChildContentEligibilityEnum.ChildContentEligibility child_content_eligibility = 86 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
ChildContentEligibilityEnum.ChildContentEligibility

The childContentEligibility.

getChildContentEligibilityValue()

public int getChildContentEligibilityValue()

Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.

optional .google.ads.admanager.v1.ChildContentEligibilityEnum.ChildContentEligibility child_content_eligibility = 86 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for childContentEligibility.

getCompanionDeliveryOption()

public CompanionDeliveryOptionEnum.CompanionDeliveryOption getCompanionDeliveryOption()

Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:

  • The "Guaranteed roadblocks" feature is enabled on your network.
  • One of the following is true (both cannot be true, these are mutually exclusive).
  • The environmentType is VIDEO_PLAYER.
  • The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.

optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption companion_delivery_option = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CompanionDeliveryOptionEnum.CompanionDeliveryOption

The companionDeliveryOption.

getCompanionDeliveryOptionValue()

public int getCompanionDeliveryOptionValue()

Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:

  • The "Guaranteed roadblocks" feature is enabled on your network.
  • One of the following is true (both cannot be true, these are mutually exclusive).
  • The environmentType is VIDEO_PLAYER.
  • The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.

optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption companion_delivery_option = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for companionDeliveryOption.

getCompetitiveConstraintScope()

public ExclusionScopeEnum.ExclusionScope getCompetitiveConstraintScope()

Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.

optional .google.ads.admanager.v1.ExclusionScopeEnum.ExclusionScope competitive_constraint_scope = 56 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
ExclusionScopeEnum.ExclusionScope

The competitiveConstraintScope.

getCompetitiveConstraintScopeValue()

public int getCompetitiveConstraintScopeValue()

Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.

optional .google.ads.admanager.v1.ExclusionScopeEnum.ExclusionScope competitive_constraint_scope = 56 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for competitiveConstraintScope.

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 adserving or other backend systems. For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a "FYI" for traffickers to manually intervene with the LineItem when needed. This attribute is only available for STANDARD line items if you have this feature enabled on your network.

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

Returns
Type Description
long

The contractedUnitsBought.

getCostType()

public LineItemCostTypeEnum.LineItemCostType getCostType()

Required. The method used for billing this LineItem.

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

Returns
Type Description
LineItemCostTypeEnum.LineItemCostType

The costType.

getCostTypeValue()

public int getCostTypeValue()

Required. The method used for billing this LineItem.

optional .google.ads.admanager.v1.LineItemCostTypeEnum.LineItemCostType cost_type = 22 [(.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 time this line item was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time this line item was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time this line item was created.

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

Returns
Type Description
TimestampOrBuilder

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 = 25 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholder

getCreativePlaceholdersBuilder(int index)

public CreativePlaceholder.Builder getCreativePlaceholdersBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholder.Builder

getCreativePlaceholdersBuilderList()

public List<CreativePlaceholder.Builder> getCreativePlaceholdersBuilderList()

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

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

Returns
Type Description
List<Builder>

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 = 25 [(.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 = 25 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<CreativePlaceholder>

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 = 25 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
CreativePlaceholderOrBuilder

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 = 25 [(.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 Creative objects that are associated with the LineItem.

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

Returns
Type Description
CreativeRotationTypeEnum.CreativeRotationType

The creativeRotationType.

getCreativeRotationTypeValue()

public int getCreativeRotationTypeValue()

Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.

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

Returns
Type Description
int

The enum numeric value on the wire for creativeRotationType.

getCreativeTargetings(int index)

public CreativeTargeting getCreativeTargetings(int index)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CreativeTargeting

getCreativeTargetingsBuilder(int index)

public CreativeTargeting.Builder getCreativeTargetingsBuilder(int index)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CreativeTargeting.Builder

getCreativeTargetingsBuilderList()

public List<CreativeTargeting.Builder> getCreativeTargetingsBuilderList()

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getCreativeTargetingsCount()

public int getCreativeTargetingsCount()

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCreativeTargetingsList()

public List<CreativeTargeting> getCreativeTargetingsList()

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<CreativeTargeting>

getCreativeTargetingsOrBuilder(int index)

public CreativeTargetingOrBuilder getCreativeTargetingsOrBuilder(int index)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CreativeTargetingOrBuilder

getCreativeTargetingsOrBuilderList()

public List<? extends CreativeTargetingOrBuilder> getCreativeTargetingsOrBuilderList()

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

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

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

getCustomFieldValuesBuilder(int index)

public CustomFieldValue.Builder getCustomFieldValuesBuilder(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.Builder

getCustomFieldValuesBuilderList()

public List<CustomFieldValue.Builder> getCustomFieldValuesBuilderList()

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

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>

getCustomPacingCurve()

public CustomPacingCurve getCustomPacingCurve()

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.

optional .google.ads.admanager.v1.CustomPacingCurve custom_pacing_curve = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomPacingCurve

The customPacingCurve.

getCustomPacingCurveBuilder()

public CustomPacingCurve.Builder getCustomPacingCurveBuilder()

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.

optional .google.ads.admanager.v1.CustomPacingCurve custom_pacing_curve = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomPacingCurve.Builder

getCustomPacingCurveOrBuilder()

public CustomPacingCurveOrBuilder getCustomPacingCurveOrBuilder()

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.

optional .google.ads.admanager.v1.CustomPacingCurve custom_pacing_curve = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomPacingCurveOrBuilder

getCustomVastExtension()

public String getCustomVastExtension()

Optional. Custom XML to be rendered in a custom VAST response at serving time.

optional string custom_vast_extension = 88 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The customVastExtension.

getCustomVastExtensionBytes()

public ByteString getCustomVastExtensionBytes()

Optional. Custom XML to be rendered in a custom VAST response at serving time.

optional string custom_vast_extension = 88 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for customVastExtension.

getDealInfo()

public LineItemDealInfo getDealInfo()

Optional. The deal information associated with this line item, if it is programmatic.

optional .google.ads.admanager.v1.LineItemDealInfo deal_info = 79 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItemDealInfo

The dealInfo.

getDealInfoBuilder()

public LineItemDealInfo.Builder getDealInfoBuilder()

Optional. The deal information associated with this line item, if it is programmatic.

optional .google.ads.admanager.v1.LineItemDealInfo deal_info = 79 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItemDealInfo.Builder

getDealInfoOrBuilder()

public LineItemDealInfoOrBuilder getDealInfoOrBuilder()

Optional. The deal information associated with this line item, if it is programmatic.

optional .google.ads.admanager.v1.LineItemDealInfo deal_info = 79 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItemDealInfoOrBuilder

getDefaultInstanceForType()

public LineItem getDefaultInstanceForType()
Returns
Type Description
LineItem

getDeliveryForecastSource()

public LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource getDeliveryForecastSource()

Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.

optional .google.ads.admanager.v1.LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource delivery_forecast_source = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource

The deliveryForecastSource.

getDeliveryForecastSourceValue()

public int getDeliveryForecastSourceValue()

Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.

optional .google.ads.admanager.v1.LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource delivery_forecast_source = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for deliveryForecastSource.

getDeliveryIndicator()

public DeliveryIndicator getDeliveryIndicator()

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:

  • The line item is not delivering.
  • The line item has an unlimited goal or cap.
  • The line item has a percentage based goal or cap.

optional .google.ads.admanager.v1.DeliveryIndicator delivery_indicator = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DeliveryIndicator

The deliveryIndicator.

getDeliveryIndicatorBuilder()

public DeliveryIndicator.Builder getDeliveryIndicatorBuilder()

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:

  • The line item is not delivering.
  • The line item has an unlimited goal or cap.
  • The line item has a percentage based goal or cap.

optional .google.ads.admanager.v1.DeliveryIndicator delivery_indicator = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DeliveryIndicator.Builder

getDeliveryIndicatorOrBuilder()

public DeliveryIndicatorOrBuilder getDeliveryIndicatorOrBuilder()

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:

  • The line item is not delivering.
  • The line item has an unlimited goal or cap.
  • The line item has a percentage based goal or cap.

optional .google.ads.admanager.v1.DeliveryIndicator delivery_indicator = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DeliveryIndicatorOrBuilder

getDeliveryRateType()

public LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType getDeliveryRateType()

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

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType

The deliveryRateType.

getDeliveryRateTypeValue()

public int getDeliveryRateTypeValue()

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

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for deliveryRateType.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDiscount()

public LineItemDiscount getDiscount()

Optional. Discount information for the line item.

optional .google.ads.admanager.v1.LineItemDiscount discount = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItemDiscount

The discount.

getDiscountBuilder()

public LineItemDiscount.Builder getDiscountBuilder()

Optional. Discount information for the line item.

optional .google.ads.admanager.v1.LineItemDiscount discount = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItemDiscount.Builder

getDiscountOrBuilder()

public LineItemDiscountOrBuilder getDiscountOrBuilder()

Optional. Discount information for the line item.

optional .google.ads.admanager.v1.LineItemDiscount discount = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItemDiscountOrBuilder

getDisplayName()

public String getDisplayName()

Required. The name of the line item. This attribute 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 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.

getEffectiveAppliedLabels(int index)

public AppliedLabel getEffectiveAppliedLabels(int index)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel

getEffectiveAppliedLabelsBuilder(int index)

public AppliedLabel.Builder getEffectiveAppliedLabelsBuilder(int index)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

getEffectiveAppliedLabelsBuilderList()

public List<AppliedLabel.Builder> getEffectiveAppliedLabelsBuilderList()

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getEffectiveAppliedLabelsCount()

public int getEffectiveAppliedLabelsCount()

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getEffectiveAppliedLabelsList()

public List<AppliedLabel> getEffectiveAppliedLabelsList()

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<AppliedLabel>

getEffectiveAppliedLabelsOrBuilder(int index)

public AppliedLabelOrBuilder getEffectiveAppliedLabelsOrBuilder(int index)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabelOrBuilder

getEffectiveAppliedLabelsOrBuilderList()

public List<? extends AppliedLabelOrBuilder> getEffectiveAppliedLabelsOrBuilderList()

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getEndTime()

public Timestamp getEndTime()

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

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

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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

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

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getEndTimeUnlimited()

public boolean getEndTimeUnlimited()

Optional. Non-empty default. Specifies whether or not the LineItem has an end time. This attribute defaults to false. It can be be set to true for only line items of type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.

optional bool end_time_unlimited = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

The endTimeUnlimited.

getEnvironmentType()

public EnvironmentTypeEnum.EnvironmentType getEnvironmentType()

Optional. Non-empty default. The environment that the LineItem 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 environmentType is also VIDEO_PLAYER.

optional .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
EnvironmentTypeEnum.EnvironmentType

The environmentType.

getEnvironmentTypeValue()

public int getEnvironmentTypeValue()

Optional. Non-empty default. The environment that the LineItem 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 environmentType is also VIDEO_PLAYER.

optional .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for environmentType.

getExternalLineItemId()

public String getExternalLineItemId()

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

optional string external_line_item_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The externalLineItemId.

getExternalLineItemIdBytes()

public ByteString getExternalLineItemIdBytes()

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

optional string external_line_item_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for externalLineItemId.

getFrequencyCaps(int index)

public FrequencyCap getFrequencyCaps(int index)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FrequencyCap

getFrequencyCapsBuilder(int index)

public FrequencyCap.Builder getFrequencyCapsBuilder(int index)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FrequencyCap.Builder

getFrequencyCapsBuilderList()

public List<FrequencyCap.Builder> getFrequencyCapsBuilderList()

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getFrequencyCapsCount()

public int getFrequencyCapsCount()

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getFrequencyCapsList()

public List<FrequencyCap> getFrequencyCapsList()

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<FrequencyCap>

getFrequencyCapsOrBuilder(int index)

public FrequencyCapOrBuilder getFrequencyCapsOrBuilder(int index)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FrequencyCapOrBuilder

getFrequencyCapsOrBuilderList()

public List<? extends FrequencyCapOrBuilder> getFrequencyCapsOrBuilderList()

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

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

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.

getGoalBuilder()

public Goal.Builder getGoalBuilder()

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

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

getGrpSettings()

public GrpSettings getGrpSettings()

Optional. Contains the information for a line item which has a target GRP demographic.

optional .google.ads.admanager.v1.GrpSettings grp_settings = 78 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpSettings

The grpSettings.

getGrpSettingsBuilder()

public GrpSettings.Builder getGrpSettingsBuilder()

Optional. Contains the information for a line item which has a target GRP demographic.

optional .google.ads.admanager.v1.GrpSettings grp_settings = 78 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpSettings.Builder

getGrpSettingsOrBuilder()

public GrpSettingsOrBuilder getGrpSettingsOrBuilder()

Optional. Contains the information for a line item which has a target GRP demographic.

optional .google.ads.admanager.v1.GrpSettings grp_settings = 78 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GrpSettingsOrBuilder

getLineItemType()

public LineItemTypeEnum.LineItemType getLineItemType()

Required. Indicates the line item type of a LineItem. 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. 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.

getMaxVideoCreativeDuration()

public Duration getMaxVideoCreativeDuration()

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

optional .google.protobuf.Duration max_video_creative_duration = 75 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The maxVideoCreativeDuration.

getMaxVideoCreativeDurationBuilder()

public Duration.Builder getMaxVideoCreativeDurationBuilder()

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

optional .google.protobuf.Duration max_video_creative_duration = 75 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getMaxVideoCreativeDurationOrBuilder()

public DurationOrBuilder getMaxVideoCreativeDurationOrBuilder()

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

optional .google.protobuf.Duration max_video_creative_duration = 75 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getMissingCreatives()

public boolean getMissingCreatives()

Output only. Indicates if a LineItem is missing any Creative creatives for the creativePlaceholders specified. Creative Creatives can be considered missing for several reasons including:

  • Not enough Creative creatives of a certain size have been uploaded, as determined by expected_creative_count. For example a LineItem specifies 750x350, 400x200 but only a 750x350 was uploaded. Or LineItem specifies 750x350 with an expected count of 2, but only one was uploaded.
  • The [Creative.applied_labels][] of an associated Creative don't match the CreativePlaceholder.applied_labels of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.

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

Returns
Type Description
boolean

The missingCreatives.

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.

getNotes()

public String getNotes()

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

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

Returns
Type Description
String

The notes.

getNotesBytes()

public ByteString getNotesBytes()

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

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

Returns
Type Description
ByteString

The bytes for notes.

getOrder()

public String getOrder()

Required. Immutable. The ID of the Order to which the LineItem belongs. Format: networks/{network_code}/orders/{order}

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

Returns
Type Description
String

The order.

getOrderBytes()

public ByteString getOrderBytes()

Required. Immutable. The ID of the Order to which the LineItem belongs. Format: networks/{network_code}/orders/{order}

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

Returns
Type Description
ByteString

The bytes for order.

getOrderDisplayName()

public String getOrderDisplayName()

Output only. The name of the Order.

optional string order_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The orderDisplayName.

getOrderDisplayNameBytes()

public ByteString getOrderDisplayNameBytes()

Output only. The name of the Order.

optional string order_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for orderDisplayName.

getPriority()

public int getPriority()

Optional. Non-empty default. The priority for the line item. Valid values range from 1 to 16. This field defaults to the default priority of the LineItemType. The following list shows the default, minimum, and maximum priority values are for each line item type:

  • 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)
  • ADMOB: 21 (1, 16)
  • PREFERRED_DEAL: 12 (12, 12) This field can only be edited by certain networks, otherwise a PermissionError will occur.

optional int32 priority = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The priority.

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.

getRateBuilder()

public Money.Builder getRateBuilder()

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

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

getRepeatedCreativeServingEnabled()

public boolean getRepeatedCreativeServingEnabled()

Optional. Indicates whether repeated creative serving is enabled for this line item.

optional bool repeated_creative_serving_enabled = 90 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The repeatedCreativeServingEnabled.

getReservationStatus()

public LineItemReservationStatusEnum.LineItemReservationStatus getReservationStatus()

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

optional .google.ads.admanager.v1.LineItemReservationStatusEnum.LineItemReservationStatus reservation_status = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItemReservationStatusEnum.LineItemReservationStatus

The reservationStatus.

getReservationStatusValue()

public int getReservationStatusValue()

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

optional .google.ads.admanager.v1.LineItemReservationStatusEnum.LineItemReservationStatus reservation_status = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for reservationStatus.

getReserveOnCreation()

public boolean getReserveOnCreation()

Input only. The flag indicates whether inventory should be reserved when creating a line item of types SPONSORSHIP and STANDARD in an unapproved Order. The default value is false.

optional bool reserve_on_creation = 31 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

The reserveOnCreation.

getRoadblockingType()

public RoadblockingTypeEnum.RoadblockingType getRoadblockingType()

Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
RoadblockingTypeEnum.RoadblockingType

The roadblockingType.

getRoadblockingTypeValue()

public int getRoadblockingTypeValue()

Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for roadblockingType.

getSameAdvertiserExceptionEnabled()

public boolean getSameAdvertiserExceptionEnabled()

Optional. If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.

optional bool same_advertiser_exception_enabled = 52 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The sameAdvertiserExceptionEnabled.

getSecondaryGoals(int index)

public Goal getSecondaryGoals(int index)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Goal

getSecondaryGoalsBuilder(int index)

public Goal.Builder getSecondaryGoalsBuilder(int index)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Goal.Builder

getSecondaryGoalsBuilderList()

public List<Goal.Builder> getSecondaryGoalsBuilderList()

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getSecondaryGoalsCount()

public int getSecondaryGoalsCount()

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSecondaryGoalsList()

public List<Goal> getSecondaryGoalsList()

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Goal>

getSecondaryGoalsOrBuilder(int index)

public GoalOrBuilder getSecondaryGoalsOrBuilder(int index)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
GoalOrBuilder

getSecondaryGoalsOrBuilderList()

public List<? extends GoalOrBuilder> getSecondaryGoalsOrBuilderList()

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

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

getSkipCrossSellingRuleWarningChecks()

public boolean getSkipCrossSellingRuleWarningChecks()

Input only. True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool skip_cross_selling_rule_warning_checks = 30 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

The skipCrossSellingRuleWarningChecks.

getSkipInventoryCheck()

public boolean getSkipInventoryCheck()

Input only. The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool skip_inventory_check = 29 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

The skipInventoryCheck.

getSkippableAdType()

public SkippableAdTypeEnum.SkippableAdType getSkippableAdType()

Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.

optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
SkippableAdTypeEnum.SkippableAdType

The skippableAdType.

getSkippableAdTypeValue()

public int getSkippableAdTypeValue()

Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.

optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for skippableAdType.

getSponsorshipExclusivityEnabled()

public boolean getSponsorshipExclusivityEnabled()

Optional. Whether the line item is enabled for sponsorship exclusivity. If true, only exclusive sponsorships can be served on inventory targeted by this LineItem. This control should only be available for 100% video sponsorships.

optional bool sponsorship_exclusivity_enabled = 89 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The sponsorshipExclusivityEnabled.

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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

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
Builder

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

getStats()

public LineItemStats getStats()

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.

optional .google.ads.admanager.v1.LineItemStats stats = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItemStats

The stats.

getStatsBuilder()

public LineItemStats.Builder getStatsBuilder()

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.

optional .google.ads.admanager.v1.LineItemStats stats = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItemStats.Builder

getStatsOrBuilder()

public LineItemStatsOrBuilder getStatsOrBuilder()

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.

optional .google.ads.admanager.v1.LineItemStats stats = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItemStatsOrBuilder

getStatus()

public LineItemComputedStatusEnum.LineItemComputedStatus getStatus()

Output only. The status of the LineItem.

optional .google.ads.admanager.v1.LineItemComputedStatusEnum.LineItemComputedStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItemComputedStatusEnum.LineItemComputedStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of the LineItem.

optional .google.ads.admanager.v1.LineItemComputedStatusEnum.LineItemComputedStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getTargetEndTime()

public Timestamp getTargetEndTime()

Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.

optional .google.protobuf.Timestamp target_end_time = 95 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The targetEndTime.

getTargetEndTimeBuilder()

public Timestamp.Builder getTargetEndTimeBuilder()

Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.

optional .google.protobuf.Timestamp target_end_time = 95 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getTargetEndTimeOrBuilder()

public TimestampOrBuilder getTargetEndTimeOrBuilder()

Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.

optional .google.protobuf.Timestamp target_end_time = 95 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getTargeting()

public Targeting getTargeting()

Required. Contains the targeting criteria for the ad campaign.

optional .google.ads.admanager.v1.Targeting targeting = 93 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Targeting

The targeting.

getTargetingBuilder()

public Targeting.Builder getTargetingBuilder()

Required. Contains the targeting criteria for the ad campaign.

optional .google.ads.admanager.v1.Targeting targeting = 93 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Targeting.Builder

getTargetingOrBuilder()

public TargetingOrBuilder getTargetingOrBuilder()

Required. Contains the targeting criteria for the ad campaign.

optional .google.ads.admanager.v1.Targeting targeting = 93 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TargetingOrBuilder

getThirdPartyMeasurementSettings()

public ThirdPartyMeasurementSettings getThirdPartyMeasurementSettings()

Optional. Third party auto-pixeling settings for cross-sell Partners.

optional .google.ads.admanager.v1.ThirdPartyMeasurementSettings third_party_measurement_settings = 67 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ThirdPartyMeasurementSettings

The thirdPartyMeasurementSettings.

getThirdPartyMeasurementSettingsBuilder()

public ThirdPartyMeasurementSettings.Builder getThirdPartyMeasurementSettingsBuilder()

Optional. Third party auto-pixeling settings for cross-sell Partners.

optional .google.ads.admanager.v1.ThirdPartyMeasurementSettings third_party_measurement_settings = 67 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ThirdPartyMeasurementSettings.Builder

getThirdPartyMeasurementSettingsOrBuilder()

public ThirdPartyMeasurementSettingsOrBuilder getThirdPartyMeasurementSettingsOrBuilder()

Optional. Third party auto-pixeling settings for cross-sell Partners.

optional .google.ads.admanager.v1.ThirdPartyMeasurementSettings third_party_measurement_settings = 67 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ThirdPartyMeasurementSettingsOrBuilder

getUpdateSource()

public String getUpdateSource()

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

optional string update_source = 53 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The updateSource.

getUpdateSourceBytes()

public ByteString getUpdateSourceBytes()

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

optional string update_source = 53 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for updateSource.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time this line item was last modified.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time this line item was last modified.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time this line item was last modified.

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

Returns
Type Description
TimestampOrBuilder

getValueCpm()

public Money getValueCpm()

Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.

optional .google.type.Money value_cpm = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
com.google.type.Money

The valueCpm.

getValueCpmBuilder()

public Money.Builder getValueCpmBuilder()

Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.

optional .google.type.Money value_cpm = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
com.google.type.Money.Builder

getValueCpmOrBuilder()

public MoneyOrBuilder getValueCpmOrBuilder()

Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.

optional .google.type.Money value_cpm = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
com.google.type.MoneyOrBuilder

getViewabilityProviderCompanies(int index)

public String getViewabilityProviderCompanies(int index)

Optional. Optional IDs of the Company that provide ad verification for this line item.

repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The viewabilityProviderCompanies at the given index.

getViewabilityProviderCompaniesBytes(int index)

public ByteString getViewabilityProviderCompaniesBytes(int index)

Optional. Optional IDs of the Company that provide ad verification for this line item.

repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the viewabilityProviderCompanies at the given index.

getViewabilityProviderCompaniesCount()

public int getViewabilityProviderCompaniesCount()

Optional. Optional IDs of the Company that provide ad verification for this line item.

repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of viewabilityProviderCompanies.

getViewabilityProviderCompaniesList()

public ProtocolStringList getViewabilityProviderCompaniesList()

Optional. Optional IDs of the Company that provide ad verification for this line item.

repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the viewabilityProviderCompanies.

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.

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

Returns
Type Description
String

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.

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

Returns
Type Description
ByteString

The bytes for webPropertyCode.

getYoutubeKidsRestricted()

public boolean getYoutubeKidsRestricted()

Optional. Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the help center article for more information: https://support.google.com/yt-partner-sales/answer/10015534.

optional bool youtube_kids_restricted = 74 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The youtubeKidsRestricted.

hasAllowOverbook()

public boolean hasAllowOverbook()

Input only. The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types SPONSORSHIP and STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool allow_overbook = 28 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the allowOverbook field is set.

hasArchived()

public boolean hasArchived()

Output only. The archival status of the LineItem.

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

Returns
Type Description
boolean

Whether the archived field is set.

hasAutoExtensionDays()

public boolean hasAutoExtensionDays()

Optional. The number of days to allow a line item to deliver past its target_end_time. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.

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

Returns
Type Description
boolean

Whether the autoExtensionDays field is set.

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.

hasChildContentEligibility()

public boolean hasChildContentEligibility()

Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.

optional .google.ads.admanager.v1.ChildContentEligibilityEnum.ChildContentEligibility child_content_eligibility = 86 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the childContentEligibility field is set.

hasCompanionDeliveryOption()

public boolean hasCompanionDeliveryOption()

Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:

  • The "Guaranteed roadblocks" feature is enabled on your network.
  • One of the following is true (both cannot be true, these are mutually exclusive).
  • The environmentType is VIDEO_PLAYER.
  • The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.

optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption companion_delivery_option = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the companionDeliveryOption field is set.

hasCompetitiveConstraintScope()

public boolean hasCompetitiveConstraintScope()

Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.

optional .google.ads.admanager.v1.ExclusionScopeEnum.ExclusionScope competitive_constraint_scope = 56 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the competitiveConstraintScope field is set.

hasContractedUnitsBought()

public boolean hasContractedUnitsBought()

Optional. This attribute is only applicable for certain line item types and acts as an "FYI" or note, which does not impact adserving or other backend systems. For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a "FYI" for traffickers to manually intervene with the LineItem when needed. This attribute is only available for STANDARD line items if you have this feature enabled on your network.

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

Returns
Type Description
boolean

Whether the contractedUnitsBought field is set.

hasCostType()

public boolean hasCostType()

Required. The method used for billing this LineItem.

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

Returns
Type Description
boolean

Whether the costType field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time this line item was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasCreativeRotationType()

public boolean hasCreativeRotationType()

Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.

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

Returns
Type Description
boolean

Whether the creativeRotationType field is set.

hasCustomPacingCurve()

public boolean hasCustomPacingCurve()

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.

optional .google.ads.admanager.v1.CustomPacingCurve custom_pacing_curve = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the customPacingCurve field is set.

hasCustomVastExtension()

public boolean hasCustomVastExtension()

Optional. Custom XML to be rendered in a custom VAST response at serving time.

optional string custom_vast_extension = 88 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the customVastExtension field is set.

hasDealInfo()

public boolean hasDealInfo()

Optional. The deal information associated with this line item, if it is programmatic.

optional .google.ads.admanager.v1.LineItemDealInfo deal_info = 79 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dealInfo field is set.

hasDeliveryForecastSource()

public boolean hasDeliveryForecastSource()

Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.

optional .google.ads.admanager.v1.LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource delivery_forecast_source = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the deliveryForecastSource field is set.

hasDeliveryIndicator()

public boolean hasDeliveryIndicator()

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:

  • The line item is not delivering.
  • The line item has an unlimited goal or cap.
  • The line item has a percentage based goal or cap.

optional .google.ads.admanager.v1.DeliveryIndicator delivery_indicator = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deliveryIndicator field is set.

hasDeliveryRateType()

public boolean hasDeliveryRateType()

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

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the deliveryRateType field is set.

hasDiscount()

public boolean hasDiscount()

Optional. Discount information for the line item.

optional .google.ads.admanager.v1.LineItemDiscount discount = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the discount field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. The name of the line item. This attribute 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 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.

hasEndTimeUnlimited()

public boolean hasEndTimeUnlimited()

Optional. Non-empty default. Specifies whether or not the LineItem has an end time. This attribute defaults to false. It can be be set to true for only line items of type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.

optional bool end_time_unlimited = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the endTimeUnlimited field is set.

hasEnvironmentType()

public boolean hasEnvironmentType()

Optional. Non-empty default. The environment that the LineItem 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 environmentType is also VIDEO_PLAYER.

optional .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the environmentType field is set.

hasExternalLineItemId()

public boolean hasExternalLineItemId()

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

optional string external_line_item_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the externalLineItemId 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.

hasGrpSettings()

public boolean hasGrpSettings()

Optional. Contains the information for a line item which has a target GRP demographic.

optional .google.ads.admanager.v1.GrpSettings grp_settings = 78 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the grpSettings field is set.

hasLineItemType()

public boolean hasLineItemType()

Required. Indicates the line item type of a LineItem. 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.

hasMaxVideoCreativeDuration()

public boolean hasMaxVideoCreativeDuration()

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

optional .google.protobuf.Duration max_video_creative_duration = 75 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maxVideoCreativeDuration field is set.

hasMissingCreatives()

public boolean hasMissingCreatives()

Output only. Indicates if a LineItem is missing any Creative creatives for the creativePlaceholders specified. Creative Creatives can be considered missing for several reasons including:

  • Not enough Creative creatives of a certain size have been uploaded, as determined by expected_creative_count. For example a LineItem specifies 750x350, 400x200 but only a 750x350 was uploaded. Or LineItem specifies 750x350 with an expected count of 2, but only one was uploaded.
  • The [Creative.applied_labels][] of an associated Creative don't match the CreativePlaceholder.applied_labels of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.

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

Returns
Type Description
boolean

Whether the missingCreatives field is set.

hasNotes()

public boolean hasNotes()

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

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

Returns
Type Description
boolean

Whether the notes field is set.

hasOrder()

public boolean hasOrder()

Required. Immutable. The ID of the Order to which the LineItem belongs. Format: networks/{network_code}/orders/{order}

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

Returns
Type Description
boolean

Whether the order field is set.

hasOrderDisplayName()

public boolean hasOrderDisplayName()

Output only. The name of the Order.

optional string order_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the orderDisplayName field is set.

hasPriority()

public boolean hasPriority()

Optional. Non-empty default. The priority for the line item. Valid values range from 1 to 16. This field defaults to the default priority of the LineItemType. The following list shows the default, minimum, and maximum priority values are for each line item type:

  • 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)
  • ADMOB: 21 (1, 16)
  • PREFERRED_DEAL: 12 (12, 12) This field can only be edited by certain networks, otherwise a PermissionError will occur.

optional int32 priority = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the priority 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.

hasRepeatedCreativeServingEnabled()

public boolean hasRepeatedCreativeServingEnabled()

Optional. Indicates whether repeated creative serving is enabled for this line item.

optional bool repeated_creative_serving_enabled = 90 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the repeatedCreativeServingEnabled field is set.

hasReservationStatus()

public boolean hasReservationStatus()

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

optional .google.ads.admanager.v1.LineItemReservationStatusEnum.LineItemReservationStatus reservation_status = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the reservationStatus field is set.

hasReserveOnCreation()

public boolean hasReserveOnCreation()

Input only. The flag indicates whether inventory should be reserved when creating a line item of types SPONSORSHIP and STANDARD in an unapproved Order. The default value is false.

optional bool reserve_on_creation = 31 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the reserveOnCreation field is set.

hasRoadblockingType()

public boolean hasRoadblockingType()

Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the roadblockingType field is set.

hasSameAdvertiserExceptionEnabled()

public boolean hasSameAdvertiserExceptionEnabled()

Optional. If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.

optional bool same_advertiser_exception_enabled = 52 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sameAdvertiserExceptionEnabled field is set.

hasSkipCrossSellingRuleWarningChecks()

public boolean hasSkipCrossSellingRuleWarningChecks()

Input only. True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool skip_cross_selling_rule_warning_checks = 30 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the skipCrossSellingRuleWarningChecks field is set.

hasSkipInventoryCheck()

public boolean hasSkipInventoryCheck()

Input only. The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool skip_inventory_check = 29 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the skipInventoryCheck field is set.

hasSkippableAdType()

public boolean hasSkippableAdType()

Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.

optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the skippableAdType field is set.

hasSponsorshipExclusivityEnabled()

public boolean hasSponsorshipExclusivityEnabled()

Optional. Whether the line item is enabled for sponsorship exclusivity. If true, only exclusive sponsorships can be served on inventory targeted by this LineItem. This control should only be available for 100% video sponsorships.

optional bool sponsorship_exclusivity_enabled = 89 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sponsorshipExclusivityEnabled 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.

hasStats()

public boolean hasStats()

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.

optional .google.ads.admanager.v1.LineItemStats stats = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the stats field is set.

hasStatus()

public boolean hasStatus()

Output only. The status of the LineItem.

optional .google.ads.admanager.v1.LineItemComputedStatusEnum.LineItemComputedStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the status field is set.

hasTargetEndTime()

public boolean hasTargetEndTime()

Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.

optional .google.protobuf.Timestamp target_end_time = 95 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the targetEndTime field is set.

hasTargeting()

public boolean hasTargeting()

Required. Contains the targeting criteria for the ad campaign.

optional .google.ads.admanager.v1.Targeting targeting = 93 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the targeting field is set.

hasThirdPartyMeasurementSettings()

public boolean hasThirdPartyMeasurementSettings()

Optional. Third party auto-pixeling settings for cross-sell Partners.

optional .google.ads.admanager.v1.ThirdPartyMeasurementSettings third_party_measurement_settings = 67 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the thirdPartyMeasurementSettings field is set.

hasUpdateSource()

public boolean hasUpdateSource()

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

optional string update_source = 53 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateSource field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time this line item was last modified.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hasValueCpm()

public boolean hasValueCpm()

Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.

optional .google.type.Money value_cpm = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the valueCpm field is set.

hasWebPropertyCode()

public boolean hasWebPropertyCode()

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.

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

Returns
Type Description
boolean

Whether the webPropertyCode field is set.

hasYoutubeKidsRestricted()

public boolean hasYoutubeKidsRestricted()

Optional. Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the help center article for more information: https://support.google.com/yt-partner-sales/answer/10015534.

optional bool youtube_kids_restricted = 74 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the youtubeKidsRestricted field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBudget(Money value)

public LineItem.Builder mergeBudget(Money value)

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];

Parameter
Name Description
value com.google.type.Money
Returns
Type Description
LineItem.Builder

mergeCreateTime(Timestamp value)

public LineItem.Builder mergeCreateTime(Timestamp value)

Output only. The time this line item was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
LineItem.Builder

mergeCustomPacingCurve(CustomPacingCurve value)

public LineItem.Builder mergeCustomPacingCurve(CustomPacingCurve value)

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.

optional .google.ads.admanager.v1.CustomPacingCurve custom_pacing_curve = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CustomPacingCurve
Returns
Type Description
LineItem.Builder

mergeDealInfo(LineItemDealInfo value)

public LineItem.Builder mergeDealInfo(LineItemDealInfo value)

Optional. The deal information associated with this line item, if it is programmatic.

optional .google.ads.admanager.v1.LineItemDealInfo deal_info = 79 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LineItemDealInfo
Returns
Type Description
LineItem.Builder

mergeDeliveryIndicator(DeliveryIndicator value)

public LineItem.Builder mergeDeliveryIndicator(DeliveryIndicator value)

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:

  • The line item is not delivering.
  • The line item has an unlimited goal or cap.
  • The line item has a percentage based goal or cap.

optional .google.ads.admanager.v1.DeliveryIndicator delivery_indicator = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DeliveryIndicator
Returns
Type Description
LineItem.Builder

mergeDiscount(LineItemDiscount value)

public LineItem.Builder mergeDiscount(LineItemDiscount value)

Optional. Discount information for the line item.

optional .google.ads.admanager.v1.LineItemDiscount discount = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LineItemDiscount
Returns
Type Description
LineItem.Builder

mergeEndTime(Timestamp value)

public LineItem.Builder mergeEndTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
LineItem.Builder

mergeFrom(LineItem other)

public LineItem.Builder mergeFrom(LineItem other)
Parameter
Name Description
other LineItem
Returns
Type Description
LineItem.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LineItem.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItem.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public LineItem.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
LineItem.Builder
Overrides

mergeGoal(Goal value)

public LineItem.Builder mergeGoal(Goal value)

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];

Parameter
Name Description
value Goal
Returns
Type Description
LineItem.Builder

mergeGrpSettings(GrpSettings value)

public LineItem.Builder mergeGrpSettings(GrpSettings value)

Optional. Contains the information for a line item which has a target GRP demographic.

optional .google.ads.admanager.v1.GrpSettings grp_settings = 78 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value GrpSettings
Returns
Type Description
LineItem.Builder

mergeMaxVideoCreativeDuration(Duration value)

public LineItem.Builder mergeMaxVideoCreativeDuration(Duration value)

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

optional .google.protobuf.Duration max_video_creative_duration = 75 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Duration
Returns
Type Description
LineItem.Builder

mergeRate(Money value)

public LineItem.Builder mergeRate(Money value)

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

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

Parameter
Name Description
value com.google.type.Money
Returns
Type Description
LineItem.Builder

mergeStartTime(Timestamp value)

public LineItem.Builder mergeStartTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
LineItem.Builder

mergeStats(LineItemStats value)

public LineItem.Builder mergeStats(LineItemStats value)

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.

optional .google.ads.admanager.v1.LineItemStats stats = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value LineItemStats
Returns
Type Description
LineItem.Builder

mergeTargetEndTime(Timestamp value)

public LineItem.Builder mergeTargetEndTime(Timestamp value)

Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.

optional .google.protobuf.Timestamp target_end_time = 95 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
LineItem.Builder

mergeTargeting(Targeting value)

public LineItem.Builder mergeTargeting(Targeting value)

Required. Contains the targeting criteria for the ad campaign.

optional .google.ads.admanager.v1.Targeting targeting = 93 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Targeting
Returns
Type Description
LineItem.Builder

mergeThirdPartyMeasurementSettings(ThirdPartyMeasurementSettings value)

public LineItem.Builder mergeThirdPartyMeasurementSettings(ThirdPartyMeasurementSettings value)

Optional. Third party auto-pixeling settings for cross-sell Partners.

optional .google.ads.admanager.v1.ThirdPartyMeasurementSettings third_party_measurement_settings = 67 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ThirdPartyMeasurementSettings
Returns
Type Description
LineItem.Builder

mergeUpdateTime(Timestamp value)

public LineItem.Builder mergeUpdateTime(Timestamp value)

Output only. The time this line item was last modified.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
LineItem.Builder

mergeValueCpm(Money value)

public LineItem.Builder mergeValueCpm(Money value)

Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.

optional .google.type.Money value_cpm = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value com.google.type.Money
Returns
Type Description
LineItem.Builder

removeAppliedLabels(int index)

public LineItem.Builder removeAppliedLabels(int index)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LineItem.Builder

removeCreativePlaceholders(int index)

public LineItem.Builder removeCreativePlaceholders(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
LineItem.Builder

removeCreativeTargetings(int index)

public LineItem.Builder removeCreativeTargetings(int index)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LineItem.Builder

removeCustomFieldValues(int index)

public LineItem.Builder removeCustomFieldValues(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
LineItem.Builder

removeEffectiveAppliedLabels(int index)

public LineItem.Builder removeEffectiveAppliedLabels(int index)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
LineItem.Builder

removeFrequencyCaps(int index)

public LineItem.Builder removeFrequencyCaps(int index)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LineItem.Builder

removeSecondaryGoals(int index)

public LineItem.Builder removeSecondaryGoals(int index)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LineItem.Builder

setAllowOverbook(boolean value)

public LineItem.Builder setAllowOverbook(boolean value)

Input only. The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types SPONSORSHIP and STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool allow_overbook = 28 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value boolean

The allowOverbook to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setAllowedFormats(int index, LineItemAllowedFormatEnum.LineItemAllowedFormat value)

public LineItem.Builder setAllowedFormats(int index, LineItemAllowedFormatEnum.LineItemAllowedFormat value)

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value LineItemAllowedFormatEnum.LineItemAllowedFormat

The allowedFormats to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setAllowedFormatsValue(int index, int value)

public LineItem.Builder setAllowedFormatsValue(int index, int value)

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.

repeated .google.ads.admanager.v1.LineItemAllowedFormatEnum.LineItemAllowedFormat allowed_formats = 112 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for allowedFormats to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setAppliedLabels(int index, AppliedLabel value)

public LineItem.Builder setAppliedLabels(int index, AppliedLabel value)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
LineItem.Builder

setAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public LineItem.Builder setAppliedLabels(int index, AppliedLabel.Builder builderForValue)

Optional. The set of labels applied directly to this line item.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 50 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
LineItem.Builder

setArchived(boolean value)

public LineItem.Builder setArchived(boolean value)

Output only. The archival status of the LineItem.

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

Parameter
Name Description
value boolean

The archived to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setAutoExtensionDays(int value)

public LineItem.Builder setAutoExtensionDays(int value)

Optional. The number of days to allow a line item to deliver past its target_end_time. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.

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

Parameter
Name Description
value int

The autoExtensionDays to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setBudget(Money value)

public LineItem.Builder setBudget(Money value)

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];

Parameter
Name Description
value com.google.type.Money
Returns
Type Description
LineItem.Builder

setBudget(Money.Builder builderForValue)

public LineItem.Builder setBudget(Money.Builder builderForValue)

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];

Parameter
Name Description
builderForValue com.google.type.Money.Builder
Returns
Type Description
LineItem.Builder

setChildContentEligibility(ChildContentEligibilityEnum.ChildContentEligibility value)

public LineItem.Builder setChildContentEligibility(ChildContentEligibilityEnum.ChildContentEligibility value)

Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.

optional .google.ads.admanager.v1.ChildContentEligibilityEnum.ChildContentEligibility child_content_eligibility = 86 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value ChildContentEligibilityEnum.ChildContentEligibility

The childContentEligibility to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setChildContentEligibilityValue(int value)

public LineItem.Builder setChildContentEligibilityValue(int value)

Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.

optional .google.ads.admanager.v1.ChildContentEligibilityEnum.ChildContentEligibility child_content_eligibility = 86 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value int

The enum numeric value on the wire for childContentEligibility to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setCompanionDeliveryOption(CompanionDeliveryOptionEnum.CompanionDeliveryOption value)

public LineItem.Builder setCompanionDeliveryOption(CompanionDeliveryOptionEnum.CompanionDeliveryOption value)

Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:

  • The "Guaranteed roadblocks" feature is enabled on your network.
  • One of the following is true (both cannot be true, these are mutually exclusive).
  • The environmentType is VIDEO_PLAYER.
  • The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.

optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption companion_delivery_option = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CompanionDeliveryOptionEnum.CompanionDeliveryOption

The companionDeliveryOption to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setCompanionDeliveryOptionValue(int value)

public LineItem.Builder setCompanionDeliveryOptionValue(int value)

Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met:

  • The "Guaranteed roadblocks" feature is enabled on your network.
  • One of the following is true (both cannot be true, these are mutually exclusive).
  • The environmentType is VIDEO_PLAYER.
  • The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.

optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption companion_delivery_option = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for companionDeliveryOption to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setCompetitiveConstraintScope(ExclusionScopeEnum.ExclusionScope value)

public LineItem.Builder setCompetitiveConstraintScope(ExclusionScopeEnum.ExclusionScope value)

Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.

optional .google.ads.admanager.v1.ExclusionScopeEnum.ExclusionScope competitive_constraint_scope = 56 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value ExclusionScopeEnum.ExclusionScope

The competitiveConstraintScope to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setCompetitiveConstraintScopeValue(int value)

public LineItem.Builder setCompetitiveConstraintScopeValue(int value)

Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.

optional .google.ads.admanager.v1.ExclusionScopeEnum.ExclusionScope competitive_constraint_scope = 56 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value int

The enum numeric value on the wire for competitiveConstraintScope to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setContractedUnitsBought(long value)

public LineItem.Builder setContractedUnitsBought(long value)

Optional. This attribute is only applicable for certain line item types and acts as an "FYI" or note, which does not impact adserving or other backend systems. For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a "FYI" for traffickers to manually intervene with the LineItem when needed. This attribute is only available for STANDARD line items if you have this feature enabled on your network.

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

Parameter
Name Description
value long

The contractedUnitsBought to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setCostType(LineItemCostTypeEnum.LineItemCostType value)

public LineItem.Builder setCostType(LineItemCostTypeEnum.LineItemCostType value)

Required. The method used for billing this LineItem.

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

Parameter
Name Description
value LineItemCostTypeEnum.LineItemCostType

The costType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setCostTypeValue(int value)

public LineItem.Builder setCostTypeValue(int value)

Required. The method used for billing this LineItem.

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

Parameter
Name Description
value int

The enum numeric value on the wire for costType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public LineItem.Builder setCreateTime(Timestamp value)

Output only. The time this line item was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
LineItem.Builder

setCreateTime(Timestamp.Builder builderForValue)

public LineItem.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time this line item was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
LineItem.Builder

setCreativePlaceholders(int index, CreativePlaceholder value)

public LineItem.Builder setCreativePlaceholders(int index, CreativePlaceholder value)

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

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

Parameters
Name Description
index int
value CreativePlaceholder
Returns
Type Description
LineItem.Builder

setCreativePlaceholders(int index, CreativePlaceholder.Builder builderForValue)

public LineItem.Builder setCreativePlaceholders(int index, CreativePlaceholder.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue CreativePlaceholder.Builder
Returns
Type Description
LineItem.Builder

setCreativeRotationType(CreativeRotationTypeEnum.CreativeRotationType value)

public LineItem.Builder setCreativeRotationType(CreativeRotationTypeEnum.CreativeRotationType value)

Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.

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

Parameter
Name Description
value CreativeRotationTypeEnum.CreativeRotationType

The creativeRotationType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setCreativeRotationTypeValue(int value)

public LineItem.Builder setCreativeRotationTypeValue(int value)

Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.

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

Parameter
Name Description
value int

The enum numeric value on the wire for creativeRotationType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setCreativeTargetings(int index, CreativeTargeting value)

public LineItem.Builder setCreativeTargetings(int index, CreativeTargeting value)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value CreativeTargeting
Returns
Type Description
LineItem.Builder

setCreativeTargetings(int index, CreativeTargeting.Builder builderForValue)

public LineItem.Builder setCreativeTargetings(int index, CreativeTargeting.Builder builderForValue)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.

repeated .google.ads.admanager.v1.CreativeTargeting creative_targetings = 94 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue CreativeTargeting.Builder
Returns
Type Description
LineItem.Builder

setCustomFieldValues(int index, CustomFieldValue value)

public LineItem.Builder setCustomFieldValues(int index, CustomFieldValue value)

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];

Parameters
Name Description
index int
value CustomFieldValue
Returns
Type Description
LineItem.Builder

setCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

public LineItem.Builder setCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue CustomFieldValue.Builder
Returns
Type Description
LineItem.Builder

setCustomPacingCurve(CustomPacingCurve value)

public LineItem.Builder setCustomPacingCurve(CustomPacingCurve value)

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.

optional .google.ads.admanager.v1.CustomPacingCurve custom_pacing_curve = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CustomPacingCurve
Returns
Type Description
LineItem.Builder

setCustomPacingCurve(CustomPacingCurve.Builder builderForValue)

public LineItem.Builder setCustomPacingCurve(CustomPacingCurve.Builder builderForValue)

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.

optional .google.ads.admanager.v1.CustomPacingCurve custom_pacing_curve = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue CustomPacingCurve.Builder
Returns
Type Description
LineItem.Builder

setCustomVastExtension(String value)

public LineItem.Builder setCustomVastExtension(String value)

Optional. Custom XML to be rendered in a custom VAST response at serving time.

optional string custom_vast_extension = 88 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The customVastExtension to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setCustomVastExtensionBytes(ByteString value)

public LineItem.Builder setCustomVastExtensionBytes(ByteString value)

Optional. Custom XML to be rendered in a custom VAST response at serving time.

optional string custom_vast_extension = 88 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for customVastExtension to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setDealInfo(LineItemDealInfo value)

public LineItem.Builder setDealInfo(LineItemDealInfo value)

Optional. The deal information associated with this line item, if it is programmatic.

optional .google.ads.admanager.v1.LineItemDealInfo deal_info = 79 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LineItemDealInfo
Returns
Type Description
LineItem.Builder

setDealInfo(LineItemDealInfo.Builder builderForValue)

public LineItem.Builder setDealInfo(LineItemDealInfo.Builder builderForValue)

Optional. The deal information associated with this line item, if it is programmatic.

optional .google.ads.admanager.v1.LineItemDealInfo deal_info = 79 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue LineItemDealInfo.Builder
Returns
Type Description
LineItem.Builder

setDeliveryForecastSource(LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource value)

public LineItem.Builder setDeliveryForecastSource(LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource value)

Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.

optional .google.ads.admanager.v1.LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource delivery_forecast_source = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource

The deliveryForecastSource to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setDeliveryForecastSourceValue(int value)

public LineItem.Builder setDeliveryForecastSourceValue(int value)

Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.

optional .google.ads.admanager.v1.LineItemDeliveryForecastSourceEnum.LineItemDeliveryForecastSource delivery_forecast_source = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value int

The enum numeric value on the wire for deliveryForecastSource to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setDeliveryIndicator(DeliveryIndicator value)

public LineItem.Builder setDeliveryIndicator(DeliveryIndicator value)

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:

  • The line item is not delivering.
  • The line item has an unlimited goal or cap.
  • The line item has a percentage based goal or cap.

optional .google.ads.admanager.v1.DeliveryIndicator delivery_indicator = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DeliveryIndicator
Returns
Type Description
LineItem.Builder

setDeliveryIndicator(DeliveryIndicator.Builder builderForValue)

public LineItem.Builder setDeliveryIndicator(DeliveryIndicator.Builder builderForValue)

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons:

  • The line item is not delivering.
  • The line item has an unlimited goal or cap.
  • The line item has a percentage based goal or cap.

optional .google.ads.admanager.v1.DeliveryIndicator delivery_indicator = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue DeliveryIndicator.Builder
Returns
Type Description
LineItem.Builder

setDeliveryRateType(LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType value)

public LineItem.Builder setDeliveryRateType(LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType value)

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

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType

The deliveryRateType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setDeliveryRateTypeValue(int value)

public LineItem.Builder setDeliveryRateTypeValue(int value)

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

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value int

The enum numeric value on the wire for deliveryRateType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setDiscount(LineItemDiscount value)

public LineItem.Builder setDiscount(LineItemDiscount value)

Optional. Discount information for the line item.

optional .google.ads.admanager.v1.LineItemDiscount discount = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LineItemDiscount
Returns
Type Description
LineItem.Builder

setDiscount(LineItemDiscount.Builder builderForValue)

public LineItem.Builder setDiscount(LineItemDiscount.Builder builderForValue)

Optional. Discount information for the line item.

optional .google.ads.admanager.v1.LineItemDiscount discount = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue LineItemDiscount.Builder
Returns
Type Description
LineItem.Builder

setDisplayName(String value)

public LineItem.Builder setDisplayName(String value)

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

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public LineItem.Builder setDisplayNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setEffectiveAppliedLabels(int index, AppliedLabel value)

public LineItem.Builder setEffectiveAppliedLabels(int index, AppliedLabel value)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
LineItem.Builder

setEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public LineItem.Builder setEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
LineItem.Builder

setEndTime(Timestamp value)

public LineItem.Builder setEndTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
LineItem.Builder

setEndTime(Timestamp.Builder builderForValue)

public LineItem.Builder setEndTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
LineItem.Builder

setEndTimeUnlimited(boolean value)

public LineItem.Builder setEndTimeUnlimited(boolean value)

Optional. Non-empty default. Specifies whether or not the LineItem has an end time. This attribute defaults to false. It can be be set to true for only line items of type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.

optional bool end_time_unlimited = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value boolean

The endTimeUnlimited to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setEnvironmentType(EnvironmentTypeEnum.EnvironmentType value)

public LineItem.Builder setEnvironmentType(EnvironmentTypeEnum.EnvironmentType value)

Optional. Non-empty default. The environment that the LineItem 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 environmentType is also VIDEO_PLAYER.

optional .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value EnvironmentTypeEnum.EnvironmentType

The environmentType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setEnvironmentTypeValue(int value)

public LineItem.Builder setEnvironmentTypeValue(int value)

Optional. Non-empty default. The environment that the LineItem 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 environmentType is also VIDEO_PLAYER.

optional .google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType environment_type = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value int

The enum numeric value on the wire for environmentType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setExternalLineItemId(String value)

public LineItem.Builder setExternalLineItemId(String value)

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

optional string external_line_item_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The externalLineItemId to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setExternalLineItemIdBytes(ByteString value)

public LineItem.Builder setExternalLineItemIdBytes(ByteString value)

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

optional string external_line_item_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for externalLineItemId to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setFrequencyCaps(int index, FrequencyCap value)

public LineItem.Builder setFrequencyCaps(int index, FrequencyCap value)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value FrequencyCap
Returns
Type Description
LineItem.Builder

setFrequencyCaps(int index, FrequencyCap.Builder builderForValue)

public LineItem.Builder setFrequencyCaps(int index, FrequencyCap.Builder builderForValue)

Optional. The set of frequency capping units for this LineItem.

repeated .google.ads.admanager.v1.FrequencyCap frequency_caps = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue FrequencyCap.Builder
Returns
Type Description
LineItem.Builder

setGoal(Goal value)

public LineItem.Builder setGoal(Goal value)

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];

Parameter
Name Description
value Goal
Returns
Type Description
LineItem.Builder

setGoal(Goal.Builder builderForValue)

public LineItem.Builder setGoal(Goal.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Goal.Builder
Returns
Type Description
LineItem.Builder

setGrpSettings(GrpSettings value)

public LineItem.Builder setGrpSettings(GrpSettings value)

Optional. Contains the information for a line item which has a target GRP demographic.

optional .google.ads.admanager.v1.GrpSettings grp_settings = 78 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value GrpSettings
Returns
Type Description
LineItem.Builder

setGrpSettings(GrpSettings.Builder builderForValue)

public LineItem.Builder setGrpSettings(GrpSettings.Builder builderForValue)

Optional. Contains the information for a line item which has a target GRP demographic.

optional .google.ads.admanager.v1.GrpSettings grp_settings = 78 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue GrpSettings.Builder
Returns
Type Description
LineItem.Builder

setLineItemType(LineItemTypeEnum.LineItemType value)

public LineItem.Builder setLineItemType(LineItemTypeEnum.LineItemType value)

Required. Indicates the line item type of a LineItem. 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];

Parameter
Name Description
value LineItemTypeEnum.LineItemType

The lineItemType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setLineItemTypeValue(int value)

public LineItem.Builder setLineItemTypeValue(int value)

Required. Indicates the line item type of a LineItem. 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];

Parameter
Name Description
value int

The enum numeric value on the wire for lineItemType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setMaxVideoCreativeDuration(Duration value)

public LineItem.Builder setMaxVideoCreativeDuration(Duration value)

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

optional .google.protobuf.Duration max_video_creative_duration = 75 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Duration
Returns
Type Description
LineItem.Builder

setMaxVideoCreativeDuration(Duration.Builder builderForValue)

public LineItem.Builder setMaxVideoCreativeDuration(Duration.Builder builderForValue)

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

optional .google.protobuf.Duration max_video_creative_duration = 75 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
LineItem.Builder

setMissingCreatives(boolean value)

public LineItem.Builder setMissingCreatives(boolean value)

Output only. Indicates if a LineItem is missing any Creative creatives for the creativePlaceholders specified. Creative Creatives can be considered missing for several reasons including:

  • Not enough Creative creatives of a certain size have been uploaded, as determined by expected_creative_count. For example a LineItem specifies 750x350, 400x200 but only a 750x350 was uploaded. Or LineItem specifies 750x350 with an expected count of 2, but only one was uploaded.
  • The [Creative.applied_labels][] of an associated Creative don't match the CreativePlaceholder.applied_labels of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.

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

Parameter
Name Description
value boolean

The missingCreatives to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setName(String value)

public LineItem.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setNameBytes(ByteString value)

public LineItem.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setNotes(String value)

public LineItem.Builder setNotes(String value)

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

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

Parameter
Name Description
value String

The notes to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setNotesBytes(ByteString value)

public LineItem.Builder setNotesBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for notes to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setOrder(String value)

public LineItem.Builder setOrder(String value)

Required. Immutable. The ID of the Order to which the LineItem belongs. Format: networks/{network_code}/orders/{order}

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

Parameter
Name Description
value String

The order to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setOrderBytes(ByteString value)

public LineItem.Builder setOrderBytes(ByteString value)

Required. Immutable. The ID of the Order to which the LineItem belongs. Format: networks/{network_code}/orders/{order}

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

Parameter
Name Description
value ByteString

The bytes for order to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setOrderDisplayName(String value)

public LineItem.Builder setOrderDisplayName(String value)

Output only. The name of the Order.

optional string order_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The orderDisplayName to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setOrderDisplayNameBytes(ByteString value)

public LineItem.Builder setOrderDisplayNameBytes(ByteString value)

Output only. The name of the Order.

optional string order_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for orderDisplayName to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setPriority(int value)

public LineItem.Builder setPriority(int value)

Optional. Non-empty default. The priority for the line item. Valid values range from 1 to 16. This field defaults to the default priority of the LineItemType. The following list shows the default, minimum, and maximum priority values are for each line item type:

  • 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)
  • ADMOB: 21 (1, 16)
  • PREFERRED_DEAL: 12 (12, 12) This field can only be edited by certain networks, otherwise a PermissionError will occur.

optional int32 priority = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value int

The priority to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setRate(Money value)

public LineItem.Builder setRate(Money value)

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

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

Parameter
Name Description
value com.google.type.Money
Returns
Type Description
LineItem.Builder

setRate(Money.Builder builderForValue)

public LineItem.Builder setRate(Money.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue com.google.type.Money.Builder
Returns
Type Description
LineItem.Builder

setRepeatedCreativeServingEnabled(boolean value)

public LineItem.Builder setRepeatedCreativeServingEnabled(boolean value)

Optional. Indicates whether repeated creative serving is enabled for this line item.

optional bool repeated_creative_serving_enabled = 90 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The repeatedCreativeServingEnabled to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setReservationStatus(LineItemReservationStatusEnum.LineItemReservationStatus value)

public LineItem.Builder setReservationStatus(LineItemReservationStatusEnum.LineItemReservationStatus value)

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

optional .google.ads.admanager.v1.LineItemReservationStatusEnum.LineItemReservationStatus reservation_status = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value LineItemReservationStatusEnum.LineItemReservationStatus

The reservationStatus to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setReservationStatusValue(int value)

public LineItem.Builder setReservationStatusValue(int value)

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

optional .google.ads.admanager.v1.LineItemReservationStatusEnum.LineItemReservationStatus reservation_status = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for reservationStatus to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setReserveOnCreation(boolean value)

public LineItem.Builder setReserveOnCreation(boolean value)

Input only. The flag indicates whether inventory should be reserved when creating a line item of types SPONSORSHIP and STANDARD in an unapproved Order. The default value is false.

optional bool reserve_on_creation = 31 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value boolean

The reserveOnCreation to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setRoadblockingType(RoadblockingTypeEnum.RoadblockingType value)

public LineItem.Builder setRoadblockingType(RoadblockingTypeEnum.RoadblockingType value)

Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value RoadblockingTypeEnum.RoadblockingType

The roadblockingType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setRoadblockingTypeValue(int value)

public LineItem.Builder setRoadblockingTypeValue(int value)

Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value int

The enum numeric value on the wire for roadblockingType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setSameAdvertiserExceptionEnabled(boolean value)

public LineItem.Builder setSameAdvertiserExceptionEnabled(boolean value)

Optional. If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.

optional bool same_advertiser_exception_enabled = 52 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The sameAdvertiserExceptionEnabled to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setSecondaryGoals(int index, Goal value)

public LineItem.Builder setSecondaryGoals(int index, Goal value)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Goal
Returns
Type Description
LineItem.Builder

setSecondaryGoals(int index, Goal.Builder builderForValue)

public LineItem.Builder setSecondaryGoals(int index, Goal.Builder builderForValue)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the line_item_type is SPONSORSHIP and cost_type is CPM.

repeated .google.ads.admanager.v1.Goal secondary_goals = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Goal.Builder
Returns
Type Description
LineItem.Builder

setSkipCrossSellingRuleWarningChecks(boolean value)

public LineItem.Builder setSkipCrossSellingRuleWarningChecks(boolean value)

Input only. True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool skip_cross_selling_rule_warning_checks = 30 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value boolean

The skipCrossSellingRuleWarningChecks to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setSkipInventoryCheck(boolean value)

public LineItem.Builder setSkipInventoryCheck(boolean value)

Input only. The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.

optional bool skip_inventory_check = 29 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value boolean

The skipInventoryCheck to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setSkippableAdType(SkippableAdTypeEnum.SkippableAdType value)

public LineItem.Builder setSkippableAdType(SkippableAdTypeEnum.SkippableAdType value)

Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.

optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value SkippableAdTypeEnum.SkippableAdType

The skippableAdType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setSkippableAdTypeValue(int value)

public LineItem.Builder setSkippableAdTypeValue(int value)

Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.

optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value int

The enum numeric value on the wire for skippableAdType to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setSponsorshipExclusivityEnabled(boolean value)

public LineItem.Builder setSponsorshipExclusivityEnabled(boolean value)

Optional. Whether the line item is enabled for sponsorship exclusivity. If true, only exclusive sponsorships can be served on inventory targeted by this LineItem. This control should only be available for 100% video sponsorships.

optional bool sponsorship_exclusivity_enabled = 89 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The sponsorshipExclusivityEnabled to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setStartTime(Timestamp value)

public LineItem.Builder setStartTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
LineItem.Builder

setStartTime(Timestamp.Builder builderForValue)

public LineItem.Builder setStartTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
LineItem.Builder

setStats(LineItemStats value)

public LineItem.Builder setStats(LineItemStats value)

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.

optional .google.ads.admanager.v1.LineItemStats stats = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value LineItemStats
Returns
Type Description
LineItem.Builder

setStats(LineItemStats.Builder builderForValue)

public LineItem.Builder setStats(LineItemStats.Builder builderForValue)

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.

optional .google.ads.admanager.v1.LineItemStats stats = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue LineItemStats.Builder
Returns
Type Description
LineItem.Builder

setStatus(LineItemComputedStatusEnum.LineItemComputedStatus value)

public LineItem.Builder setStatus(LineItemComputedStatusEnum.LineItemComputedStatus value)

Output only. The status of the LineItem.

optional .google.ads.admanager.v1.LineItemComputedStatusEnum.LineItemComputedStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value LineItemComputedStatusEnum.LineItemComputedStatus

The status to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setStatusValue(int value)

public LineItem.Builder setStatusValue(int value)

Output only. The status of the LineItem.

optional .google.ads.admanager.v1.LineItemComputedStatusEnum.LineItemComputedStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for status to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setTargetEndTime(Timestamp value)

public LineItem.Builder setTargetEndTime(Timestamp value)

Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.

optional .google.protobuf.Timestamp target_end_time = 95 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
LineItem.Builder

setTargetEndTime(Timestamp.Builder builderForValue)

public LineItem.Builder setTargetEndTime(Timestamp.Builder builderForValue)

Optional. The target end time of the line item. This attribute is required unless end_time_unlimited is set to true. If specified, it must be after the start_time. This does not include auto extension days.

optional .google.protobuf.Timestamp target_end_time = 95 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
LineItem.Builder

setTargeting(Targeting value)

public LineItem.Builder setTargeting(Targeting value)

Required. Contains the targeting criteria for the ad campaign.

optional .google.ads.admanager.v1.Targeting targeting = 93 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Targeting
Returns
Type Description
LineItem.Builder

setTargeting(Targeting.Builder builderForValue)

public LineItem.Builder setTargeting(Targeting.Builder builderForValue)

Required. Contains the targeting criteria for the ad campaign.

optional .google.ads.admanager.v1.Targeting targeting = 93 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Targeting.Builder
Returns
Type Description
LineItem.Builder

setThirdPartyMeasurementSettings(ThirdPartyMeasurementSettings value)

public LineItem.Builder setThirdPartyMeasurementSettings(ThirdPartyMeasurementSettings value)

Optional. Third party auto-pixeling settings for cross-sell Partners.

optional .google.ads.admanager.v1.ThirdPartyMeasurementSettings third_party_measurement_settings = 67 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ThirdPartyMeasurementSettings
Returns
Type Description
LineItem.Builder

setThirdPartyMeasurementSettings(ThirdPartyMeasurementSettings.Builder builderForValue)

public LineItem.Builder setThirdPartyMeasurementSettings(ThirdPartyMeasurementSettings.Builder builderForValue)

Optional. Third party auto-pixeling settings for cross-sell Partners.

optional .google.ads.admanager.v1.ThirdPartyMeasurementSettings third_party_measurement_settings = 67 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ThirdPartyMeasurementSettings.Builder
Returns
Type Description
LineItem.Builder

setUpdateSource(String value)

public LineItem.Builder setUpdateSource(String value)

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

optional string update_source = 53 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The updateSource to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setUpdateSourceBytes(ByteString value)

public LineItem.Builder setUpdateSourceBytes(ByteString value)

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

optional string update_source = 53 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for updateSource to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public LineItem.Builder setUpdateTime(Timestamp value)

Output only. The time this line item was last modified.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
LineItem.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public LineItem.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time this line item was last modified.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
LineItem.Builder

setValueCpm(Money value)

public LineItem.Builder setValueCpm(Money value)

Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.

optional .google.type.Money value_cpm = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value com.google.type.Money
Returns
Type Description
LineItem.Builder

setValueCpm(Money.Builder builderForValue)

public LineItem.Builder setValueCpm(Money.Builder builderForValue)

Optional. Non-empty default. An amount to help the adserver rank inventory. value_cpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.

optional .google.type.Money value_cpm = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
builderForValue com.google.type.Money.Builder
Returns
Type Description
LineItem.Builder

setViewabilityProviderCompanies(int index, String value)

public LineItem.Builder setViewabilityProviderCompanies(int index, String value)

Optional. Optional IDs of the Company that provide ad verification for this line item.

repeated string viewability_provider_companies = 85 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The viewabilityProviderCompanies to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setWebPropertyCode(String value)

public LineItem.Builder setWebPropertyCode(String value)

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.

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

Parameter
Name Description
value String

The webPropertyCode to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setWebPropertyCodeBytes(ByteString value)

public LineItem.Builder setWebPropertyCodeBytes(ByteString value)

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.

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

Parameter
Name Description
value ByteString

The bytes for webPropertyCode to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.

setYoutubeKidsRestricted(boolean value)

public LineItem.Builder setYoutubeKidsRestricted(boolean value)

Optional. Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the help center article for more information: https://support.google.com/yt-partner-sales/answer/10015534.

optional bool youtube_kids_restricted = 74 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The youtubeKidsRestricted to set.

Returns
Type Description
LineItem.Builder

This builder for chaining.