com.google.api.ads.admanager.axis.v201905

Class SuggestedAdUnit

java.lang.Object

com.google.api.ads.admanager.axis.v201905.SuggestedAdUnit

All Implemented Interfaces:

Serializable

public class SuggestedAdUnit
extends Object
implements Serializable

A SuggestedAdUnit represents a suggestion for a new ad unit, based on an ad tag that has been served at least ten times in the past week, but which does not correspond to a defined ad unit. This type is read-only.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SuggestedAdUnit()
SuggestedAdUnit(String id, Long numRequests, String[] path, AdUnitParent[] parentPath, AdUnitTargetWindow targetWindow, TargetPlatform targetPlatform, AdUnitSize[] suggestedAdUnitSizes)

Method Summary

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
String	getId() Gets the id value for this SuggestedAdUnit.
Long	getNumRequests() Gets the numRequests value for this SuggestedAdUnit.
AdUnitParent[]	getParentPath() Gets the parentPath value for this SuggestedAdUnit.
AdUnitParent	getParentPath(int i)
String[]	getPath() Gets the path value for this SuggestedAdUnit.
String	getPath(int i)
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
AdUnitSize[]	getSuggestedAdUnitSizes() Gets the suggestedAdUnitSizes value for this SuggestedAdUnit.
AdUnitSize	getSuggestedAdUnitSizes(int i)
TargetPlatform	getTargetPlatform() Gets the targetPlatform value for this SuggestedAdUnit.
AdUnitTargetWindow	getTargetWindow() Gets the targetWindow value for this SuggestedAdUnit.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setId(String id) Sets the id value for this SuggestedAdUnit.
void	setNumRequests(Long numRequests) Sets the numRequests value for this SuggestedAdUnit.
void	setParentPath(AdUnitParent[] parentPath) Sets the parentPath value for this SuggestedAdUnit.
void	setParentPath(int i, AdUnitParent _value)
void	setPath(int i, String _value)
void	setPath(String[] path) Sets the path value for this SuggestedAdUnit.
void	setSuggestedAdUnitSizes(AdUnitSize[] suggestedAdUnitSizes) Sets the suggestedAdUnitSizes value for this SuggestedAdUnit.
void	setSuggestedAdUnitSizes(int i, AdUnitSize _value)
void	setTargetPlatform(TargetPlatform targetPlatform) Sets the targetPlatform value for this SuggestedAdUnit.
void	setTargetWindow(AdUnitTargetWindow targetWindow) Sets the targetWindow value for this SuggestedAdUnit.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestedAdUnit

public SuggestedAdUnit()

SuggestedAdUnit

public SuggestedAdUnit(String id,
                       Long numRequests,
                       String[] path,
                       AdUnitParent[] parentPath,
                       AdUnitTargetWindow targetWindow,
                       TargetPlatform targetPlatform,
                       AdUnitSize[] suggestedAdUnitSizes)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getId

public String getId()

Gets the id value for this SuggestedAdUnit.

Returns:

id * The unique ID of the suggested ad unit. After API version 201311 this field will be a numerical ID. Earlier versions will return a string value which is the complete path to the suggested ad unit with path elements separated by '/' characters. This attribute is read-only and is populated by Google.

setId

public void setId(String id)

Sets the id value for this SuggestedAdUnit.

Parameters:

id - * The unique ID of the suggested ad unit. After API version 201311 this field will be a numerical ID. Earlier versions will return a string value which is the complete path to the suggested ad unit with path elements separated by '/' characters. This attribute is read-only and is populated by Google.

getNumRequests

public Long getNumRequests()

Gets the numRequests value for this SuggestedAdUnit.

Returns:

numRequests * Returns the number of times the ad tag corresponding to this suggested ad unit has been served in the previous week. Suggested ad units are only created when they have been served at least ten times in that period. This attribute is read-only and is populated by Google.

setNumRequests

public void setNumRequests(Long numRequests)

Sets the numRequests value for this SuggestedAdUnit.

Parameters:

numRequests - * Returns the number of times the ad tag corresponding to this suggested ad unit has been served in the previous week. Suggested ad units are only created when they have been served at least ten times in that period. This attribute is read-only and is populated by Google.

getPath

public String[] getPath()

Gets the path value for this SuggestedAdUnit.

Returns:

path * The hierarchical path from the last existing ad unit after this and all suggested parent ad units have been created. Each path element is a separate ad unit code in the returned list. This attribute is read-only and is populated by Google.

setPath

public void setPath(String[] path)

Sets the path value for this SuggestedAdUnit.

Parameters:

path - * The hierarchical path from the last existing ad unit after this and all suggested parent ad units have been created. Each path element is a separate ad unit code in the returned list. This attribute is read-only and is populated by Google.

getPath

public String getPath(int i)

setPath

public void setPath(int i,
                    String _value)

getParentPath

public AdUnitParent[] getParentPath()

Gets the parentPath value for this SuggestedAdUnit.

Returns:

parentPath * The existing hierarchical path leading up to, and including, the parent of the first suggested ad unit in the ad unit hierarchy. The parentPath and the path make up the full path of the suggested ad unit after it is approved. This attribute is read-only and is populated by Google.

Note: The ad unit code for each of the parent ad units will not be provided.

setParentPath

public void setParentPath(AdUnitParent[] parentPath)

Sets the parentPath value for this SuggestedAdUnit.

Parameters:

parentPath - * The existing hierarchical path leading up to, and including, the parent of the first suggested ad unit in the ad unit hierarchy. The parentPath and the path make up the full path of the suggested ad unit after it is approved. This attribute is read-only and is populated by Google.

Note: The ad unit code for each of the parent ad units will not be provided.

getParentPath

public AdUnitParent getParentPath(int i)

setParentPath

public void setParentPath(int i,
                          AdUnitParent _value)

getTargetWindow

public AdUnitTargetWindow getTargetWindow()

Gets the targetWindow value for this SuggestedAdUnit.

Returns:

targetWindow * The target attribute of the underlying ad tag, as defined in the AdUnit. This attribute is read-only and is populated by Google.

setTargetWindow

public void setTargetWindow(AdUnitTargetWindow targetWindow)

Sets the targetWindow value for this SuggestedAdUnit.

Parameters:

targetWindow - * The target attribute of the underlying ad tag, as defined in the AdUnit. This attribute is read-only and is populated by Google.

getTargetPlatform

public TargetPlatform getTargetPlatform()

Gets the targetPlatform value for this SuggestedAdUnit.

Returns:

targetPlatform * The target platform for the browser that clicked the underlying ad tag. This attribute is read-only and is populated by Google.

setTargetPlatform

public void setTargetPlatform(TargetPlatform targetPlatform)

Sets the targetPlatform value for this SuggestedAdUnit.

Parameters:

targetPlatform - * The target platform for the browser that clicked the underlying ad tag. This attribute is read-only and is populated by Google.

getSuggestedAdUnitSizes

public AdUnitSize[] getSuggestedAdUnitSizes()

Gets the suggestedAdUnitSizes value for this SuggestedAdUnit.

Returns:

suggestedAdUnitSizes * The target sizes associated with this SuggestedAdUnit. This attribute is read-only and is populated by Google.

setSuggestedAdUnitSizes

public void setSuggestedAdUnitSizes(AdUnitSize[] suggestedAdUnitSizes)

Sets the suggestedAdUnitSizes value for this SuggestedAdUnit.

Parameters:

suggestedAdUnitSizes - * The target sizes associated with this SuggestedAdUnit. This attribute is read-only and is populated by Google.

getSuggestedAdUnitSizes

public AdUnitSize getSuggestedAdUnitSizes(int i)

setSuggestedAdUnitSizes

public void setSuggestedAdUnitSizes(int i,
                                    AdUnitSize _value)

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