Class CreativeTemplate.Builder (0.39.0)

Version latest

• 0.39.0 (latest)
• 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 CreativeTemplate.Builder extends GeneratedMessageV3.Builder<CreativeTemplate.Builder> implements CreativeTemplateOrBuilder

A template that can be used to create a [TemplateCreative][].

Protobuf type google.ads.admanager.v1.CreativeTemplate

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreativeTemplate.Builder

Implements

CreativeTemplateOrBuilder

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)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

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

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(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

addAllVariables(Iterable<? extends CreativeTemplateVariable> values)

public CreativeTemplate.Builder addAllVariables(Iterable<? extends CreativeTemplateVariable> values)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
values	Iterable<? extends com.google.ads.admanager.v1.CreativeTemplateVariable>

Returns
Type	Description
CreativeTemplate.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreativeTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CreativeTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addVariables(CreativeTemplateVariable value)

public CreativeTemplate.Builder addVariables(CreativeTemplateVariable value)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	CreativeTemplateVariable

Returns
Type	Description
CreativeTemplate.Builder

addVariables(CreativeTemplateVariable.Builder builderForValue)

public CreativeTemplate.Builder addVariables(CreativeTemplateVariable.Builder builderForValue)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	CreativeTemplateVariable.Builder

Returns
Type	Description
CreativeTemplate.Builder

addVariables(int index, CreativeTemplateVariable value)

public CreativeTemplate.Builder addVariables(int index, CreativeTemplateVariable value)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
value	CreativeTemplateVariable

Returns
Type	Description
CreativeTemplate.Builder

addVariables(int index, CreativeTemplateVariable.Builder builderForValue)

public CreativeTemplate.Builder addVariables(int index, CreativeTemplateVariable.Builder builderForValue)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
builderForValue	CreativeTemplateVariable.Builder

Returns
Type	Description
CreativeTemplate.Builder

addVariablesBuilder()

public CreativeTemplateVariable.Builder addVariablesBuilder()

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CreativeTemplateVariable.Builder

addVariablesBuilder(int index)

public CreativeTemplateVariable.Builder addVariablesBuilder(int index)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
CreativeTemplateVariable.Builder

build()

public CreativeTemplate build()

Returns
Type	Description
CreativeTemplate

buildPartial()

public CreativeTemplate buildPartial()

Returns
Type	Description
CreativeTemplate

clear()

public CreativeTemplate.Builder clear()

Returns
Type	Description
CreativeTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDescription()

public CreativeTemplate.Builder clearDescription()

Optional. The description of the creative template.

optional string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

clearDisplayName()

public CreativeTemplate.Builder clearDisplayName()

Required. The display name of the creative template. This has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreativeTemplate.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CreativeTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearInterstitial()

public CreativeTemplate.Builder clearInterstitial()

Optional. True if this creative template produces out-of-page creatives. Creative templates with this setting enabled must include the viewed impression macro.

optional bool interstitial = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

clearName()

public CreativeTemplate.Builder clearName()

Identifier. The resource name of the creative template. Format: networks/{network_code}/creativeTemplates/{creative_template_id}

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

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

clearNativeEligible()

public CreativeTemplate.Builder clearNativeEligible()

Optional. True if this creative template produces native-eligible creatives.

optional bool native_eligible = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

clearNativeVideoEligible()

public CreativeTemplate.Builder clearNativeVideoEligible()

Optional. True if this creative template produces native video-eligible creatives.

optional bool native_video_eligible = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CreativeTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
CreativeTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSafeFrameCompatible()

public CreativeTemplate.Builder clearSafeFrameCompatible()

Optional. Whether the Creative produced is compatible for SafeFrame rendering. This attribute defaults to True.

optional bool safe_frame_compatible = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

clearSnippet()

public CreativeTemplate.Builder clearSnippet()

Required. The code snippet of the creative template, with placeholders for the associated variables.

optional string snippet = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

clearStatus()

public CreativeTemplate.Builder clearStatus()

Output only. The status of the creative template. This attribute is assigned by Google.

optional .google.ads.admanager.v1.CreativeTemplateStatusEnum.CreativeTemplateStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

clearType()

public CreativeTemplate.Builder clearType()

Optional. The type of the creative template. Users can only create or update CreativeTemplateType.CUSTOM templates.

optional .google.ads.admanager.v1.CreativeTemplateTypeEnum.CreativeTemplateType type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

clearVariables()

public CreativeTemplate.Builder clearVariables()

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CreativeTemplate.Builder

clone()

public CreativeTemplate.Builder clone()

Returns
Type	Description
CreativeTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public CreativeTemplate getDefaultInstanceForType()

Returns
Type	Description
CreativeTemplate

getDescription()

public String getDescription()

Optional. The description of the creative template.

optional string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the creative template.

optional string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

Required. The display name of the creative template. This 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. The display name of the creative template. This 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.

getInterstitial()

public boolean getInterstitial()

Optional. True if this creative template produces out-of-page creatives. Creative templates with this setting enabled must include the viewed impression macro.

optional bool interstitial = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The interstitial.

getName()

public String getName()

Identifier. The resource name of the creative template. Format: networks/{network_code}/creativeTemplates/{creative_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 creative template. Format: networks/{network_code}/creativeTemplates/{creative_template_id}

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

Returns
Type	Description
ByteString	The bytes for name.

getNativeEligible()

public boolean getNativeEligible()

Optional. True if this creative template produces native-eligible creatives.

optional bool native_eligible = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The nativeEligible.

getNativeVideoEligible()

public boolean getNativeVideoEligible()

Optional. True if this creative template produces native video-eligible creatives.

optional bool native_video_eligible = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The nativeVideoEligible.

getSafeFrameCompatible()

public boolean getSafeFrameCompatible()

Optional. Whether the Creative produced is compatible for SafeFrame rendering. This attribute defaults to True.

optional bool safe_frame_compatible = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The safeFrameCompatible.

getSnippet()

public String getSnippet()

Required. The code snippet of the creative template, with placeholders for the associated variables.

optional string snippet = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The snippet.

getSnippetBytes()

public ByteString getSnippetBytes()

Required. The code snippet of the creative template, with placeholders for the associated variables.

optional string snippet = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for snippet.

getStatus()

public CreativeTemplateStatusEnum.CreativeTemplateStatus getStatus()

Output only. The status of the creative template. This attribute is assigned by Google.

optional .google.ads.admanager.v1.CreativeTemplateStatusEnum.CreativeTemplateStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
CreativeTemplateStatusEnum.CreativeTemplateStatus	The status.

getStatusValue()

public int getStatusValue()

Output only. The status of the creative template. This attribute is assigned by Google.

optional .google.ads.admanager.v1.CreativeTemplateStatusEnum.CreativeTemplateStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for status.

getType()

public CreativeTemplateTypeEnum.CreativeTemplateType getType()

Optional. The type of the creative template. Users can only create or update CreativeTemplateType.CUSTOM templates.

optional .google.ads.admanager.v1.CreativeTemplateTypeEnum.CreativeTemplateType type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CreativeTemplateTypeEnum.CreativeTemplateType	The type.

getTypeValue()

public int getTypeValue()

Optional. The type of the creative template. Users can only create or update CreativeTemplateType.CUSTOM templates.

optional .google.ads.admanager.v1.CreativeTemplateTypeEnum.CreativeTemplateType type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for type.

getVariables(int index)

public CreativeTemplateVariable getVariables(int index)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
CreativeTemplateVariable

getVariablesBuilder(int index)

public CreativeTemplateVariable.Builder getVariablesBuilder(int index)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
CreativeTemplateVariable.Builder

getVariablesBuilderList()

public List<CreativeTemplateVariable.Builder> getVariablesBuilderList()

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<Builder>

getVariablesCount()

public int getVariablesCount()

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int

getVariablesList()

public List<CreativeTemplateVariable> getVariablesList()

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<CreativeTemplateVariable>

getVariablesOrBuilder(int index)

public CreativeTemplateVariableOrBuilder getVariablesOrBuilder(int index)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
CreativeTemplateVariableOrBuilder

getVariablesOrBuilderList()

public List<? extends CreativeTemplateVariableOrBuilder> getVariablesOrBuilderList()

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

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

hasDescription()

public boolean hasDescription()

Optional. The description of the creative template.

optional string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the description field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. The display name of the creative template. This 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.

hasInterstitial()

public boolean hasInterstitial()

Optional. True if this creative template produces out-of-page creatives. Creative templates with this setting enabled must include the viewed impression macro.

optional bool interstitial = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the interstitial field is set.

hasNativeEligible()

public boolean hasNativeEligible()

Optional. True if this creative template produces native-eligible creatives.

optional bool native_eligible = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the nativeEligible field is set.

hasNativeVideoEligible()

public boolean hasNativeVideoEligible()

Optional. True if this creative template produces native video-eligible creatives.

optional bool native_video_eligible = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the nativeVideoEligible field is set.

hasSafeFrameCompatible()

public boolean hasSafeFrameCompatible()

Optional. Whether the Creative produced is compatible for SafeFrame rendering. This attribute defaults to True.

optional bool safe_frame_compatible = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the safeFrameCompatible field is set.

hasSnippet()

public boolean hasSnippet()

Required. The code snippet of the creative template, with placeholders for the associated variables.

optional string snippet = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the snippet field is set.

hasStatus()

public boolean hasStatus()

Output only. The status of the creative template. This attribute is assigned by Google.

optional .google.ads.admanager.v1.CreativeTemplateStatusEnum.CreativeTemplateStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the status field is set.

hasType()

public boolean hasType()

Optional. The type of the creative template. Users can only create or update CreativeTemplateType.CUSTOM templates.

optional .google.ads.admanager.v1.CreativeTemplateTypeEnum.CreativeTemplateType type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the type field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CreativeTemplate other)

public CreativeTemplate.Builder mergeFrom(CreativeTemplate other)

Parameter
Name	Description
other	CreativeTemplate

Returns
Type	Description
CreativeTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CreativeTemplate.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CreativeTemplate.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CreativeTemplate.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreativeTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CreativeTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeVariables(int index)

public CreativeTemplate.Builder removeVariables(int index)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
CreativeTemplate.Builder

setDescription(String value)

public CreativeTemplate.Builder setDescription(String value)

Optional. The description of the creative template.

optional string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public CreativeTemplate.Builder setDescriptionBytes(ByteString value)

Optional. The description of the creative template.

optional string description = 3 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setDisplayName(String value)

public CreativeTemplate.Builder setDisplayName(String value)

Required. The display name of the creative template. This has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public CreativeTemplate.Builder setDisplayNameBytes(ByteString value)

Required. The display name of the creative template. This has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

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

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreativeTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CreativeTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setInterstitial(boolean value)

public CreativeTemplate.Builder setInterstitial(boolean value)

Optional. True if this creative template produces out-of-page creatives. Creative templates with this setting enabled must include the viewed impression macro.

optional bool interstitial = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The interstitial to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setName(String value)

public CreativeTemplate.Builder setName(String value)

Identifier. The resource name of the creative template. Format: networks/{network_code}/creativeTemplates/{creative_template_id}

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

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setNameBytes(ByteString value)

public CreativeTemplate.Builder setNameBytes(ByteString value)

Identifier. The resource name of the creative template. Format: networks/{network_code}/creativeTemplates/{creative_template_id}

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

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

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setNativeEligible(boolean value)

public CreativeTemplate.Builder setNativeEligible(boolean value)

Optional. True if this creative template produces native-eligible creatives.

optional bool native_eligible = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The nativeEligible to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setNativeVideoEligible(boolean value)

public CreativeTemplate.Builder setNativeVideoEligible(boolean value)

Optional. True if this creative template produces native video-eligible creatives.

optional bool native_video_eligible = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The nativeVideoEligible to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreativeTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
CreativeTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSafeFrameCompatible(boolean value)

public CreativeTemplate.Builder setSafeFrameCompatible(boolean value)

Optional. Whether the Creative produced is compatible for SafeFrame rendering. This attribute defaults to True.

optional bool safe_frame_compatible = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The safeFrameCompatible to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setSnippet(String value)

public CreativeTemplate.Builder setSnippet(String value)

Required. The code snippet of the creative template, with placeholders for the associated variables.

optional string snippet = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The snippet to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setSnippetBytes(ByteString value)

public CreativeTemplate.Builder setSnippetBytes(ByteString value)

Required. The code snippet of the creative template, with placeholders for the associated variables.

optional string snippet = 4 [(.google.api.field_behavior) = REQUIRED];

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

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setStatus(CreativeTemplateStatusEnum.CreativeTemplateStatus value)

public CreativeTemplate.Builder setStatus(CreativeTemplateStatusEnum.CreativeTemplateStatus value)

Output only. The status of the creative template. This attribute is assigned by Google.

optional .google.ads.admanager.v1.CreativeTemplateStatusEnum.CreativeTemplateStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	CreativeTemplateStatusEnum.CreativeTemplateStatus The status to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setStatusValue(int value)

public CreativeTemplate.Builder setStatusValue(int value)

Output only. The status of the creative template. This attribute is assigned by Google.

optional .google.ads.admanager.v1.CreativeTemplateStatusEnum.CreativeTemplateStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	int The enum numeric value on the wire for status to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setType(CreativeTemplateTypeEnum.CreativeTemplateType value)

public CreativeTemplate.Builder setType(CreativeTemplateTypeEnum.CreativeTemplateType value)

Optional. The type of the creative template. Users can only create or update CreativeTemplateType.CUSTOM templates.

optional .google.ads.admanager.v1.CreativeTemplateTypeEnum.CreativeTemplateType type = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	CreativeTemplateTypeEnum.CreativeTemplateType The type to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setTypeValue(int value)

public CreativeTemplate.Builder setTypeValue(int value)

Optional. The type of the creative template. Users can only create or update CreativeTemplateType.CUSTOM templates.

optional .google.ads.admanager.v1.CreativeTemplateTypeEnum.CreativeTemplateType type = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for type to set.

Returns
Type	Description
CreativeTemplate.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CreativeTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CreativeTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setVariables(int index, CreativeTemplateVariable value)

public CreativeTemplate.Builder setVariables(int index, CreativeTemplateVariable value)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
value	CreativeTemplateVariable

Returns
Type	Description
CreativeTemplate.Builder

setVariables(int index, CreativeTemplateVariable.Builder builderForValue)

public CreativeTemplate.Builder setVariables(int index, CreativeTemplateVariable.Builder builderForValue)

Required. The list of creative template variables.

repeated .google.ads.admanager.v1.CreativeTemplateVariable variables = 14 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
builderForValue	CreativeTemplateVariable.Builder

Returns
Type	Description
CreativeTemplate.Builder