com.google.api.ads.dfp.axis.v201208

Class FlashExpandableCreative

java.lang.Object

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

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

com.google.api.ads.dfp.axis.v201208.FlashExpandableCreative

All Implemented Interfaces:

Serializable

public class FlashExpandableCreative
extends HasDestinationUrlCreative
implements Serializable

An expandable Creative where the collapsed size is a Flash SWF file and the expanded size is another Flash SWF file. If Flash isn't supported in the browser, the fallback image will be used.

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FlashExpandableCreative()
FlashExpandableCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues, 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 collapsedWidth, Integer collapsedHeight, Integer expandedWidth, Integer expandedHeight, FlashExpandableCreativeExpandDirection expandDirection, Boolean expandOnMouseOver, String javascriptFunctionForExpand, Boolean collapseOnMouseOut, String javascriptFunctionForCollapse)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
byte[]	getCollapsedFallbackImageAssetByteArray() Gets the collapsedFallbackImageAssetByteArray value for this FlashExpandableCreative.
Long	getCollapsedFallbackImageAssetId() Gets the collapsedFallbackImageAssetId value for this FlashExpandableCreative.
String	getCollapsedFallbackImageFileName() Gets the collapsedFallbackImageFileName value for this FlashExpandableCreative.
byte[]	getCollapsedFlashAssetByteArray() Gets the collapsedFlashAssetByteArray value for this FlashExpandableCreative.
Long	getCollapsedFlashAssetId() Gets the collapsedFlashAssetId value for this FlashExpandableCreative.
String	getCollapsedFlashFileName() Gets the collapsedFlashFileName value for this FlashExpandableCreative.
Integer	getCollapsedHeight() Gets the collapsedHeight value for this FlashExpandableCreative.
Integer	getCollapsedWidth() Gets the collapsedWidth value for this FlashExpandableCreative.
Boolean	getCollapseOnMouseOut() Gets the collapseOnMouseOut value for this FlashExpandableCreative.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
FlashExpandableCreativeExpandDirection	getExpandDirection() Gets the expandDirection value for this FlashExpandableCreative.
byte[]	getExpandedFlashAssetByteArray() Gets the expandedFlashAssetByteArray value for this FlashExpandableCreative.
Long	getExpandedFlashAssetId() Gets the expandedFlashAssetId value for this FlashExpandableCreative.
String	getExpandedFlashFileName() Gets the expandedFlashFileName value for this FlashExpandableCreative.
Integer	getExpandedHeight() Gets the expandedHeight value for this FlashExpandableCreative.
Integer	getExpandedWidth() Gets the expandedWidth value for this FlashExpandableCreative.
Boolean	getExpandOnMouseOver() Gets the expandOnMouseOver value for this FlashExpandableCreative.
String	getJavascriptFunctionForCollapse() Gets the javascriptFunctionForCollapse value for this FlashExpandableCreative.
String	getJavascriptFunctionForExpand() Gets the javascriptFunctionForExpand value for this FlashExpandableCreative.
Integer	getRequiredFlashVersion() Gets the requiredFlashVersion value for this FlashExpandableCreative.
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
int	hashCode()
void	setCollapsedFallbackImageAssetByteArray(byte[] collapsedFallbackImageAssetByteArray) Sets the collapsedFallbackImageAssetByteArray value for this FlashExpandableCreative.
void	setCollapsedFallbackImageAssetId(Long collapsedFallbackImageAssetId) Sets the collapsedFallbackImageAssetId value for this FlashExpandableCreative.
void	setCollapsedFallbackImageFileName(String collapsedFallbackImageFileName) Sets the collapsedFallbackImageFileName value for this FlashExpandableCreative.
void	setCollapsedFlashAssetByteArray(byte[] collapsedFlashAssetByteArray) Sets the collapsedFlashAssetByteArray value for this FlashExpandableCreative.
void	setCollapsedFlashAssetId(Long collapsedFlashAssetId) Sets the collapsedFlashAssetId value for this FlashExpandableCreative.
void	setCollapsedFlashFileName(String collapsedFlashFileName) Sets the collapsedFlashFileName value for this FlashExpandableCreative.
void	setCollapsedHeight(Integer collapsedHeight) Sets the collapsedHeight value for this FlashExpandableCreative.
void	setCollapsedWidth(Integer collapsedWidth) Sets the collapsedWidth value for this FlashExpandableCreative.
void	setCollapseOnMouseOut(Boolean collapseOnMouseOut) Sets the collapseOnMouseOut value for this FlashExpandableCreative.
void	setExpandDirection(FlashExpandableCreativeExpandDirection expandDirection) Sets the expandDirection value for this FlashExpandableCreative.
void	setExpandedFlashAssetByteArray(byte[] expandedFlashAssetByteArray) Sets the expandedFlashAssetByteArray value for this FlashExpandableCreative.
void	setExpandedFlashAssetId(Long expandedFlashAssetId) Sets the expandedFlashAssetId value for this FlashExpandableCreative.
void	setExpandedFlashFileName(String expandedFlashFileName) Sets the expandedFlashFileName value for this FlashExpandableCreative.
void	setExpandedHeight(Integer expandedHeight) Sets the expandedHeight value for this FlashExpandableCreative.
void	setExpandedWidth(Integer expandedWidth) Sets the expandedWidth value for this FlashExpandableCreative.
void	setExpandOnMouseOver(Boolean expandOnMouseOver) Sets the expandOnMouseOver value for this FlashExpandableCreative.
void	setJavascriptFunctionForCollapse(String javascriptFunctionForCollapse) Sets the javascriptFunctionForCollapse value for this FlashExpandableCreative.
void	setJavascriptFunctionForExpand(String javascriptFunctionForExpand) Sets the javascriptFunctionForExpand value for this FlashExpandableCreative.
void	setRequiredFlashVersion(Integer requiredFlashVersion) Sets the requiredFlashVersion value for this FlashExpandableCreative.

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

getDestinationUrl, setDestinationUrl

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

FlashExpandableCreative

public FlashExpandableCreative()

FlashExpandableCreative

public FlashExpandableCreative(Long advertiserId,
                       Long id,
                       String name,
                       Size size,
                       String previewUrl,
                       AppliedLabel[] appliedLabels,
                       DateTime lastModifiedDateTime,
                       BaseCustomFieldValue[] customFieldValues,
                       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 collapsedWidth,
                       Integer collapsedHeight,
                       Integer expandedWidth,
                       Integer expandedHeight,
                       FlashExpandableCreativeExpandDirection expandDirection,
                       Boolean expandOnMouseOver,
                       String javascriptFunctionForExpand,
                       Boolean collapseOnMouseOut,
                       String javascriptFunctionForCollapse)

Method Detail

getCollapsedFlashAssetId

public Long getCollapsedFlashAssetId()

Gets the collapsedFlashAssetId value for this FlashExpandableCreative.

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

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

Returns:

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

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 FlashExpandableCreative is retrieved.

setCollapsedFlashAssetByteArray

public void setCollapsedFlashAssetByteArray(byte[] collapsedFlashAssetByteArray)

Sets the collapsedFlashAssetByteArray value for this FlashExpandableCreative.

Parameters:

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

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 FlashExpandableCreative is retrieved.

getCollapsedFlashFileName

public String getCollapsedFlashFileName()

Gets the collapsedFlashFileName value for this FlashExpandableCreative.

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

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

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

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

Returns:

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

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 FlashExpandableCreative is retrieved.

setCollapsedFallbackImageAssetByteArray

public void setCollapsedFallbackImageAssetByteArray(byte[] collapsedFallbackImageAssetByteArray)

Sets the collapsedFallbackImageAssetByteArray value for this FlashExpandableCreative.

Parameters:

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

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 FlashExpandableCreative is retrieved.

getCollapsedFallbackImageFileName

public String getCollapsedFallbackImageFileName()

Gets the collapsedFallbackImageFileName value for this FlashExpandableCreative.

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

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

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

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

Returns:

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

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 FlashExpandableCreative is retrieved.

setExpandedFlashAssetByteArray

public void setExpandedFlashAssetByteArray(byte[] expandedFlashAssetByteArray)

Sets the expandedFlashAssetByteArray value for this FlashExpandableCreative.

Parameters:

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

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 FlashExpandableCreative is retrieved.

getExpandedFlashFileName

public String getExpandedFlashFileName()

Gets the expandedFlashFileName value for this FlashExpandableCreative.

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

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

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

Parameters:

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

getCollapsedWidth

public Integer getCollapsedWidth()

Gets the collapsedWidth value for this FlashExpandableCreative.

Returns:

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

setCollapsedWidth

public void setCollapsedWidth(Integer collapsedWidth)

Sets the collapsedWidth value for this FlashExpandableCreative.

Parameters:

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

getCollapsedHeight

public Integer getCollapsedHeight()

Gets the collapsedHeight value for this FlashExpandableCreative.

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

Parameters:

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

getExpandedWidth

public Integer getExpandedWidth()

Gets the expandedWidth value for this FlashExpandableCreative.

Returns:

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

setExpandedWidth

public void setExpandedWidth(Integer expandedWidth)

Sets the expandedWidth value for this FlashExpandableCreative.

Parameters:

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

getExpandedHeight

public Integer getExpandedHeight()

Gets the expandedHeight value for this FlashExpandableCreative.

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

Parameters:

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

getExpandDirection

public FlashExpandableCreativeExpandDirection getExpandDirection()

Gets the expandDirection value for this FlashExpandableCreative.

Returns:

expandDirection * The direction in which the creative will expand. This attribute is required.

setExpandDirection

public void setExpandDirection(FlashExpandableCreativeExpandDirection expandDirection)

Sets the expandDirection value for this FlashExpandableCreative.

Parameters:

expandDirection - * The direction in which the creative will expand. This attribute is required.

getExpandOnMouseOver

public Boolean getExpandOnMouseOver()

Gets the expandOnMouseOver value for this FlashExpandableCreative.

Returns:

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

setExpandOnMouseOver

public void setExpandOnMouseOver(Boolean expandOnMouseOver)

Sets the expandOnMouseOver value for this FlashExpandableCreative.

Parameters:

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

getJavascriptFunctionForExpand

public String getJavascriptFunctionForExpand()

Gets the javascriptFunctionForExpand value for this FlashExpandableCreative.

Returns:

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

setJavascriptFunctionForExpand

public void setJavascriptFunctionForExpand(String javascriptFunctionForExpand)

Sets the javascriptFunctionForExpand value for this FlashExpandableCreative.

Parameters:

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

getCollapseOnMouseOut

public Boolean getCollapseOnMouseOut()

Gets the collapseOnMouseOut value for this FlashExpandableCreative.

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

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

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

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