public static final class ImageRedirectOverlayCreativeDetails.Builder extends GeneratedMessage.Builder<ImageRedirectOverlayCreativeDetails.Builder> implements ImageRedirectOverlayCreativeDetailsOrBuilderAn overlay Creative that loads an image asset from a specified URL and is served via VAST XML. Overlays cover part of the video content they are displayed on top of. This creative is read only.
Protobuf type google.ads.admanager.v1.ImageRedirectOverlayCreativeDetails
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ImageRedirectOverlayCreativeDetails.BuilderImplements
ImageRedirectOverlayCreativeDetailsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllCompanionCreatives(Iterable<String> values)
public ImageRedirectOverlayCreativeDetails.Builder addAllCompanionCreatives(Iterable<String> values)Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The companionCreatives to add. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
addAllExpectedCompanions(Iterable<? extends CreativePlaceholder> values)
public ImageRedirectOverlayCreativeDetails.Builder addAllExpectedCompanions(Iterable<? extends CreativePlaceholder> values) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.ads.admanager.v1.CreativePlaceholder> |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
addAllTrackingUrls(Iterable<? extends VideoTrackingUrl> values)
public ImageRedirectOverlayCreativeDetails.Builder addAllTrackingUrls(Iterable<? extends VideoTrackingUrl> values)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.ads.admanager.v1.VideoTrackingUrl> |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
addCompanionCreatives(String value)
public ImageRedirectOverlayCreativeDetails.Builder addCompanionCreatives(String value)Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe companionCreatives to add. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
addCompanionCreativesBytes(ByteString value)
public ImageRedirectOverlayCreativeDetails.Builder addCompanionCreativesBytes(ByteString value)Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the companionCreatives to add. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
addExpectedCompanions(CreativePlaceholder value)
public ImageRedirectOverlayCreativeDetails.Builder addExpectedCompanions(CreativePlaceholder value) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativePlaceholder |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
addExpectedCompanions(CreativePlaceholder.Builder builderForValue)
public ImageRedirectOverlayCreativeDetails.Builder addExpectedCompanions(CreativePlaceholder.Builder builderForValue) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CreativePlaceholder.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
addExpectedCompanions(int index, CreativePlaceholder value)
public ImageRedirectOverlayCreativeDetails.Builder addExpectedCompanions(int index, CreativePlaceholder value) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CreativePlaceholder |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
addExpectedCompanions(int index, CreativePlaceholder.Builder builderForValue)
public ImageRedirectOverlayCreativeDetails.Builder addExpectedCompanions(int index, CreativePlaceholder.Builder builderForValue) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CreativePlaceholder.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
addExpectedCompanionsBuilder()
public CreativePlaceholder.Builder addExpectedCompanionsBuilder() Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 11 [(.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 = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CreativePlaceholder.Builder |
|
addTrackingUrls(VideoTrackingUrl value)
public ImageRedirectOverlayCreativeDetails.Builder addTrackingUrls(VideoTrackingUrl value)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
addTrackingUrls(VideoTrackingUrl.Builder builderForValue)
public ImageRedirectOverlayCreativeDetails.Builder addTrackingUrls(VideoTrackingUrl.Builder builderForValue)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
addTrackingUrls(int index, VideoTrackingUrl value)
public ImageRedirectOverlayCreativeDetails.Builder addTrackingUrls(int index, VideoTrackingUrl value)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
addTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue)
public ImageRedirectOverlayCreativeDetails.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 = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
addTrackingUrlsBuilder()
public VideoTrackingUrl.Builder addTrackingUrlsBuilder()Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 9 [(.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 = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
VideoTrackingUrl.Builder |
|
build()
public ImageRedirectOverlayCreativeDetails build()| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails |
|
buildPartial()
public ImageRedirectOverlayCreativeDetails buildPartial()| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails |
|
clear()
public ImageRedirectOverlayCreativeDetails.Builder clear()| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
clearAssetSize()
public ImageRedirectOverlayCreativeDetails.Builder clearAssetSize()Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.
optional .google.ads.admanager.v1.Size asset_size = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
clearCompanionCreatives()
public ImageRedirectOverlayCreativeDetails.Builder clearCompanionCreatives()Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
clearCreativeSet()
public ImageRedirectOverlayCreativeDetails.Builder clearCreativeSet()Output only. The resource name of the creative set. Format: "networks/{network_code}/creativeSets/{creative_set_id}"
optional string creative_set = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
clearCreativeSetDisplayName()
public ImageRedirectOverlayCreativeDetails.Builder clearCreativeSetDisplayName()Output only. The display name of the creative set.
optional string creative_set_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
clearCustomParameters()
public ImageRedirectOverlayCreativeDetails.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 = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
clearDestinationUrl()
public ImageRedirectOverlayCreativeDetails.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 = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
clearDestinationUrlType()
public ImageRedirectOverlayCreativeDetails.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 = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
clearDuration()
public ImageRedirectOverlayCreativeDetails.Builder clearDuration()Optional. Minimum suggested duration.
optional .google.protobuf.Duration duration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
clearExpectedCompanionDeliveryOption()
public ImageRedirectOverlayCreativeDetails.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 = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
clearExpectedCompanions()
public ImageRedirectOverlayCreativeDetails.Builder clearExpectedCompanions() Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
clearImageUrl()
public ImageRedirectOverlayCreativeDetails.Builder clearImageUrl()Required. The URL where the actual image asset resides. This attribute is required and has a maximum length of 1024 characters.
optional string image_url = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
clearTrackingUrls()
public ImageRedirectOverlayCreativeDetails.Builder clearTrackingUrls()Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
clearVastPreviewUrl()
public ImageRedirectOverlayCreativeDetails.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 = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
getAssetSize()
public Size getAssetSize()Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.
optional .google.ads.admanager.v1.Size asset_size = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Size |
The assetSize. |
getAssetSizeBuilder()
public Size.Builder getAssetSizeBuilder()Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.
optional .google.ads.admanager.v1.Size asset_size = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Size.Builder |
|
getAssetSizeOrBuilder()
public SizeOrBuilder getAssetSizeOrBuilder()Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.
optional .google.ads.admanager.v1.Size asset_size = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SizeOrBuilder |
|
getCompanionCreatives(int index)
public String getCompanionCreatives(int index)Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 6 [(.google.api.field_behavior) = OPTIONAL, (.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)Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 6 [(.google.api.field_behavior) = OPTIONAL, (.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()Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of companionCreatives. |
getCompanionCreativesList()
public ProtocolStringList getCompanionCreativesList()Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 6 [(.google.api.field_behavior) = OPTIONAL, (.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 = 5 [(.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 = 5 [(.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 = 4 [(.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 = 4 [(.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 = 10 [(.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 = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for customParameters. |
getDefaultInstanceForType()
public ImageRedirectOverlayCreativeDetails getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails |
|
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 = 2 [(.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 = 2 [(.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 = 3 [(.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 = 3 [(.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.
optional .google.protobuf.Duration duration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration |
The duration. |
getDurationBuilder()
public Duration.Builder getDurationBuilder()Optional. Minimum suggested duration.
optional .google.protobuf.Duration duration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getDurationOrBuilder()
public DurationOrBuilder getDurationOrBuilder()Optional. Minimum suggested duration.
optional .google.protobuf.Duration duration = 8 [(.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 = 12 [(.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 = 12 [(.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 = 11 [(.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 = 11 [(.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 = 11 [(.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 = 11 [(.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 = 11 [(.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 = 11 [(.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 = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.CreativePlaceholderOrBuilder> |
|
getImageUrl()
public String getImageUrl()Required. The URL where the actual image asset resides. This attribute is required and has a maximum length of 1024 characters.
optional string image_url = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The imageUrl. |
getImageUrlBytes()
public ByteString getImageUrlBytes()Required. The URL where the actual image asset resides. This attribute is required and has a maximum length of 1024 characters.
optional string image_url = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for imageUrl. |
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 = 9 [(.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 = 9 [(.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 = 9 [(.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 = 9 [(.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 = 9 [(.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 = 9 [(.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 = 9 [(.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 = 14 [(.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 = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for vastPreviewUrl. |
hasAssetSize()
public boolean hasAssetSize()Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.
optional .google.ads.admanager.v1.Size asset_size = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the assetSize field is set. |
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 = 5 [(.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 = 4 [(.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 = 10 [(.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 = 2 [(.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 = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the destinationUrlType field is set. |
hasDuration()
public boolean hasDuration()Optional. Minimum suggested duration.
optional .google.protobuf.Duration duration = 8 [(.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 = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the expectedCompanionDeliveryOption field is set. |
hasImageUrl()
public boolean hasImageUrl()Required. The URL where the actual image asset resides. This attribute is required and has a maximum length of 1024 characters.
optional string image_url = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the imageUrl 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 = 14 [(.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 |
|
mergeAssetSize(Size value)
public ImageRedirectOverlayCreativeDetails.Builder mergeAssetSize(Size value)Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.
optional .google.ads.admanager.v1.Size asset_size = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Size |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
mergeDuration(Duration value)
public ImageRedirectOverlayCreativeDetails.Builder mergeDuration(Duration value)Optional. Minimum suggested duration.
optional .google.protobuf.Duration duration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
mergeFrom(ImageRedirectOverlayCreativeDetails other)
public ImageRedirectOverlayCreativeDetails.Builder mergeFrom(ImageRedirectOverlayCreativeDetails other)| Parameter | |
|---|---|
| Name | Description |
other |
ImageRedirectOverlayCreativeDetails |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ImageRedirectOverlayCreativeDetails.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ImageRedirectOverlayCreativeDetails.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
removeExpectedCompanions(int index)
public ImageRedirectOverlayCreativeDetails.Builder removeExpectedCompanions(int index) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
removeTrackingUrls(int index)
public ImageRedirectOverlayCreativeDetails.Builder removeTrackingUrls(int index)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
setAssetSize(Size value)
public ImageRedirectOverlayCreativeDetails.Builder setAssetSize(Size value)Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.
optional .google.ads.admanager.v1.Size asset_size = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Size |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
setAssetSize(Size.Builder builderForValue)
public ImageRedirectOverlayCreativeDetails.Builder setAssetSize(Size.Builder builderForValue)Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.
optional .google.ads.admanager.v1.Size asset_size = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Size.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
setCompanionCreatives(int index, String value)
public ImageRedirectOverlayCreativeDetails.Builder setCompanionCreatives(int index, String value)Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe companionCreatives to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setCreativeSet(String value)
public ImageRedirectOverlayCreativeDetails.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 = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe creativeSet to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setCreativeSetBytes(ByteString value)
public ImageRedirectOverlayCreativeDetails.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 = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for creativeSet to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setCreativeSetDisplayName(String value)
public ImageRedirectOverlayCreativeDetails.Builder setCreativeSetDisplayName(String value)Output only. The display name of the creative set.
optional string creative_set_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe creativeSetDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setCreativeSetDisplayNameBytes(ByteString value)
public ImageRedirectOverlayCreativeDetails.Builder setCreativeSetDisplayNameBytes(ByteString value)Output only. The display name of the creative set.
optional string creative_set_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for creativeSetDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setCustomParameters(String value)
public ImageRedirectOverlayCreativeDetails.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 = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customParameters to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setCustomParametersBytes(ByteString value)
public ImageRedirectOverlayCreativeDetails.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 = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for customParameters to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setDestinationUrl(String value)
public ImageRedirectOverlayCreativeDetails.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 = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe destinationUrl to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setDestinationUrlBytes(ByteString value)
public ImageRedirectOverlayCreativeDetails.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 = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for destinationUrl to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setDestinationUrlType(CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType value)
public ImageRedirectOverlayCreativeDetails.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 = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeDestinationUrlTypeEnum.CreativeDestinationUrlTypeThe destinationUrlType to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setDestinationUrlTypeValue(int value)
public ImageRedirectOverlayCreativeDetails.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 = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for destinationUrlType to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setDuration(Duration value)
public ImageRedirectOverlayCreativeDetails.Builder setDuration(Duration value)Optional. Minimum suggested duration.
optional .google.protobuf.Duration duration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
setDuration(Duration.Builder builderForValue)
public ImageRedirectOverlayCreativeDetails.Builder setDuration(Duration.Builder builderForValue)Optional. Minimum suggested duration.
optional .google.protobuf.Duration duration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
setExpectedCompanionDeliveryOption(CompanionDeliveryOptionEnum.CompanionDeliveryOption value)
public ImageRedirectOverlayCreativeDetails.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 = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
CompanionDeliveryOptionEnum.CompanionDeliveryOptionThe expectedCompanionDeliveryOption to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setExpectedCompanionDeliveryOptionValue(int value)
public ImageRedirectOverlayCreativeDetails.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 = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for expectedCompanionDeliveryOption to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setExpectedCompanions(int index, CreativePlaceholder value)
public ImageRedirectOverlayCreativeDetails.Builder setExpectedCompanions(int index, CreativePlaceholder value) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CreativePlaceholder |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
setExpectedCompanions(int index, CreativePlaceholder.Builder builderForValue)
public ImageRedirectOverlayCreativeDetails.Builder setExpectedCompanions(int index, CreativePlaceholder.Builder builderForValue) Optional. CreativePlaceholder objects a creative set should fulfill.
repeated .google.ads.admanager.v1.CreativePlaceholder expected_companions = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CreativePlaceholder.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
setImageUrl(String value)
public ImageRedirectOverlayCreativeDetails.Builder setImageUrl(String value)Required. The URL where the actual image asset resides. This attribute is required and has a maximum length of 1024 characters.
optional string image_url = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe imageUrl to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setImageUrlBytes(ByteString value)
public ImageRedirectOverlayCreativeDetails.Builder setImageUrlBytes(ByteString value)Required. The URL where the actual image asset resides. This attribute is required and has a maximum length of 1024 characters.
optional string image_url = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for imageUrl to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setTrackingUrls(int index, VideoTrackingUrl value)
public ImageRedirectOverlayCreativeDetails.Builder setTrackingUrls(int index, VideoTrackingUrl value)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
setTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue)
public ImageRedirectOverlayCreativeDetails.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 = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
|
setVastPreviewUrl(String value)
public ImageRedirectOverlayCreativeDetails.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 = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe vastPreviewUrl to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |
setVastPreviewUrlBytes(ByteString value)
public ImageRedirectOverlayCreativeDetails.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 = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for vastPreviewUrl to set. |
| Returns | |
|---|---|
| Type | Description |
ImageRedirectOverlayCreativeDetails.Builder |
This builder for chaining. |