com.google.api.ads.dfp.axis.v201403

Class FlashOverlayCreative

java.lang.Object

com.google.api.ads.dfp.axis.v201403.Creative

com.google.api.ads.dfp.axis.v201403.HasDestinationUrlCreative

com.google.api.ads.dfp.axis.v201403.BaseFlashCreative

com.google.api.ads.dfp.axis.v201403.FlashOverlayCreative

All Implemented Interfaces:

Serializable

public class FlashOverlayCreative
extends BaseFlashCreative
implements Serializable

An overlay Creative that displays a Flash-based ad and is served via VAST 2.0 XML. Overlays cover part of the video content they are displayed on top of. This creative is read-only.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FlashOverlayCreative()
FlashOverlayCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues, String creativeType, String destinationUrl, String flashName, byte[] flashByteArray, String fallbackImageName, byte[] fallbackImageByteArray, Boolean overrideSize, Boolean clickTagRequired, String fallbackPreviewUrl, Size flashAssetSize, Size fallbackAssetSize, long[] companionCreativeIds, ConversionEvent_TrackingUrlsMapEntry[] trackingUrls, String customParameters, ApiFramework apiFramework, Integer duration, String vastPreviewUrl)

Method Summary

Methods

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

Methods inherited from class com.google.api.ads.dfp.axis.v201403.BaseFlashCreative

getClickTagRequired, getFallbackAssetSize, getFallbackImageByteArray, getFallbackImageName, getFallbackPreviewUrl, getFlashAssetSize, getFlashByteArray, getFlashName, getOverrideSize, setClickTagRequired, setFallbackAssetSize, setFallbackImageByteArray, setFallbackImageName, setFallbackPreviewUrl, setFlashAssetSize, setFlashByteArray, setFlashName, setOverrideSize

Methods inherited from class com.google.api.ads.dfp.axis.v201403.HasDestinationUrlCreative

getDestinationUrl, setDestinationUrl

Methods inherited from class com.google.api.ads.dfp.axis.v201403.Creative

getAdvertiserId, getAppliedLabels, getAppliedLabels, getCreativeType, getCustomFieldValues, getCustomFieldValues, getId, getLastModifiedDateTime, getName, getPreviewUrl, getSize, setAdvertiserId, setAppliedLabels, setAppliedLabels, setCreativeType, setCustomFieldValues, setCustomFieldValues, setId, setLastModifiedDateTime, setName, setPreviewUrl, setSize

Methods inherited from class java.lang.Object

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

Constructor Detail

FlashOverlayCreative

public FlashOverlayCreative()

FlashOverlayCreative

public FlashOverlayCreative(Long advertiserId,
                    Long id,
                    String name,
                    Size size,
                    String previewUrl,
                    AppliedLabel[] appliedLabels,
                    DateTime lastModifiedDateTime,
                    BaseCustomFieldValue[] customFieldValues,
                    String creativeType,
                    String destinationUrl,
                    String flashName,
                    byte[] flashByteArray,
                    String fallbackImageName,
                    byte[] fallbackImageByteArray,
                    Boolean overrideSize,
                    Boolean clickTagRequired,
                    String fallbackPreviewUrl,
                    Size flashAssetSize,
                    Size fallbackAssetSize,
                    long[] companionCreativeIds,
                    ConversionEvent_TrackingUrlsMapEntry[] trackingUrls,
                    String customParameters,
                    ApiFramework apiFramework,
                    Integer duration,
                    String vastPreviewUrl)

Method Detail

getCompanionCreativeIds

public long[] getCompanionCreativeIds()

Gets the companionCreativeIds value for this FlashOverlayCreative.

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

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

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

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

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

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

Returns:

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

setApiFramework

public void setApiFramework(ApiFramework apiFramework)

Sets the apiFramework value for this FlashOverlayCreative.

Parameters:

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

getDuration

public Integer getDuration()

Gets the duration value for this FlashOverlayCreative.

Returns:

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

setDuration

public void setDuration(Integer duration)

Sets the duration value for this FlashOverlayCreative.

Parameters:

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

getVastPreviewUrl

public String getVastPreviewUrl()

Gets the vastPreviewUrl value for this FlashOverlayCreative.

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

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 BaseFlashCreative

hashCode

public int hashCode()

Overrides:

hashCode in class BaseFlashCreative

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