public static final class VastInfo.Builder extends GeneratedMessage.Builder<VastInfo.Builder> implements VastInfoOrBuilderFields common to Video Ad Serving Template (VAST) creatives.
Protobuf type google.ads.admanager.v1.VastInfo
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > VastInfo.BuilderImplements
VastInfoOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllCompanionCreatives(Iterable<String> values)
public VastInfo.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 = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The companionCreatives to add. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
addAllTrackingUrls(Iterable<? extends VideoTrackingUrl> values)
public VastInfo.Builder addAllTrackingUrls(Iterable<? extends VideoTrackingUrl> values)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 |
values |
Iterable<? extends com.google.ads.admanager.v1.VideoTrackingUrl> |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
addCompanionCreatives(String value)
public VastInfo.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 = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe companionCreatives to add. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
addCompanionCreativesBytes(ByteString value)
public VastInfo.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 = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the companionCreatives to add. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
addTrackingUrls(VideoTrackingUrl value)
public VastInfo.Builder addTrackingUrls(VideoTrackingUrl value)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 |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
addTrackingUrls(VideoTrackingUrl.Builder builderForValue)
public VastInfo.Builder addTrackingUrls(VideoTrackingUrl.Builder builderForValue)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 |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
addTrackingUrls(int index, VideoTrackingUrl value)
public VastInfo.Builder addTrackingUrls(int index, VideoTrackingUrl value)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
addTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue)
public VastInfo.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 = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
addTrackingUrlsBuilder()
public VideoTrackingUrl.Builder addTrackingUrlsBuilder()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 |
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 = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
VideoTrackingUrl.Builder |
|
build()
public VastInfo build()| Returns | |
|---|---|
| Type | Description |
VastInfo |
|
buildPartial()
public VastInfo buildPartial()| Returns | |
|---|---|
| Type | Description |
VastInfo |
|
clear()
public VastInfo.Builder clear()| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
clearAdId()
public VastInfo.Builder clearAdId() 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 |
VastInfo.Builder |
This builder for chaining. |
clearAdIdType()
public VastInfo.Builder clearAdIdType() 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 |
VastInfo.Builder |
This builder for chaining. |
clearAllowDurationOverride()
public VastInfo.Builder clearAllowDurationOverride()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 |
VastInfo.Builder |
This builder for chaining. |
clearCompanionCreatives()
public VastInfo.Builder clearCompanionCreatives()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 |
VastInfo.Builder |
This builder for chaining. |
clearCreativeSet()
public VastInfo.Builder clearCreativeSet()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 |
VastInfo.Builder |
This builder for chaining. |
clearCreativeSetDisplayName()
public VastInfo.Builder clearCreativeSetDisplayName()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 |
VastInfo.Builder |
This builder for chaining. |
clearCustomParameters()
public VastInfo.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 = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
clearDestinationUrl()
public VastInfo.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 = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
clearDestinationUrlType()
public VastInfo.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 = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
clearDuration()
public VastInfo.Builder clearDuration()Optional. The expected duration of this creative.
.google.protobuf.Duration duration = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
clearSkippableAdType()
public VastInfo.Builder clearSkippableAdType()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 |
VastInfo.Builder |
This builder for chaining. |
clearTrackingUrls()
public VastInfo.Builder clearTrackingUrls()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 |
VastInfo.Builder |
|
clearVastPreviewUrl()
public VastInfo.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 = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
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 |
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 = 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 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 |
|
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 = 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. |
getDurationBuilder()
public Duration.Builder getDurationBuilder()Optional. The expected duration of this creative.
.google.protobuf.Duration duration = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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 |
|
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 |
|
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 = 3 [(.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 = 3 [(.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 = 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeDuration(Duration value)
public VastInfo.Builder mergeDuration(Duration value)Optional. The expected duration of this creative.
.google.protobuf.Duration duration = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
mergeFrom(VastInfo other)
public VastInfo.Builder mergeFrom(VastInfo other)| Parameter | |
|---|---|
| Name | Description |
other |
VastInfo |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public VastInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public VastInfo.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
removeTrackingUrls(int index)
public VastInfo.Builder removeTrackingUrls(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 |
VastInfo.Builder |
|
setAdId(String value)
public VastInfo.Builder setAdId(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe adId to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setAdIdBytes(ByteString value)
public VastInfo.Builder setAdIdBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for adId to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setAdIdType(VastAdIdTypeEnum.VastAdIdType value)
public VastInfo.Builder setAdIdType(VastAdIdTypeEnum.VastAdIdType value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
VastAdIdTypeEnum.VastAdIdTypeThe adIdType to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setAdIdTypeValue(int value)
public VastInfo.Builder setAdIdTypeValue(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for adIdType to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setAllowDurationOverride(boolean value)
public VastInfo.Builder setAllowDurationOverride(boolean value)Optional. Allows the creative duration to differ from the actual asset durations.
optional bool allow_duration_override = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe allowDurationOverride to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setCompanionCreatives(int index, String value)
public VastInfo.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 = 18 [(.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 |
VastInfo.Builder |
This builder for chaining. |
setCreativeSet(String value)
public VastInfo.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 = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe creativeSet to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setCreativeSetBytes(ByteString value)
public VastInfo.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 = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for creativeSet to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setCreativeSetDisplayName(String value)
public VastInfo.Builder setCreativeSetDisplayName(String value)Output only. The display name of the creative set.
optional string creative_set_display_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe creativeSetDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setCreativeSetDisplayNameBytes(ByteString value)
public VastInfo.Builder setCreativeSetDisplayNameBytes(ByteString value)Output only. The display name of the creative set.
optional string creative_set_display_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for creativeSetDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setCustomParameters(String value)
public VastInfo.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 = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customParameters to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setCustomParametersBytes(ByteString value)
public VastInfo.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 = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for customParameters to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setDestinationUrl(String value)
public VastInfo.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 = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe destinationUrl to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setDestinationUrlBytes(ByteString value)
public VastInfo.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 = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for destinationUrl to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setDestinationUrlType(CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType value)
public VastInfo.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 = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeDestinationUrlTypeEnum.CreativeDestinationUrlTypeThe destinationUrlType to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setDestinationUrlTypeValue(int value)
public VastInfo.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 = 17 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for destinationUrlType to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setDuration(Duration value)
public VastInfo.Builder setDuration(Duration value)Optional. The expected duration of this creative.
.google.protobuf.Duration duration = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
setDuration(Duration.Builder builderForValue)
public VastInfo.Builder setDuration(Duration.Builder builderForValue)Optional. The expected duration of this creative.
.google.protobuf.Duration duration = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
setSkippableAdType(SkippableAdTypeEnum.SkippableAdType value)
public VastInfo.Builder setSkippableAdType(SkippableAdTypeEnum.SkippableAdType value)Optional. The type of skippable ad.
optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
SkippableAdTypeEnum.SkippableAdTypeThe skippableAdType to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setSkippableAdTypeValue(int value)
public VastInfo.Builder setSkippableAdTypeValue(int value)Optional. The type of skippable ad.
optional .google.ads.admanager.v1.SkippableAdTypeEnum.SkippableAdType skippable_ad_type = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for skippableAdType to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setTrackingUrls(int index, VideoTrackingUrl value)
public VastInfo.Builder setTrackingUrls(int index, VideoTrackingUrl value)Optional. URLs that will be pinged when conversion events happen.
repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
VideoTrackingUrl |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
setTrackingUrls(int index, VideoTrackingUrl.Builder builderForValue)
public VastInfo.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 = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
VideoTrackingUrl.Builder |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
|
setVastPreviewUrl(String value)
public VastInfo.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 = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe vastPreviewUrl to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |
setVastPreviewUrlBytes(ByteString value)
public VastInfo.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 = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for vastPreviewUrl to set. |
| Returns | |
|---|---|
| Type | Description |
VastInfo.Builder |
This builder for chaining. |