com.google.api.ads.admanager.axis.v202111

Class CreativeWrapper

java.lang.Object

com.google.api.ads.admanager.axis.v202111.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, CreativeWrapperType creativeWrapperType, String htmlHeader, String htmlFooter, String ampHead, String ampBody, ConversionEvent_TrackingUrlsMapEntry[] videoTrackingUrls, ThirdPartyDataDeclaration thirdPartyDataDeclaration, CreativeWrapperOrdering ordering, CreativeWrapperStatus status)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAmpBody() Gets the ampBody value for this CreativeWrapper.
String	getAmpHead() Gets the ampHead value for this CreativeWrapper.
CreativeWrapperType	getCreativeWrapperType() Gets the creativeWrapperType value for this CreativeWrapper.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
String	getHtmlFooter() Gets the htmlFooter value for this CreativeWrapper.
String	getHtmlHeader() Gets the htmlHeader 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.
ThirdPartyDataDeclaration	getThirdPartyDataDeclaration() Gets the thirdPartyDataDeclaration value for this CreativeWrapper.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
ConversionEvent_TrackingUrlsMapEntry[]	getVideoTrackingUrls() Gets the videoTrackingUrls value for this CreativeWrapper.
ConversionEvent_TrackingUrlsMapEntry	getVideoTrackingUrls(int i)
int	hashCode()
void	setAmpBody(String ampBody) Sets the ampBody value for this CreativeWrapper.
void	setAmpHead(String ampHead) Sets the ampHead value for this CreativeWrapper.
void	setCreativeWrapperType(CreativeWrapperType creativeWrapperType) Sets the creativeWrapperType value for this CreativeWrapper.
void	setHtmlFooter(String htmlFooter) Sets the htmlFooter value for this CreativeWrapper.
void	setHtmlHeader(String htmlHeader) Sets the htmlHeader 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.
void	setThirdPartyDataDeclaration(ThirdPartyDataDeclaration thirdPartyDataDeclaration) Sets the thirdPartyDataDeclaration value for this CreativeWrapper.
void	setVideoTrackingUrls(ConversionEvent_TrackingUrlsMapEntry[] videoTrackingUrls) Sets the videoTrackingUrls value for this CreativeWrapper.
void	setVideoTrackingUrls(int i, ConversionEvent_TrackingUrlsMapEntry _value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreativeWrapper

public CreativeWrapper()

CreativeWrapper

public CreativeWrapper(Long id,
                       Long labelId,
                       CreativeWrapperType creativeWrapperType,
                       String htmlHeader,
                       String htmlFooter,
                       String ampHead,
                       String ampBody,
                       ConversionEvent_TrackingUrlsMapEntry[] videoTrackingUrls,
                       ThirdPartyDataDeclaration thirdPartyDataDeclaration,
                       CreativeWrapperOrdering ordering,
                       CreativeWrapperStatus status)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

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.

getCreativeWrapperType

public CreativeWrapperType getCreativeWrapperType()

Gets the creativeWrapperType value for this CreativeWrapper.

Returns:

creativeWrapperType * The creative wrapper type. If the creative wrapper type is CreativeWrapperType.VIDEO_TRACKING_URL, the videoTrackingUrls field must be set. If the creative wrapper type is CreativeWrapperType.HTML, either the header or footer field must be set. This field is required.

setCreativeWrapperType

public void setCreativeWrapperType(CreativeWrapperType creativeWrapperType)

Sets the creativeWrapperType value for this CreativeWrapper.

Parameters:

creativeWrapperType - * The creative wrapper type. If the creative wrapper type is CreativeWrapperType.VIDEO_TRACKING_URL, the videoTrackingUrls field must be set. If the creative wrapper type is CreativeWrapperType.HTML, either the header or footer field must be set. This field is required.

getHtmlHeader

public String getHtmlHeader()

Gets the htmlHeader value for this CreativeWrapper.

Returns:

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

setHtmlHeader

public void setHtmlHeader(String htmlHeader)

Sets the htmlHeader value for this CreativeWrapper.

Parameters:

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

getHtmlFooter

public String getHtmlFooter()

Gets the htmlFooter value for this CreativeWrapper.

Returns:

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

setHtmlFooter

public void setHtmlFooter(String htmlFooter)

Sets the htmlFooter value for this CreativeWrapper.

Parameters:

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

getAmpHead

public String getAmpHead()

Gets the ampHead value for this CreativeWrapper.

Returns:

ampHead * The header AMP snippet that this creative wrapper delivers.

setAmpHead

public void setAmpHead(String ampHead)

Sets the ampHead value for this CreativeWrapper.

Parameters:

ampHead - * The header AMP snippet that this creative wrapper delivers.

getAmpBody

public String getAmpBody()

Gets the ampBody value for this CreativeWrapper.

Returns:

ampBody * The footer AMP snippet that this creative wrapper delivers.

setAmpBody

public void setAmpBody(String ampBody)

Sets the ampBody value for this CreativeWrapper.

Parameters:

ampBody - * The footer AMP snippet that this creative wrapper delivers.

getVideoTrackingUrls

public ConversionEvent_TrackingUrlsMapEntry[] getVideoTrackingUrls()

Gets the videoTrackingUrls value for this CreativeWrapper.

Returns:

videoTrackingUrls * The video tracking URLs that this creative wrapper delivers. This field is required if the creativeWrapperType is CreativeWrapperType.VIDEO_TRACKING_URL and ignored otherwise.

setVideoTrackingUrls

public void setVideoTrackingUrls(ConversionEvent_TrackingUrlsMapEntry[] videoTrackingUrls)

Sets the videoTrackingUrls value for this CreativeWrapper.

Parameters:

videoTrackingUrls - * The video tracking URLs that this creative wrapper delivers. This field is required if the creativeWrapperType is CreativeWrapperType.VIDEO_TRACKING_URL and ignored otherwise.

getVideoTrackingUrls

public ConversionEvent_TrackingUrlsMapEntry getVideoTrackingUrls(int i)

setVideoTrackingUrls

public void setVideoTrackingUrls(int i,
                                 ConversionEvent_TrackingUrlsMapEntry _value)

getThirdPartyDataDeclaration

public ThirdPartyDataDeclaration getThirdPartyDataDeclaration()

Gets the thirdPartyDataDeclaration value for this CreativeWrapper.

Returns:

thirdPartyDataDeclaration * The ThirdPartyDataDeclaration for this creative wrapper.

It is copied to one of the underlying creatives. If the header creative is active then it is persisted there. Otherwise it is stored on the footer creative.

setThirdPartyDataDeclaration

public void setThirdPartyDataDeclaration(ThirdPartyDataDeclaration thirdPartyDataDeclaration)

Sets the thirdPartyDataDeclaration value for this CreativeWrapper.

Parameters:

thirdPartyDataDeclaration - * The ThirdPartyDataDeclaration for this creative wrapper.

It is copied to one of the underlying creatives. If the header creative is active then it is persisted there. Otherwise it is stored on the footer creative.

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