Class VastInfo (0.62.0)

public final class VastInfo extends GeneratedMessage implements VastInfoOrBuilder

Fields common to Video Ad Serving Template (VAST) creatives.

Protobuf type google.ads.admanager.v1.VastInfo

Implements

VastInfoOrBuilder

Static Fields

AD_ID_FIELD_NUMBER

public static final int AD_ID_FIELD_NUMBER
Field Value
Type Description
int

AD_ID_TYPE_FIELD_NUMBER

public static final int AD_ID_TYPE_FIELD_NUMBER
Field Value
Type Description
int

ALLOW_DURATION_OVERRIDE_FIELD_NUMBER

public static final int ALLOW_DURATION_OVERRIDE_FIELD_NUMBER
Field Value
Type Description
int

COMPANION_CREATIVES_FIELD_NUMBER

public static final int COMPANION_CREATIVES_FIELD_NUMBER
Field Value
Type Description
int

CREATIVE_SET_DISPLAY_NAME_FIELD_NUMBER

public static final int CREATIVE_SET_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

CREATIVE_SET_FIELD_NUMBER

public static final int CREATIVE_SET_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_PARAMETERS_FIELD_NUMBER

public static final int CUSTOM_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_URL_FIELD_NUMBER

public static final int DESTINATION_URL_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_URL_TYPE_FIELD_NUMBER

public static final int DESTINATION_URL_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
Type Description
int

SKIPPABLE_AD_TYPE_FIELD_NUMBER

public static final int SKIPPABLE_AD_TYPE_FIELD_NUMBER
Field Value
Type Description
int

TRACKING_URLS_FIELD_NUMBER

public static final int TRACKING_URLS_FIELD_NUMBER
Field Value
Type Description
int

VAST_PREVIEW_URL_FIELD_NUMBER

public static final int VAST_PREVIEW_URL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VastInfo getDefaultInstance()
Returns
Type Description
VastInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static VastInfo.Builder newBuilder()
Returns
Type Description
VastInfo.Builder

newBuilder(VastInfo prototype)

public static VastInfo.Builder newBuilder(VastInfo prototype)
Parameter
Name Description
prototype VastInfo
Returns
Type Description
VastInfo.Builder

parseDelimitedFrom(InputStream input)

public static VastInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VastInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VastInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VastInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static VastInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
VastInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VastInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VastInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VastInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
VastInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VastInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VastInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VastInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
VastInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VastInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VastInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static VastInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VastInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VastInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VastInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static VastInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
VastInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VastInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VastInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<VastInfo> parser()
Returns
Type Description
Parser<VastInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdId()

public 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 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 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 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 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 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 int

The 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 = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The 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 = 18 [(.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 = 18 [(.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 = 15 [(.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 = 15 [(.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 = 14 [(.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 = 14 [(.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 = 4 [(.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 = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for customParameters.

getDefaultInstanceForType()

public VastInfo getDefaultInstanceForType()
Returns
Type Description
VastInfo

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 = 16 [(.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 = 16 [(.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 = 17 [(.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 = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for destinationUrlType.

getDuration()

public 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 DurationOrBuilder getDurationOrBuilder()

Optional. The expected duration of this creative.

.google.protobuf.Duration duration = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getParserForType()

public Parser<VastInfo> getParserForType()
Returns
Type Description
Parser<VastInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSkippableAdType()

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public VastInfo.Builder newBuilderForType()
Returns
Type Description
VastInfo.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected VastInfo.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
VastInfo.Builder
Overrides

toBuilder()

public VastInfo.Builder toBuilder()
Returns
Type Description
VastInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException