com.google.api.ads.dfp.axis.v201302

Class FloatingFlashCreative

java.lang.Object

com.google.api.ads.dfp.axis.v201302.Creative

com.google.api.ads.dfp.axis.v201302.HasDestinationUrlCreative

com.google.api.ads.dfp.axis.v201302.FloatingFlashCreative

All Implemented Interfaces:

Serializable

public class FloatingFlashCreative
extends HasDestinationUrlCreative
implements Serializable

A floating flash creative. This creative is an interstitial creative, and its Creative.size must be 1x1.

This creative will not work with iframe ad tags.

This creative is only available to small business networks. Starting in version v201306 this will be returned as a TemplateCreative identified with a TemplateCreative.creativeTemplateId of 10000560.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FloatingFlashCreative()
FloatingFlashCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues, String creativeType, String destinationUrl, String flashName, byte[] flashByteArray, Long flashAssetId, String fallbackImageName, byte[] fallbackImageByteArray, Long fallbackImageAssetId, Integer requiredFlashVersion, Integer width, Integer height, String topPosition, String leftPosition, Integer displayTimeInSecond, String thirdPartyImpressionTracker)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Integer	getDisplayTimeInSecond() Gets the displayTimeInSecond value for this FloatingFlashCreative.
Long	getFallbackImageAssetId() Gets the fallbackImageAssetId value for this FloatingFlashCreative.
byte[]	getFallbackImageByteArray() Gets the fallbackImageByteArray value for this FloatingFlashCreative.
String	getFallbackImageName() Gets the fallbackImageName value for this FloatingFlashCreative.
Long	getFlashAssetId() Gets the flashAssetId value for this FloatingFlashCreative.
byte[]	getFlashByteArray() Gets the flashByteArray value for this FloatingFlashCreative.
String	getFlashName() Gets the flashName value for this FloatingFlashCreative.
Integer	getHeight() Gets the height value for this FloatingFlashCreative.
String	getLeftPosition() Gets the leftPosition value for this FloatingFlashCreative.
Integer	getRequiredFlashVersion() Gets the requiredFlashVersion value for this FloatingFlashCreative.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
String	getThirdPartyImpressionTracker() Gets the thirdPartyImpressionTracker value for this FloatingFlashCreative.
String	getTopPosition() Gets the topPosition value for this FloatingFlashCreative.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
Integer	getWidth() Gets the width value for this FloatingFlashCreative.
int	hashCode()
void	setDisplayTimeInSecond(Integer displayTimeInSecond) Sets the displayTimeInSecond value for this FloatingFlashCreative.
void	setFallbackImageAssetId(Long fallbackImageAssetId) Sets the fallbackImageAssetId value for this FloatingFlashCreative.
void	setFallbackImageByteArray(byte[] fallbackImageByteArray) Sets the fallbackImageByteArray value for this FloatingFlashCreative.
void	setFallbackImageName(String fallbackImageName) Sets the fallbackImageName value for this FloatingFlashCreative.
void	setFlashAssetId(Long flashAssetId) Sets the flashAssetId value for this FloatingFlashCreative.
void	setFlashByteArray(byte[] flashByteArray) Sets the flashByteArray value for this FloatingFlashCreative.
void	setFlashName(String flashName) Sets the flashName value for this FloatingFlashCreative.
void	setHeight(Integer height) Sets the height value for this FloatingFlashCreative.
void	setLeftPosition(String leftPosition) Sets the leftPosition value for this FloatingFlashCreative.
void	setRequiredFlashVersion(Integer requiredFlashVersion) Sets the requiredFlashVersion value for this FloatingFlashCreative.
void	setThirdPartyImpressionTracker(String thirdPartyImpressionTracker) Sets the thirdPartyImpressionTracker value for this FloatingFlashCreative.
void	setTopPosition(String topPosition) Sets the topPosition value for this FloatingFlashCreative.
void	setWidth(Integer width) Sets the width value for this FloatingFlashCreative.

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

getDestinationUrl, setDestinationUrl

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

FloatingFlashCreative

public FloatingFlashCreative()

FloatingFlashCreative

public FloatingFlashCreative(Long advertiserId,
                     Long id,
                     String name,
                     Size size,
                     String previewUrl,
                     AppliedLabel[] appliedLabels,
                     DateTime lastModifiedDateTime,
                     BaseCustomFieldValue[] customFieldValues,
                     String creativeType,
                     String destinationUrl,
                     String flashName,
                     byte[] flashByteArray,
                     Long flashAssetId,
                     String fallbackImageName,
                     byte[] fallbackImageByteArray,
                     Long fallbackImageAssetId,
                     Integer requiredFlashVersion,
                     Integer width,
                     Integer height,
                     String topPosition,
                     String leftPosition,
                     Integer displayTimeInSecond,
                     String thirdPartyImpressionTracker)

Method Detail

getFlashName

public String getFlashName()

Gets the flashName value for this FloatingFlashCreative.

Returns:

flashName * The file name of the Flash asset. This attribute is required when creating a new asset (e.g. when flashByteArray is not null).

setFlashName

public void setFlashName(String flashName)

Sets the flashName value for this FloatingFlashCreative.

Parameters:

flashName - * The file name of the Flash asset. This attribute is required when creating a new asset (e.g. when flashByteArray is not null).

getFlashByteArray

public byte[] getFlashByteArray()

Gets the flashByteArray value for this FloatingFlashCreative.

Returns:

flashByteArray * The content of the Flash asset as a byte array. This attribute is required when creating a new FloatingFlashCreative.

When updating the content, pass a new byte array, and set flashAssetId to null. Otherwise, this field can be null and will not be updated.

The flashByteArray will be null when the FloatingFlashCreative is retrieved.

setFlashByteArray

public void setFlashByteArray(byte[] flashByteArray)

Sets the flashByteArray value for this FloatingFlashCreative.

Parameters:

flashByteArray - * The content of the Flash asset as a byte array. This attribute is required when creating a new FloatingFlashCreative.

When updating the content, pass a new byte array, and set flashAssetId to null. Otherwise, this field can be null and will not be updated.

The flashByteArray will be null when the FloatingFlashCreative is retrieved.

getFlashAssetId

public Long getFlashAssetId()

Gets the flashAssetId value for this FloatingFlashCreative.

Returns:

flashAssetId * The ID of the Flash asset. This attribute is read-only and is populated by Google.

setFlashAssetId

public void setFlashAssetId(Long flashAssetId)

Sets the flashAssetId value for this FloatingFlashCreative.

Parameters:

flashAssetId - * The ID of the Flash asset. This attribute is read-only and is populated by Google.

getFallbackImageName

public String getFallbackImageName()

Gets the fallbackImageName value for this FloatingFlashCreative.

Returns:

fallbackImageName * The file name of the fallback image asset. This attribute is required when creating a new asset (e.g. when fallbackImageByteArray is not null).

setFallbackImageName

public void setFallbackImageName(String fallbackImageName)

Sets the fallbackImageName value for this FloatingFlashCreative.

Parameters:

fallbackImageName - * The file name of the fallback image asset. This attribute is required when creating a new asset (e.g. when fallbackImageByteArray is not null).

getFallbackImageByteArray

public byte[] getFallbackImageByteArray()

Gets the fallbackImageByteArray value for this FloatingFlashCreative.

Returns:

fallbackImageByteArray * The content of the fallback image asset as a byte array. This attribute is required when creating a new FloatingFlashCreative.

When updating the content, pass a new byte array, and set fallbackImageAssetId to null. Otherwise, this field can be null and will not be updated.

The fallbackImageByteArray will be null when the FloatingFlashCreative is retrieved.

setFallbackImageByteArray

public void setFallbackImageByteArray(byte[] fallbackImageByteArray)

Sets the fallbackImageByteArray value for this FloatingFlashCreative.

Parameters:

fallbackImageByteArray - * The content of the fallback image asset as a byte array. This attribute is required when creating a new FloatingFlashCreative.

When updating the content, pass a new byte array, and set fallbackImageAssetId to null. Otherwise, this field can be null and will not be updated.

The fallbackImageByteArray will be null when the FloatingFlashCreative is retrieved.

getFallbackImageAssetId

public Long getFallbackImageAssetId()

Gets the fallbackImageAssetId value for this FloatingFlashCreative.

Returns:

fallbackImageAssetId * The ID of the fallback image asset. This attribute is read-only and is populated by Google.

setFallbackImageAssetId

public void setFallbackImageAssetId(Long fallbackImageAssetId)

Sets the fallbackImageAssetId value for this FloatingFlashCreative.

Parameters:

fallbackImageAssetId - * The ID of the fallback image asset. This attribute is read-only and is populated by Google.

getRequiredFlashVersion

public Integer getRequiredFlashVersion()

Gets the requiredFlashVersion value for this FloatingFlashCreative.

Returns:

requiredFlashVersion * The minimum version of Flash player required to properly display the flash file. This attribute is optional and defaults to 8.

setRequiredFlashVersion

public void setRequiredFlashVersion(Integer requiredFlashVersion)

Sets the requiredFlashVersion value for this FloatingFlashCreative.

Parameters:

requiredFlashVersion - * The minimum version of Flash player required to properly display the flash file. This attribute is optional and defaults to 8.

getWidth

public Integer getWidth()

Gets the width value for this FloatingFlashCreative.

Returns:

width * The width of the Flash in pixels when this creative is shown. This attribute is required.

setWidth

public void setWidth(Integer width)

Sets the width value for this FloatingFlashCreative.

Parameters:

width - * The width of the Flash in pixels when this creative is shown. This attribute is required.

getHeight

public Integer getHeight()

Gets the height value for this FloatingFlashCreative.

Returns:

height * The height of the Flash in pixels when this creative is shown. This attribute is required.

setHeight

public void setHeight(Integer height)

Sets the height value for this FloatingFlashCreative.

Parameters:

height - * The height of the Flash in pixels when this creative is shown. This attribute is required.

getTopPosition

public String getTopPosition()

Gets the topPosition value for this FloatingFlashCreative.

Returns:

topPosition * The position of the creative, in pixels, from the top edge of your web page (e.g. "100"), or "centered" to center the creative. This attribute is optional and defaults to "centered".

setTopPosition

public void setTopPosition(String topPosition)

Sets the topPosition value for this FloatingFlashCreative.

Parameters:

topPosition - * The position of the creative, in pixels, from the top edge of your web page (e.g. "100"), or "centered" to center the creative. This attribute is optional and defaults to "centered".

getLeftPosition

public String getLeftPosition()

Gets the leftPosition value for this FloatingFlashCreative.

Returns:

leftPosition * The position of the creative, in pixels, from the left edge of your web page (e.g. "100"), or "centered" to center the creative. This attribute is optional and defaults to "centered".

setLeftPosition

public void setLeftPosition(String leftPosition)

Sets the leftPosition value for this FloatingFlashCreative.

Parameters:

leftPosition - * The position of the creative, in pixels, from the left edge of your web page (e.g. "100"), or "centered" to center the creative. This attribute is optional and defaults to "centered".

getDisplayTimeInSecond

public Integer getDisplayTimeInSecond()

Gets the displayTimeInSecond value for this FloatingFlashCreative.

Returns:

displayTimeInSecond * Indicates how long the creative should remain visible, in seconds. This attribute is optional and defaults to 60 seconds.

setDisplayTimeInSecond

public void setDisplayTimeInSecond(Integer displayTimeInSecond)

Sets the displayTimeInSecond value for this FloatingFlashCreative.

Parameters:

displayTimeInSecond - * Indicates how long the creative should remain visible, in seconds. This attribute is optional and defaults to 60 seconds.

getThirdPartyImpressionTracker

public String getThirdPartyImpressionTracker()

Gets the thirdPartyImpressionTracker value for this FloatingFlashCreative.

Returns:

thirdPartyImpressionTracker * Third party impression tracking URL. This URL can call an image or HTML code. This attribute is optional.

setThirdPartyImpressionTracker

public void setThirdPartyImpressionTracker(String thirdPartyImpressionTracker)

Sets the thirdPartyImpressionTracker value for this FloatingFlashCreative.

Parameters:

thirdPartyImpressionTracker - * Third party impression tracking URL. This URL can call an image or HTML code. 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