Class LineItemTemplate.Builder (0.62.0)

public static final class LineItemTemplate.Builder extends GeneratedMessage.Builder<LineItemTemplate.Builder> implements LineItemTemplateOrBuilder

The LineItemTemplate resource.

Protobuf type google.ads.admanager.v1.LineItemTemplate

Static Methods

getDescriptor()

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

Methods

build()

public LineItemTemplate build()
Returns
Type Description
LineItemTemplate

buildPartial()

public LineItemTemplate buildPartial()
Returns
Type Description
LineItemTemplate

clear()

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

clearCreativeRotationType()

public LineItemTemplate.Builder clearCreativeRotationType()

Required. The default creative_rotation_type of a new LineItem.

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

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

clearDefaultTemplate()

public LineItemTemplate.Builder clearDefaultTemplate()

Output only. Whether or not the LineItemTemplate represents the default choices for creating a LineItem. Only one default LineItemTemplate is allowed per Network.

optional bool default_template = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

clearDeliveryRateType()

public LineItemTemplate.Builder clearDeliveryRateType()

Required. The default delivery_rate_type of a new LineItem.

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

clearDisplayName()

public LineItemTemplate.Builder clearDisplayName()

Required. Display name of the LineItemTemplate. This attribute has a maximum length of 255 characters.

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

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

clearLineItemDisplayName()

public LineItemTemplate.Builder clearLineItemDisplayName()

Optional. The default display_name of a new LineItem. This attribute has a maximum length of 127 characters.

optional string line_item_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

clearLineItemType()

public LineItemTemplate.Builder clearLineItemType()

Required. The default line_item_type of a new LineItem.

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

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

clearName()

public LineItemTemplate.Builder clearName()

Identifier. The resource name of the LineItemTemplate. Format: networks/{network_code}/lineItemTemplates/{line_item_template_id}

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

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

clearNotes()

public LineItemTemplate.Builder clearNotes()

Optional. The default notes of a new LineItem. This attribute has a maximum length of 65,535 characters.

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

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

clearRoadblockingType()

public LineItemTemplate.Builder clearRoadblockingType()

Required. The default roadblocking_type of a new LineItem.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

clearSameAdvertiserExceptionEnabled()

public LineItemTemplate.Builder clearSameAdvertiserExceptionEnabled()

Optional. The default value for same_advertiser_exception_enabled of a new LineItem.

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

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

getCreativeRotationType()

public CreativeRotationTypeEnum.CreativeRotationType getCreativeRotationType()

Required. The default creative_rotation_type of a new 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 default creative_rotation_type of a new 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.

getDefaultInstanceForType()

public LineItemTemplate getDefaultInstanceForType()
Returns
Type Description
LineItemTemplate

getDefaultTemplate()

public boolean getDefaultTemplate()

Output only. Whether or not the LineItemTemplate represents the default choices for creating a LineItem. Only one default LineItemTemplate is allowed per Network.

optional bool default_template = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The defaultTemplate.

getDeliveryRateType()

public LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType getDeliveryRateType()

Required. The default delivery_rate_type of a new LineItem.

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType

The deliveryRateType.

getDeliveryRateTypeValue()

public int getDeliveryRateTypeValue()

Required. The default delivery_rate_type of a new LineItem.

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for deliveryRateType.

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Required. Display name of the LineItemTemplate. This attribute has a maximum length of 255 characters.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Display name of the LineItemTemplate. This attribute has a maximum length of 255 characters.

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

Returns
Type Description
ByteString

The bytes for displayName.

getLineItemDisplayName()

public String getLineItemDisplayName()

Optional. The default display_name of a new LineItem. This attribute has a maximum length of 127 characters.

optional string line_item_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The lineItemDisplayName.

getLineItemDisplayNameBytes()

public ByteString getLineItemDisplayNameBytes()

Optional. The default display_name of a new LineItem. This attribute has a maximum length of 127 characters.

optional string line_item_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for lineItemDisplayName.

getLineItemType()

public LineItemTypeEnum.LineItemType getLineItemType()

Required. The default line_item_type of a new LineItem.

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

Returns
Type Description
LineItemTypeEnum.LineItemType

The lineItemType.

getLineItemTypeValue()

public int getLineItemTypeValue()

Required. The default line_item_type of a new LineItem.

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

Returns
Type Description
int

The enum numeric value on the wire for lineItemType.

getName()

public String getName()

Identifier. The resource name of the LineItemTemplate. Format: networks/{network_code}/lineItemTemplates/{line_item_template_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 LineItemTemplate. Format: networks/{network_code}/lineItemTemplates/{line_item_template_id}

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

Returns
Type Description
ByteString

The bytes for name.

getNotes()

public String getNotes()

Optional. The default notes of a new LineItem. This attribute has a maximum length of 65,535 characters.

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

Returns
Type Description
String

The notes.

getNotesBytes()

public ByteString getNotesBytes()

Optional. The default notes of a new LineItem. This attribute has a maximum length of 65,535 characters.

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

Returns
Type Description
ByteString

The bytes for notes.

getRoadblockingType()

public RoadblockingTypeEnum.RoadblockingType getRoadblockingType()

Required. The default roadblocking_type of a new LineItem.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RoadblockingTypeEnum.RoadblockingType

The roadblockingType.

getRoadblockingTypeValue()

public int getRoadblockingTypeValue()

Required. The default roadblocking_type of a new LineItem.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for roadblockingType.

getSameAdvertiserExceptionEnabled()

public boolean getSameAdvertiserExceptionEnabled()

Optional. The default value for same_advertiser_exception_enabled of a new LineItem.

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

Returns
Type Description
boolean

The sameAdvertiserExceptionEnabled.

hasCreativeRotationType()

public boolean hasCreativeRotationType()

Required. The default creative_rotation_type of a new 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.

hasDefaultTemplate()

public boolean hasDefaultTemplate()

Output only. Whether or not the LineItemTemplate represents the default choices for creating a LineItem. Only one default LineItemTemplate is allowed per Network.

optional bool default_template = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the defaultTemplate field is set.

hasDeliveryRateType()

public boolean hasDeliveryRateType()

Required. The default delivery_rate_type of a new LineItem.

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the deliveryRateType field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. Display name of the LineItemTemplate. This attribute has a maximum length of 255 characters.

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

Returns
Type Description
boolean

Whether the displayName field is set.

hasLineItemDisplayName()

public boolean hasLineItemDisplayName()

Optional. The default display_name of a new LineItem. This attribute has a maximum length of 127 characters.

optional string line_item_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the lineItemDisplayName field is set.

hasLineItemType()

public boolean hasLineItemType()

Required. The default line_item_type of a new LineItem.

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

Returns
Type Description
boolean

Whether the lineItemType field is set.

hasNotes()

public boolean hasNotes()

Optional. The default notes of a new LineItem. This attribute has a maximum length of 65,535 characters.

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

Returns
Type Description
boolean

Whether the notes field is set.

hasRoadblockingType()

public boolean hasRoadblockingType()

Required. The default roadblocking_type of a new LineItem.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the roadblockingType field is set.

hasSameAdvertiserExceptionEnabled()

public boolean hasSameAdvertiserExceptionEnabled()

Optional. The default value for same_advertiser_exception_enabled of a new LineItem.

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

Returns
Type Description
boolean

Whether the sameAdvertiserExceptionEnabled field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(LineItemTemplate other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setCreativeRotationType(CreativeRotationTypeEnum.CreativeRotationType value)

public LineItemTemplate.Builder setCreativeRotationType(CreativeRotationTypeEnum.CreativeRotationType value)

Required. The default creative_rotation_type of a new 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
LineItemTemplate.Builder

This builder for chaining.

setCreativeRotationTypeValue(int value)

public LineItemTemplate.Builder setCreativeRotationTypeValue(int value)

Required. The default creative_rotation_type of a new 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
LineItemTemplate.Builder

This builder for chaining.

setDefaultTemplate(boolean value)

public LineItemTemplate.Builder setDefaultTemplate(boolean value)

Output only. Whether or not the LineItemTemplate represents the default choices for creating a LineItem. Only one default LineItemTemplate is allowed per Network.

optional bool default_template = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The defaultTemplate to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setDeliveryRateType(LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType value)

public LineItemTemplate.Builder setDeliveryRateType(LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType value)

Required. The default delivery_rate_type of a new LineItem.

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType

The deliveryRateType to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setDeliveryRateTypeValue(int value)

public LineItemTemplate.Builder setDeliveryRateTypeValue(int value)

Required. The default delivery_rate_type of a new LineItem.

optional .google.ads.admanager.v1.LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType delivery_rate_type = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

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

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setDisplayName(String value)

public LineItemTemplate.Builder setDisplayName(String value)

Required. Display name of the LineItemTemplate. This attribute has a maximum length of 255 characters.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public LineItemTemplate.Builder setDisplayNameBytes(ByteString value)

Required. Display name of the LineItemTemplate. This attribute has a maximum length of 255 characters.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setLineItemDisplayName(String value)

public LineItemTemplate.Builder setLineItemDisplayName(String value)

Optional. The default display_name of a new LineItem. This attribute has a maximum length of 127 characters.

optional string line_item_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The lineItemDisplayName to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setLineItemDisplayNameBytes(ByteString value)

public LineItemTemplate.Builder setLineItemDisplayNameBytes(ByteString value)

Optional. The default display_name of a new LineItem. This attribute has a maximum length of 127 characters.

optional string line_item_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for lineItemDisplayName to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setLineItemType(LineItemTypeEnum.LineItemType value)

public LineItemTemplate.Builder setLineItemType(LineItemTypeEnum.LineItemType value)

Required. The default line_item_type of a new LineItem.

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

Parameter
Name Description
value LineItemTypeEnum.LineItemType

The lineItemType to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setLineItemTypeValue(int value)

public LineItemTemplate.Builder setLineItemTypeValue(int value)

Required. The default line_item_type of a new LineItem.

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

Parameter
Name Description
value int

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

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setName(String value)

public LineItemTemplate.Builder setName(String value)

Identifier. The resource name of the LineItemTemplate. Format: networks/{network_code}/lineItemTemplates/{line_item_template_id}

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setNameBytes(ByteString value)

public LineItemTemplate.Builder setNameBytes(ByteString value)

Identifier. The resource name of the LineItemTemplate. Format: networks/{network_code}/lineItemTemplates/{line_item_template_id}

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setNotes(String value)

public LineItemTemplate.Builder setNotes(String value)

Optional. The default notes of a new LineItem. This attribute has a maximum length of 65,535 characters.

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

Parameter
Name Description
value String

The notes to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setNotesBytes(ByteString value)

public LineItemTemplate.Builder setNotesBytes(ByteString value)

Optional. The default notes of a new LineItem. This attribute has a maximum length of 65,535 characters.

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

Parameter
Name Description
value ByteString

The bytes for notes to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setRoadblockingType(RoadblockingTypeEnum.RoadblockingType value)

public LineItemTemplate.Builder setRoadblockingType(RoadblockingTypeEnum.RoadblockingType value)

Required. The default roadblocking_type of a new LineItem.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value RoadblockingTypeEnum.RoadblockingType

The roadblockingType to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setRoadblockingTypeValue(int value)

public LineItemTemplate.Builder setRoadblockingTypeValue(int value)

Required. The default roadblocking_type of a new LineItem.

optional .google.ads.admanager.v1.RoadblockingTypeEnum.RoadblockingType roadblocking_type = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

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

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.

setSameAdvertiserExceptionEnabled(boolean value)

public LineItemTemplate.Builder setSameAdvertiserExceptionEnabled(boolean value)

Optional. The default value for same_advertiser_exception_enabled of a new LineItem.

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

Parameter
Name Description
value boolean

The sameAdvertiserExceptionEnabled to set.

Returns
Type Description
LineItemTemplate.Builder

This builder for chaining.