public interface ImageOverlayCreativeDetailsOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCompanionCreatives(int index)
public abstract 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 abstract 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 abstract 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 abstract List<String> 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 |
List<String> |
A list containing the companionCreatives. |
getCreativeSet()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getDestinationUrl()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract Duration getDuration()Optional. Minimum suggested duration.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration |
The duration. |
getDurationOrBuilder()
public abstract DurationOrBuilder getDurationOrBuilder()Optional. Minimum suggested duration.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getExpectedCompanionDeliveryOption()
public abstract 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 abstract 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 abstract 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 |
|
getExpectedCompanionsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getPrimaryImageAssetOrBuilder()
public abstract 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 abstract 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 |
|
getTrackingUrlsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |