Class LineItemTemplate (0.62.0)

public final class LineItemTemplate extends GeneratedMessage implements LineItemTemplateOrBuilder

The LineItemTemplate resource.

Protobuf type google.ads.admanager.v1.LineItemTemplate

Static Fields

CREATIVE_ROTATION_TYPE_FIELD_NUMBER

public static final int CREATIVE_ROTATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_TEMPLATE_FIELD_NUMBER

public static final int DEFAULT_TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int

DELIVERY_RATE_TYPE_FIELD_NUMBER

public static final int DELIVERY_RATE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

LINE_ITEM_DISPLAY_NAME_FIELD_NUMBER

public static final int LINE_ITEM_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

LINE_ITEM_TYPE_FIELD_NUMBER

public static final int LINE_ITEM_TYPE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NOTES_FIELD_NUMBER

public static final int NOTES_FIELD_NUMBER
Field Value
Type Description
int

ROADBLOCKING_TYPE_FIELD_NUMBER

public static final int ROADBLOCKING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SAME_ADVERTISER_EXCEPTION_ENABLED_FIELD_NUMBER

public static final int SAME_ADVERTISER_EXCEPTION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LineItemTemplate getDefaultInstance()
Returns
Type Description
LineItemTemplate

getDescriptor()

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

newBuilder()

public static LineItemTemplate.Builder newBuilder()
Returns
Type Description
LineItemTemplate.Builder

newBuilder(LineItemTemplate prototype)

public static LineItemTemplate.Builder newBuilder(LineItemTemplate prototype)
Parameter
Name Description
prototype LineItemTemplate
Returns
Type Description
LineItemTemplate.Builder

parseDelimitedFrom(InputStream input)

public static LineItemTemplate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LineItemTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LineItemTemplate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LineItemTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LineItemTemplate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LineItemTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LineItemTemplate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LineItemTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LineItemTemplate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LineItemTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LineItemTemplate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LineItemTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LineItemTemplate> parser()
Returns
Type Description
Parser<LineItemTemplate>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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.

getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LineItemTemplate.Builder newBuilderForType()
Returns
Type Description
LineItemTemplate.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected LineItemTemplate.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LineItemTemplate.Builder
Overrides

toBuilder()

public LineItemTemplate.Builder toBuilder()
Returns
Type Description
LineItemTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException