com.google.api.ads.dfp.axis.v201203
Class VpaidLinearCreative

java.lang.Object
  com.google.api.ads.dfp.axis.v201203.Creative
      com.google.api.ads.dfp.axis.v201203.HasDestinationUrlCreative
          com.google.api.ads.dfp.axis.v201203.VpaidLinearCreative

All Implemented Interfaces:

Serializable

public class VpaidLinearCreative
extends HasDestinationUrlCreative
implements Serializable

A Creative that displays a DFP-hosted Flash-based ad and is served via VAST 2.0 XML. It is displayed in a linear fashion with a video (before, after, interrupting). This creative is read only.

See Also:

Serialized Form

Constructor Summary

VpaidLinearCreative()

VpaidLinearCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, String creativeType, String destinationUrl, String flashName, byte[] flashByteArray, Boolean overrideSize, Size flashAssetSize, long[] companionCreativeIds, ConversionEvent_TrackingUrlsMapEntry[] trackingUrls, String customParameters, Integer duration)

Method Summary

boolean	equals(Object obj)
long[]	getCompanionCreativeIds() Gets the companionCreativeIds value for this VpaidLinearCreative.
long	getCompanionCreativeIds(int i)
String	getCustomParameters() Gets the customParameters value for this VpaidLinearCreative.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Integer	getDuration() Gets the duration value for this VpaidLinearCreative.
Size	getFlashAssetSize() Gets the flashAssetSize value for this VpaidLinearCreative.
byte[]	getFlashByteArray() Gets the flashByteArray value for this VpaidLinearCreative.
String	getFlashName() Gets the flashName value for this VpaidLinearCreative.
Boolean	getOverrideSize() Gets the overrideSize value for this VpaidLinearCreative.
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 VpaidLinearCreative.
ConversionEvent_TrackingUrlsMapEntry	getTrackingUrls(int i)
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setCompanionCreativeIds(int i, long _value)
void	setCompanionCreativeIds(long[] companionCreativeIds) Sets the companionCreativeIds value for this VpaidLinearCreative.
void	setCustomParameters(String customParameters) Sets the customParameters value for this VpaidLinearCreative.
void	setDuration(Integer duration) Sets the duration value for this VpaidLinearCreative.
void	setFlashAssetSize(Size flashAssetSize) Sets the flashAssetSize value for this VpaidLinearCreative.
void	setFlashByteArray(byte[] flashByteArray) Sets the flashByteArray value for this VpaidLinearCreative.
void	setFlashName(String flashName) Sets the flashName value for this VpaidLinearCreative.
void	setOverrideSize(Boolean overrideSize) Sets the overrideSize value for this VpaidLinearCreative.
void	setTrackingUrls(ConversionEvent_TrackingUrlsMapEntry[] trackingUrls) Sets the trackingUrls value for this VpaidLinearCreative.
void	setTrackingUrls(int i, ConversionEvent_TrackingUrlsMapEntry _value)

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

getDestinationUrl, setDestinationUrl

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

VpaidLinearCreative

public VpaidLinearCreative()

VpaidLinearCreative

public VpaidLinearCreative(Long advertiserId,
                           Long id,
                           String name,
                           Size size,
                           String previewUrl,
                           AppliedLabel[] appliedLabels,
                           DateTime lastModifiedDateTime,
                           String creativeType,
                           String destinationUrl,
                           String flashName,
                           byte[] flashByteArray,
                           Boolean overrideSize,
                           Size flashAssetSize,
                           long[] companionCreativeIds,
                           ConversionEvent_TrackingUrlsMapEntry[] trackingUrls,
                           String customParameters,
                           Integer duration)

Method Detail

getFlashName

public String getFlashName()

Gets the flashName value for this VpaidLinearCreative.

Returns:

flashName * The name of the Flash asset. This attribute is required and has a maximum length of 248 characters.

setFlashName

public void setFlashName(String flashName)

Sets the flashName value for this VpaidLinearCreative.

Parameters:

flashName - * The name of the Flash asset. This attribute is required and has a maximum length of 248 characters.

getFlashByteArray

public byte[] getFlashByteArray()

Gets the flashByteArray value for this VpaidLinearCreative.

Returns:

flashByteArray * The contents of the Flash asset as a byte array. This attribute is required. The flashByteArray will be null when the FlashCreative is retrieved. To view the Flash image, use the previewUrl.

setFlashByteArray

public void setFlashByteArray(byte[] flashByteArray)

Sets the flashByteArray value for this VpaidLinearCreative.

Parameters:

flashByteArray - * The contents of the Flash asset as a byte array. This attribute is required. The flashByteArray will be null when the FlashCreative is retrieved. To view the Flash image, use the previewUrl.

getOverrideSize

public Boolean getOverrideSize()

Gets the overrideSize value for this VpaidLinearCreative.

Returns:

overrideSize * Allows the creative size to differ from the actual Flash asset size. This attribute is optional.

setOverrideSize

public void setOverrideSize(Boolean overrideSize)

Sets the overrideSize value for this VpaidLinearCreative.

Parameters:

overrideSize - * Allows the creative size to differ from the actual Flash asset size. This attribute is optional.

getFlashAssetSize

public Size getFlashAssetSize()

Gets the flashAssetSize value for this VpaidLinearCreative.

Returns:

flashAssetSize * The Flash asset size. Note that this may differ from Creative.size if overrideSize is set to true. This attribute is read-only and is populated by Google.

setFlashAssetSize

public void setFlashAssetSize(Size flashAssetSize)

Sets the flashAssetSize value for this VpaidLinearCreative.

Parameters:

flashAssetSize - * The Flash asset size. Note that this may differ from Creative.size if overrideSize is set to true. This attribute is read-only and is populated by Google.

getCompanionCreativeIds

public long[] getCompanionCreativeIds()

Gets the companionCreativeIds value for this VpaidLinearCreative.

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

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

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

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

Returns:

customParameters * A string that is supplied to the VPAID creative's init function. This is written into the VAST XML in the AdParameters section. This attribute is optional.

setCustomParameters

public void setCustomParameters(String customParameters)

Sets the customParameters value for this VpaidLinearCreative.

Parameters:

customParameters - * A string that is supplied to the VPAID creative's init function. This is written into the VAST XML in the AdParameters section. This attribute is optional.

getDuration

public Integer getDuration()

Gets the duration value for this VpaidLinearCreative.

Returns:

duration * Duration in milliseconds for the vpaid ad given no user interaction. This attribute is optional.

setDuration

public void setDuration(Integer duration)

Sets the duration value for this VpaidLinearCreative.

Parameters:

duration - * Duration in milliseconds for the vpaid ad given no user interaction. This attribute is optional.

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