Interface CreativeTemplateOrBuilder (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 interface CreativeTemplateOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

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

getDisplayName()

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

getVariablesCount()

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