Package com.iab.omid.library.adsession

Enum Class ImpressionType

java.lang.Object

java.lang.Enum<ImpressionType>

com.iab.omid.library.adsession.ImpressionType

All Implemented Interfaces:

Serializable, Comparable<ImpressionType>, Constable

public enum ImpressionType
extends Enum<ImpressionType>

The criterion for an ad session's OMID impression event. Declaring an impression type makes it easier to understand discrepancies between measurers of the ad session, since many metrics depend on impressions.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUDIBLE	The integration is using audible criteria (2 continuous second of media playback with non-zero volume) for the OMID impression.
BEGIN_TO_RENDER	The integration is using begin-to-render criteria for the OMID impression.
DEFINED_BY_JAVASCRIPT	Impression type will be set by JavaScript session script.
LOADED	The integration is using count-on-download criteria for the OMID impression.
ONE_PIXEL	The integration is using one-pixel criteria (when the creative has at least 1 visible pixel on screen) for the OMID impression.
OTHER	The integration's criteria uses none of the above criteria for the OMID impression.
UNSPECIFIED	The integration is not declaring the criteria for the OMID impression.
VIEWABLE	The integration is using viewable criteria (1 second for display, 2 seconds while playing for video, and at least 50% of the creative is visible) for the OMID impression.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFINED_BY_JAVASCRIPT

public static final ImpressionType DEFINED_BY_JAVASCRIPT

Impression type will be set by JavaScript session script.

UNSPECIFIED

public static final ImpressionType UNSPECIFIED

The integration is not declaring the criteria for the OMID impression. This is the default impression type for OMID 1.2 and for integrations that don't set an impression type.

LOADED

public static final ImpressionType LOADED

The integration is using count-on-download criteria for the OMID impression.

BEGIN_TO_RENDER

public static final ImpressionType BEGIN_TO_RENDER

The integration is using begin-to-render criteria for the OMID impression.

ONE_PIXEL

public static final ImpressionType ONE_PIXEL

The integration is using one-pixel criteria (when the creative has at least 1 visible pixel on screen) for the OMID impression.

VIEWABLE

public static final ImpressionType VIEWABLE

The integration is using viewable criteria (1 second for display, 2 seconds while playing for video, and at least 50% of the creative is visible) for the OMID impression.

AUDIBLE

public static final ImpressionType AUDIBLE

The integration is using audible criteria (2 continuous second of media playback with non-zero volume) for the OMID impression.

OTHER

public static final ImpressionType OTHER

The integration's criteria uses none of the above criteria for the OMID impression.

Method Details

values

public static ImpressionType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ImpressionType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<ImpressionType>