public static final class CreativeWrapper.Builder extends GeneratedMessage.Builder<CreativeWrapper.Builder> 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
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > CreativeWrapper.BuilderImplements
CreativeWrapperOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllVideoTrackingUrls(Iterable<? extends VideoTrackingUrl> values)
public CreativeWrapper.Builder addAllVideoTrackingUrls(Iterable<? extends VideoTrackingUrl> values) 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 |
values |
Iterable<? extends com.google.ads.admanager.v1.VideoTrackingUrl> |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
addVideoTrackingUrls(VideoTrackingUrl value)
public CreativeWrapper.Builder addVideoTrackingUrls(VideoTrackingUrl value) 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 |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
addVideoTrackingUrls(VideoTrackingUrl.Builder builderForValue)
public CreativeWrapper.Builder addVideoTrackingUrls(VideoTrackingUrl.Builder builderForValue) 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 |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
addVideoTrackingUrls(int index, VideoTrackingUrl value)
public CreativeWrapper.Builder addVideoTrackingUrls(int index, VideoTrackingUrl value) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
addVideoTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue)
public CreativeWrapper.Builder addVideoTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
addVideoTrackingUrlsBuilder()
public VideoTrackingUrl.Builder addVideoTrackingUrlsBuilder() 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 |
VideoTrackingUrl.Builder |
|
addVideoTrackingUrlsBuilder(int index)
public VideoTrackingUrl.Builder addVideoTrackingUrlsBuilder(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.Builder |
|
build()
public CreativeWrapper build()| Returns | |
|---|---|
| Type | Description |
CreativeWrapper |
|
buildPartial()
public CreativeWrapper buildPartial()| Returns | |
|---|---|
| Type | Description |
CreativeWrapper |
|
clear()
public CreativeWrapper.Builder clear()| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
clearAmpFooter()
public CreativeWrapper.Builder clearAmpFooter() Optional. The footer AMP snippet that this CreativeWrapper delivers.
optional string amp_footer = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
clearAmpHeader()
public CreativeWrapper.Builder clearAmpHeader() Optional. The header AMP snippet that this CreativeWrapper delivers.
optional string amp_header = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
clearCreativeWrapperType()
public CreativeWrapper.Builder clearCreativeWrapperType() 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 |
CreativeWrapper.Builder |
This builder for chaining. |
clearFooterCreative()
public CreativeWrapper.Builder clearFooterCreative() 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 |
CreativeWrapper.Builder |
This builder for chaining. |
clearHeaderCreative()
public CreativeWrapper.Builder clearHeaderCreative() 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 |
CreativeWrapper.Builder |
This builder for chaining. |
clearHtmlFooter()
public CreativeWrapper.Builder clearHtmlFooter() Optional. The footer HTML snippet that this CreativeWrapper delivers.
optional string html_footer = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
clearHtmlHeader()
public CreativeWrapper.Builder clearHtmlHeader() Optional. The header HTML snippet that this CreativeWrapper delivers.
optional string html_header = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
clearLabel()
public CreativeWrapper.Builder clearLabel() 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 |
CreativeWrapper.Builder |
This builder for chaining. |
clearName()
public CreativeWrapper.Builder clearName() 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 |
CreativeWrapper.Builder |
This builder for chaining. |
clearOrdering()
public CreativeWrapper.Builder clearOrdering()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 |
CreativeWrapper.Builder |
This builder for chaining. |
clearStatus()
public CreativeWrapper.Builder clearStatus() 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 |
CreativeWrapper.Builder |
This builder for chaining. |
clearThirdPartyDataDeclaration()
public CreativeWrapper.Builder clearThirdPartyDataDeclaration() 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 |
CreativeWrapper.Builder |
|
clearVideoTrackingUrls()
public CreativeWrapper.Builder clearVideoTrackingUrls() 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 |
CreativeWrapper.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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. |
getThirdPartyDataDeclarationBuilder()
public ThirdPartyDataDeclaration.Builder getThirdPartyDataDeclarationBuilder() 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.Builder |
|
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 |
|
getVideoTrackingUrlsBuilder(int index)
public VideoTrackingUrl.Builder getVideoTrackingUrlsBuilder(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.Builder |
|
getVideoTrackingUrlsBuilderList()
public List<VideoTrackingUrl.Builder> getVideoTrackingUrlsBuilderList() 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<Builder> |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CreativeWrapper other)
public CreativeWrapper.Builder mergeFrom(CreativeWrapper other)| Parameter | |
|---|---|
| Name | Description |
other |
CreativeWrapper |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreativeWrapper.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CreativeWrapper.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
mergeThirdPartyDataDeclaration(ThirdPartyDataDeclaration value)
public CreativeWrapper.Builder mergeThirdPartyDataDeclaration(ThirdPartyDataDeclaration value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ThirdPartyDataDeclaration |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
removeVideoTrackingUrls(int index)
public CreativeWrapper.Builder removeVideoTrackingUrls(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 |
CreativeWrapper.Builder |
|
setAmpFooter(String value)
public CreativeWrapper.Builder setAmpFooter(String value) Optional. The footer AMP snippet that this CreativeWrapper delivers.
optional string amp_footer = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe ampFooter to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setAmpFooterBytes(ByteString value)
public CreativeWrapper.Builder setAmpFooterBytes(ByteString value) Optional. The footer AMP snippet that this CreativeWrapper delivers.
optional string amp_footer = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for ampFooter to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setAmpHeader(String value)
public CreativeWrapper.Builder setAmpHeader(String value) Optional. The header AMP snippet that this CreativeWrapper delivers.
optional string amp_header = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe ampHeader to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setAmpHeaderBytes(ByteString value)
public CreativeWrapper.Builder setAmpHeaderBytes(ByteString value) Optional. The header AMP snippet that this CreativeWrapper delivers.
optional string amp_header = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for ampHeader to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setCreativeWrapperType(CreativeWrapperTypeEnum.CreativeWrapperType value)
public CreativeWrapper.Builder setCreativeWrapperType(CreativeWrapperTypeEnum.CreativeWrapperType value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeWrapperTypeEnum.CreativeWrapperTypeThe creativeWrapperType to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setCreativeWrapperTypeValue(int value)
public CreativeWrapper.Builder setCreativeWrapperTypeValue(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for creativeWrapperType to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setFooterCreative(String value)
public CreativeWrapper.Builder setFooterCreative(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe footerCreative to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setFooterCreativeBytes(ByteString value)
public CreativeWrapper.Builder setFooterCreativeBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for footerCreative to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setHeaderCreative(String value)
public CreativeWrapper.Builder setHeaderCreative(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe headerCreative to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setHeaderCreativeBytes(ByteString value)
public CreativeWrapper.Builder setHeaderCreativeBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for headerCreative to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setHtmlFooter(String value)
public CreativeWrapper.Builder setHtmlFooter(String value) Optional. The footer HTML snippet that this CreativeWrapper delivers.
optional string html_footer = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe htmlFooter to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setHtmlFooterBytes(ByteString value)
public CreativeWrapper.Builder setHtmlFooterBytes(ByteString value) Optional. The footer HTML snippet that this CreativeWrapper delivers.
optional string html_footer = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for htmlFooter to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setHtmlHeader(String value)
public CreativeWrapper.Builder setHtmlHeader(String value) Optional. The header HTML snippet that this CreativeWrapper delivers.
optional string html_header = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe htmlHeader to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setHtmlHeaderBytes(ByteString value)
public CreativeWrapper.Builder setHtmlHeaderBytes(ByteString value) Optional. The header HTML snippet that this CreativeWrapper delivers.
optional string html_header = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for htmlHeader to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setLabel(String value)
public CreativeWrapper.Builder setLabel(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe label to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setLabelBytes(ByteString value)
public CreativeWrapper.Builder setLabelBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for label to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setName(String value)
public CreativeWrapper.Builder setName(String value) Identifier. The resource name of the CreativeWrapper.
Format: networks/{network_code}/creativeWrappers/{creative_wrapper_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public CreativeWrapper.Builder setNameBytes(ByteString value) Identifier. The resource name of the CreativeWrapper.
Format: networks/{network_code}/creativeWrappers/{creative_wrapper_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setOrdering(CreativeWrapperOrderingEnum.CreativeWrapperOrdering value)
public CreativeWrapper.Builder setOrdering(CreativeWrapperOrderingEnum.CreativeWrapperOrdering value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeWrapperOrderingEnum.CreativeWrapperOrderingThe ordering to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setOrderingValue(int value)
public CreativeWrapper.Builder setOrderingValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for ordering to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setStatus(CreativeWrapperStatusEnum.CreativeWrapperStatus value)
public CreativeWrapper.Builder setStatus(CreativeWrapperStatusEnum.CreativeWrapperStatus value) Output only. The status of the CreativeWrapper.
optional .google.ads.admanager.v1.CreativeWrapperStatusEnum.CreativeWrapperStatus status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeWrapperStatusEnum.CreativeWrapperStatusThe status to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setStatusValue(int value)
public CreativeWrapper.Builder setStatusValue(int value) Output only. The status of the CreativeWrapper.
optional .google.ads.admanager.v1.CreativeWrapperStatusEnum.CreativeWrapperStatus status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for status to set. |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
This builder for chaining. |
setThirdPartyDataDeclaration(ThirdPartyDataDeclaration value)
public CreativeWrapper.Builder setThirdPartyDataDeclaration(ThirdPartyDataDeclaration value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ThirdPartyDataDeclaration |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
setThirdPartyDataDeclaration(ThirdPartyDataDeclaration.Builder builderForValue)
public CreativeWrapper.Builder setThirdPartyDataDeclaration(ThirdPartyDataDeclaration.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ThirdPartyDataDeclaration.Builder |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
setVideoTrackingUrls(int index, VideoTrackingUrl value)
public CreativeWrapper.Builder setVideoTrackingUrls(int index, VideoTrackingUrl value) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|
setVideoTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue)
public CreativeWrapper.Builder setVideoTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
CreativeWrapper.Builder |
|