com.google.api.ads.dfp.jaxws.v201711

Enum MidrollFrequencyType

java.lang.Object

java.lang.Enum<MidrollFrequencyType>

com.google.api.ads.dfp.jaxws.v201711.MidrollFrequencyType

All Implemented Interfaces:

Serializable, Comparable<MidrollFrequencyType>

public enum MidrollFrequencyType
extends Enum<MidrollFrequencyType>

Java class for MidrollFrequencyType.

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

 <simpleType name="MidrollFrequencyType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="NONE"/>
     <enumeration value="EVERY_N_SECONDS"/>
     <enumeration value="FIXED_TIME"/>
     <enumeration value="EVERY_N_CUEPOINTS"/>
     <enumeration value="FIXED_CUE_POINTS"/>
     <enumeration value="UNKNOWN"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVERY_N_CUEPOINTS MidrollFrequency is a cue point interval and is a single integer value, such as "5", which means "play a mid-roll every 5th cue point".
EVERY_N_SECONDS MidrollFrequency is a time interval and mentioned as a single numeric value in seconds.
FIXED_CUE_POINTS Same as FIXED_TIME, except the values represent the ordinal cue points ("1,3,5", for example).
FIXED_TIME MidrollFrequency is a comma-delimited list of points in time (in seconds) when an ad should play.
NONE The ad rule slot is not a mid-roll and hence MidrollFrequency should be ignored.
UNKNOWN The value returned if the actual value is not exposed by the requested API version.

Method Summary

Modifier and Type	Method and Description
static MidrollFrequencyType	fromValue(String v)
String	value()
static MidrollFrequencyType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MidrollFrequencyType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final MidrollFrequencyType NONE

The ad rule slot is not a mid-roll and hence MidrollFrequency should be ignored.

EVERY_N_SECONDS

public static final MidrollFrequencyType EVERY_N_SECONDS

MidrollFrequency is a time interval and mentioned as a single numeric value in seconds. For example, "100" would mean "play a mid-roll every 100 seconds".

FIXED_TIME

public static final MidrollFrequencyType FIXED_TIME

MidrollFrequency is a comma-delimited list of points in time (in seconds) when an ad should play. For example, "100,300" would mean "play an ad at 100 seconds and 300 seconds".

EVERY_N_CUEPOINTS

public static final MidrollFrequencyType EVERY_N_CUEPOINTS

MidrollFrequency is a cue point interval and is a single integer value, such as "5", which means "play a mid-roll every 5th cue point".

FIXED_CUE_POINTS

public static final MidrollFrequencyType FIXED_CUE_POINTS

Same as FIXED_TIME, except the values represent the ordinal cue points ("1,3,5", for example).

UNKNOWN

public static final MidrollFrequencyType UNKNOWN

The value returned if the actual value is not exposed by the requested API version.

Method Detail

values

public static MidrollFrequencyType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MidrollFrequencyType c : MidrollFrequencyType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MidrollFrequencyType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

fromValue

public static MidrollFrequencyType fromValue(String v)