com.google.api.ads.admanager.axis.v202002

Class ImageOverlayCreative

java.lang.Object

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

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

com.google.api.ads.admanager.axis.v202002.BaseImageCreative

com.google.api.ads.admanager.axis.v202002.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 prior to v201705.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImageOverlayCreative()
ImageOverlayCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, CreativePolicyViolation[] policyViolations, CreativePolicyViolation[] policyLabels, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues, String destinationUrl, DestinationUrlType destinationUrlType, Boolean overrideSize, CreativeAsset primaryImageAsset, long[] companionCreativeIds, ConversionEvent_TrackingUrlsMapEntry[] trackingUrls, LockedOrientation lockedOrientation, String customParameters, Integer duration, String vastPreviewUrl)

Method Summary

Modifier and Type	Method and Description
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.
LockedOrientation	getLockedOrientation() Gets the lockedOrientation 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
String	getVastPreviewUrl() Gets the vastPreviewUrl value for this ImageOverlayCreative.
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	setLockedOrientation(LockedOrientation lockedOrientation) Sets the lockedOrientation value for this ImageOverlayCreative.
void	setTrackingUrls(ConversionEvent_TrackingUrlsMapEntry[] trackingUrls) Sets the trackingUrls value for this ImageOverlayCreative.
void	setTrackingUrls(int i, ConversionEvent_TrackingUrlsMapEntry _value)
void	setVastPreviewUrl(String vastPreviewUrl) Sets the vastPreviewUrl value for this ImageOverlayCreative.
String	toString()

Methods inherited from class com.google.api.ads.admanager.axis.v202002.BaseImageCreative

getOverrideSize, getPrimaryImageAsset, setOverrideSize, setPrimaryImageAsset

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

getDestinationUrl, getDestinationUrlType, setDestinationUrl, setDestinationUrlType

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

ImageOverlayCreative

public ImageOverlayCreative()

ImageOverlayCreative

public ImageOverlayCreative(Long advertiserId,
                            Long id,
                            String name,
                            Size size,
                            String previewUrl,
                            CreativePolicyViolation[] policyViolations,
                            CreativePolicyViolation[] policyLabels,
                            AppliedLabel[] appliedLabels,
                            DateTime lastModifiedDateTime,
                            BaseCustomFieldValue[] customFieldValues,
                            String destinationUrl,
                            DestinationUrlType destinationUrlType,
                            Boolean overrideSize,
                            CreativeAsset primaryImageAsset,
                            long[] companionCreativeIds,
                            ConversionEvent_TrackingUrlsMapEntry[] trackingUrls,
                            LockedOrientation lockedOrientation,
                            String customParameters,
                            Integer duration,
                            String vastPreviewUrl)

Method Detail

toString

public String toString()

Overrides:

toString in class BaseImageCreative

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. This attribute is read-only.

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. This attribute is read-only.

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)

getLockedOrientation

public LockedOrientation getLockedOrientation()

Gets the lockedOrientation value for this ImageOverlayCreative.

Returns:

lockedOrientation * A locked orientation for this creative to be displayed in.

setLockedOrientation

public void setLockedOrientation(LockedOrientation lockedOrientation)

Sets the lockedOrientation value for this ImageOverlayCreative.

Parameters:

lockedOrientation - * A locked orientation for this creative to be displayed in.

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.

getVastPreviewUrl

public String getVastPreviewUrl()

Gets the vastPreviewUrl value for this ImageOverlayCreative.

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

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