com.google.api.ads.dfp.axis.v201203
Class FlashPushdownCreative

java.lang.Object
  com.google.api.ads.dfp.axis.v201203.Creative
      com.google.api.ads.dfp.axis.v201203.HasDestinationUrlCreative
          com.google.api.ads.dfp.axis.v201203.FlashPushdownCreative

All Implemented Interfaces:

Serializable

public class FlashPushdownCreative
extends HasDestinationUrlCreative
implements Serializable

Creative that pushes page content down when the creative expands. The collapsed size is one Flash SWF file and the expanded size is another Flash SWF file.

This creative will not work with iframe ad tags.

This creative is only available to small business networks.

See Also:

Serialized Form

Constructor Summary

FlashPushdownCreative()

FlashPushdownCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, String creativeType, String destinationUrl, Long collapsedFlashAssetId, byte[] collapsedFlashAssetByteArray, String collapsedFlashFileName, Long collapsedFallbackImageAssetId, byte[] collapsedFallbackImageAssetByteArray, String collapsedFallbackImageFileName, Long expandedFlashAssetId, byte[] expandedFlashAssetByteArray, String expandedFlashFileName, Integer requiredFlashVersion, Integer width, Integer collapsedHeight, Integer expandedHeight, Boolean pushdownOnMouseOver, String javascriptFunctionForPushdown, Boolean collapseOnMouseOut, String javascriptFunctionForCollapse)

Method Summary

boolean	equals(Object obj)
byte[]	getCollapsedFallbackImageAssetByteArray() Gets the collapsedFallbackImageAssetByteArray value for this FlashPushdownCreative.
Long	getCollapsedFallbackImageAssetId() Gets the collapsedFallbackImageAssetId value for this FlashPushdownCreative.
String	getCollapsedFallbackImageFileName() Gets the collapsedFallbackImageFileName value for this FlashPushdownCreative.
byte[]	getCollapsedFlashAssetByteArray() Gets the collapsedFlashAssetByteArray value for this FlashPushdownCreative.
Long	getCollapsedFlashAssetId() Gets the collapsedFlashAssetId value for this FlashPushdownCreative.
String	getCollapsedFlashFileName() Gets the collapsedFlashFileName value for this FlashPushdownCreative.
Integer	getCollapsedHeight() Gets the collapsedHeight value for this FlashPushdownCreative.
Boolean	getCollapseOnMouseOut() Gets the collapseOnMouseOut value for this FlashPushdownCreative.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
byte[]	getExpandedFlashAssetByteArray() Gets the expandedFlashAssetByteArray value for this FlashPushdownCreative.
Long	getExpandedFlashAssetId() Gets the expandedFlashAssetId value for this FlashPushdownCreative.
String	getExpandedFlashFileName() Gets the expandedFlashFileName value for this FlashPushdownCreative.
Integer	getExpandedHeight() Gets the expandedHeight value for this FlashPushdownCreative.
String	getJavascriptFunctionForCollapse() Gets the javascriptFunctionForCollapse value for this FlashPushdownCreative.
String	getJavascriptFunctionForPushdown() Gets the javascriptFunctionForPushdown value for this FlashPushdownCreative.
Boolean	getPushdownOnMouseOver() Gets the pushdownOnMouseOver value for this FlashPushdownCreative.
Integer	getRequiredFlashVersion() Gets the requiredFlashVersion value for this FlashPushdownCreative.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
Integer	getWidth() Gets the width value for this FlashPushdownCreative.
int	hashCode()
void	setCollapsedFallbackImageAssetByteArray(byte[] collapsedFallbackImageAssetByteArray) Sets the collapsedFallbackImageAssetByteArray value for this FlashPushdownCreative.
void	setCollapsedFallbackImageAssetId(Long collapsedFallbackImageAssetId) Sets the collapsedFallbackImageAssetId value for this FlashPushdownCreative.
void	setCollapsedFallbackImageFileName(String collapsedFallbackImageFileName) Sets the collapsedFallbackImageFileName value for this FlashPushdownCreative.
void	setCollapsedFlashAssetByteArray(byte[] collapsedFlashAssetByteArray) Sets the collapsedFlashAssetByteArray value for this FlashPushdownCreative.
void	setCollapsedFlashAssetId(Long collapsedFlashAssetId) Sets the collapsedFlashAssetId value for this FlashPushdownCreative.
void	setCollapsedFlashFileName(String collapsedFlashFileName) Sets the collapsedFlashFileName value for this FlashPushdownCreative.
void	setCollapsedHeight(Integer collapsedHeight) Sets the collapsedHeight value for this FlashPushdownCreative.
void	setCollapseOnMouseOut(Boolean collapseOnMouseOut) Sets the collapseOnMouseOut value for this FlashPushdownCreative.
void	setExpandedFlashAssetByteArray(byte[] expandedFlashAssetByteArray) Sets the expandedFlashAssetByteArray value for this FlashPushdownCreative.
void	setExpandedFlashAssetId(Long expandedFlashAssetId) Sets the expandedFlashAssetId value for this FlashPushdownCreative.
void	setExpandedFlashFileName(String expandedFlashFileName) Sets the expandedFlashFileName value for this FlashPushdownCreative.
void	setExpandedHeight(Integer expandedHeight) Sets the expandedHeight value for this FlashPushdownCreative.
void	setJavascriptFunctionForCollapse(String javascriptFunctionForCollapse) Sets the javascriptFunctionForCollapse value for this FlashPushdownCreative.
void	setJavascriptFunctionForPushdown(String javascriptFunctionForPushdown) Sets the javascriptFunctionForPushdown value for this FlashPushdownCreative.
void	setPushdownOnMouseOver(Boolean pushdownOnMouseOver) Sets the pushdownOnMouseOver value for this FlashPushdownCreative.
void	setRequiredFlashVersion(Integer requiredFlashVersion) Sets the requiredFlashVersion value for this FlashPushdownCreative.
void	setWidth(Integer width) Sets the width value for this FlashPushdownCreative.

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

getDestinationUrl, setDestinationUrl

Methods inherited from class com.google.api.ads.dfp.axis.v201203.Creative

getAdvertiserId, getAppliedLabels, getAppliedLabels, getCreativeType, getId, getLastModifiedDateTime, getName, getPreviewUrl, getSize, setAdvertiserId, setAppliedLabels, setAppliedLabels, setCreativeType, setId, setLastModifiedDateTime, setName, setPreviewUrl, setSize

Methods inherited from class java.lang.Object

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

Constructor Detail

FlashPushdownCreative

public FlashPushdownCreative()

FlashPushdownCreative

public FlashPushdownCreative(Long advertiserId,
                             Long id,
                             String name,
                             Size size,
                             String previewUrl,
                             AppliedLabel[] appliedLabels,
                             DateTime lastModifiedDateTime,
                             String creativeType,
                             String destinationUrl,
                             Long collapsedFlashAssetId,
                             byte[] collapsedFlashAssetByteArray,
                             String collapsedFlashFileName,
                             Long collapsedFallbackImageAssetId,
                             byte[] collapsedFallbackImageAssetByteArray,
                             String collapsedFallbackImageFileName,
                             Long expandedFlashAssetId,
                             byte[] expandedFlashAssetByteArray,
                             String expandedFlashFileName,
                             Integer requiredFlashVersion,
                             Integer width,
                             Integer collapsedHeight,
                             Integer expandedHeight,
                             Boolean pushdownOnMouseOver,
                             String javascriptFunctionForPushdown,
                             Boolean collapseOnMouseOut,
                             String javascriptFunctionForCollapse)

Method Detail

getCollapsedFlashAssetId

public Long getCollapsedFlashAssetId()

Gets the collapsedFlashAssetId value for this FlashPushdownCreative.

Returns:

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

setCollapsedFlashAssetId

public void setCollapsedFlashAssetId(Long collapsedFlashAssetId)

Sets the collapsedFlashAssetId value for this FlashPushdownCreative.

Parameters:

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

getCollapsedFlashAssetByteArray

public byte[] getCollapsedFlashAssetByteArray()

Gets the collapsedFlashAssetByteArray value for this FlashPushdownCreative.

Returns:

collapsedFlashAssetByteArray * The content of the collapsed Flash asset as a byte array. This attribute is required when creating a new FlashPushdownCreative.

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

The collapsedFlashAssetByteArray will be null when the FlashPushdownCreative is retrieved.

setCollapsedFlashAssetByteArray

public void setCollapsedFlashAssetByteArray(byte[] collapsedFlashAssetByteArray)

Sets the collapsedFlashAssetByteArray value for this FlashPushdownCreative.

Parameters:

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

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

The collapsedFlashAssetByteArray will be null when the FlashPushdownCreative is retrieved.

getCollapsedFlashFileName

public String getCollapsedFlashFileName()

Gets the collapsedFlashFileName value for this FlashPushdownCreative.

Returns:

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

setCollapsedFlashFileName

public void setCollapsedFlashFileName(String collapsedFlashFileName)

Sets the collapsedFlashFileName value for this FlashPushdownCreative.

Parameters:

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

getCollapsedFallbackImageAssetId

public Long getCollapsedFallbackImageAssetId()

Gets the collapsedFallbackImageAssetId value for this FlashPushdownCreative.

Returns:

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

setCollapsedFallbackImageAssetId

public void setCollapsedFallbackImageAssetId(Long collapsedFallbackImageAssetId)

Sets the collapsedFallbackImageAssetId value for this FlashPushdownCreative.

Parameters:

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

getCollapsedFallbackImageAssetByteArray

public byte[] getCollapsedFallbackImageAssetByteArray()

Gets the collapsedFallbackImageAssetByteArray value for this FlashPushdownCreative.

Returns:

collapsedFallbackImageAssetByteArray * The content of the collapsed fallback image as a byte array. This attribute is required when creating a new FlashPushdownCreative.

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

The collapsedFallbackImageAssetByteArray will be null when the FlashPushdownCreative is retrieved.

setCollapsedFallbackImageAssetByteArray

public void setCollapsedFallbackImageAssetByteArray(byte[] collapsedFallbackImageAssetByteArray)

Sets the collapsedFallbackImageAssetByteArray value for this FlashPushdownCreative.

Parameters:

collapsedFallbackImageAssetByteArray - * The content of the collapsed fallback image as a byte array. This attribute is required when creating a new FlashPushdownCreative.

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

The collapsedFallbackImageAssetByteArray will be null when the FlashPushdownCreative is retrieved.

getCollapsedFallbackImageFileName

public String getCollapsedFallbackImageFileName()

Gets the collapsedFallbackImageFileName value for this FlashPushdownCreative.

Returns:

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

setCollapsedFallbackImageFileName

public void setCollapsedFallbackImageFileName(String collapsedFallbackImageFileName)

Sets the collapsedFallbackImageFileName value for this FlashPushdownCreative.

Parameters:

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

getExpandedFlashAssetId

public Long getExpandedFlashAssetId()

Gets the expandedFlashAssetId value for this FlashPushdownCreative.

Returns:

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

setExpandedFlashAssetId

public void setExpandedFlashAssetId(Long expandedFlashAssetId)

Sets the expandedFlashAssetId value for this FlashPushdownCreative.

Parameters:

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

getExpandedFlashAssetByteArray

public byte[] getExpandedFlashAssetByteArray()

Gets the expandedFlashAssetByteArray value for this FlashPushdownCreative.

Returns:

expandedFlashAssetByteArray * The content of the expanded Flash as a byte array. This attribute is required when creating a new FlashPushdownCreative.

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

The expandedFlashAssetByteArray will be null when the FlashPushdownCreative is retrieved.

setExpandedFlashAssetByteArray

public void setExpandedFlashAssetByteArray(byte[] expandedFlashAssetByteArray)

Sets the expandedFlashAssetByteArray value for this FlashPushdownCreative.

Parameters:

expandedFlashAssetByteArray - * The content of the expanded Flash as a byte array. This attribute is required when creating a new FlashPushdownCreative.

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

The expandedFlashAssetByteArray will be null when the FlashPushdownCreative is retrieved.

getExpandedFlashFileName

public String getExpandedFlashFileName()

Gets the expandedFlashFileName value for this FlashPushdownCreative.

Returns:

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

setExpandedFlashFileName

public void setExpandedFlashFileName(String expandedFlashFileName)

Sets the expandedFlashFileName value for this FlashPushdownCreative.

Parameters:

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

getRequiredFlashVersion

public Integer getRequiredFlashVersion()

Gets the requiredFlashVersion value for this FlashPushdownCreative.

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

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

Returns:

width * The width of the creative in pixels. This attribute is required.

setWidth

public void setWidth(Integer width)

Sets the width value for this FlashPushdownCreative.

Parameters:

width - * The width of the creative in pixels. This attribute is required.

getCollapsedHeight

public Integer getCollapsedHeight()

Gets the collapsedHeight value for this FlashPushdownCreative.

Returns:

collapsedHeight * The collapsed height of the creative in pixels. This attribute is required.

setCollapsedHeight

public void setCollapsedHeight(Integer collapsedHeight)

Sets the collapsedHeight value for this FlashPushdownCreative.

Parameters:

collapsedHeight - * The collapsed height of the creative in pixels. This attribute is required.

getExpandedHeight

public Integer getExpandedHeight()

Gets the expandedHeight value for this FlashPushdownCreative.

Returns:

expandedHeight * The expanded height of the creative in pixels. This attribute is required.

setExpandedHeight

public void setExpandedHeight(Integer expandedHeight)

Sets the expandedHeight value for this FlashPushdownCreative.

Parameters:

expandedHeight - * The expanded height of the creative in pixels. This attribute is required.

getPushdownOnMouseOver

public Boolean getPushdownOnMouseOver()

Gets the pushdownOnMouseOver value for this FlashPushdownCreative.

Returns:

pushdownOnMouseOver * Whether or not the creative should pushdown when the mouse moves over the collapsed state. This attribute is optional and defaults to true.

setPushdownOnMouseOver

public void setPushdownOnMouseOver(Boolean pushdownOnMouseOver)

Sets the pushdownOnMouseOver value for this FlashPushdownCreative.

Parameters:

pushdownOnMouseOver - * Whether or not the creative should pushdown when the mouse moves over the collapsed state. This attribute is optional and defaults to true.

getJavascriptFunctionForPushdown

public String getJavascriptFunctionForPushdown()

Gets the javascriptFunctionForPushdown value for this FlashPushdownCreative.

Returns:

javascriptFunctionForPushdown * The name of javascript function needed in the SWF code to expand creative if the pushdownOnMouseOver is false. This attribute is optional and defaults to "dclk_show()".

setJavascriptFunctionForPushdown

public void setJavascriptFunctionForPushdown(String javascriptFunctionForPushdown)

Sets the javascriptFunctionForPushdown value for this FlashPushdownCreative.

Parameters:

javascriptFunctionForPushdown - * The name of javascript function needed in the SWF code to expand creative if the pushdownOnMouseOver is false. This attribute is optional and defaults to "dclk_show()".

getCollapseOnMouseOut

public Boolean getCollapseOnMouseOut()

Gets the collapseOnMouseOut value for this FlashPushdownCreative.

Returns:

collapseOnMouseOut * Whether or not the creative should collapse when the mouse moves off the expanded state. This attribute is optional and defaults to true.

setCollapseOnMouseOut

public void setCollapseOnMouseOut(Boolean collapseOnMouseOut)

Sets the collapseOnMouseOut value for this FlashPushdownCreative.

Parameters:

collapseOnMouseOut - * Whether or not the creative should collapse when the mouse moves off the expanded state. This attribute is optional and defaults to true.

getJavascriptFunctionForCollapse

public String getJavascriptFunctionForCollapse()

Gets the javascriptFunctionForCollapse value for this FlashPushdownCreative.

Returns:

javascriptFunctionForCollapse * The name of javascript function needed in the SWF code to collapse creative if the collapseOnMouseOut is false. This attribute is optional and defaults to "dclk_hide()".

setJavascriptFunctionForCollapse

public void setJavascriptFunctionForCollapse(String javascriptFunctionForCollapse)

Sets the javascriptFunctionForCollapse value for this FlashPushdownCreative.

Parameters:

javascriptFunctionForCollapse - * The name of javascript function needed in the SWF code to collapse creative if the collapseOnMouseOut is false. This attribute is optional and defaults to "dclk_hide()".

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