com.google.api.ads.dfp.axis.v201403

Class AdUnitSize

java.lang.Object

com.google.api.ads.dfp.axis.v201403.AdUnitSize

All Implemented Interfaces:

Serializable

public class AdUnitSize
extends Object
implements Serializable

An AdUnitSize represents the size of an ad in an ad unit. Starting with v201108 this also represents the environment, and companions of a particular ad in an ad unit. In most cases, it is a simple size with just a width and a height (sometimes representing an aspect ratio).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdUnitSize()
AdUnitSize(Size size, EnvironmentType environmentType, AdUnitSize[] companions, String fullDisplayString)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
AdUnitSize[]	getCompanions() Gets the companions value for this AdUnitSize.
AdUnitSize	getCompanions(int i)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
EnvironmentType	getEnvironmentType() Gets the environmentType value for this AdUnitSize.
String	getFullDisplayString() Gets the fullDisplayString value for this AdUnitSize.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
Size	getSize() Gets the size value for this AdUnitSize.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setCompanions(AdUnitSize[] companions) Sets the companions value for this AdUnitSize.
void	setCompanions(int i, AdUnitSize _value)
void	setEnvironmentType(EnvironmentType environmentType) Sets the environmentType value for this AdUnitSize.
void	setFullDisplayString(String fullDisplayString) Sets the fullDisplayString value for this AdUnitSize.
void	setSize(Size size) Sets the size value for this AdUnitSize.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdUnitSize

public AdUnitSize()

AdUnitSize

public AdUnitSize(Size size,
          EnvironmentType environmentType,
          AdUnitSize[] companions,
          String fullDisplayString)

Method Detail

getSize

public Size getSize()

Gets the size value for this AdUnitSize.

Returns:

size * The permissible creative size that can be served inside this ad unit.

setSize

public void setSize(Size size)

Sets the size value for this AdUnitSize.

Parameters:

size - * The permissible creative size that can be served inside this ad unit.

getEnvironmentType

public EnvironmentType getEnvironmentType()

Gets the environmentType value for this AdUnitSize.

Returns:

environmentType * The environment type of the ad unit size. The default value is EnvironmentType.BROWSER.

setEnvironmentType

public void setEnvironmentType(EnvironmentType environmentType)

Sets the environmentType value for this AdUnitSize.

Parameters:

environmentType - * The environment type of the ad unit size. The default value is EnvironmentType.BROWSER.

getCompanions

public AdUnitSize[] getCompanions()

Gets the companions value for this AdUnitSize.

Returns:

companions * The companions for this ad unit size. Companions are only valid if the environment is EnvironmentType.VIDEO_PLAYER. If the environment is EnvironmentType.BROWSER including companions results in an error.

setCompanions

public void setCompanions(AdUnitSize[] companions)

Sets the companions value for this AdUnitSize.

Parameters:

companions - * The companions for this ad unit size. Companions are only valid if the environment is EnvironmentType.VIDEO_PLAYER. If the environment is EnvironmentType.BROWSER including companions results in an error.

getCompanions

public AdUnitSize getCompanions(int i)

setCompanions

public void setCompanions(int i,
                 AdUnitSize _value)

getFullDisplayString

public String getFullDisplayString()

Gets the fullDisplayString value for this AdUnitSize.

Returns:

fullDisplayString * The full (including companion sizes, if applicable) display string of the size, e.g. "300x250" or "300x250v (180x150)"

setFullDisplayString

public void setFullDisplayString(String fullDisplayString)

Sets the fullDisplayString value for this AdUnitSize.

Parameters:

fullDisplayString - * The full (including companion sizes, if applicable) display string of the size, e.g. "300x250" or "300x250v (180x150)"

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