Class CreativeSet (0.54.0)

public final class CreativeSet extends GeneratedMessage implements CreativeSetOrBuilder

A CreativeSet is comprised of a master Creative and its companion Creatives.

Protobuf type google.ads.admanager.v1.CreativeSet

Static Fields

COMPANION_CREATIVES_FIELD_NUMBER

public static final int COMPANION_CREATIVES_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

MASTER_CREATIVE_FIELD_NUMBER

public static final int MASTER_CREATIVE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int 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 CreativeSet getDefaultInstance()
Returns
Type Description
CreativeSet

getDescriptor()

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

newBuilder()

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

newBuilder(CreativeSet prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCompanionCreatives(int index)

public String getCompanionCreatives(int index)

Required. The resource names of the companion Creatives associated with this CreativeSet. Format: networks/{network_code}/creatives/{creative}

repeated string companion_creatives = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The companionCreatives at the given index.

getCompanionCreativesBytes(int index)

public ByteString getCompanionCreativesBytes(int index)

Required. The resource names of the companion Creatives associated with this CreativeSet. Format: networks/{network_code}/creatives/{creative}

repeated string companion_creatives = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the companionCreatives at the given index.

getCompanionCreativesCount()

public int getCompanionCreativesCount()

Required. The resource names of the companion Creatives associated with this CreativeSet. Format: networks/{network_code}/creatives/{creative}

repeated string companion_creatives = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of companionCreatives.

getCompanionCreativesList()

public ProtocolStringList getCompanionCreativesList()

Required. The resource names of the companion Creatives associated with this CreativeSet. Format: networks/{network_code}/creatives/{creative}

repeated string companion_creatives = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the companionCreatives.

getDefaultInstanceForType()

public CreativeSet getDefaultInstanceForType()
Returns
Type Description
CreativeSet

getDisplayName()

public String getDisplayName()

Required. The name of the CreativeSet. 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 CreativeSet. 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.

getMasterCreative()

public String getMasterCreative()

Required. Immutable. The master Creative to which the CreativeSet is associated.

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

Returns
Type Description
String

The masterCreative.

getMasterCreativeBytes()

public ByteString getMasterCreativeBytes()

Required. Immutable. The master Creative to which the CreativeSet is associated.

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

Returns
Type Description
ByteString

The bytes for masterCreative.

getName()

public String getName()

Identifier. The resource name of the CreativeSet. Format: networks/{network_code}/creativeSets/{creative_set_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 CreativeSet. Format: networks/{network_code}/creativeSets/{creative_set_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time this CreativeSet was last modified.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time this CreativeSet was last modified.

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

Returns
Type Description
TimestampOrBuilder

hasDisplayName()

public boolean hasDisplayName()

Required. The name of the CreativeSet. 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.

hasMasterCreative()

public boolean hasMasterCreative()

Required. Immutable. The master Creative to which the CreativeSet is associated.

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

Returns
Type Description
boolean

Whether the masterCreative field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time this CreativeSet was last modified.

optional .google.protobuf.Timestamp update_time = 9 [(.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 CreativeSet.Builder newBuilderForType()
Returns
Type Description
CreativeSet.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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