Package com.naver.ads.video.vast.raw

Enum VastEvent

  • All Implemented Interfaces:
    java.io.Serializable , kotlin.Comparable 
    
public enum VastEvent
extends Enum<VastEvent>

    The event of VAST.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class VastEvent.Companion

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      MUTE

      The user activated the mute control and muted the creative
      UNMUTE

      The user activated the mute control and unmuted the creative.
      PAUSE

      The user clicked the pause control and stopped the creative.
      RESUME

      The user activated the resume control after the creative had been stopped or paused.
      REWIND

      The user activated the rewind control to access a previous point in the creative timeline.
      SKIP

      The user activated a skip control to skip the creative.
      PLAYER_EXPAND

      The user activated a control to extend the player to a larger size. This event replaces the fullscreen event per the 2014 Digital Video In-Stream Ad Metric Definitions.
      EXPAND
      PLAYER_COLLAPSE

      The user activated a control to reduce player to a smaller size. This event replaces the exitFullscreen event per the 2014 Digital Video In-Stream Ad Metric Definitions.
      COLLAPSE
      FULLSCREEN

      The user activated a control to extend the video player to the edges of the viewer’s screen.
      EXIT_FULLSCREEN

      The user activated the control to reduce video player size to original dimensions.
      NOT_USED

      This ad was not and will not be played (e.g. it was prefetched for a particular ad break but was not chosen for playback). This allows ad servers to reuse an ad earlier than otherwise would be possible due to budget/frequency capping. This is a terminal event; no other tracking events should be sent when this is used. Player support is optional and if implemented is provided on a best effort basis as it is not technically possible to fire this event for every unused ad (e.g. when the player itself is terminated before playback).
      LOADED

      This event should be used to indicate when the player considers that it has loaded and buffered the creative’s media and assets either fully or to the extent that it is ready to play the media.
      START

      This event is used to indicate that an individual creative within the ad was loaded and playback began. As with creativeView, this event is another way of tracking creative playback. Macros defined to describe auto-play and muted states.
      FIRST_QUARTILE

      The creative played continuously for at least 25% of the total duration. at normal speed.
      MID_POINT

      The creative played continuously for at least 50% of the total duration at normal speed.
      THIRD_QUARTILE

      The creative played continuously for at least 75% of the duration at normal speed.
      COMPLETE

      The creative was played to the end at normal speed so that 100% of the creative was played.
      PROGRESS

      The creative played for a duration at normal speed that is equal to or greater than the value provided in an additional offset attribute for the <Tracking> element under Linear ads. Values can be time in the format HH:MM:SS or HH:MM:SS.mmm or a percentage value in the format n%. Multiple progress events with different values can be used to track multiple progress points in the linear creative timeline. This event can be used in addition to, or instead of, the quartile events (firstQuartile, midpoint, thirdQuartile, complete). The additional <Tracking> offset value can be used to help track a view when an agreed upon duration or percentage of the ad has played.
      CLOSE_LINEAR

      The viewer has chosen to close the linear ad unit. This is currently inuse by some of the largest mobile SDKs to mark the dismissal of the end card companion that follows the video, as well as a close of the video itself, if applicable.
      CREATIVE_VIEW

      Not to be confused with an impression, this event indicates that an individual creative portion of the ad was viewed. An impression indicates that at least a portion of the ad was displayed; however an ad may be composed of multiple creative, or creative that only play on some platforms and not others. This event enables ad servers to track which ad creative are viewed, and therefore, which platforms are more common.
      ACCEPT_INVITATION

      The user clicked or otherwise activated a control used to pause streaming content, which either expands the ad within the player’s viewable area or takes-over the streaming content area by launching an additional portion of the ad. An ad in video format ad is usually played upon acceptance, but other forms of media such as games, animation, tutorials, social media, or other engaging media are also used.
      AD_EXPAND

      The user activated a control to expand the creative.
      AD_COLLAPSE

      The user activated a control to reduce the creative to its original dimensions.
      MINIMIZE

      The user clicked or otherwise activated a control used to minimize the ad to a size smaller than a collapsed ad but without fully dispatching the ad from the player environment. Unlike a collapsed ad that is big enough to display it’s message, the minimized ad is only big enough to offer a control that enables the user to redisplay the ad if desired.
      CLOSE

      The user clicked or otherwise activated a control for removing the ad, which fully dispatches the ad from the player environment in a manner that does not allow the user to re-display the ad.
      OVERLAY_VIEW_DURATION

      The time that the initial ad is displayed. This time is based on the time between the impression and either the completed length of display based on the agreement between transactional parties or a close, minimize, or accept invitation event.
      OTHER_AD_INTERACTION

      An optional metric that can capture all other user interactions under one metric such a s hover-overs, or custom clicks. It should NOT replace clickthrough events or other existing events like mute, unmute, pause, etc.
      NOT_SUPPORTED

    • Method Summary

      Modifier and Type Method Description
      final VastEvent valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<VastEvent> values() Returns an array containing the constants of this enum type, in the order they're declared.
      final String getKey() the key of vast event.
      final Boolean getOneTime() the value indicating whether it should be fired only once.
      final EnumEntries<VastEvent> getEntries() The event of VAST.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • valueOf

         final VastEvent valueOf(String value)

        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.)

      • values

         final Array<VastEvent> values()

        Returns an array containing the constants of this enum type, in the order they're declared.

        This method may be used to iterate over the constants.

      • getOneTime

         final Boolean getOneTime()

        the value indicating whether it should be fired only once.