com.google.api.ads.admanager.axis.v201808

Class ImageRedirectOverlayCreative

java.lang.Object

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

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

com.google.api.ads.admanager.axis.v201808.BaseImageRedirectCreative

com.google.api.ads.admanager.axis.v201808.ImageRedirectOverlayCreative

All Implemented Interfaces:

Serializable

public class ImageRedirectOverlayCreative
extends BaseImageRedirectCreative
implements Serializable

An overlay Creative that loads an image asset from a specified URL and is served via VAST 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
ImageRedirectOverlayCreative()
ImageRedirectOverlayCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, CreativePolicyViolation[] policyViolations, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues, String destinationUrl, DestinationUrlType destinationUrlType, String imageUrl, Size assetSize, Integer duration, long[] companionCreativeIds, ConversionEvent_TrackingUrlsMapEntry[] trackingUrls, String customParameters, String vastPreviewUrl)

Method Summary

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

Methods inherited from class com.google.api.ads.admanager.axis.v201808.BaseImageRedirectCreative

getImageUrl, setImageUrl

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

getDestinationUrl, getDestinationUrlType, setDestinationUrl, setDestinationUrlType

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageRedirectOverlayCreative

public ImageRedirectOverlayCreative()

ImageRedirectOverlayCreative

public ImageRedirectOverlayCreative(Long advertiserId,
                                    Long id,
                                    String name,
                                    Size size,
                                    String previewUrl,
                                    CreativePolicyViolation[] policyViolations,
                                    AppliedLabel[] appliedLabels,
                                    DateTime lastModifiedDateTime,
                                    BaseCustomFieldValue[] customFieldValues,
                                    String destinationUrl,
                                    DestinationUrlType destinationUrlType,
                                    String imageUrl,
                                    Size assetSize,
                                    Integer duration,
                                    long[] companionCreativeIds,
                                    ConversionEvent_TrackingUrlsMapEntry[] trackingUrls,
                                    String customParameters,
                                    String vastPreviewUrl)

Method Detail

toString

public String toString()

Overrides:

toString in class BaseImageRedirectCreative

getAssetSize

public Size getAssetSize()

Gets the assetSize value for this ImageRedirectOverlayCreative.

Returns:

assetSize * The size of the image 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.

setAssetSize

public void setAssetSize(Size assetSize)

Sets the assetSize value for this ImageRedirectOverlayCreative.

Parameters:

assetSize - * The size of the image 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.

getDuration

public Integer getDuration()

Gets the duration value for this ImageRedirectOverlayCreative.

Returns:

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

setDuration

public void setDuration(Integer duration)

Sets the duration value for this ImageRedirectOverlayCreative.

Parameters:

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

getCompanionCreativeIds

public long[] getCompanionCreativeIds()

Gets the companionCreativeIds value for this ImageRedirectOverlayCreative.

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

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

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

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

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

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.

getVastPreviewUrl

public String getVastPreviewUrl()

Gets the vastPreviewUrl value for this ImageRedirectOverlayCreative.

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

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 BaseImageRedirectCreative

hashCode

public int hashCode()

Overrides:

hashCode in class BaseImageRedirectCreative

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