Interface LineItemCreativeAssociationOrBuilder (0.62.0)

public interface LineItemCreativeAssociationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreative()

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

getDestinationUrl()

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

getSequentialCreativeRotationIndex()

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

getSizes(int index)

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