com.google.api.ads.dfp.axis.v201805

Class AspectRatioImageCreative

java.lang.Object

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

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

com.google.api.ads.dfp.axis.v201805.AspectRatioImageCreative

All Implemented Interfaces:

Serializable

public class AspectRatioImageCreative
extends HasDestinationUrlCreative
implements Serializable

A Creative intended for mobile platforms that displays an image, whose size is defined as an aspect ratio, i.e. Size.isAspectRatio. It can have multiple images whose dimensions conform to that aspect ratio.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AspectRatioImageCreative()
AspectRatioImageCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, CreativePolicyViolation[] policyViolations, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues, String destinationUrl, DestinationUrlType destinationUrlType, CreativeAsset[] imageAssets, String altText, String thirdPartyImpressionUrl, Boolean overrideSize)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAltText() Gets the altText value for this AspectRatioImageCreative.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
CreativeAsset[]	getImageAssets() Gets the imageAssets value for this AspectRatioImageCreative.
CreativeAsset	getImageAssets(int i)
Boolean	getOverrideSize() Gets the overrideSize value for this AspectRatioImageCreative.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
String	getThirdPartyImpressionUrl() Gets the thirdPartyImpressionUrl value for this AspectRatioImageCreative.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setAltText(String altText) Sets the altText value for this AspectRatioImageCreative.
void	setImageAssets(CreativeAsset[] imageAssets) Sets the imageAssets value for this AspectRatioImageCreative.
void	setImageAssets(int i, CreativeAsset _value)
void	setOverrideSize(Boolean overrideSize) Sets the overrideSize value for this AspectRatioImageCreative.
void	setThirdPartyImpressionUrl(String thirdPartyImpressionUrl) Sets the thirdPartyImpressionUrl value for this AspectRatioImageCreative.
String	toString()

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

getDestinationUrl, getDestinationUrlType, setDestinationUrl, setDestinationUrlType

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

getAdvertiserId, getAppliedLabels, getAppliedLabels, getCustomFieldValues, getCustomFieldValues, getId, getLastModifiedDateTime, getName, getPolicyViolations, getPolicyViolations, getPreviewUrl, getSize, setAdvertiserId, setAppliedLabels, setAppliedLabels, setCustomFieldValues, setCustomFieldValues, setId, setLastModifiedDateTime, setName, setPolicyViolations, setPolicyViolations, setPreviewUrl, setSize

Methods inherited from class java.lang.Object

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

Constructor Detail

AspectRatioImageCreative

public AspectRatioImageCreative()

AspectRatioImageCreative

public AspectRatioImageCreative(Long advertiserId,
                                Long id,
                                String name,
                                Size size,
                                String previewUrl,
                                CreativePolicyViolation[] policyViolations,
                                AppliedLabel[] appliedLabels,
                                DateTime lastModifiedDateTime,
                                BaseCustomFieldValue[] customFieldValues,
                                String destinationUrl,
                                DestinationUrlType destinationUrlType,
                                CreativeAsset[] imageAssets,
                                String altText,
                                String thirdPartyImpressionUrl,
                                Boolean overrideSize)

Method Detail

toString

public String toString()

Overrides:

toString in class HasDestinationUrlCreative

getImageAssets

public CreativeAsset[] getImageAssets()

Gets the imageAssets value for this AspectRatioImageCreative.

Returns:

imageAssets * The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

setImageAssets

public void setImageAssets(CreativeAsset[] imageAssets)

Sets the imageAssets value for this AspectRatioImageCreative.

Parameters:

imageAssets - * The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.

getImageAssets

public CreativeAsset getImageAssets(int i)

setImageAssets

public void setImageAssets(int i,
                           CreativeAsset _value)

getAltText

public String getAltText()

Gets the altText value for this AspectRatioImageCreative.

Returns:

altText * The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and has a maximum length of 500 characters.

setAltText

public void setAltText(String altText)

Sets the altText value for this AspectRatioImageCreative.

Parameters:

altText - * The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and has a maximum length of 500 characters.

getThirdPartyImpressionUrl

public String getThirdPartyImpressionUrl()

Gets the thirdPartyImpressionUrl value for this AspectRatioImageCreative.

Returns:

thirdPartyImpressionUrl * An impression tracking URL to ping when this creative is displayed. This field is optional has a maximum length of 1024 characters.

setThirdPartyImpressionUrl

public void setThirdPartyImpressionUrl(String thirdPartyImpressionUrl)

Sets the thirdPartyImpressionUrl value for this AspectRatioImageCreative.

Parameters:

thirdPartyImpressionUrl - * An impression tracking URL to ping when this creative is displayed. This field is optional has a maximum length of 1024 characters.

getOverrideSize

public Boolean getOverrideSize()

Gets the overrideSize value for this AspectRatioImageCreative.

Returns:

overrideSize * Allows the actual image asset sizes to differ from the creative size. This attribute is optional.

setOverrideSize

public void setOverrideSize(Boolean overrideSize)

Sets the overrideSize value for this AspectRatioImageCreative.

Parameters:

overrideSize - * Allows the actual image asset sizes to differ from the creative size. 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