Class CreativeSet.Builder (0.54.0)

0.54.0 (latest) 0.53.0 0.52.0 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class CreativeSet.Builder extends GeneratedMessage.Builder<CreativeSet.Builder> implements CreativeSetOrBuilder

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

Protobuf type google.ads.admanager.v1.CreativeSet

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > CreativeSet.Builder

Implements

CreativeSetOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllCompanionCreatives(Iterable<String> values)

public CreativeSet.Builder addAllCompanionCreatives(Iterable<String> values)

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
values	Iterable<String> The companionCreatives to add.

Returns
Type	Description
CreativeSet.Builder	This builder for chaining.

addCompanionCreatives(String value)

public CreativeSet.Builder addCompanionCreatives(String value)

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
value	String The companionCreatives to add.

Returns
Type	Description
CreativeSet.Builder	This builder for chaining.

addCompanionCreativesBytes(ByteString value)

public CreativeSet.Builder addCompanionCreativesBytes(ByteString value)

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
value	ByteString The bytes of the companionCreatives to add.

Returns
Type	Description
CreativeSet.Builder	This builder for chaining.

build()

public CreativeSet build()

Returns
Type	Description
CreativeSet

buildPartial()

public CreativeSet buildPartial()

Returns
Type	Description
CreativeSet

clear()

public CreativeSet.Builder clear()

Returns
Type	Description
CreativeSet.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearCompanionCreatives()

public CreativeSet.Builder clearCompanionCreatives()

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
CreativeSet.Builder	This builder for chaining.

clearDisplayName()

public CreativeSet.Builder clearDisplayName()

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
CreativeSet.Builder	This builder for chaining.

clearMasterCreative()

public CreativeSet.Builder clearMasterCreative()

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
CreativeSet.Builder	This builder for chaining.

clearName()

public CreativeSet.Builder clearName()

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
CreativeSet.Builder	This builder for chaining.

clearUpdateTime()

public CreativeSet.Builder clearUpdateTime()

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
CreativeSet.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(CreativeSet other)

public CreativeSet.Builder mergeFrom(CreativeSet other)

Parameter
Name	Description
other	CreativeSet

Returns
Type	Description
CreativeSet.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreativeSet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativeSet.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CreativeSet.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CreativeSet.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUpdateTime(Timestamp value)

public CreativeSet.Builder mergeUpdateTime(Timestamp value)

Output only. The time this CreativeSet was last modified.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
CreativeSet.Builder

setCompanionCreatives(int index, String value)

public CreativeSet.Builder setCompanionCreatives(int index, String value)

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) = { ... }

Parameters
Name	Description
index	int The index to set the value at.
value	String The companionCreatives to set.

Returns
Type	Description
CreativeSet.Builder	This builder for chaining.

setDisplayName(String value)

public CreativeSet.Builder setDisplayName(String value)

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];

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
CreativeSet.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public CreativeSet.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
CreativeSet.Builder	This builder for chaining.

setMasterCreative(String value)

public CreativeSet.Builder setMasterCreative(String value)

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) = { ... }

Parameter
Name	Description
value	String The masterCreative to set.

Returns
Type	Description
CreativeSet.Builder	This builder for chaining.

setMasterCreativeBytes(ByteString value)

public CreativeSet.Builder setMasterCreativeBytes(ByteString value)

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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for masterCreative to set.

Returns
Type	Description
CreativeSet.Builder	This builder for chaining.

setName(String value)

public CreativeSet.Builder setName(String value)

Identifier. The resource name of the CreativeSet. Format: networks/{network_code}/creativeSets/{creative_set_id}

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

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
CreativeSet.Builder	This builder for chaining.

setNameBytes(ByteString value)

public CreativeSet.Builder setNameBytes(ByteString value)

Identifier. The resource name of the CreativeSet. Format: networks/{network_code}/creativeSets/{creative_set_id}

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

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
CreativeSet.Builder	This builder for chaining.

setUpdateTime(Timestamp value)

public CreativeSet.Builder setUpdateTime(Timestamp value)

Output only. The time this CreativeSet was last modified.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
CreativeSet.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public CreativeSet.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time this CreativeSet was last modified.

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
CreativeSet.Builder