com.google.api.ads.dfp.axis.v201206
Class ImageOverlayCreative

java.lang.Object
  com.google.api.ads.dfp.axis.v201206.Creative
      com.google.api.ads.dfp.axis.v201206.HasDestinationUrlCreative
          com.google.api.ads.dfp.axis.v201206.BaseImageCreative
              com.google.api.ads.dfp.axis.v201206.ImageOverlayCreative

All Implemented Interfaces:

Serializable

public class ImageOverlayCreative
extends BaseImageCreative
implements Serializable

An overlay Creative that displays an image 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

ImageOverlayCreative()

ImageOverlayCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues, String creativeType, String destinationUrl, String imageName, byte[] imageByteArray, Boolean overrideSize, Size assetSize, String imageUrl, long[] companionCreativeIds, ConversionEvent_TrackingUrlsMapEntry[] trackingUrls, String customParameters, Integer duration)

Method Summary

boolean	equals(Object obj)
long[]	getCompanionCreativeIds() Gets the companionCreativeIds value for this ImageOverlayCreative.
long	getCompanionCreativeIds(int i)
String	getCustomParameters() Gets the customParameters value for this ImageOverlayCreative.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Integer	getDuration() Gets the duration value for this ImageOverlayCreative.
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 ImageOverlayCreative.
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 ImageOverlayCreative.
void	setCustomParameters(String customParameters) Sets the customParameters value for this ImageOverlayCreative.
void	setDuration(Integer duration) Sets the duration value for this ImageOverlayCreative.
void	setTrackingUrls(ConversionEvent_TrackingUrlsMapEntry[] trackingUrls) Sets the trackingUrls value for this ImageOverlayCreative.
void	setTrackingUrls(int i, ConversionEvent_TrackingUrlsMapEntry _value)

Methods inherited from class com.google.api.ads.dfp.axis.v201206.BaseImageCreative

getAssetSize, getImageByteArray, getImageName, getImageUrl, getOverrideSize, setAssetSize, setImageByteArray, setImageName, setImageUrl, setOverrideSize

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

getDestinationUrl, setDestinationUrl

Methods inherited from class com.google.api.ads.dfp.axis.v201206.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

ImageOverlayCreative

public ImageOverlayCreative()

ImageOverlayCreative

public ImageOverlayCreative(Long advertiserId,
                            Long id,
                            String name,
                            Size size,
                            String previewUrl,
                            AppliedLabel[] appliedLabels,
                            DateTime lastModifiedDateTime,
                            BaseCustomFieldValue[] customFieldValues,
                            String creativeType,
                            String destinationUrl,
                            String imageName,
                            byte[] imageByteArray,
                            Boolean overrideSize,
                            Size assetSize,
                            String imageUrl,
                            long[] companionCreativeIds,
                            ConversionEvent_TrackingUrlsMapEntry[] trackingUrls,
                            String customParameters,
                            Integer duration)

Method Detail

getCompanionCreativeIds

public long[] getCompanionCreativeIds()

Gets the companionCreativeIds value for this ImageOverlayCreative.

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

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

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

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

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

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.

getDuration

public Integer getDuration()

Gets the duration value for this ImageOverlayCreative.

Returns:

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

setDuration

public void setDuration(Integer duration)

Sets the duration value for this ImageOverlayCreative.

Parameters:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class BaseImageCreative

hashCode

public int hashCode()

Overrides:

hashCode in class BaseImageCreative

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