AdRule (DFP AppEngine components 3.14.2 API)

java.lang.Object
- com.google.api.ads.dfp.jaxws.v201711.AdRule

public class AdRule
extends Object

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

Java class for AdRule complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="AdRule">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="adRuleId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="priority" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="targeting" type="{https://www.google.com/apis/ads/publisher/v201711}Targeting" minOccurs="0"/>
         <element name="startDateTime" type="{https://www.google.com/apis/ads/publisher/v201711}DateTime" minOccurs="0"/>
         <element name="startDateTimeType" type="{https://www.google.com/apis/ads/publisher/v201711}StartDateTimeType" minOccurs="0"/>
         <element name="endDateTime" type="{https://www.google.com/apis/ads/publisher/v201711}DateTime" minOccurs="0"/>
         <element name="unlimitedEndDateTime" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="status" type="{https://www.google.com/apis/ads/publisher/v201711}AdRuleStatus" minOccurs="0"/>
         <element name="frequencyCapBehavior" type="{https://www.google.com/apis/ads/publisher/v201711}FrequencyCapBehavior" minOccurs="0"/>
         <element name="maxImpressionsPerLineItemPerStream" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="maxImpressionsPerLineItemPerPod" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="preroll" type="{https://www.google.com/apis/ads/publisher/v201711}BaseAdRuleSlot" minOccurs="0"/>
         <element name="midroll" type="{https://www.google.com/apis/ads/publisher/v201711}BaseAdRuleSlot" minOccurs="0"/>
         <element name="postroll" type="{https://www.google.com/apis/ads/publisher/v201711}BaseAdRuleSlot" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Long`	`adRuleId`
`protected DateTime`	`endDateTime`
`protected FrequencyCapBehavior`	`frequencyCapBehavior`
`protected Integer`	`maxImpressionsPerLineItemPerPod`
`protected Integer`	`maxImpressionsPerLineItemPerStream`
`protected BaseAdRuleSlot`	`midroll`
`protected String`	`name`
`protected BaseAdRuleSlot`	`postroll`
`protected BaseAdRuleSlot`	`preroll`
`protected Integer`	`priority`
`protected DateTime`	`startDateTime`
`protected StartDateTimeType`	`startDateTimeType`
`protected AdRuleStatus`	`status`
`protected Targeting`	`targeting`
`protected Boolean`	`unlimitedEndDateTime`

Constructor Summary

Constructors
Constructor and Description

AdRule()

Constructors
Constructor and Description
`AdRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getAdRuleId()` Gets the value of the adRuleId property.
`DateTime`	`getEndDateTime()` Gets the value of the endDateTime property.
`FrequencyCapBehavior`	`getFrequencyCapBehavior()` Gets the value of the frequencyCapBehavior property.
`Integer`	`getMaxImpressionsPerLineItemPerPod()` Gets the value of the maxImpressionsPerLineItemPerPod property.
`Integer`	`getMaxImpressionsPerLineItemPerStream()` Gets the value of the maxImpressionsPerLineItemPerStream property.
`BaseAdRuleSlot`	`getMidroll()` Gets the value of the midroll property.
`String`	`getName()` Gets the value of the name property.
`BaseAdRuleSlot`	`getPostroll()` Gets the value of the postroll property.
`BaseAdRuleSlot`	`getPreroll()` Gets the value of the preroll property.
`Integer`	`getPriority()` Gets the value of the priority property.
`DateTime`	`getStartDateTime()` Gets the value of the startDateTime property.
`StartDateTimeType`	`getStartDateTimeType()` Gets the value of the startDateTimeType property.
`AdRuleStatus`	`getStatus()` Gets the value of the status property.
`Targeting`	`getTargeting()` Gets the value of the targeting property.
`Boolean`	`isUnlimitedEndDateTime()` Gets the value of the unlimitedEndDateTime property.
`void`	`setAdRuleId(Long value)` Sets the value of the adRuleId property.
`void`	`setEndDateTime(DateTime value)` Sets the value of the endDateTime property.
`void`	`setFrequencyCapBehavior(FrequencyCapBehavior value)` Sets the value of the frequencyCapBehavior property.
`void`	`setMaxImpressionsPerLineItemPerPod(Integer value)` Sets the value of the maxImpressionsPerLineItemPerPod property.
`void`	`setMaxImpressionsPerLineItemPerStream(Integer value)` Sets the value of the maxImpressionsPerLineItemPerStream property.
`void`	`setMidroll(BaseAdRuleSlot value)` Sets the value of the midroll property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setPostroll(BaseAdRuleSlot value)` Sets the value of the postroll property.
`void`	`setPreroll(BaseAdRuleSlot value)` Sets the value of the preroll property.
`void`	`setPriority(Integer value)` Sets the value of the priority property.
`void`	`setStartDateTime(DateTime value)` Sets the value of the startDateTime property.
`void`	`setStartDateTimeType(StartDateTimeType value)` Sets the value of the startDateTimeType property.
`void`	`setStatus(AdRuleStatus value)` Sets the value of the status property.
`void`	`setTargeting(Targeting value)` Sets the value of the targeting property.
`void`	`setUnlimitedEndDateTime(Boolean value)` Sets the value of the unlimitedEndDateTime property.

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

- Field Detail
  - adRuleId
```
protected Long adRuleId
```
  - name
```
protected String name
```
  - priority
```
protected Integer priority
```
  - targeting
```
protected Targeting targeting
```
  - startDateTime
```
protected DateTime startDateTime
```
  - startDateTimeType
```
protected StartDateTimeType startDateTimeType
```
  - endDateTime
```
protected DateTime endDateTime
```
  - unlimitedEndDateTime
```
protected Boolean unlimitedEndDateTime
```
  - status
```
protected AdRuleStatus status
```
  - frequencyCapBehavior
```
protected FrequencyCapBehavior frequencyCapBehavior
```
  - maxImpressionsPerLineItemPerStream
```
protected Integer maxImpressionsPerLineItemPerStream
```
  - maxImpressionsPerLineItemPerPod
```
protected Integer maxImpressionsPerLineItemPerPod
```
  - preroll
```
protected BaseAdRuleSlot preroll
```
  - midroll
```
protected BaseAdRuleSlot midroll
```
  - postroll
```
protected BaseAdRuleSlot postroll
```
- Constructor Detail
  - AdRule
```
public AdRule()
```
- Method Detail
  - getAdRuleId
```
public Long getAdRuleId()
```
    Gets the value of the adRuleId property.
    
    Returns:
    
    possible object is Long
  - setAdRuleId
```
public void setAdRuleId(Long value)
```
    Sets the value of the adRuleId property.
    
    Parameters:
    
    value - allowed object is Long
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getPriority
```
public Integer getPriority()
```
    Gets the value of the priority property.
    
    Returns:
    
    possible object is Integer
  - setPriority
```
public void setPriority(Integer value)
```
    Sets the value of the priority property.
    
    Parameters:
    
    value - allowed object is Integer
  - getTargeting
```
public Targeting getTargeting()
```
    Gets the value of the targeting property.
    
    Returns:
    
    possible object is Targeting
  - setTargeting
```
public void setTargeting(Targeting value)
```
    Sets the value of the targeting property.
    
    Parameters:
    
    value - allowed object is Targeting
  - getStartDateTime
```
public DateTime getStartDateTime()
```
    Gets the value of the startDateTime property.
    
    Returns:
    
    possible object is DateTime
  - setStartDateTime
```
public void setStartDateTime(DateTime value)
```
    Sets the value of the startDateTime property.
    
    Parameters:
    
    value - allowed object is DateTime
  - getStartDateTimeType
```
public StartDateTimeType getStartDateTimeType()
```
    Gets the value of the startDateTimeType property.
    
    Returns:
    
    possible object is StartDateTimeType
  - setStartDateTimeType
```
public void setStartDateTimeType(StartDateTimeType value)
```
    Sets the value of the startDateTimeType property.
    
    Parameters:
    
    value - allowed object is StartDateTimeType
  - getEndDateTime
```
public DateTime getEndDateTime()
```
    Gets the value of the endDateTime property.
    
    Returns:
    
    possible object is DateTime
  - setEndDateTime
```
public void setEndDateTime(DateTime value)
```
    Sets the value of the endDateTime property.
    
    Parameters:
    
    value - allowed object is DateTime
  - isUnlimitedEndDateTime
```
public Boolean isUnlimitedEndDateTime()
```
    Gets the value of the unlimitedEndDateTime property.
    
    Returns:
    
    possible object is Boolean
  - setUnlimitedEndDateTime
```
public void setUnlimitedEndDateTime(Boolean value)
```
    Sets the value of the unlimitedEndDateTime property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getStatus
```
public AdRuleStatus getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is AdRuleStatus
  - setStatus
```
public void setStatus(AdRuleStatus value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is AdRuleStatus
  - getFrequencyCapBehavior
```
public FrequencyCapBehavior getFrequencyCapBehavior()
```
    Gets the value of the frequencyCapBehavior property.
    
    Returns:
    
    possible object is FrequencyCapBehavior
  - setFrequencyCapBehavior
```
public void setFrequencyCapBehavior(FrequencyCapBehavior value)
```
    Sets the value of the frequencyCapBehavior property.
    
    Parameters:
    
    value - allowed object is FrequencyCapBehavior
  - getMaxImpressionsPerLineItemPerStream
```
public Integer getMaxImpressionsPerLineItemPerStream()
```
    Gets the value of the maxImpressionsPerLineItemPerStream property.
    
    Returns:
    
    possible object is Integer
  - setMaxImpressionsPerLineItemPerStream
```
public void setMaxImpressionsPerLineItemPerStream(Integer value)
```
    Sets the value of the maxImpressionsPerLineItemPerStream property.
    
    Parameters:
    
    value - allowed object is Integer
  - getMaxImpressionsPerLineItemPerPod
```
public Integer getMaxImpressionsPerLineItemPerPod()
```
    Gets the value of the maxImpressionsPerLineItemPerPod property.
    
    Returns:
    
    possible object is Integer
  - setMaxImpressionsPerLineItemPerPod
```
public void setMaxImpressionsPerLineItemPerPod(Integer value)
```
    Sets the value of the maxImpressionsPerLineItemPerPod property.
    
    Parameters:
    
    value - allowed object is Integer
  - getPreroll
```
public BaseAdRuleSlot getPreroll()
```
    Gets the value of the preroll property.
    
    Returns:
    
    possible object is BaseAdRuleSlot
  - setPreroll
```
public void setPreroll(BaseAdRuleSlot value)
```
    Sets the value of the preroll property.
    
    Parameters:
    
    value - allowed object is BaseAdRuleSlot
  - getMidroll
```
public BaseAdRuleSlot getMidroll()
```
    Gets the value of the midroll property.
    
    Returns:
    
    possible object is BaseAdRuleSlot
  - setMidroll
```
public void setMidroll(BaseAdRuleSlot value)
```
    Sets the value of the midroll property.
    
    Parameters:
    
    value - allowed object is BaseAdRuleSlot
  - getPostroll
```
public BaseAdRuleSlot getPostroll()
```
    Gets the value of the postroll property.
    
    Returns:
    
    possible object is BaseAdRuleSlot
  - setPostroll
```
public void setPostroll(BaseAdRuleSlot value)
```
    Sets the value of the postroll property.
    
    Parameters:
    
    value - allowed object is BaseAdRuleSlot

Class AdRule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

adRuleId

name

priority

targeting

startDateTime

startDateTimeType

endDateTime

unlimitedEndDateTime

status

frequencyCapBehavior

maxImpressionsPerLineItemPerStream

maxImpressionsPerLineItemPerPod

preroll

midroll

postroll

Constructor Detail

AdRule

Method Detail

getAdRuleId

setAdRuleId

getName

setName

getPriority

setPriority

getTargeting

setTargeting

getStartDateTime

setStartDateTime

getStartDateTimeType

setStartDateTimeType

getEndDateTime

setEndDateTime

isUnlimitedEndDateTime

setUnlimitedEndDateTime

getStatus

setStatus

getFrequencyCapBehavior

setFrequencyCapBehavior

getMaxImpressionsPerLineItemPerStream

setMaxImpressionsPerLineItemPerStream

getMaxImpressionsPerLineItemPerPod

setMaxImpressionsPerLineItemPerPod

getPreroll

setPreroll

getMidroll

setMidroll

getPostroll

setPostroll