public static final class ImageOverlayCreativeDetails.Builder extends GeneratedMessage.Builder<ImageOverlayCreativeDetails.Builder> implements ImageOverlayCreativeDetailsOrBuilderAn overlay Creative that displays an image and is served via VAST 2.0 XML. Overlays cover part of the video content they are displayed on top of.
Protobuf type google.ads.admanager.v1.ImageOverlayCreativeDetails
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ImageOverlayCreativeDetails.BuilderImplements
ImageOverlayCreativeDetailsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllCompanionCreatives(Iterable<String> values)
public ImageOverlayCreativeDetails.Builder addAllCompanionCreatives(Iterable<String> values)Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The companionCreatives to add. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
addAllExpectedCompanions(Iterable<? extends CreativePlaceholder> values)
public ImageOverlayCreativeDetails.Builder addAllExpectedCompanions(Iterable<? extends CreativePlaceholder> values) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.ads.admanager.v1.CreativePlaceholder> |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
addAllTrackingUrls(Iterable<? extends VideoTrackingUrl> values)
public ImageOverlayCreativeDetails.Builder addAllTrackingUrls(Iterable<? extends VideoTrackingUrl> values)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.ads.admanager.v1.VideoTrackingUrl> |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
addCompanionCreatives(String value)
public ImageOverlayCreativeDetails.Builder addCompanionCreatives(String value)Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe companionCreatives to add. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
addCompanionCreativesBytes(ByteString value)
public ImageOverlayCreativeDetails.Builder addCompanionCreativesBytes(ByteString value)Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the companionCreatives to add. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
addExpectedCompanions(CreativePlaceholder value)
public ImageOverlayCreativeDetails.Builder addExpectedCompanions(CreativePlaceholder value) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativePlaceholder |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
addExpectedCompanions(CreativePlaceholder.Builder builderForValue)
public ImageOverlayCreativeDetails.Builder addExpectedCompanions(CreativePlaceholder.Builder builderForValue) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CreativePlaceholder.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
addExpectedCompanions(int index, CreativePlaceholder value)
public ImageOverlayCreativeDetails.Builder addExpectedCompanions(int index, CreativePlaceholder value) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CreativePlaceholder |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
addExpectedCompanions(int index, CreativePlaceholder.Builder builderForValue)
public ImageOverlayCreativeDetails.Builder addExpectedCompanions(int index, CreativePlaceholder.Builder builderForValue) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CreativePlaceholder.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
addExpectedCompanionsBuilder()
public CreativePlaceholder.Builder addExpectedCompanionsBuilder() Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CreativePlaceholder.Builder |
|
addExpectedCompanionsBuilder(int index)
public CreativePlaceholder.Builder addExpectedCompanionsBuilder(int index) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CreativePlaceholder.Builder |
|
addTrackingUrls(VideoTrackingUrl value)
public ImageOverlayCreativeDetails.Builder addTrackingUrls(VideoTrackingUrl value)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
addTrackingUrls(VideoTrackingUrl.Builder builderForValue)
public ImageOverlayCreativeDetails.Builder addTrackingUrls(VideoTrackingUrl.Builder builderForValue)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
addTrackingUrls(int index, VideoTrackingUrl value)
public ImageOverlayCreativeDetails.Builder addTrackingUrls(int index, VideoTrackingUrl value)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
addTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue)
public ImageOverlayCreativeDetails.Builder addTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
addTrackingUrlsBuilder()
public VideoTrackingUrl.Builder addTrackingUrlsBuilder()Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
VideoTrackingUrl.Builder |
|
addTrackingUrlsBuilder(int index)
public VideoTrackingUrl.Builder addTrackingUrlsBuilder(int index)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
VideoTrackingUrl.Builder |
|
build()
public ImageOverlayCreativeDetails build()| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails |
|
buildPartial()
public ImageOverlayCreativeDetails buildPartial()| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails |
|
clear()
public ImageOverlayCreativeDetails.Builder clear()| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
clearCompanionCreatives()
public ImageOverlayCreativeDetails.Builder clearCompanionCreatives()Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
clearCreativeSet()
public ImageOverlayCreativeDetails.Builder clearCreativeSet()Output only. The resource name of the creative set. Format: "networks/{network_code}/creativeSets/{creative_set_id}"
optional string creative_set = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
clearCreativeSetDisplayName()
public ImageOverlayCreativeDetails.Builder clearCreativeSetDisplayName()Output only. The display name of the creative set.
optional string creative_set_display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
clearCustomParameters()
public ImageOverlayCreativeDetails.Builder clearCustomParameters() Optional. A comma separated key=value list of parameters that will be
supplied to the creative, written into the VAST AdParameters node.
optional string custom_parameters = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
clearDestinationUrl()
public ImageOverlayCreativeDetails.Builder clearDestinationUrl() Optional. The URL that the user is directed to if they click on the
creative. This attribute is required unless the destinationUrlType is
NONE, and has a maximum length of 1024 characters.
optional string destination_url = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
clearDestinationUrlType()
public ImageOverlayCreativeDetails.Builder clearDestinationUrlType() Optional. The action that should be performed if the user clicks on the
creative. This attribute defaults to CLICK_TO_WEB.
optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
clearDuration()
public ImageOverlayCreativeDetails.Builder clearDuration()Optional. Minimum suggested duration.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
clearExpectedCompanionDeliveryOption()
public ImageOverlayCreativeDetails.Builder clearExpectedCompanionDeliveryOption()Output only. The companion delivery option this set will be served with.
optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption expected_companion_delivery_option = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
clearExpectedCompanions()
public ImageOverlayCreativeDetails.Builder clearExpectedCompanions() Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
clearLockedOrientation()
public ImageOverlayCreativeDetails.Builder clearLockedOrientation()Optional. A locked orientation for this creative to be displayed in.
optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
clearOverrideSize()
public ImageOverlayCreativeDetails.Builder clearOverrideSize()Optional. Allows the creative size to differ from the actual image asset size.
optional bool override_size = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
clearPrimaryImageAsset()
public ImageOverlayCreativeDetails.Builder clearPrimaryImageAsset()Required. The primary image asset associated with this creative.
.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
clearTrackingUrls()
public ImageOverlayCreativeDetails.Builder clearTrackingUrls()Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
clearVastPreviewUrl()
public ImageOverlayCreativeDetails.Builder clearVastPreviewUrl()Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.
optional string vast_preview_url = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
getCompanionCreatives(int index)
public String getCompanionCreatives(int index)Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The companionCreatives at the given index. |
getCompanionCreativesBytes(int index)
public ByteString getCompanionCreativesBytes(int index)Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the companionCreatives at the given index. |
getCompanionCreativesCount()
public int getCompanionCreativesCount()Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of companionCreatives. |
getCompanionCreativesList()
public ProtocolStringList getCompanionCreativesList()Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the companionCreatives. |
getCreativeSet()
public String getCreativeSet()Output only. The resource name of the creative set. Format: "networks/{network_code}/creativeSets/{creative_set_id}"
optional string creative_set = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The creativeSet. |
getCreativeSetBytes()
public ByteString getCreativeSetBytes()Output only. The resource name of the creative set. Format: "networks/{network_code}/creativeSets/{creative_set_id}"
optional string creative_set = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for creativeSet. |
getCreativeSetDisplayName()
public String getCreativeSetDisplayName()Output only. The display name of the creative set.
optional string creative_set_display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The creativeSetDisplayName. |
getCreativeSetDisplayNameBytes()
public ByteString getCreativeSetDisplayNameBytes()Output only. The display name of the creative set.
optional string creative_set_display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for creativeSetDisplayName. |
getCustomParameters()
public String getCustomParameters() Optional. A comma separated key=value list of parameters that will be
supplied to the creative, written into the VAST AdParameters node.
optional string custom_parameters = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The customParameters. |
getCustomParametersBytes()
public ByteString getCustomParametersBytes() Optional. A comma separated key=value list of parameters that will be
supplied to the creative, written into the VAST AdParameters node.
optional string custom_parameters = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for customParameters. |
getDefaultInstanceForType()
public ImageOverlayCreativeDetails getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDestinationUrl()
public String getDestinationUrl() Optional. The URL that the user is directed to if they click on the
creative. This attribute is required unless the destinationUrlType is
NONE, and has a maximum length of 1024 characters.
optional string destination_url = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The destinationUrl. |
getDestinationUrlBytes()
public ByteString getDestinationUrlBytes() Optional. The URL that the user is directed to if they click on the
creative. This attribute is required unless the destinationUrlType is
NONE, and has a maximum length of 1024 characters.
optional string destination_url = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for destinationUrl. |
getDestinationUrlType()
public CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType getDestinationUrlType() Optional. The action that should be performed if the user clicks on the
creative. This attribute defaults to CLICK_TO_WEB.
optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType |
The destinationUrlType. |
getDestinationUrlTypeValue()
public int getDestinationUrlTypeValue() Optional. The action that should be performed if the user clicks on the
creative. This attribute defaults to CLICK_TO_WEB.
optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for destinationUrlType. |
getDuration()
public Duration getDuration()Optional. Minimum suggested duration.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration |
The duration. |
getDurationBuilder()
public Duration.Builder getDurationBuilder()Optional. Minimum suggested duration.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getDurationOrBuilder()
public DurationOrBuilder getDurationOrBuilder()Optional. Minimum suggested duration.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getExpectedCompanionDeliveryOption()
public CompanionDeliveryOptionEnum.CompanionDeliveryOption getExpectedCompanionDeliveryOption()Output only. The companion delivery option this set will be served with.
optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption expected_companion_delivery_option = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CompanionDeliveryOptionEnum.CompanionDeliveryOption |
The expectedCompanionDeliveryOption. |
getExpectedCompanionDeliveryOptionValue()
public int getExpectedCompanionDeliveryOptionValue()Output only. The companion delivery option this set will be served with.
optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption expected_companion_delivery_option = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for expectedCompanionDeliveryOption. |
getExpectedCompanions(int index)
public CreativePlaceholder getExpectedCompanions(int index) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CreativePlaceholder |
|
getExpectedCompanionsBuilder(int index)
public CreativePlaceholder.Builder getExpectedCompanionsBuilder(int index) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CreativePlaceholder.Builder |
|
getExpectedCompanionsBuilderList()
public List<CreativePlaceholder.Builder> getExpectedCompanionsBuilderList() Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getExpectedCompanionsCount()
public int getExpectedCompanionsCount() Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getExpectedCompanionsList()
public List<CreativePlaceholder> getExpectedCompanionsList() Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<CreativePlaceholder> |
|
getExpectedCompanionsOrBuilder(int index)
public CreativePlaceholderOrBuilder getExpectedCompanionsOrBuilder(int index) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CreativePlaceholderOrBuilder |
|
getExpectedCompanionsOrBuilderList()
public List<? extends CreativePlaceholderOrBuilder> getExpectedCompanionsOrBuilderList() Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.CreativePlaceholderOrBuilder> |
|
getLockedOrientation()
public CreativeLockedOrientationEnum.CreativeLockedOrientation getLockedOrientation()Optional. A locked orientation for this creative to be displayed in.
optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CreativeLockedOrientationEnum.CreativeLockedOrientation |
The lockedOrientation. |
getLockedOrientationValue()
public int getLockedOrientationValue()Optional. A locked orientation for this creative to be displayed in.
optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for lockedOrientation. |
getOverrideSize()
public boolean getOverrideSize()Optional. Allows the creative size to differ from the actual image asset size.
optional bool override_size = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The overrideSize. |
getPrimaryImageAsset()
public CreativeAsset getPrimaryImageAsset()Required. The primary image asset associated with this creative.
.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CreativeAsset |
The primaryImageAsset. |
getPrimaryImageAssetBuilder()
public CreativeAsset.Builder getPrimaryImageAssetBuilder()Required. The primary image asset associated with this creative.
.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CreativeAsset.Builder |
|
getPrimaryImageAssetOrBuilder()
public CreativeAssetOrBuilder getPrimaryImageAssetOrBuilder()Required. The primary image asset associated with this creative.
.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CreativeAssetOrBuilder |
|
getTrackingUrls(int index)
public VideoTrackingUrl getTrackingUrls(int index)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
VideoTrackingUrl |
|
getTrackingUrlsBuilder(int index)
public VideoTrackingUrl.Builder getTrackingUrlsBuilder(int index)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
VideoTrackingUrl.Builder |
|
getTrackingUrlsBuilderList()
public List<VideoTrackingUrl.Builder> getTrackingUrlsBuilderList()Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getTrackingUrlsCount()
public int getTrackingUrlsCount()Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getTrackingUrlsList()
public List<VideoTrackingUrl> getTrackingUrlsList()Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<VideoTrackingUrl> |
|
getTrackingUrlsOrBuilder(int index)
public VideoTrackingUrlOrBuilder getTrackingUrlsOrBuilder(int index)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
VideoTrackingUrlOrBuilder |
|
getTrackingUrlsOrBuilderList()
public List<? extends VideoTrackingUrlOrBuilder> getTrackingUrlsOrBuilderList()Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.VideoTrackingUrlOrBuilder> |
|
getVastPreviewUrl()
public String getVastPreviewUrl()Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.
optional string vast_preview_url = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The vastPreviewUrl. |
getVastPreviewUrlBytes()
public ByteString getVastPreviewUrlBytes()Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.
optional string vast_preview_url = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for vastPreviewUrl. |
hasCreativeSet()
public boolean hasCreativeSet()Output only. The resource name of the creative set. Format: "networks/{network_code}/creativeSets/{creative_set_id}"
optional string creative_set = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the creativeSet field is set. |
hasCreativeSetDisplayName()
public boolean hasCreativeSetDisplayName()Output only. The display name of the creative set.
optional string creative_set_display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the creativeSetDisplayName field is set. |
hasCustomParameters()
public boolean hasCustomParameters() Optional. A comma separated key=value list of parameters that will be
supplied to the creative, written into the VAST AdParameters node.
optional string custom_parameters = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customParameters field is set. |
hasDestinationUrl()
public boolean hasDestinationUrl() Optional. The URL that the user is directed to if they click on the
creative. This attribute is required unless the destinationUrlType is
NONE, and has a maximum length of 1024 characters.
optional string destination_url = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the destinationUrl field is set. |
hasDestinationUrlType()
public boolean hasDestinationUrlType() Optional. The action that should be performed if the user clicks on the
creative. This attribute defaults to CLICK_TO_WEB.
optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the destinationUrlType field is set. |
hasDuration()
public boolean hasDuration()Optional. Minimum suggested duration.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the duration field is set. |
hasExpectedCompanionDeliveryOption()
public boolean hasExpectedCompanionDeliveryOption()Output only. The companion delivery option this set will be served with.
optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption expected_companion_delivery_option = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the expectedCompanionDeliveryOption field is set. |
hasLockedOrientation()
public boolean hasLockedOrientation()Optional. A locked orientation for this creative to be displayed in.
optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the lockedOrientation field is set. |
hasOverrideSize()
public boolean hasOverrideSize()Optional. Allows the creative size to differ from the actual image asset size.
optional bool override_size = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the overrideSize field is set. |
hasPrimaryImageAsset()
public boolean hasPrimaryImageAsset()Required. The primary image asset associated with this creative.
.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the primaryImageAsset field is set. |
hasVastPreviewUrl()
public boolean hasVastPreviewUrl()Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.
optional string vast_preview_url = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the vastPreviewUrl field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeDuration(Duration value)
public ImageOverlayCreativeDetails.Builder mergeDuration(Duration value)Optional. Minimum suggested duration.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
mergeFrom(ImageOverlayCreativeDetails other)
public ImageOverlayCreativeDetails.Builder mergeFrom(ImageOverlayCreativeDetails other)| Parameter | |
|---|---|
| Name | Description |
other |
ImageOverlayCreativeDetails |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ImageOverlayCreativeDetails.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ImageOverlayCreativeDetails.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
mergePrimaryImageAsset(CreativeAsset value)
public ImageOverlayCreativeDetails.Builder mergePrimaryImageAsset(CreativeAsset value)Required. The primary image asset associated with this creative.
.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeAsset |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
removeExpectedCompanions(int index)
public ImageOverlayCreativeDetails.Builder removeExpectedCompanions(int index) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
removeTrackingUrls(int index)
public ImageOverlayCreativeDetails.Builder removeTrackingUrls(int index)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
setCompanionCreatives(int index, String value)
public ImageOverlayCreativeDetails.Builder setCompanionCreatives(int index, String value)Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe companionCreatives to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setCreativeSet(String value)
public ImageOverlayCreativeDetails.Builder setCreativeSet(String value)Output only. The resource name of the creative set. Format: "networks/{network_code}/creativeSets/{creative_set_id}"
optional string creative_set = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe creativeSet to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setCreativeSetBytes(ByteString value)
public ImageOverlayCreativeDetails.Builder setCreativeSetBytes(ByteString value)Output only. The resource name of the creative set. Format: "networks/{network_code}/creativeSets/{creative_set_id}"
optional string creative_set = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for creativeSet to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setCreativeSetDisplayName(String value)
public ImageOverlayCreativeDetails.Builder setCreativeSetDisplayName(String value)Output only. The display name of the creative set.
optional string creative_set_display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe creativeSetDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setCreativeSetDisplayNameBytes(ByteString value)
public ImageOverlayCreativeDetails.Builder setCreativeSetDisplayNameBytes(ByteString value)Output only. The display name of the creative set.
optional string creative_set_display_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for creativeSetDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setCustomParameters(String value)
public ImageOverlayCreativeDetails.Builder setCustomParameters(String value) Optional. A comma separated key=value list of parameters that will be
supplied to the creative, written into the VAST AdParameters node.
optional string custom_parameters = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customParameters to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setCustomParametersBytes(ByteString value)
public ImageOverlayCreativeDetails.Builder setCustomParametersBytes(ByteString value) Optional. A comma separated key=value list of parameters that will be
supplied to the creative, written into the VAST AdParameters node.
optional string custom_parameters = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for customParameters to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setDestinationUrl(String value)
public ImageOverlayCreativeDetails.Builder setDestinationUrl(String value) Optional. The URL that the user is directed to if they click on the
creative. This attribute is required unless the destinationUrlType is
NONE, and has a maximum length of 1024 characters.
optional string destination_url = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe destinationUrl to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setDestinationUrlBytes(ByteString value)
public ImageOverlayCreativeDetails.Builder setDestinationUrlBytes(ByteString value) Optional. The URL that the user is directed to if they click on the
creative. This attribute is required unless the destinationUrlType is
NONE, and has a maximum length of 1024 characters.
optional string destination_url = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for destinationUrl to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setDestinationUrlType(CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType value)
public ImageOverlayCreativeDetails.Builder setDestinationUrlType(CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType value) Optional. The action that should be performed if the user clicks on the
creative. This attribute defaults to CLICK_TO_WEB.
optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeDestinationUrlTypeEnum.CreativeDestinationUrlTypeThe destinationUrlType to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setDestinationUrlTypeValue(int value)
public ImageOverlayCreativeDetails.Builder setDestinationUrlTypeValue(int value) Optional. The action that should be performed if the user clicks on the
creative. This attribute defaults to CLICK_TO_WEB.
optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for destinationUrlType to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setDuration(Duration value)
public ImageOverlayCreativeDetails.Builder setDuration(Duration value)Optional. Minimum suggested duration.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
setDuration(Duration.Builder builderForValue)
public ImageOverlayCreativeDetails.Builder setDuration(Duration.Builder builderForValue)Optional. Minimum suggested duration.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
setExpectedCompanionDeliveryOption(CompanionDeliveryOptionEnum.CompanionDeliveryOption value)
public ImageOverlayCreativeDetails.Builder setExpectedCompanionDeliveryOption(CompanionDeliveryOptionEnum.CompanionDeliveryOption value)Output only. The companion delivery option this set will be served with.
optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption expected_companion_delivery_option = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
CompanionDeliveryOptionEnum.CompanionDeliveryOptionThe expectedCompanionDeliveryOption to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setExpectedCompanionDeliveryOptionValue(int value)
public ImageOverlayCreativeDetails.Builder setExpectedCompanionDeliveryOptionValue(int value)Output only. The companion delivery option this set will be served with.
optional .google.ads.admanager.v1.CompanionDeliveryOptionEnum.CompanionDeliveryOption expected_companion_delivery_option = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for expectedCompanionDeliveryOption to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setExpectedCompanions(int index, CreativePlaceholder value)
public ImageOverlayCreativeDetails.Builder setExpectedCompanions(int index, CreativePlaceholder value) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CreativePlaceholder |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
setExpectedCompanions(int index, CreativePlaceholder.Builder builderForValue)
public ImageOverlayCreativeDetails.Builder setExpectedCompanions(int index, CreativePlaceholder.Builder builderForValue) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CreativePlaceholder.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
setLockedOrientation(CreativeLockedOrientationEnum.CreativeLockedOrientation value)
public ImageOverlayCreativeDetails.Builder setLockedOrientation(CreativeLockedOrientationEnum.CreativeLockedOrientation value)Optional. A locked orientation for this creative to be displayed in.
optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeLockedOrientationEnum.CreativeLockedOrientationThe lockedOrientation to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setLockedOrientationValue(int value)
public ImageOverlayCreativeDetails.Builder setLockedOrientationValue(int value)Optional. A locked orientation for this creative to be displayed in.
optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for lockedOrientation to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setOverrideSize(boolean value)
public ImageOverlayCreativeDetails.Builder setOverrideSize(boolean value)Optional. Allows the creative size to differ from the actual image asset size.
optional bool override_size = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe overrideSize to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setPrimaryImageAsset(CreativeAsset value)
public ImageOverlayCreativeDetails.Builder setPrimaryImageAsset(CreativeAsset value)Required. The primary image asset associated with this creative.
.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeAsset |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
setPrimaryImageAsset(CreativeAsset.Builder builderForValue)
public ImageOverlayCreativeDetails.Builder setPrimaryImageAsset(CreativeAsset.Builder builderForValue)Required. The primary image asset associated with this creative.
.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CreativeAsset.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
setTrackingUrls(int index, VideoTrackingUrl value)
public ImageOverlayCreativeDetails.Builder setTrackingUrls(int index, VideoTrackingUrl value)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
setTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue)
public ImageOverlayCreativeDetails.Builder setTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
|
setVastPreviewUrl(String value)
public ImageOverlayCreativeDetails.Builder setVastPreviewUrl(String value)Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.
optional string vast_preview_url = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe vastPreviewUrl to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |
setVastPreviewUrlBytes(ByteString value)
public ImageOverlayCreativeDetails.Builder setVastPreviewUrlBytes(ByteString value)Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.
optional string vast_preview_url = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for vastPreviewUrl to set. |
| Returns | |
|---|---|
| Type | Description |
ImageOverlayCreativeDetails.Builder |
This builder for chaining. |