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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ImageCreative, ImageOverlayCreative

public abstract class BaseImageCreative
extends HasDestinationUrlCreative
implements Serializable

The base type for creatives that display an image.

See Also:

Serialized Form

Constructor Summary

BaseImageCreative()

BaseImageCreative(Long advertiserId, Long id, String name, Size size, String previewUrl, AppliedLabel[] appliedLabels, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues, String creativeType, String destinationUrl, String imageName, byte[] imageByteArray, Boolean overrideSize, Size assetSize, String imageUrl)

Method Summary

boolean	equals(Object obj)
Size	getAssetSize() Gets the assetSize value for this BaseImageCreative.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
byte[]	getImageByteArray() Gets the imageByteArray value for this BaseImageCreative.
String	getImageName() Gets the imageName value for this BaseImageCreative.
String	getImageUrl() Gets the imageUrl value for this BaseImageCreative.
Boolean	getOverrideSize() Gets the overrideSize value for this BaseImageCreative.
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	setAssetSize(Size assetSize) Sets the assetSize value for this BaseImageCreative.
void	setImageByteArray(byte[] imageByteArray) Sets the imageByteArray value for this BaseImageCreative.
void	setImageName(String imageName) Sets the imageName value for this BaseImageCreative.
void	setImageUrl(String imageUrl) Sets the imageUrl value for this BaseImageCreative.
void	setOverrideSize(Boolean overrideSize) Sets the overrideSize value for this BaseImageCreative.

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

BaseImageCreative

public BaseImageCreative()

BaseImageCreative

public BaseImageCreative(Long advertiserId,
                         Long id,
                         String name,
                         Size size,
                         String previewUrl,
                         AppliedLabel[] appliedLabels,
                         DateTime lastModifiedDateTime,
                         BaseCustomFieldValue[] customFieldValues,
                         String creativeType,
                         String destinationUrl,
                         String imageName,
                         byte[] imageByteArray,
                         Boolean overrideSize,
                         Size assetSize,
                         String imageUrl)

Method Detail

getImageName

public String getImageName()

Gets the imageName value for this BaseImageCreative.

Returns:

imageName * The name of the image asset. This attribute is required and has a maximum length of 248 characters.

setImageName

public void setImageName(String imageName)

Sets the imageName value for this BaseImageCreative.

Parameters:

imageName - * The name of the image asset. This attribute is required and has a maximum length of 248 characters.

getImageByteArray

public byte[] getImageByteArray()

Gets the imageByteArray value for this BaseImageCreative.

Returns:

imageByteArray * The content of the image asset as a byte array. This attribute is required. The imageByteArray will be null when the ImageCreative is retrieved. To view the image, use the previewUrl.

setImageByteArray

public void setImageByteArray(byte[] imageByteArray)

Sets the imageByteArray value for this BaseImageCreative.

Parameters:

imageByteArray - * The content of the image asset as a byte array. This attribute is required. The imageByteArray will be null when the ImageCreative is retrieved. To view the image, use the previewUrl.

getOverrideSize

public Boolean getOverrideSize()

Gets the overrideSize value for this BaseImageCreative.

Returns:

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

setOverrideSize

public void setOverrideSize(Boolean overrideSize)

Sets the overrideSize value for this BaseImageCreative.

Parameters:

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

getAssetSize

public Size getAssetSize()

Gets the assetSize value for this BaseImageCreative.

Returns:

assetSize * The image asset size. Note that this may differ from size if users set overrideSize to true. This attribute read-only and is populated by Google.

setAssetSize

public void setAssetSize(Size assetSize)

Sets the assetSize value for this BaseImageCreative.

Parameters:

assetSize - * The image asset size. Note that this may differ from size if users set overrideSize to true. This attribute read-only and is populated by Google.

getImageUrl

public String getImageUrl()

Gets the imageUrl value for this BaseImageCreative.

Returns:

imageUrl * The URL where the actual asset resides. This attribute is read-only and has a maximum length of 1024 characters.

setImageUrl

public void setImageUrl(String imageUrl)

Sets the imageUrl value for this BaseImageCreative.

Parameters:

imageUrl - * The URL where the actual asset resides. This attribute is read-only and has a maximum length of 1024 characters.

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