com.google.api.ads.dfp.axis.v201802

Class BaseAdRuleSlot

java.lang.Object

com.google.api.ads.dfp.axis.v201802.BaseAdRuleSlot

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NoPoddingAdRuleSlot, OptimizedPoddingAdRuleSlot, StandardPoddingAdRuleSlot, UnknownAdRuleSlot

public abstract class BaseAdRuleSlot
extends Object
implements Serializable

Simple object representing an ad slot within an AdRule. Ad rule slots contain information about the types/number of ads to display, as well as additional information on how the ad server will generate playlists.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseAdRuleSlot()
BaseAdRuleSlot(AdRuleSlotBehavior slotBehavior, Long minVideoAdDuration, Long maxVideoAdDuration, MidrollFrequencyType videoMidrollFrequencyType, String videoMidrollFrequency, AdRuleSlotBumper bumper, Long maxBumperDuration, Long minPodDuration, Long maxPodDuration, Integer maxAdsInPod)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AdRuleSlotBumper	getBumper() Gets the bumper value for this BaseAdRuleSlot.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Integer	getMaxAdsInPod() Gets the maxAdsInPod value for this BaseAdRuleSlot.
Long	getMaxBumperDuration() Gets the maxBumperDuration value for this BaseAdRuleSlot.
Long	getMaxPodDuration() Gets the maxPodDuration value for this BaseAdRuleSlot.
Long	getMaxVideoAdDuration() Gets the maxVideoAdDuration value for this BaseAdRuleSlot.
Long	getMinPodDuration() Gets the minPodDuration value for this BaseAdRuleSlot.
Long	getMinVideoAdDuration() Gets the minVideoAdDuration value for this BaseAdRuleSlot.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
AdRuleSlotBehavior	getSlotBehavior() Gets the slotBehavior value for this BaseAdRuleSlot.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
String	getVideoMidrollFrequency() Gets the videoMidrollFrequency value for this BaseAdRuleSlot.
MidrollFrequencyType	getVideoMidrollFrequencyType() Gets the videoMidrollFrequencyType value for this BaseAdRuleSlot.
int	hashCode()
void	setBumper(AdRuleSlotBumper bumper) Sets the bumper value for this BaseAdRuleSlot.
void	setMaxAdsInPod(Integer maxAdsInPod) Sets the maxAdsInPod value for this BaseAdRuleSlot.
void	setMaxBumperDuration(Long maxBumperDuration) Sets the maxBumperDuration value for this BaseAdRuleSlot.
void	setMaxPodDuration(Long maxPodDuration) Sets the maxPodDuration value for this BaseAdRuleSlot.
void	setMaxVideoAdDuration(Long maxVideoAdDuration) Sets the maxVideoAdDuration value for this BaseAdRuleSlot.
void	setMinPodDuration(Long minPodDuration) Sets the minPodDuration value for this BaseAdRuleSlot.
void	setMinVideoAdDuration(Long minVideoAdDuration) Sets the minVideoAdDuration value for this BaseAdRuleSlot.
void	setSlotBehavior(AdRuleSlotBehavior slotBehavior) Sets the slotBehavior value for this BaseAdRuleSlot.
void	setVideoMidrollFrequency(String videoMidrollFrequency) Sets the videoMidrollFrequency value for this BaseAdRuleSlot.
void	setVideoMidrollFrequencyType(MidrollFrequencyType videoMidrollFrequencyType) Sets the videoMidrollFrequencyType value for this BaseAdRuleSlot.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseAdRuleSlot

public BaseAdRuleSlot()

BaseAdRuleSlot

public BaseAdRuleSlot(AdRuleSlotBehavior slotBehavior,
                      Long minVideoAdDuration,
                      Long maxVideoAdDuration,
                      MidrollFrequencyType videoMidrollFrequencyType,
                      String videoMidrollFrequency,
                      AdRuleSlotBumper bumper,
                      Long maxBumperDuration,
                      Long minPodDuration,
                      Long maxPodDuration,
                      Integer maxAdsInPod)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getSlotBehavior

public AdRuleSlotBehavior getSlotBehavior()

Gets the slotBehavior value for this BaseAdRuleSlot.

Returns:

slotBehavior * The AdRuleSlotBehavior for video ads for this slot. This attribute is optional and defaults to AdRuleSlotBehavior.DEFER.

Indicates whether video ads are allowed for this slot, or if the decision is deferred to a lower-priority ad rule.

setSlotBehavior

public void setSlotBehavior(AdRuleSlotBehavior slotBehavior)

Sets the slotBehavior value for this BaseAdRuleSlot.

Parameters:

slotBehavior - * The AdRuleSlotBehavior for video ads for this slot. This attribute is optional and defaults to AdRuleSlotBehavior.DEFER.

Indicates whether video ads are allowed for this slot, or if the decision is deferred to a lower-priority ad rule.

getMinVideoAdDuration

public Long getMinVideoAdDuration()

Gets the minVideoAdDuration value for this BaseAdRuleSlot.

Returns:

minVideoAdDuration * The minimum duration in milliseconds of video ads within this slot. This attribute is optional and defaults to 0.

setMinVideoAdDuration

public void setMinVideoAdDuration(Long minVideoAdDuration)

Sets the minVideoAdDuration value for this BaseAdRuleSlot.

Parameters:

minVideoAdDuration - * The minimum duration in milliseconds of video ads within this slot. This attribute is optional and defaults to 0.

getMaxVideoAdDuration

public Long getMaxVideoAdDuration()

Gets the maxVideoAdDuration value for this BaseAdRuleSlot.

Returns:

maxVideoAdDuration * The maximum duration in milliseconds of video ads within this slot. This attribute is optional and defaults to 0.

setMaxVideoAdDuration

public void setMaxVideoAdDuration(Long maxVideoAdDuration)

Sets the maxVideoAdDuration value for this BaseAdRuleSlot.

Parameters:

maxVideoAdDuration - * The maximum duration in milliseconds of video ads within this slot. This attribute is optional and defaults to 0.

getVideoMidrollFrequencyType

public MidrollFrequencyType getVideoMidrollFrequencyType()

Gets the videoMidrollFrequencyType value for this BaseAdRuleSlot.

Returns:

videoMidrollFrequencyType * The frequency type for video ads in this ad rule slot. This attribute is required for mid-rolls, but if this is not a mid-roll, the value is set to MidrollFrequencyType.NONE.

setVideoMidrollFrequencyType

public void setVideoMidrollFrequencyType(MidrollFrequencyType videoMidrollFrequencyType)

Sets the videoMidrollFrequencyType value for this BaseAdRuleSlot.

Parameters:

videoMidrollFrequencyType - * The frequency type for video ads in this ad rule slot. This attribute is required for mid-rolls, but if this is not a mid-roll, the value is set to MidrollFrequencyType.NONE.

getVideoMidrollFrequency

public String getVideoMidrollFrequency()

Gets the videoMidrollFrequency value for this BaseAdRuleSlot.

Returns:

videoMidrollFrequency * The mid-roll frequency of this ad rule slot for video ads. This attribute is required for mid-rolls, but if MidrollFrequencyType is set to MidrollFrequencyType.NONE, this value should be ignored. For example, if this slot has a frequency type of MidrollFrequencyType.EVERY_N_SECONDS and #videoMidrollFrequency = "60", this would mean " play a mid-roll every 60 seconds."

setVideoMidrollFrequency

public void setVideoMidrollFrequency(String videoMidrollFrequency)

Sets the videoMidrollFrequency value for this BaseAdRuleSlot.

Parameters:

videoMidrollFrequency - * The mid-roll frequency of this ad rule slot for video ads. This attribute is required for mid-rolls, but if MidrollFrequencyType is set to MidrollFrequencyType.NONE, this value should be ignored. For example, if this slot has a frequency type of MidrollFrequencyType.EVERY_N_SECONDS and #videoMidrollFrequency = "60", this would mean " play a mid-roll every 60 seconds."

getBumper

public AdRuleSlotBumper getBumper()

Gets the bumper value for this BaseAdRuleSlot.

Returns:

bumper * The AdRuleSlotBumper for this slot. This attribute is optional and defaults to AdRuleSlotBumper.NONE.

setBumper

public void setBumper(AdRuleSlotBumper bumper)

Sets the bumper value for this BaseAdRuleSlot.

Parameters:

bumper - * The AdRuleSlotBumper for this slot. This attribute is optional and defaults to AdRuleSlotBumper.NONE.

getMaxBumperDuration

public Long getMaxBumperDuration()

Gets the maxBumperDuration value for this BaseAdRuleSlot.

Returns:

maxBumperDuration * The maximum duration of bumper ads within this slot. This attribute is optional and defaults to 0.

setMaxBumperDuration

public void setMaxBumperDuration(Long maxBumperDuration)

Sets the maxBumperDuration value for this BaseAdRuleSlot.

Parameters:

maxBumperDuration - * The maximum duration of bumper ads within this slot. This attribute is optional and defaults to 0.

getMinPodDuration

public Long getMinPodDuration()

Gets the minPodDuration value for this BaseAdRuleSlot.

Returns:

minPodDuration * The minimum pod duration in milliseconds for this slot. This attribute is optional and defaults to 0.

setMinPodDuration

public void setMinPodDuration(Long minPodDuration)

Sets the minPodDuration value for this BaseAdRuleSlot.

Parameters:

minPodDuration - * The minimum pod duration in milliseconds for this slot. This attribute is optional and defaults to 0.

getMaxPodDuration

public Long getMaxPodDuration()

Gets the maxPodDuration value for this BaseAdRuleSlot.

Returns:

maxPodDuration * The maximum pod duration in milliseconds for this slot. This attribute is optional and defaults to 0.

setMaxPodDuration

public void setMaxPodDuration(Long maxPodDuration)

Sets the maxPodDuration value for this BaseAdRuleSlot.

Parameters:

maxPodDuration - * The maximum pod duration in milliseconds for this slot. This attribute is optional and defaults to 0.

getMaxAdsInPod

public Integer getMaxAdsInPod()

Gets the maxAdsInPod value for this BaseAdRuleSlot.

Returns:

maxAdsInPod * The maximum number of ads allowed in a pod in this slot. This attribute is optional and defaults to 0.

setMaxAdsInPod

public void setMaxAdsInPod(Integer maxAdsInPod)

Sets the maxAdsInPod value for this BaseAdRuleSlot.

Parameters:

maxAdsInPod - * The maximum number of ads allowed in a pod in this slot. This attribute is optional and defaults to 0.

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