com.google.api.ads.admanager.axis.v202108

Class BaseVideoCreative

java.lang.Object

com.google.api.ads.admanager.axis.v202108.Creative

com.google.api.ads.admanager.axis.v202108.HasDestinationUrlCreative

com.google.api.ads.admanager.axis.v202108.BaseVideoCreative

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SetTopBoxCreative, VideoCreative, VideoRedirectCreative

public abstract class BaseVideoCreative
extends HasDestinationUrlCreative
implements Serializable

A base type for video creatives.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseVideoCreative()
BaseVideoCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, CreativePolicyViolation[] policyLabels, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues, ThirdPartyDataDeclaration thirdPartyDataDeclaration, String destinationUrl, DestinationUrlType destinationUrlType, Integer duration, Boolean allowDurationOverride, ConversionEvent_TrackingUrlsMapEntry[] trackingUrls, long[] companionCreativeIds, String customParameters, String adId, AdIdType adIdType, SkippableAdType skippableAdType, String vastPreviewUrl, SslScanResult sslScanResult, SslManualOverride sslManualOverride)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAdId() Gets the adId value for this BaseVideoCreative.
AdIdType	getAdIdType() Gets the adIdType value for this BaseVideoCreative.
Boolean	getAllowDurationOverride() Gets the allowDurationOverride value for this BaseVideoCreative.
long[]	getCompanionCreativeIds() Gets the companionCreativeIds value for this BaseVideoCreative.
long	getCompanionCreativeIds(int i)
String	getCustomParameters() Gets the customParameters value for this BaseVideoCreative.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Integer	getDuration() Gets the duration value for this BaseVideoCreative.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
SkippableAdType	getSkippableAdType() Gets the skippableAdType value for this BaseVideoCreative.
SslManualOverride	getSslManualOverride() Gets the sslManualOverride value for this BaseVideoCreative.
SslScanResult	getSslScanResult() Gets the sslScanResult value for this BaseVideoCreative.
ConversionEvent_TrackingUrlsMapEntry[]	getTrackingUrls() Gets the trackingUrls value for this BaseVideoCreative.
ConversionEvent_TrackingUrlsMapEntry	getTrackingUrls(int i)
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
String	getVastPreviewUrl() Gets the vastPreviewUrl value for this BaseVideoCreative.
int	hashCode()
void	setAdId(String adId) Sets the adId value for this BaseVideoCreative.
void	setAdIdType(AdIdType adIdType) Sets the adIdType value for this BaseVideoCreative.
void	setAllowDurationOverride(Boolean allowDurationOverride) Sets the allowDurationOverride value for this BaseVideoCreative.
void	setCompanionCreativeIds(int i, long _value)
void	setCompanionCreativeIds(long[] companionCreativeIds) Sets the companionCreativeIds value for this BaseVideoCreative.
void	setCustomParameters(String customParameters) Sets the customParameters value for this BaseVideoCreative.
void	setDuration(Integer duration) Sets the duration value for this BaseVideoCreative.
void	setSkippableAdType(SkippableAdType skippableAdType) Sets the skippableAdType value for this BaseVideoCreative.
void	setSslManualOverride(SslManualOverride sslManualOverride) Sets the sslManualOverride value for this BaseVideoCreative.
void	setSslScanResult(SslScanResult sslScanResult) Sets the sslScanResult value for this BaseVideoCreative.
void	setTrackingUrls(ConversionEvent_TrackingUrlsMapEntry[] trackingUrls) Sets the trackingUrls value for this BaseVideoCreative.
void	setTrackingUrls(int i, ConversionEvent_TrackingUrlsMapEntry _value)
void	setVastPreviewUrl(String vastPreviewUrl) Sets the vastPreviewUrl value for this BaseVideoCreative.
String	toString()

Methods inherited from class com.google.api.ads.admanager.axis.v202108.HasDestinationUrlCreative

getDestinationUrl, getDestinationUrlType, setDestinationUrl, setDestinationUrlType

Methods inherited from class com.google.api.ads.admanager.axis.v202108.Creative

getAdvertiserId, getAppliedLabels, getAppliedLabels, getCustomFieldValues, getCustomFieldValues, getId, getLastModifiedDateTime, getName, getPolicyLabels, getPolicyLabels, getPreviewUrl, getSize, getThirdPartyDataDeclaration, setAdvertiserId, setAppliedLabels, setAppliedLabels, setCustomFieldValues, setCustomFieldValues, setId, setLastModifiedDateTime, setName, setPolicyLabels, setPolicyLabels, setPreviewUrl, setSize, setThirdPartyDataDeclaration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseVideoCreative

public BaseVideoCreative()

BaseVideoCreative

public BaseVideoCreative(Long advertiserId,
                         Long id,
                         String name,
                         Size size,
                         String previewUrl,
                         CreativePolicyViolation[] policyLabels,
                         AppliedLabel[] appliedLabels,
                         DateTime lastModifiedDateTime,
                         BaseCustomFieldValue[] customFieldValues,
                         ThirdPartyDataDeclaration thirdPartyDataDeclaration,
                         String destinationUrl,
                         DestinationUrlType destinationUrlType,
                         Integer duration,
                         Boolean allowDurationOverride,
                         ConversionEvent_TrackingUrlsMapEntry[] trackingUrls,
                         long[] companionCreativeIds,
                         String customParameters,
                         String adId,
                         AdIdType adIdType,
                         SkippableAdType skippableAdType,
                         String vastPreviewUrl,
                         SslScanResult sslScanResult,
                         SslManualOverride sslManualOverride)

Method Detail

toString

public String toString()

Overrides:

toString in class HasDestinationUrlCreative

getDuration

public Integer getDuration()

Gets the duration value for this BaseVideoCreative.

Returns:

duration * The expected duration of this creative in milliseconds.

setDuration

public void setDuration(Integer duration)

Sets the duration value for this BaseVideoCreative.

Parameters:

duration - * The expected duration of this creative in milliseconds.

getAllowDurationOverride

public Boolean getAllowDurationOverride()

Gets the allowDurationOverride value for this BaseVideoCreative.

Returns:

allowDurationOverride * Allows the creative duration to differ from the actual asset durations. This attribute is optional.

setAllowDurationOverride

public void setAllowDurationOverride(Boolean allowDurationOverride)

Sets the allowDurationOverride value for this BaseVideoCreative.

Parameters:

allowDurationOverride - * Allows the creative duration to differ from the actual asset durations. This attribute is optional.

getTrackingUrls

public ConversionEvent_TrackingUrlsMapEntry[] getTrackingUrls()

Gets the trackingUrls value for this BaseVideoCreative.

Returns:

trackingUrls * A map from ConversionEvent to a list of URLs that will be pinged when the event happens. This attribute is optional.

setTrackingUrls

public void setTrackingUrls(ConversionEvent_TrackingUrlsMapEntry[] trackingUrls)

Sets the trackingUrls value for this BaseVideoCreative.

Parameters:

trackingUrls - * A map from ConversionEvent to a list of URLs that will be pinged when the event happens. This attribute is optional.

getTrackingUrls

public ConversionEvent_TrackingUrlsMapEntry getTrackingUrls(int i)

setTrackingUrls

public void setTrackingUrls(int i,
                            ConversionEvent_TrackingUrlsMapEntry _value)

getCompanionCreativeIds

public long[] getCompanionCreativeIds()

Gets the companionCreativeIds value for this BaseVideoCreative.

Returns:

companionCreativeIds * The IDs of the companion creatives that are associated with this creative. This attribute is optional.

setCompanionCreativeIds

public void setCompanionCreativeIds(long[] companionCreativeIds)

Sets the companionCreativeIds value for this BaseVideoCreative.

Parameters:

companionCreativeIds - * The IDs of the companion creatives that are associated with this creative. This attribute is optional.

getCompanionCreativeIds

public long getCompanionCreativeIds(int i)

setCompanionCreativeIds

public void setCompanionCreativeIds(int i,
                                    long _value)

getCustomParameters

public String getCustomParameters()

Gets the customParameters value for this BaseVideoCreative.

Returns:

customParameters * A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node. This attribute is optional.

setCustomParameters

public void setCustomParameters(String customParameters)

Sets the customParameters value for this BaseVideoCreative.

Parameters:

customParameters - * A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node. This attribute is optional.

getAdId

public String getAdId()

Gets the adId value for this BaseVideoCreative.

Returns:

adId * The ad id associated with the video as defined by the adIdType registry. This field is required if adIdType is not AdIdType.NONE.

setAdId

public void setAdId(String adId)

Sets the adId value for this BaseVideoCreative.

Parameters:

adId - * The ad id associated with the video as defined by the adIdType registry. This field is required if adIdType is not AdIdType.NONE.

getAdIdType

public AdIdType getAdIdType()

Gets the adIdType value for this BaseVideoCreative.

Returns:

adIdType * The registry which the ad id of this creative belongs to. This field is optional and defaults to AdIdType.NONE.

setAdIdType

public void setAdIdType(AdIdType adIdType)

Sets the adIdType value for this BaseVideoCreative.

Parameters:

adIdType - * The registry which the ad id of this creative belongs to. This field is optional and defaults to AdIdType.NONE.

getSkippableAdType

public SkippableAdType getSkippableAdType()

Gets the skippableAdType value for this BaseVideoCreative.

Returns:

skippableAdType * The type of skippable ad.

setSkippableAdType

public void setSkippableAdType(SkippableAdType skippableAdType)

Sets the skippableAdType value for this BaseVideoCreative.

Parameters:

skippableAdType - * The type of skippable ad.

getVastPreviewUrl

public String getVastPreviewUrl()

Gets the vastPreviewUrl value for this BaseVideoCreative.

Returns:

vastPreviewUrl * An ad tag URL that will return a preview of the VAST XML response specific to this creative. This attribute is read-only.

setVastPreviewUrl

public void setVastPreviewUrl(String vastPreviewUrl)

Sets the vastPreviewUrl value for this BaseVideoCreative.

Parameters:

vastPreviewUrl - * An ad tag URL that will return a preview of the VAST XML response specific to this creative. This attribute is read-only.

getSslScanResult

public SslScanResult getSslScanResult()

Gets the sslScanResult value for this BaseVideoCreative.

Returns:

sslScanResult * The SSL compatibility scan result of this creative.

This attribute is read-only and determined by Google.

setSslScanResult

public void setSslScanResult(SslScanResult sslScanResult)

Sets the sslScanResult value for this BaseVideoCreative.

Parameters:

sslScanResult - * The SSL compatibility scan result of this creative.

This attribute is read-only and determined by Google.

getSslManualOverride

public SslManualOverride getSslManualOverride()

Gets the sslManualOverride value for this BaseVideoCreative.

Returns:

sslManualOverride * The manual override for the SSL compatibility of this creative.

This attribute is optional and defaults to SslManualOverride.NO_OVERRIDE.

setSslManualOverride

public void setSslManualOverride(SslManualOverride sslManualOverride)

Sets the sslManualOverride value for this BaseVideoCreative.

Parameters:

sslManualOverride - * The manual override for the SSL compatibility of this creative.

This attribute is optional and defaults to SslManualOverride.NO_OVERRIDE.

equals

public boolean equals(Object obj)

Overrides:

equals in class HasDestinationUrlCreative

hashCode

public int hashCode()

Overrides:

hashCode in class HasDestinationUrlCreative

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer