Interface CreativeWrapperOrBuilder (0.58.0) 

public interface CreativeWrapperOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAmpFooter()

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

getFooterCreative()

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

getStatus()

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