com.google.api.ads.admanager.axis.v202008

Class AdRule

java.lang.Object

com.google.api.ads.admanager.axis.v202008.AdRule

All Implemented Interfaces:

Serializable

public class AdRule
extends Object
implements Serializable

An AdRule contains data that the ad server will use to generate a playlist of video ads.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdRule()
AdRule(Long id, String name, Integer priority, Targeting targeting, DateTime startDateTime, StartDateTimeType startDateTimeType, DateTime endDateTime, Boolean unlimitedEndDateTime, AdRuleStatus status, FrequencyCapBehavior frequencyCapBehavior, Integer maxImpressionsPerLineItemPerStream, Integer maxImpressionsPerLineItemPerPod, BaseAdRuleSlot preroll, BaseAdRuleSlot midroll, BaseAdRuleSlot postroll)

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
DateTime	getEndDateTime() Gets the endDateTime value for this AdRule.
FrequencyCapBehavior	getFrequencyCapBehavior() Gets the frequencyCapBehavior value for this AdRule.
Long	getId() Gets the id value for this AdRule.
Integer	getMaxImpressionsPerLineItemPerPod() Gets the maxImpressionsPerLineItemPerPod value for this AdRule.
Integer	getMaxImpressionsPerLineItemPerStream() Gets the maxImpressionsPerLineItemPerStream value for this AdRule.
BaseAdRuleSlot	getMidroll() Gets the midroll value for this AdRule.
String	getName() Gets the name value for this AdRule.
BaseAdRuleSlot	getPostroll() Gets the postroll value for this AdRule.
BaseAdRuleSlot	getPreroll() Gets the preroll value for this AdRule.
Integer	getPriority() Gets the priority value for this AdRule.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
DateTime	getStartDateTime() Gets the startDateTime value for this AdRule.
StartDateTimeType	getStartDateTimeType() Gets the startDateTimeType value for this AdRule.
AdRuleStatus	getStatus() Gets the status value for this AdRule.
Targeting	getTargeting() Gets the targeting value for this AdRule.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
Boolean	getUnlimitedEndDateTime() Gets the unlimitedEndDateTime value for this AdRule.
int	hashCode()
void	setEndDateTime(DateTime endDateTime) Sets the endDateTime value for this AdRule.
void	setFrequencyCapBehavior(FrequencyCapBehavior frequencyCapBehavior) Sets the frequencyCapBehavior value for this AdRule.
void	setId(Long id) Sets the id value for this AdRule.
void	setMaxImpressionsPerLineItemPerPod(Integer maxImpressionsPerLineItemPerPod) Sets the maxImpressionsPerLineItemPerPod value for this AdRule.
void	setMaxImpressionsPerLineItemPerStream(Integer maxImpressionsPerLineItemPerStream) Sets the maxImpressionsPerLineItemPerStream value for this AdRule.
void	setMidroll(BaseAdRuleSlot midroll) Sets the midroll value for this AdRule.
void	setName(String name) Sets the name value for this AdRule.
void	setPostroll(BaseAdRuleSlot postroll) Sets the postroll value for this AdRule.
void	setPreroll(BaseAdRuleSlot preroll) Sets the preroll value for this AdRule.
void	setPriority(Integer priority) Sets the priority value for this AdRule.
void	setStartDateTime(DateTime startDateTime) Sets the startDateTime value for this AdRule.
void	setStartDateTimeType(StartDateTimeType startDateTimeType) Sets the startDateTimeType value for this AdRule.
void	setStatus(AdRuleStatus status) Sets the status value for this AdRule.
void	setTargeting(Targeting targeting) Sets the targeting value for this AdRule.
void	setUnlimitedEndDateTime(Boolean unlimitedEndDateTime) Sets the unlimitedEndDateTime value for this AdRule.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AdRule

public AdRule()

AdRule

public AdRule(Long id,
              String name,
              Integer priority,
              Targeting targeting,
              DateTime startDateTime,
              StartDateTimeType startDateTimeType,
              DateTime endDateTime,
              Boolean unlimitedEndDateTime,
              AdRuleStatus status,
              FrequencyCapBehavior frequencyCapBehavior,
              Integer maxImpressionsPerLineItemPerStream,
              Integer maxImpressionsPerLineItemPerPod,
              BaseAdRuleSlot preroll,
              BaseAdRuleSlot midroll,
              BaseAdRuleSlot postroll)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getId

public Long getId()

Gets the id value for this AdRule.

Returns:

id * The unique ID of the AdRule. This value is readonly and is assigned by Google.

setId

public void setId(Long id)

Sets the id value for this AdRule.

Parameters:

id - * The unique ID of the AdRule. This value is readonly and is assigned by Google.

getName

public String getName()

Gets the name value for this AdRule.

Returns:

name * The unique name of the AdRule. This attribute is required to create an ad rule and has a maximum length of 255 characters.

setName

public void setName(String name)

Sets the name value for this AdRule.

Parameters:

name - * The unique name of the AdRule. This attribute is required to create an ad rule and has a maximum length of 255 characters.

getPriority

public Integer getPriority()

Gets the priority value for this AdRule.

Returns:

priority * The priority of the AdRule. This attribute is required and can range from 1 to 1000, with 1 being the highest possible priority.

Changing an ad rule's priority can affect the priorities of other ad rules. For example, increasing an ad rule's priority from 5 to 1 will shift the ad rules that were previously in priority positions 1 through 4 down one.

setPriority

public void setPriority(Integer priority)

Sets the priority value for this AdRule.

Parameters:

priority - * The priority of the AdRule. This attribute is required and can range from 1 to 1000, with 1 being the highest possible priority.

Changing an ad rule's priority can affect the priorities of other ad rules. For example, increasing an ad rule's priority from 5 to 1 will shift the ad rules that were previously in priority positions 1 through 4 down one.

getTargeting

public Targeting getTargeting()

Gets the targeting value for this AdRule.

Returns:

targeting * The targeting criteria of the AdRule. This attribute is required.

setTargeting

public void setTargeting(Targeting targeting)

Sets the targeting value for this AdRule.

Parameters:

targeting - * The targeting criteria of the AdRule. This attribute is required.

getStartDateTime

public DateTime getStartDateTime()

Gets the startDateTime value for this AdRule.

Returns:

startDateTime * This AdRule object's start date and time. This attribute is required and must be a date in the future for new ad rules.

setStartDateTime

public void setStartDateTime(DateTime startDateTime)

Sets the startDateTime value for this AdRule.

Parameters:

startDateTime - * This AdRule object's start date and time. This attribute is required and must be a date in the future for new ad rules.

getStartDateTimeType

public StartDateTimeType getStartDateTimeType()

Gets the startDateTimeType value for this AdRule.

Returns:

startDateTimeType * Specifies whether to start using the AdRule right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.

setStartDateTimeType

public void setStartDateTimeType(StartDateTimeType startDateTimeType)

Sets the startDateTimeType value for this AdRule.

Parameters:

startDateTimeType - * Specifies whether to start using the AdRule right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.

getEndDateTime

public DateTime getEndDateTime()

Gets the endDateTime value for this AdRule.

Returns:

endDateTime * This AdRule object's end date and time. This attribute is required unless unlimitedEndDateTime is set to true. If specified, it must be after the startDateTime.

setEndDateTime

public void setEndDateTime(DateTime endDateTime)

Sets the endDateTime value for this AdRule.

Parameters:

endDateTime - * This AdRule object's end date and time. This attribute is required unless unlimitedEndDateTime is set to true. If specified, it must be after the startDateTime.

getUnlimitedEndDateTime

public Boolean getUnlimitedEndDateTime()

Gets the unlimitedEndDateTime value for this AdRule.

Returns:

unlimitedEndDateTime * Specifies whether the AdRule has an end time. This attribute is optional and defaults to false.

setUnlimitedEndDateTime

public void setUnlimitedEndDateTime(Boolean unlimitedEndDateTime)

Sets the unlimitedEndDateTime value for this AdRule.

Parameters:

unlimitedEndDateTime - * Specifies whether the AdRule has an end time. This attribute is optional and defaults to false.

getStatus

public AdRuleStatus getStatus()

Gets the status value for this AdRule.

Returns:

status * The AdRuleStatus of the ad rule. This attribute is read-only and defaults to AdRuleStatus.INACTIVE.

setStatus

public void setStatus(AdRuleStatus status)

Sets the status value for this AdRule.

Parameters:

status - * The AdRuleStatus of the ad rule. This attribute is read-only and defaults to AdRuleStatus.INACTIVE.

getFrequencyCapBehavior

public FrequencyCapBehavior getFrequencyCapBehavior()

Gets the frequencyCapBehavior value for this AdRule.

Returns:

frequencyCapBehavior * The FrequencyCapBehavior of the AdRule. This attribute is optional and defaults to FrequencyCapBehavior.DEFER.

setFrequencyCapBehavior

public void setFrequencyCapBehavior(FrequencyCapBehavior frequencyCapBehavior)

Sets the frequencyCapBehavior value for this AdRule.

Parameters:

frequencyCapBehavior - * The FrequencyCapBehavior of the AdRule. This attribute is optional and defaults to FrequencyCapBehavior.DEFER.

getMaxImpressionsPerLineItemPerStream

public Integer getMaxImpressionsPerLineItemPerStream()

Gets the maxImpressionsPerLineItemPerStream value for this AdRule.

Returns:

maxImpressionsPerLineItemPerStream * This AdRule object's frequency cap for the maximum impressions per stream. This attribute is optional and defaults to 0.

setMaxImpressionsPerLineItemPerStream

public void setMaxImpressionsPerLineItemPerStream(Integer maxImpressionsPerLineItemPerStream)

Sets the maxImpressionsPerLineItemPerStream value for this AdRule.

Parameters:

maxImpressionsPerLineItemPerStream - * This AdRule object's frequency cap for the maximum impressions per stream. This attribute is optional and defaults to 0.

getMaxImpressionsPerLineItemPerPod

public Integer getMaxImpressionsPerLineItemPerPod()

Gets the maxImpressionsPerLineItemPerPod value for this AdRule.

Returns:

maxImpressionsPerLineItemPerPod * This AdRule object's frequency cap for the maximum impressions per pod. This attribute is optional and defaults to 0.

setMaxImpressionsPerLineItemPerPod

public void setMaxImpressionsPerLineItemPerPod(Integer maxImpressionsPerLineItemPerPod)

Sets the maxImpressionsPerLineItemPerPod value for this AdRule.

Parameters:

maxImpressionsPerLineItemPerPod - * This AdRule object's frequency cap for the maximum impressions per pod. This attribute is optional and defaults to 0.

getPreroll

public BaseAdRuleSlot getPreroll()

Gets the preroll value for this AdRule.

Returns:

preroll * This AdRule object's pre-roll slot. This attribute is required.

setPreroll

public void setPreroll(BaseAdRuleSlot preroll)

Sets the preroll value for this AdRule.

Parameters:

preroll - * This AdRule object's pre-roll slot. This attribute is required.

getMidroll

public BaseAdRuleSlot getMidroll()

Gets the midroll value for this AdRule.

Returns:

midroll * This AdRule object's mid-roll slot. This attribute is required.

setMidroll

public void setMidroll(BaseAdRuleSlot midroll)

Sets the midroll value for this AdRule.

Parameters:

midroll - * This AdRule object's mid-roll slot. This attribute is required.

getPostroll

public BaseAdRuleSlot getPostroll()

Gets the postroll value for this AdRule.

Returns:

postroll * This AdRule object's post-roll slot. This attribute is required.

setPostroll

public void setPostroll(BaseAdRuleSlot postroll)

Sets the postroll value for this AdRule.

Parameters:

postroll - * This AdRule object's post-roll slot. This attribute is required.

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