public interface VastInfoOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAdId()
public abstract String getAdId() Optional. The ad id associated with the video as defined by the adIdType
registry. This field is required if adIdType is not NONE.
optional string ad_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The adId. |
getAdIdBytes()
public abstract ByteString getAdIdBytes() Optional. The ad id associated with the video as defined by the adIdType
registry. This field is required if adIdType is not NONE.
optional string ad_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for adId. |
getAdIdType()
public abstract VastAdIdTypeEnum.VastAdIdType getAdIdType() Optional. The registry which the ad id of this creative belongs to. This
field defaults to NONE.
optional .google.ads.admanager.v1.VastAdIdTypeEnum.VastAdIdType ad_id_type = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
VastAdIdTypeEnum.VastAdIdType |
The adIdType. |
getAdIdTypeValue()
public abstract int getAdIdTypeValue() Optional. The registry which the ad id of this creative belongs to. This
field defaults to NONE.
optional .google.ads.admanager.v1.VastAdIdTypeEnum.VastAdIdType ad_id_type = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for adIdType. |
getAllowDurationOverride()
public abstract boolean getAllowDurationOverride()Optional. Allows the creative duration to differ from the actual asset durations.
optional bool allow_duration_override = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The allowDurationOverride. |
getCompanionCreatives(int index)
public abstract 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 = 18 [(.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 abstract 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 = 18 [(.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 abstract int getCompanionCreativesCount()Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of companionCreatives. |
getCompanionCreativesList()
public abstract List<String> getCompanionCreativesList()Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
repeated string companion_creatives = 18 [(.google.api.field_behavior) = OPTIONAL, (.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 = 15 [(.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 = 15 [(.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 = 14 [(.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 = 14 [(.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 = 4 [(.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 = 4 [(.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 = 16 [(.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 = 16 [(.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 = 17 [(.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 = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for destinationUrlType. |
getDuration()
public abstract Duration getDuration()Optional. The expected duration of this creative.
.google.protobuf.Duration duration = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration |
The duration. |
getDurationOrBuilder()
public abstract DurationOrBuilder getDurationOrBuilder()Optional. The expected duration of this creative.
.google.protobuf.Duration duration = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getSkippableAdType()
public abstract SkippableAdTypeEnum.SkippableAdType getSkippableAdType()Optional. The type of skippable ad.
optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SkippableAdTypeEnum.SkippableAdType |
The skippableAdType. |
getSkippableAdTypeValue()
public abstract int getSkippableAdTypeValue()Optional. The type of skippable ad.
optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for skippableAdType. |
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 = 3 [(.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 = 3 [(.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 = 3 [(.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 = 3 [(.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 = 3 [(.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 = 8 [(.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 = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for vastPreviewUrl. |
hasAdId()
public abstract boolean hasAdId() Optional. The ad id associated with the video as defined by the adIdType
registry. This field is required if adIdType is not NONE.
optional string ad_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the adId field is set. |
hasAdIdType()
public abstract boolean hasAdIdType() Optional. The registry which the ad id of this creative belongs to. This
field defaults to NONE.
optional .google.ads.admanager.v1.VastAdIdTypeEnum.VastAdIdType ad_id_type = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the adIdType field is set. |
hasAllowDurationOverride()
public abstract boolean hasAllowDurationOverride()Optional. Allows the creative duration to differ from the actual asset durations.
optional bool allow_duration_override = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the allowDurationOverride field is set. |
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 = 15 [(.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 = 14 [(.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 = 4 [(.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 = 16 [(.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 = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the destinationUrlType field is set. |
hasDuration()
public abstract boolean hasDuration()Optional. The expected duration of this creative.
.google.protobuf.Duration duration = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the duration field is set. |
hasSkippableAdType()
public abstract boolean hasSkippableAdType()Optional. The type of skippable ad.
optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the skippableAdType 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 = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the vastPreviewUrl field is set. |