com.google.api.ads.admanager.axis.v201905

Class FlashRedirectOverlayCreative

java.lang.Object

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

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

com.google.api.ads.admanager.axis.v201905.BaseFlashRedirectCreative

com.google.api.ads.admanager.axis.v201905.FlashRedirectOverlayCreative

All Implemented Interfaces:

Serializable

public class FlashRedirectOverlayCreative
extends BaseFlashRedirectCreative
implements Serializable

An overlay Creative that loads a Flash asset from a specified URL and is served via VAST XML. Overlays cover part of the video content they are displayed on top of.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FlashRedirectOverlayCreative()
FlashRedirectOverlayCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, CreativePolicyViolation[] policyViolations, CreativePolicyViolation[] policyLabels, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues, String destinationUrl, DestinationUrlType destinationUrlType, String flashUrl, String fallbackUrl, String fallbackPreviewUrl, SslScanResult sslScanResult, SslManualOverride sslManualOverride, long[] companionCreativeIds, ConversionEvent_TrackingUrlsMapEntry[] trackingUrls, String customParameters, ApiFramework apiFramework, Integer duration, Size flashAssetSize, String vastPreviewUrl)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ApiFramework	getApiFramework() Gets the apiFramework value for this FlashRedirectOverlayCreative.
long[]	getCompanionCreativeIds() Gets the companionCreativeIds value for this FlashRedirectOverlayCreative.
long	getCompanionCreativeIds(int i)
String	getCustomParameters() Gets the customParameters value for this FlashRedirectOverlayCreative.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Integer	getDuration() Gets the duration value for this FlashRedirectOverlayCreative.
Size	getFlashAssetSize() Gets the flashAssetSize value for this FlashRedirectOverlayCreative.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
ConversionEvent_TrackingUrlsMapEntry[]	getTrackingUrls() Gets the trackingUrls value for this FlashRedirectOverlayCreative.
ConversionEvent_TrackingUrlsMapEntry	getTrackingUrls(int i)
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
String	getVastPreviewUrl() Gets the vastPreviewUrl value for this FlashRedirectOverlayCreative.
int	hashCode()
void	setApiFramework(ApiFramework apiFramework) Sets the apiFramework value for this FlashRedirectOverlayCreative.
void	setCompanionCreativeIds(int i, long _value)
void	setCompanionCreativeIds(long[] companionCreativeIds) Sets the companionCreativeIds value for this FlashRedirectOverlayCreative.
void	setCustomParameters(String customParameters) Sets the customParameters value for this FlashRedirectOverlayCreative.
void	setDuration(Integer duration) Sets the duration value for this FlashRedirectOverlayCreative.
void	setFlashAssetSize(Size flashAssetSize) Sets the flashAssetSize value for this FlashRedirectOverlayCreative.
void	setTrackingUrls(ConversionEvent_TrackingUrlsMapEntry[] trackingUrls) Sets the trackingUrls value for this FlashRedirectOverlayCreative.
void	setTrackingUrls(int i, ConversionEvent_TrackingUrlsMapEntry _value)
void	setVastPreviewUrl(String vastPreviewUrl) Sets the vastPreviewUrl value for this FlashRedirectOverlayCreative.
String	toString()

Methods inherited from class com.google.api.ads.admanager.axis.v201905.BaseFlashRedirectCreative

getFallbackPreviewUrl, getFallbackUrl, getFlashUrl, getSslManualOverride, getSslScanResult, setFallbackPreviewUrl, setFallbackUrl, setFlashUrl, setSslManualOverride, setSslScanResult

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

getDestinationUrl, getDestinationUrlType, setDestinationUrl, setDestinationUrlType

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FlashRedirectOverlayCreative

public FlashRedirectOverlayCreative()

FlashRedirectOverlayCreative

public FlashRedirectOverlayCreative(Long advertiserId,
                                    Long id,
                                    String name,
                                    Size size,
                                    String previewUrl,
                                    CreativePolicyViolation[] policyViolations,
                                    CreativePolicyViolation[] policyLabels,
                                    AppliedLabel[] appliedLabels,
                                    DateTime lastModifiedDateTime,
                                    BaseCustomFieldValue[] customFieldValues,
                                    String destinationUrl,
                                    DestinationUrlType destinationUrlType,
                                    String flashUrl,
                                    String fallbackUrl,
                                    String fallbackPreviewUrl,
                                    SslScanResult sslScanResult,
                                    SslManualOverride sslManualOverride,
                                    long[] companionCreativeIds,
                                    ConversionEvent_TrackingUrlsMapEntry[] trackingUrls,
                                    String customParameters,
                                    ApiFramework apiFramework,
                                    Integer duration,
                                    Size flashAssetSize,
                                    String vastPreviewUrl)

Method Detail

toString

public String toString()

Overrides:

toString in class BaseFlashRedirectCreative

getCompanionCreativeIds

public long[] getCompanionCreativeIds()

Gets the companionCreativeIds value for this FlashRedirectOverlayCreative.

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

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)

getTrackingUrls

public ConversionEvent_TrackingUrlsMapEntry[] getTrackingUrls()

Gets the trackingUrls value for this FlashRedirectOverlayCreative.

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

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)

getCustomParameters

public String getCustomParameters()

Gets the customParameters value for this FlashRedirectOverlayCreative.

Returns:

customParameters * A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node. If the apiFramework is ApiFramework.VPAID, the value does not need to be a comma separated key-value list (and can instead be any arbitrary string). This attribute is optional.

setCustomParameters

public void setCustomParameters(String customParameters)

Sets the customParameters value for this FlashRedirectOverlayCreative.

Parameters:

customParameters - * A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node. If the apiFramework is ApiFramework.VPAID, the value does not need to be a comma separated key-value list (and can instead be any arbitrary string). This attribute is optional.

getApiFramework

public ApiFramework getApiFramework()

Gets the apiFramework value for this FlashRedirectOverlayCreative.

Returns:

apiFramework * The API framework of the asset. This attribute is optional.

setApiFramework

public void setApiFramework(ApiFramework apiFramework)

Sets the apiFramework value for this FlashRedirectOverlayCreative.

Parameters:

apiFramework - * The API framework of the asset. This attribute is optional.

getDuration

public Integer getDuration()

Gets the duration value for this FlashRedirectOverlayCreative.

Returns:

duration * Minimum suggested duration in milliseconds. This attribute is optional.

setDuration

public void setDuration(Integer duration)

Sets the duration value for this FlashRedirectOverlayCreative.

Parameters:

duration - * Minimum suggested duration in milliseconds. This attribute is optional.

getFlashAssetSize

public Size getFlashAssetSize()

Gets the flashAssetSize value for this FlashRedirectOverlayCreative.

Returns:

flashAssetSize * The size of the flash asset. Note that this may differ from Creative.size if the asset is not expected to fill the entire video player. This attribute is optional.

setFlashAssetSize

public void setFlashAssetSize(Size flashAssetSize)

Sets the flashAssetSize value for this FlashRedirectOverlayCreative.

Parameters:

flashAssetSize - * The size of the flash asset. Note that this may differ from Creative.size if the asset is not expected to fill the entire video player. This attribute is optional.

getVastPreviewUrl

public String getVastPreviewUrl()

Gets the vastPreviewUrl value for this FlashRedirectOverlayCreative.

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

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.

equals

public boolean equals(Object obj)

Overrides:

equals in class BaseFlashRedirectCreative

hashCode

public int hashCode()

Overrides:

hashCode in class BaseFlashRedirectCreative

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