GoogleInteractiveMediaAds Framework Reference

IMAAdEventType

enum IMAAdEventType : NSInteger {}

Different event types sent by the IMAAdsManager to its delegate.

• kIMAAdEvent_AD_BREAK_READY

  Ad break ready.

  Declaration

  Swift

  case AD_BREAK_READY = 0

  Objective-C

  kIMAAdEvent_AD_BREAK_READY

• kIMAAdEvent_AD_BREAK_FETCH_ERROR

  Ad break will not play back any ads.

  Declaration

  Swift

  case AD_BREAK_FETCH_ERROR = 1

  Objective-C

  kIMAAdEvent_AD_BREAK_FETCH_ERROR

• kIMAAdEvent_AD_BREAK_ENDED

  Fired the first time each ad break ends. Applications must reenable seeking when this occurs (only used for dynamic ad insertion).

  Declaration

  Swift

  case AD_BREAK_ENDED = 2

  Objective-C

  kIMAAdEvent_AD_BREAK_ENDED

• kIMAAdEvent_AD_BREAK_STARTED

  Fired first time each ad break begins playback. If an ad break is watched subsequent times this will not be fired. Applications must disable seeking when this occurs (only used for dynamic ad insertion).

  Declaration

  Swift

  case AD_BREAK_STARTED = 3

  Objective-C

  kIMAAdEvent_AD_BREAK_STARTED

• kIMAAdEvent_AD_PERIOD_ENDED

  Fired every time the stream switches from advertising or slate to content. This will be fired even when an ad is played a second time or when seeking into an ad (only used for dynamic ad insertion).

  Declaration

  Swift

  case AD_PERIOD_ENDED = 4

  Objective-C

  kIMAAdEvent_AD_PERIOD_ENDED

• kIMAAdEvent_AD_PERIOD_STARTED

  Fired every time the stream switches from content to advertising or slate. This will be fired even when an ad is played a second time or when seeking into an ad (only used for dynamic ad insertion).

  Declaration

  Swift

  case AD_PERIOD_STARTED = 5

  Objective-C

  kIMAAdEvent_AD_PERIOD_STARTED

• kIMAAdEvent_ALL_ADS_COMPLETED

  All valid ads managed by the ads manager have completed or the ad response did not return any valid ads.

  Declaration

  Swift

  case ALL_ADS_COMPLETED = 6

  Objective-C

  kIMAAdEvent_ALL_ADS_COMPLETED

• kIMAAdEvent_CLICKED

  Ad clicked.

  Declaration

  Swift

  case CLICKED = 7

  Objective-C

  kIMAAdEvent_CLICKED

• kIMAAdEvent_COMPLETE

  Single ad has finished.

  Declaration

  Swift

  case COMPLETE = 8

  Objective-C

  kIMAAdEvent_COMPLETE

• kIMAAdEvent_CUEPOINTS_CHANGED

  Cuepoints changed for VOD stream (only used for dynamic ad insertion). For this event, the IMAAdEvent.adData property contains a list of IMACuepoints at IMAAdEvent.adData[@"cuepoints"].

  Declaration

  Swift

  case CUEPOINTS_CHANGED = 9

  Objective-C

  kIMAAdEvent_CUEPOINTS_CHANGED

• kIMAAdEvent_ICON_FALLBACK_IMAGE_CLOSED

  The user has closed the icon fallback image dialog. This may be a good time to resume ad playback, which the SDK autopaused on icon tap. This event only fires for tvOS.

  Declaration

  Swift

  case ICON_FALLBACK_IMAGE_CLOSED = 10

  Objective-C

  kIMAAdEvent_ICON_FALLBACK_IMAGE_CLOSED

• kIMAAdEvent_ICON_TAPPED

  The user has tapped an ad icon. On iOS, the SDK will navigate to the landing page. On tvOS, the SDK will present a modal dialog containing the VAST icon fallback image.

  Declaration

  Swift

  case ICON_TAPPED = 11

  Objective-C

  kIMAAdEvent_ICON_TAPPED

• kIMAAdEvent_FIRST_QUARTILE

  First quartile of a linear ad was reached.

  Declaration

  Swift

  case FIRST_QUARTILE = 12

  Objective-C

  kIMAAdEvent_FIRST_QUARTILE

• kIMAAdEvent_LOADED

  An ad was loaded.

  Declaration

  Swift

  case LOADED = 13

  Objective-C

  kIMAAdEvent_LOADED

• kIMAAdEvent_LOG

  A log event for the ads being played. These are typically non fatal errors.

  Declaration

  Swift

  case LOG = 14

  Objective-C

  kIMAAdEvent_LOG

• kIMAAdEvent_MIDPOINT

  Midpoint of a linear ad was reached.

  Declaration

  Swift

  case MIDPOINT = 15

  Objective-C

  kIMAAdEvent_MIDPOINT

• kIMAAdEvent_PAUSE

  Ad paused.

  Declaration

  Swift

  case PAUSE = 16

  Objective-C

  kIMAAdEvent_PAUSE

• kIMAAdEvent_RESUME

  Ad resumed.

  Declaration

  Swift

  case RESUME = 17

  Objective-C

  kIMAAdEvent_RESUME

• kIMAAdEvent_SKIPPED

  Ad has skipped.

  Declaration

  Swift

  case SKIPPED = 18

  Objective-C

  kIMAAdEvent_SKIPPED

• kIMAAdEvent_STARTED

  Ad has started.

  Declaration

  Swift

  case STARTED = 19

  Objective-C

  kIMAAdEvent_STARTED

• kIMAAdEvent_STREAM_LOADED

  Stream request has loaded (only used for dynamic ad insertion).

  Declaration

  Swift

  case STREAM_LOADED = 20

  Objective-C

  kIMAAdEvent_STREAM_LOADED

• kIMAAdEvent_STREAM_STARTED

  Stream has started playing (only used for dynamic ad insertion). Start Picture-in-Picture here if applicable.

  Declaration

  Swift

  case STREAM_STARTED = 21

  Objective-C

  kIMAAdEvent_STREAM_STARTED

• kIMAAdEvent_TAPPED

  Ad tapped.

  Declaration

  Swift

  case TAPPED = 22

  Objective-C

  kIMAAdEvent_TAPPED

• kIMAAdEvent_THIRD_QUARTILE

  Third quartile of a linear ad was reached.

  Declaration

  Swift

  case THIRD_QUARTILE = 23

  Objective-C

  kIMAAdEvent_THIRD_QUARTILE