Class LineItemCreativeAssociation (0.62.0)

public final class LineItemCreativeAssociation extends GeneratedMessage implements LineItemCreativeAssociationOrBuilder

A LineItemCreativeAssociation associates a Creative or CreativeSet with a LineItem so that the creative can be served in ad units targeted by the line item.

Protobuf type google.ads.admanager.v1.LineItemCreativeAssociation

Static Fields

CREATIVE_FIELD_NUMBER

public static final int CREATIVE_FIELD_NUMBER
Field Value
Type Description
int

CREATIVE_SET_FIELD_NUMBER

public static final int CREATIVE_SET_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_URL_FIELD_NUMBER

public static final int DESTINATION_URL_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

LINE_ITEM_FIELD_NUMBER

public static final int LINE_ITEM_FIELD_NUMBER
Field Value
Type Description
int

MANUAL_CREATIVE_ROTATION_WEIGHT_FIELD_NUMBER

public static final int MANUAL_CREATIVE_ROTATION_WEIGHT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SEQUENTIAL_CREATIVE_ROTATION_INDEX_FIELD_NUMBER

public static final int SEQUENTIAL_CREATIVE_ROTATION_INDEX_FIELD_NUMBER
Field Value
Type Description
int

SIZES_FIELD_NUMBER

public static final int SIZES_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATS_FIELD_NUMBER

public static final int STATS_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TARGETING_DISPLAY_NAME_FIELD_NUMBER

public static final int TARGETING_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LineItemCreativeAssociation getDefaultInstance()
Returns
Type Description
LineItemCreativeAssociation

getDescriptor()

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

newBuilder()

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

newBuilder(LineItemCreativeAssociation prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCreative()

public String getCreative()

Optional. Immutable. The Creative to which the LineItemCreativeAssociation associated. Optional if creativeSet is set.

optional string creative = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The creative.

getCreativeBytes()

public ByteString getCreativeBytes()

Optional. Immutable. The Creative to which the LineItemCreativeAssociation associated. Optional if creativeSet is set.

optional string creative = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for creative.

getCreativeSet()

public String getCreativeSet()

Optional. Immutable. The CreativeSet to which the LineItemCreativeAssociation associated. Optional if creative is set.

optional string creative_set = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The creativeSet.

getCreativeSetBytes()

public ByteString getCreativeSetBytes()

Optional. Immutable. The CreativeSet to which the LineItemCreativeAssociation associated. Optional if creative is set.

optional string creative_set = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for creativeSet.

getDefaultInstanceForType()

public LineItemCreativeAssociation getDefaultInstanceForType()
Returns
Type Description
LineItemCreativeAssociation

getDestinationUrl()

public String getDestinationUrl()

Optional. Overrides the value set for destinationUrl of the creative. This value is only valid for Ad Manager 360 networks.

optional string destination_url = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The destinationUrl.

getDestinationUrlBytes()

public ByteString getDestinationUrlBytes()

Optional. Overrides the value set for destinationUrl of the creative. This value is only valid for Ad Manager 360 networks.

optional string destination_url = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for destinationUrl.

getEndTime()

public Timestamp getEndTime()

Optional. Overrides endTime of the lineItem. This value is only valid for Ad Manager 360 networks. If unset, the endTime of the lineItem will be used.

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

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Optional. Overrides endTime of the lineItem. This value is only valid for Ad Manager 360 networks. If unset, the endTime of the lineItem will be used.

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

Returns
Type Description
TimestampOrBuilder

getLineItem()

public String getLineItem()

Required. Immutable. The LineItem to which the LineItemCreativeAssociation belongs.

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

Returns
Type Description
String

The lineItem.

getLineItemBytes()

public ByteString getLineItemBytes()

Required. Immutable. The LineItem to which the LineItemCreativeAssociation belongs.

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

Returns
Type Description
ByteString

The bytes for lineItem.

getManualCreativeRotationWeight()

public double getManualCreativeRotationWeight()

Optional. Non-empty default. The weight of the creative. This value is only used if the creativeRotationType of the lineItem is set to WEIGHTED. Defaults to 10.

optional double manual_creative_rotation_weight = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
double

The manualCreativeRotationWeight.

getName()

public String getName()

Identifier. The resource name of the LineItemCreativeAssociation. Format: networks/{network_code}/lineItems/{line_item_id}/creatives/{creative_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 LineItemCreativeAssociation. Format: networks/{network_code}/lineItems/{line_item_id}/creatives/{creative_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSequentialCreativeRotationIndex()

public int getSequentialCreativeRotationIndex()

Optional. Non-empty default. The sequential rotation index of the Creative. This value is used only if the lineItem's creativeRotationType is set to SEQUENTIAL. Defaults to 1.

optional int32 sequential_creative_rotation_index = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The sequentialCreativeRotationIndex.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSizes(int index)

public Size getSizes(int index)

Optional. Overrides the value set for size of the creative, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size.

repeated .google.ads.admanager.v1.Size sizes = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Size

getSizesCount()

public int getSizesCount()

Optional. Overrides the value set for size of the creative, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size.

repeated .google.ads.admanager.v1.Size sizes = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSizesList()

public List<Size> getSizesList()

Optional. Overrides the value set for size of the creative, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size.

repeated .google.ads.admanager.v1.Size sizes = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Size>

getSizesOrBuilder(int index)

public SizeOrBuilder getSizesOrBuilder(int index)

Optional. Overrides the value set for size of the creative, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size.

repeated .google.ads.admanager.v1.Size sizes = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SizeOrBuilder

getSizesOrBuilderList()

public List<? extends SizeOrBuilder> getSizesOrBuilderList()

Optional. Overrides the value set for size of the creative, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size.

repeated .google.ads.admanager.v1.Size sizes = 8 [(.google.api.field_behavior) = OPTIONAL];

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

getStartTime()

public Timestamp getStartTime()

Optional. Overrides the value set for startTime of the lineItem. This value is only valid for Ad Manager 360 networks. If unset, the startTime of the lineItem will be used.

optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Optional. Overrides the value set for startTime of the lineItem. This value is only valid for Ad Manager 360 networks. If unset, the startTime of the lineItem will be used.

optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getStats()

public LineItemCreativeAssociationStats getStats()

Output only. Contains trafficking statistics for the association.

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

Returns
Type Description
LineItemCreativeAssociationStats

The stats.

getStatsOrBuilder()

public LineItemCreativeAssociationStatsOrBuilder getStatsOrBuilder()

Output only. Contains trafficking statistics for the association.

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

Returns
Type Description
LineItemCreativeAssociationStatsOrBuilder

getStatus()

public LineItemCreativeAssociationStatusEnum.LineItemCreativeAssociationStatus getStatus()

Output only. The status of the association.

optional .google.ads.admanager.v1.LineItemCreativeAssociationStatusEnum.LineItemCreativeAssociationStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineItemCreativeAssociationStatusEnum.LineItemCreativeAssociationStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of the association.

optional .google.ads.admanager.v1.LineItemCreativeAssociationStatusEnum.LineItemCreativeAssociationStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getTargetingDisplayName()

public String getTargetingDisplayName()

Optional. Specifies creative targeting for this line item creative association. It should match the targetingName specified on the corresponding creativePlaceholder on the lineItem.

string targeting_display_name = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The targetingDisplayName.

getTargetingDisplayNameBytes()

public ByteString getTargetingDisplayNameBytes()

Optional. Specifies creative targeting for this line item creative association. It should match the targetingName specified on the corresponding creativePlaceholder on the lineItem.

string targeting_display_name = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for targetingDisplayName.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The date and time this association was last modified.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The date and time this association was last modified.

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

Returns
Type Description
TimestampOrBuilder

hasCreative()

public boolean hasCreative()

Optional. Immutable. The Creative to which the LineItemCreativeAssociation associated. Optional if creativeSet is set.

optional string creative = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the creative field is set.

hasCreativeSet()

public boolean hasCreativeSet()

Optional. Immutable. The CreativeSet to which the LineItemCreativeAssociation associated. Optional if creative is set.

optional string creative_set = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the creativeSet field is set.

hasDestinationUrl()

public boolean hasDestinationUrl()

Optional. Overrides the value set for destinationUrl of the creative. This value is only valid for Ad Manager 360 networks.

optional string destination_url = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the destinationUrl field is set.

hasEndTime()

public boolean hasEndTime()

Optional. Overrides endTime of the lineItem. This value is only valid for Ad Manager 360 networks. If unset, the endTime of the lineItem will be used.

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

Returns
Type Description
boolean

Whether the endTime field is set.

hasLineItem()

public boolean hasLineItem()

Required. Immutable. The LineItem to which the LineItemCreativeAssociation belongs.

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

Returns
Type Description
boolean

Whether the lineItem field is set.

hasManualCreativeRotationWeight()

public boolean hasManualCreativeRotationWeight()

Optional. Non-empty default. The weight of the creative. This value is only used if the creativeRotationType of the lineItem is set to WEIGHTED. Defaults to 10.

optional double manual_creative_rotation_weight = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the manualCreativeRotationWeight field is set.

hasSequentialCreativeRotationIndex()

public boolean hasSequentialCreativeRotationIndex()

Optional. Non-empty default. The sequential rotation index of the Creative. This value is used only if the lineItem's creativeRotationType is set to SEQUENTIAL. Defaults to 1.

optional int32 sequential_creative_rotation_index = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the sequentialCreativeRotationIndex field is set.

hasStartTime()

public boolean hasStartTime()

Optional. Overrides the value set for startTime of the lineItem. This value is only valid for Ad Manager 360 networks. If unset, the startTime of the lineItem will be used.

optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the startTime field is set.

hasStats()

public boolean hasStats()

Output only. Contains trafficking statistics for the association.

optional .google.ads.admanager.v1.LineItemCreativeAssociationStats stats = 25 [(.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 association.

optional .google.ads.admanager.v1.LineItemCreativeAssociationStatusEnum.LineItemCreativeAssociationStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the status field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The date and time this association was last modified.

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

Returns
Type Description
boolean

Whether the updateTime 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 LineItemCreativeAssociation.Builder newBuilderForType()
Returns
Type Description
LineItemCreativeAssociation.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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