AdSpot (Ad Manager Axis classes 4.14.0 API)

java.lang.Object
- com.google.api.ads.admanager.axis.v202008.AdSpot

All Implemented Interfaces:

Serializable
```
public class AdSpot
extends Object
implements Serializable
```
A AdSpot is a targetable entity used in the creation of AdRule objects.
A ad spot contains a variable number of ads and has constraints (ad duration, reservation type, etc) on the ads that can appear in it.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`AdSpot()`
`AdSpot(Long id, String name, String displayName, Boolean customSpot, Boolean flexible, Long maxDurationMillis, Integer maxNumberOfAds, AdSpotTargetingType targetingType, Boolean backfillBlocked, LineItemType[] allowedLineItemTypes, Boolean inventorySharingBlocked)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`LineItemType[]`	`getAllowedLineItemTypes()` Gets the allowedLineItemTypes value for this AdSpot.
`LineItemType`	`getAllowedLineItemTypes(int i)`
`Boolean`	`getBackfillBlocked()` Gets the backfillBlocked value for this AdSpot.
`Boolean`	`getCustomSpot()` Gets the customSpot value for this AdSpot.
`static org.apache.axis.encoding.Deserializer`	`getDeserializer(String mechType, Class _javaType, QName _xmlType)` Get Custom Deserializer
`String`	`getDisplayName()` Gets the displayName value for this AdSpot.
`Boolean`	`getFlexible()` Gets the flexible value for this AdSpot.
`Long`	`getId()` Gets the id value for this AdSpot.
`Boolean`	`getInventorySharingBlocked()` Gets the inventorySharingBlocked value for this AdSpot.
`Long`	`getMaxDurationMillis()` Gets the maxDurationMillis value for this AdSpot.
`Integer`	`getMaxNumberOfAds()` Gets the maxNumberOfAds value for this AdSpot.
`String`	`getName()` Gets the name value for this AdSpot.
`static org.apache.axis.encoding.Serializer`	`getSerializer(String mechType, Class _javaType, QName _xmlType)` Get Custom Serializer
`AdSpotTargetingType`	`getTargetingType()` Gets the targetingType value for this AdSpot.
`static org.apache.axis.description.TypeDesc`	`getTypeDesc()` Return type metadata object
`int`	`hashCode()`
`void`	`setAllowedLineItemTypes(int i, LineItemType _value)`
`void`	`setAllowedLineItemTypes(LineItemType[] allowedLineItemTypes)` Sets the allowedLineItemTypes value for this AdSpot.
`void`	`setBackfillBlocked(Boolean backfillBlocked)` Sets the backfillBlocked value for this AdSpot.
`void`	`setCustomSpot(Boolean customSpot)` Sets the customSpot value for this AdSpot.
`void`	`setDisplayName(String displayName)` Sets the displayName value for this AdSpot.
`void`	`setFlexible(Boolean flexible)` Sets the flexible value for this AdSpot.
`void`	`setId(Long id)` Sets the id value for this AdSpot.
`void`	`setInventorySharingBlocked(Boolean inventorySharingBlocked)` Sets the inventorySharingBlocked value for this AdSpot.
`void`	`setMaxDurationMillis(Long maxDurationMillis)` Sets the maxDurationMillis value for this AdSpot.
`void`	`setMaxNumberOfAds(Integer maxNumberOfAds)` Sets the maxNumberOfAds value for this AdSpot.
`void`	`setName(String name)` Sets the name value for this AdSpot.
`void`	`setTargetingType(AdSpotTargetingType targetingType)` Sets the targetingType value for this AdSpot.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AdSpot
```
public AdSpot()
```
  - AdSpot
```
public AdSpot(Long id,
              String name,
              String displayName,
              Boolean customSpot,
              Boolean flexible,
              Long maxDurationMillis,
              Integer maxNumberOfAds,
              AdSpotTargetingType targetingType,
              Boolean backfillBlocked,
              LineItemType[] allowedLineItemTypes,
              Boolean inventorySharingBlocked)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getId
```
public Long getId()
```
    Gets the id value for this AdSpot.
    
    Returns:
    
    id * The unique ID of the AdSpot. This value is readonly and is assigned by Google.
  - setId
```
public void setId(Long id)
```
    Sets the id value for this AdSpot.
    
    Parameters:
    
    id - * The unique ID of the AdSpot. This value is readonly and is assigned by Google.
  - getName
```
public String getName()
```
    Gets the name value for this AdSpot.
    
    Returns:
    
    name * Name of the AdSpot. The name is case insenstive and can be referenced in ad tags. This value is required if customSpot is true, and cannot be set otherwise.
    You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
  - setName
```
public void setName(String name)
```
    Sets the name value for this AdSpot.
    
    Parameters:
    
    name - * Name of the AdSpot. The name is case insenstive and can be referenced in ad tags. This value is required if customSpot is true, and cannot be set otherwise.
    You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
  - getDisplayName
```
public String getDisplayName()
```
    Gets the displayName value for this AdSpot.
    
    Returns:
    
    displayName * Descriptive name for the AdSpot.This value is optional if customSpot is true, and cannot be set otherwise.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Sets the displayName value for this AdSpot.
    
    Parameters:
    
    displayName - * Descriptive name for the AdSpot.This value is optional if customSpot is true, and cannot be set otherwise.
  - getCustomSpot
```
public Boolean getCustomSpot()
```
    Gets the customSpot value for this AdSpot.
    
    Returns:
    
    customSpot * Whether this ad spot is a custom spot. This field is optional and defaults to false.
    Custom spots can be reused and targeted in the targeting picker.
  - setCustomSpot
```
public void setCustomSpot(Boolean customSpot)
```
    Sets the customSpot value for this AdSpot.
    
    Parameters:
    
    customSpot - * Whether this ad spot is a custom spot. This field is optional and defaults to false.
    Custom spots can be reused and targeted in the targeting picker.
  - getFlexible
```
public Boolean getFlexible()
```
    Gets the flexible value for this AdSpot.
    
    Returns:
    
    flexible * Whether this ad spot is a flexible spot. This field is optional and defaults to false.
    Flexible spots are allowed to have no max number of ads.
  - setFlexible
```
public void setFlexible(Boolean flexible)
```
    Sets the flexible value for this AdSpot.
    
    Parameters:
    
    flexible - * Whether this ad spot is a flexible spot. This field is optional and defaults to false.
    Flexible spots are allowed to have no max number of ads.
  - getMaxDurationMillis
```
public Long getMaxDurationMillis()
```
    Gets the maxDurationMillis value for this AdSpot.
    
    Returns:
    
    maxDurationMillis * The maximum total duration for this AdSpot. This field is optional, defaults to 0, and supports precision to the nearest second.
  - setMaxDurationMillis
```
public void setMaxDurationMillis(Long maxDurationMillis)
```
    Sets the maxDurationMillis value for this AdSpot.
    
    Parameters:
    
    maxDurationMillis - * The maximum total duration for this AdSpot. This field is optional, defaults to 0, and supports precision to the nearest second.
  - getMaxNumberOfAds
```
public Integer getMaxNumberOfAds()
```
    Gets the maxNumberOfAds value for this AdSpot.
    
    Returns:
    
    maxNumberOfAds * The maximum number of ads allowed in the AdSpot. This field is optional and defaults to O.
    A maxNumberOfAds of 0 means that there is no maximum for the number of ads in the ad spot. No max ads is only supported for ad spots that have flexible set to true.
  - setMaxNumberOfAds
```
public void setMaxNumberOfAds(Integer maxNumberOfAds)
```
    Sets the maxNumberOfAds value for this AdSpot.
    
    Parameters:
    
    maxNumberOfAds - * The maximum number of ads allowed in the AdSpot. This field is optional and defaults to O.
    A maxNumberOfAds of 0 means that there is no maximum for the number of ads in the ad spot. No max ads is only supported for ad spots that have flexible set to true.
  - getTargetingType
```
public AdSpotTargetingType getTargetingType()
```
    Gets the targetingType value for this AdSpot.
    
    Returns:
    
    targetingType * The SubpodTargetingType determines how this ad spot can be targeted. This field is required.
  - setTargetingType
```
public void setTargetingType(AdSpotTargetingType targetingType)
```
    Sets the targetingType value for this AdSpot.
    
    Parameters:
    
    targetingType - * The SubpodTargetingType determines how this ad spot can be targeted. This field is required.
  - getBackfillBlocked
```
public Boolean getBackfillBlocked()
```
    Gets the backfillBlocked value for this AdSpot.
    
    Returns:
    
    backfillBlocked * Whether backfill is blocked in this ad spot. This field is optional and defaults to false.
  - setBackfillBlocked
```
public void setBackfillBlocked(Boolean backfillBlocked)
```
    Sets the backfillBlocked value for this AdSpot.
    
    Parameters:
    
    backfillBlocked - * Whether backfill is blocked in this ad spot. This field is optional and defaults to false.
  - getAllowedLineItemTypes
```
public LineItemType[] getAllowedLineItemTypes()
```
    Gets the allowedLineItemTypes value for this AdSpot.
    
    Returns:
    
    allowedLineItemTypes * The set of line item types that may appear in the ad spot. This field is optional and defaults to an empty set, which means that all types are allowed.
    Note, backfill reservation types are controlled via the backfillBlocked field.
  - setAllowedLineItemTypes
```
public void setAllowedLineItemTypes(LineItemType[] allowedLineItemTypes)
```
    Sets the allowedLineItemTypes value for this AdSpot.
    
    Parameters:
    
    allowedLineItemTypes - * The set of line item types that may appear in the ad spot. This field is optional and defaults to an empty set, which means that all types are allowed.
    Note, backfill reservation types are controlled via the backfillBlocked field.
  - getAllowedLineItemTypes
```
public LineItemType getAllowedLineItemTypes(int i)
```
  - setAllowedLineItemTypes
```
public void setAllowedLineItemTypes(int i,
                                    LineItemType _value)
```
  - getInventorySharingBlocked
```
public Boolean getInventorySharingBlocked()
```
    Gets the inventorySharingBlocked value for this AdSpot.
    
    Returns:
    
    inventorySharingBlocked * Whether inventory sharing is blocked in this ad spot. This field is optional and defaults to false.
  - setInventorySharingBlocked
```
public void setInventorySharingBlocked(Boolean inventorySharingBlocked)
```
    Sets the inventorySharingBlocked value for this AdSpot.
    
    Parameters:
    
    inventorySharingBlocked - * Whether inventory sharing is blocked in this ad spot. This field is optional and defaults to false.
  - 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

Class AdSpot

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AdSpot

AdSpot

Method Detail

toString

getId

setId

getName

setName

getDisplayName

setDisplayName

getCustomSpot

setCustomSpot

getFlexible

setFlexible

getMaxDurationMillis

setMaxDurationMillis

getMaxNumberOfAds

setMaxNumberOfAds

getTargetingType

setTargetingType

getBackfillBlocked

setBackfillBlocked

getAllowedLineItemTypes

setAllowedLineItemTypes

getAllowedLineItemTypes

setAllowedLineItemTypes

getInventorySharingBlocked

setInventorySharingBlocked

equals

hashCode

getTypeDesc

getSerializer

getDeserializer