com.google.api.ads.dfp.axis.v201306

Class CreativeWrapper

java.lang.Object

com.google.api.ads.dfp.axis.v201306.CreativeWrapper

All Implemented Interfaces:

Serializable

public class CreativeWrapper
extends Object
implements Serializable

A CreativeWrapper allows the wrapping of HTML snippets to be served along with Creative objects.

Creative wrappers must be associated with a LabelType.CREATIVE_WRAPPER label and applied to ad units by AdUnit.appliedLabels.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreativeWrapper()
CreativeWrapper(Long id, Long labelId, CreativeWrapperHtmlSnippet header, CreativeWrapperHtmlSnippet footer, CreativeWrapperOrdering ordering, CreativeWrapperStatus status)

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
CreativeWrapperHtmlSnippet	getFooter() Gets the footer value for this CreativeWrapper.
CreativeWrapperHtmlSnippet	getHeader() Gets the header value for this CreativeWrapper.
Long	getId() Gets the id value for this CreativeWrapper.
Long	getLabelId() Gets the labelId value for this CreativeWrapper.
CreativeWrapperOrdering	getOrdering() Gets the ordering value for this CreativeWrapper.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
CreativeWrapperStatus	getStatus() Gets the status value for this CreativeWrapper.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setFooter(CreativeWrapperHtmlSnippet footer) Sets the footer value for this CreativeWrapper.
void	setHeader(CreativeWrapperHtmlSnippet header) Sets the header value for this CreativeWrapper.
void	setId(Long id) Sets the id value for this CreativeWrapper.
void	setLabelId(Long labelId) Sets the labelId value for this CreativeWrapper.
void	setOrdering(CreativeWrapperOrdering ordering) Sets the ordering value for this CreativeWrapper.
void	setStatus(CreativeWrapperStatus status) Sets the status value for this CreativeWrapper.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreativeWrapper

public CreativeWrapper()

CreativeWrapper

public CreativeWrapper(Long id,
               Long labelId,
               CreativeWrapperHtmlSnippet header,
               CreativeWrapperHtmlSnippet footer,
               CreativeWrapperOrdering ordering,
               CreativeWrapperStatus status)

Method Detail

getId

public Long getId()

Gets the id value for this CreativeWrapper.

Returns:

id * The unique ID of the CreativeWrapper. This value is readonly and is assigned by Google.

setId

public void setId(Long id)

Sets the id value for this CreativeWrapper.

Parameters:

id - * The unique ID of the CreativeWrapper. This value is readonly and is assigned by Google.

getLabelId

public Long getLabelId()

Gets the labelId value for this CreativeWrapper.

Returns:

labelId * The ID of the Label which will be used to label ad units. The labelId on a creative wrapper cannot be changed once it is created.

setLabelId

public void setLabelId(Long labelId)

Sets the labelId value for this CreativeWrapper.

Parameters:

labelId - * The ID of the Label which will be used to label ad units. The labelId on a creative wrapper cannot be changed once it is created.

getHeader

public CreativeWrapperHtmlSnippet getHeader()

Gets the header value for this CreativeWrapper.

Returns:

header * The header HTML snippet that this creative wrapper delivers.

setHeader

public void setHeader(CreativeWrapperHtmlSnippet header)

Sets the header value for this CreativeWrapper.

Parameters:

header - * The header HTML snippet that this creative wrapper delivers.

getFooter

public CreativeWrapperHtmlSnippet getFooter()

Gets the footer value for this CreativeWrapper.

Returns:

footer * The footer HTML snippet that this creative wrapper delivers.

setFooter

public void setFooter(CreativeWrapperHtmlSnippet footer)

Sets the footer value for this CreativeWrapper.

Parameters:

footer - * The footer HTML snippet that this creative wrapper delivers.

getOrdering

public CreativeWrapperOrdering getOrdering()

Gets the ordering value for this CreativeWrapper.

Returns:

ordering * If there are multiple wrappers for a creative, then ordering defines the order in which the HTML snippets are rendered.

setOrdering

public void setOrdering(CreativeWrapperOrdering ordering)

Sets the ordering value for this CreativeWrapper.

Parameters:

ordering - * If there are multiple wrappers for a creative, then ordering defines the order in which the HTML snippets are rendered.

getStatus

public CreativeWrapperStatus getStatus()

Gets the status value for this CreativeWrapper.

Returns:

status * The status of the CreativeWrapper. This attribute is readonly.

setStatus

public void setStatus(CreativeWrapperStatus status)

Sets the status value for this CreativeWrapper.

Parameters:

status - * The status of the CreativeWrapper. This attribute is readonly.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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