com.google.api.ads.dfp.jaxws.v201708

Class ImageOverlayCreative

java.lang.Object

com.google.api.ads.dfp.jaxws.v201708.Creative

com.google.api.ads.dfp.jaxws.v201708.HasDestinationUrlCreative

com.google.api.ads.dfp.jaxws.v201708.BaseImageCreative

com.google.api.ads.dfp.jaxws.v201708.ImageOverlayCreative

public class ImageOverlayCreative
extends BaseImageCreative

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.

Java class for ImageOverlayCreative complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ImageOverlayCreative">
   <complexContent>
     <extension base="{https://www.google.com/apis/ads/publisher/v201708}BaseImageCreative">
       <sequence>
         <element name="companionCreativeIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
         <element name="trackingUrls" type="{https://www.google.com/apis/ads/publisher/v201708}ConversionEvent_TrackingUrlsMapEntry" maxOccurs="unbounded" minOccurs="0"/>
         <element name="lockedOrientation" type="{https://www.google.com/apis/ads/publisher/v201708}LockedOrientation" minOccurs="0"/>
         <element name="customParameters" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="duration" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="vastPreviewUrl" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Long>	companionCreativeIds
protected String	customParameters
protected Integer	duration
protected LockedOrientation	lockedOrientation
protected List<ConversionEventTrackingUrlsMapEntry>	trackingUrls
protected String	vastPreviewUrl

Fields inherited from class com.google.api.ads.dfp.jaxws.v201708.BaseImageCreative

overrideSize, primaryImageAsset

Fields inherited from class com.google.api.ads.dfp.jaxws.v201708.HasDestinationUrlCreative

destinationUrl, destinationUrlType

Fields inherited from class com.google.api.ads.dfp.jaxws.v201708.Creative

advertiserId, appliedLabels, customFieldValues, id, lastModifiedDateTime, name, policyViolations, previewUrl, size

Constructor Summary

Constructors

Constructor and Description
ImageOverlayCreative()

Method Summary

Modifier and Type	Method and Description
List<Long>	getCompanionCreativeIds() Gets the value of the companionCreativeIds property.
String	getCustomParameters() Gets the value of the customParameters property.
Integer	getDuration() Gets the value of the duration property.
LockedOrientation	getLockedOrientation() Gets the value of the lockedOrientation property.
List<ConversionEventTrackingUrlsMapEntry>	getTrackingUrls() Gets the value of the trackingUrls property.
String	getVastPreviewUrl() Gets the value of the vastPreviewUrl property.
void	setCustomParameters(String value) Sets the value of the customParameters property.
void	setDuration(Integer value) Sets the value of the duration property.
void	setLockedOrientation(LockedOrientation value) Sets the value of the lockedOrientation property.
void	setVastPreviewUrl(String value) Sets the value of the vastPreviewUrl property.

Methods inherited from class com.google.api.ads.dfp.jaxws.v201708.BaseImageCreative

getPrimaryImageAsset, isOverrideSize, setOverrideSize, setPrimaryImageAsset

Methods inherited from class com.google.api.ads.dfp.jaxws.v201708.HasDestinationUrlCreative

getDestinationUrl, getDestinationUrlType, setDestinationUrl, setDestinationUrlType

Methods inherited from class com.google.api.ads.dfp.jaxws.v201708.Creative

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

Methods inherited from class java.lang.Object

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

Field Detail

companionCreativeIds

protected List<Long> companionCreativeIds

trackingUrls

protected List<ConversionEventTrackingUrlsMapEntry> trackingUrls

lockedOrientation

protected LockedOrientation lockedOrientation

customParameters

protected String customParameters

duration

protected Integer duration

vastPreviewUrl

protected String vastPreviewUrl

Constructor Detail

ImageOverlayCreative

public ImageOverlayCreative()

Method Detail

getCompanionCreativeIds

public List<Long> getCompanionCreativeIds()

Gets the value of the companionCreativeIds property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the companionCreativeIds property.

For example, to add a new item, do as follows:

    getCompanionCreativeIds().add(newItem);
 

Objects of the following type(s) are allowed in the list Long

getTrackingUrls

public List<ConversionEventTrackingUrlsMapEntry> getTrackingUrls()

Gets the value of the trackingUrls property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the trackingUrls property.

For example, to add a new item, do as follows:

    getTrackingUrls().add(newItem);
 

Objects of the following type(s) are allowed in the list ConversionEventTrackingUrlsMapEntry

getLockedOrientation

public LockedOrientation getLockedOrientation()

Gets the value of the lockedOrientation property.

Returns:

possible object is LockedOrientation

setLockedOrientation

public void setLockedOrientation(LockedOrientation value)

Sets the value of the lockedOrientation property.

Parameters:

value - allowed object is LockedOrientation

getCustomParameters

public String getCustomParameters()

Gets the value of the customParameters property.

Returns:

possible object is String

setCustomParameters

public void setCustomParameters(String value)

Sets the value of the customParameters property.

Parameters:

value - allowed object is String

getDuration

public Integer getDuration()

Gets the value of the duration property.

Returns:

possible object is Integer

setDuration

public void setDuration(Integer value)

Sets the value of the duration property.

Parameters:

value - allowed object is Integer

getVastPreviewUrl

public String getVastPreviewUrl()

Gets the value of the vastPreviewUrl property.

Returns:

possible object is String

setVastPreviewUrl

public void setVastPreviewUrl(String value)

Sets the value of the vastPreviewUrl property.

Parameters:

value - allowed object is String