Class CreativeWrapper (0.58.0)

public final class CreativeWrapper extends GeneratedMessage implements CreativeWrapperOrBuilder

A CreativeWrapper allows the wrapping of HTML snippets to be served along with Creative objects.

CreativeWrapper must be associated with a LabelType.CREATIVE_WRAPPER label and applied to ad units by AdUnit.appliedLabels.

Protobuf type google.ads.admanager.v1.CreativeWrapper

Static Fields

public static final int AMP_FOOTER_FIELD_NUMBER
Field Value
Type Description
int

AMP_HEADER_FIELD_NUMBER

public static final int AMP_HEADER_FIELD_NUMBER
Field Value
Type Description
int

CREATIVE_WRAPPER_TYPE_FIELD_NUMBER

public static final int CREATIVE_WRAPPER_TYPE_FIELD_NUMBER
Field Value
Type Description
int
public static final int FOOTER_CREATIVE_FIELD_NUMBER
Field Value
Type Description
int

HEADER_CREATIVE_FIELD_NUMBER

public static final int HEADER_CREATIVE_FIELD_NUMBER
Field Value
Type Description
int
public static final int HTML_FOOTER_FIELD_NUMBER
Field Value
Type Description
int

HTML_HEADER_FIELD_NUMBER

public static final int HTML_HEADER_FIELD_NUMBER
Field Value
Type Description
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ORDERING_FIELD_NUMBER

public static final int ORDERING_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

THIRD_PARTY_DATA_DECLARATION_FIELD_NUMBER

public static final int THIRD_PARTY_DATA_DECLARATION_FIELD_NUMBER
Field Value
Type Description
int

VIDEO_TRACKING_URLS_FIELD_NUMBER

public static final int VIDEO_TRACKING_URLS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreativeWrapper getDefaultInstance()
Returns
Type Description
CreativeWrapper

getDescriptor()

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

newBuilder()

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

newBuilder(CreativeWrapper prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAmpFooter()

public String getAmpFooter()

Optional. The footer AMP snippet that this CreativeWrapper delivers.

optional string amp_footer = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The ampFooter.

getAmpFooterBytes()

public ByteString getAmpFooterBytes()

Optional. The footer AMP snippet that this CreativeWrapper delivers.

optional string amp_footer = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for ampFooter.

getAmpHeader()

public String getAmpHeader()

Optional. The header AMP snippet that this CreativeWrapper delivers.

optional string amp_header = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The ampHeader.

getAmpHeaderBytes()

public ByteString getAmpHeaderBytes()

Optional. The header AMP snippet that this CreativeWrapper delivers.

optional string amp_header = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for ampHeader.

getCreativeWrapperType()

public CreativeWrapperTypeEnum.CreativeWrapperType getCreativeWrapperType()

Required. The creative_wrapper_type. If the creative_wrapper_type is CreativeWrapperType.VIDEO_TRACKING_URL, the video_tracking_urls field must be set. If the creative_wrapper_type is CreativeWrapperType.HTML, either the header or footer field must be set.

optional .google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType creative_wrapper_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreativeWrapperTypeEnum.CreativeWrapperType

The creativeWrapperType.

getCreativeWrapperTypeValue()

public int getCreativeWrapperTypeValue()

Required. The creative_wrapper_type. If the creative_wrapper_type is CreativeWrapperType.VIDEO_TRACKING_URL, the video_tracking_urls field must be set. If the creative_wrapper_type is CreativeWrapperType.HTML, either the header or footer field must be set.

optional .google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType creative_wrapper_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for creativeWrapperType.

getDefaultInstanceForType()

public CreativeWrapper getDefaultInstanceForType()
Returns
Type Description
CreativeWrapper

getFooterCreative()

public String getFooterCreative()

Output only. The resource name of the Creative. Format: networks/{network_code}/creative/{creative_id}

optional string footer_creative = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The footerCreative.

getFooterCreativeBytes()

public ByteString getFooterCreativeBytes()

Output only. The resource name of the Creative. Format: networks/{network_code}/creative/{creative_id}

optional string footer_creative = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for footerCreative.

getHeaderCreative()

public String getHeaderCreative()

Output only. The resource name of the Creative. Format: networks/{network_code}/creative/{creative_id}

optional string header_creative = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The headerCreative.

getHeaderCreativeBytes()

public ByteString getHeaderCreativeBytes()

Output only. The resource name of the Creative. Format: networks/{network_code}/creative/{creative_id}

optional string header_creative = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for headerCreative.

getHtmlFooter()

public String getHtmlFooter()

Optional. The footer HTML snippet that this CreativeWrapper delivers.

optional string html_footer = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The htmlFooter.

getHtmlFooterBytes()

public ByteString getHtmlFooterBytes()

Optional. The footer HTML snippet that this CreativeWrapper delivers.

optional string html_footer = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for htmlFooter.

getHtmlHeader()

public String getHtmlHeader()

Optional. The header HTML snippet that this CreativeWrapper delivers.

optional string html_header = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The htmlHeader.

getHtmlHeaderBytes()

public ByteString getHtmlHeaderBytes()

Optional. The header HTML snippet that this CreativeWrapper delivers.

optional string html_header = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for htmlHeader.

getLabel()

public String getLabel()

Required. Immutable. The resource name of the Label. Format:networks/{network_code}/label/{label_id}

string label = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The label.

getLabelBytes()

public ByteString getLabelBytes()

Required. Immutable. The resource name of the Label. Format:networks/{network_code}/label/{label_id}

string label = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for label.

getName()

public String getName()

Identifier. The resource name of the CreativeWrapper. Format: networks/{network_code}/creativeWrappers/{creative_wrapper_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 CreativeWrapper. Format: networks/{network_code}/creativeWrappers/{creative_wrapper_id}

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

Returns
Type Description
ByteString

The bytes for name.

getOrdering()

public CreativeWrapperOrderingEnum.CreativeWrapperOrdering getOrdering()

Optional. If there are multiple wrappers for a Creative, then ordering defines the order in which the HTML snippets are rendered.

optional .google.ads.admanager.v1.CreativeWrapperOrderingEnum.CreativeWrapperOrdering ordering = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeWrapperOrderingEnum.CreativeWrapperOrdering

The ordering.

getOrderingValue()

public int getOrderingValue()

Optional. If there are multiple wrappers for a Creative, then ordering defines the order in which the HTML snippets are rendered.

optional .google.ads.admanager.v1.CreativeWrapperOrderingEnum.CreativeWrapperOrdering ordering = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for ordering.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public CreativeWrapperStatusEnum.CreativeWrapperStatus getStatus()

Output only. The status of the CreativeWrapper.

optional .google.ads.admanager.v1.CreativeWrapperStatusEnum.CreativeWrapperStatus status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CreativeWrapperStatusEnum.CreativeWrapperStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of the CreativeWrapper.

optional .google.ads.admanager.v1.CreativeWrapperStatusEnum.CreativeWrapperStatus status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getThirdPartyDataDeclaration()

public ThirdPartyDataDeclaration getThirdPartyDataDeclaration()

Optional. The ThirdPartyDataDeclaration for this creative wrapper.

The third party companies that are associated with this CreativeWrapper and are present in the html_header or html_footer. This field is only applicable when the creative_wrapper_type is CreativeWrapperType.HTML.

optional .google.ads.admanager.v1.ThirdPartyDataDeclaration third_party_data_declaration = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ThirdPartyDataDeclaration

The thirdPartyDataDeclaration.

getThirdPartyDataDeclarationOrBuilder()

public ThirdPartyDataDeclarationOrBuilder getThirdPartyDataDeclarationOrBuilder()

Optional. The ThirdPartyDataDeclaration for this creative wrapper.

The third party companies that are associated with this CreativeWrapper and are present in the html_header or html_footer. This field is only applicable when the creative_wrapper_type is CreativeWrapperType.HTML.

optional .google.ads.admanager.v1.ThirdPartyDataDeclaration third_party_data_declaration = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ThirdPartyDataDeclarationOrBuilder

getVideoTrackingUrls(int index)

public VideoTrackingUrl getVideoTrackingUrls(int index)

Optional. The video tracking URLs that this CreativeWrapper delivers. This field is required if the creative_wrapper_type is CreativeWrapperType.VIDEO_TRACKING_URL and ignored otherwise.

repeated .google.ads.admanager.v1.VideoTrackingUrl video_tracking_urls = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
VideoTrackingUrl

getVideoTrackingUrlsCount()

public int getVideoTrackingUrlsCount()

Optional. The video tracking URLs that this CreativeWrapper delivers. This field is required if the creative_wrapper_type is CreativeWrapperType.VIDEO_TRACKING_URL and ignored otherwise.

repeated .google.ads.admanager.v1.VideoTrackingUrl video_tracking_urls = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getVideoTrackingUrlsList()

public List<VideoTrackingUrl> getVideoTrackingUrlsList()

Optional. The video tracking URLs that this CreativeWrapper delivers. This field is required if the creative_wrapper_type is CreativeWrapperType.VIDEO_TRACKING_URL and ignored otherwise.

repeated .google.ads.admanager.v1.VideoTrackingUrl video_tracking_urls = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<VideoTrackingUrl>

getVideoTrackingUrlsOrBuilder(int index)

public VideoTrackingUrlOrBuilder getVideoTrackingUrlsOrBuilder(int index)

Optional. The video tracking URLs that this CreativeWrapper delivers. This field is required if the creative_wrapper_type is CreativeWrapperType.VIDEO_TRACKING_URL and ignored otherwise.

repeated .google.ads.admanager.v1.VideoTrackingUrl video_tracking_urls = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
VideoTrackingUrlOrBuilder

getVideoTrackingUrlsOrBuilderList()

public List<? extends VideoTrackingUrlOrBuilder> getVideoTrackingUrlsOrBuilderList()

Optional. The video tracking URLs that this CreativeWrapper delivers. This field is required if the creative_wrapper_type is CreativeWrapperType.VIDEO_TRACKING_URL and ignored otherwise.

repeated .google.ads.admanager.v1.VideoTrackingUrl video_tracking_urls = 15 [(.google.api.field_behavior) = OPTIONAL];

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

hasAmpFooter()

public boolean hasAmpFooter()

Optional. The footer AMP snippet that this CreativeWrapper delivers.

optional string amp_footer = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ampFooter field is set.

hasAmpHeader()

public boolean hasAmpHeader()

Optional. The header AMP snippet that this CreativeWrapper delivers.

optional string amp_header = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ampHeader field is set.

hasCreativeWrapperType()

public boolean hasCreativeWrapperType()

Required. The creative_wrapper_type. If the creative_wrapper_type is CreativeWrapperType.VIDEO_TRACKING_URL, the video_tracking_urls field must be set. If the creative_wrapper_type is CreativeWrapperType.HTML, either the header or footer field must be set.

optional .google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType creative_wrapper_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the creativeWrapperType field is set.

hasFooterCreative()

public boolean hasFooterCreative()

Output only. The resource name of the Creative. Format: networks/{network_code}/creative/{creative_id}

optional string footer_creative = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the footerCreative field is set.

hasHeaderCreative()

public boolean hasHeaderCreative()

Output only. The resource name of the Creative. Format: networks/{network_code}/creative/{creative_id}

optional string header_creative = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the headerCreative field is set.

hasHtmlFooter()

public boolean hasHtmlFooter()

Optional. The footer HTML snippet that this CreativeWrapper delivers.

optional string html_footer = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the htmlFooter field is set.

hasHtmlHeader()

public boolean hasHtmlHeader()

Optional. The header HTML snippet that this CreativeWrapper delivers.

optional string html_header = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the htmlHeader field is set.

hasOrdering()

public boolean hasOrdering()

Optional. If there are multiple wrappers for a Creative, then ordering defines the order in which the HTML snippets are rendered.

optional .google.ads.admanager.v1.CreativeWrapperOrderingEnum.CreativeWrapperOrdering ordering = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ordering field is set.

hasStatus()

public boolean hasStatus()

Output only. The status of the CreativeWrapper.

optional .google.ads.admanager.v1.CreativeWrapperStatusEnum.CreativeWrapperStatus status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the status field is set.

hasThirdPartyDataDeclaration()

public boolean hasThirdPartyDataDeclaration()

Optional. The ThirdPartyDataDeclaration for this creative wrapper.

The third party companies that are associated with this CreativeWrapper and are present in the html_header or html_footer. This field is only applicable when the creative_wrapper_type is CreativeWrapperType.HTML.

optional .google.ads.admanager.v1.ThirdPartyDataDeclaration third_party_data_declaration = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the thirdPartyDataDeclaration 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 CreativeWrapper.Builder newBuilderForType()
Returns
Type Description
CreativeWrapper.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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