GoogleInteractiveMediaAds Framework Reference

IMAAdPodInfo

@interface IMAAdPodInfo : NSObject

Simple data object containing podding metadata.

• totalAds

  Total number of ads in the pod this ad belongs to. Will be 1 for standalone ads.

  Declaration

  Swift

  var totalAds: Int { get }

  Objective-C

  @property (nonatomic, readonly) NSInteger totalAds;

• adPosition

  The position of this ad within an ad pod. Will be 1 for standalone ads.

  Declaration

  Swift

  var adPosition: Int { get }

  Objective-C

  @property (nonatomic, readonly) NSInteger adPosition;

• isBumper

  Specifies whether the ad is a bumper. Bumpers are short videos used to open and close ad breaks.

  Declaration

  Swift

  var isBumper: Bool { get }

  Objective-C

  @property (nonatomic, readonly) BOOL isBumper;

• podIndex

  Client side: Returns the index of the ad pod. For a preroll pod, returns 0. For midrolls, returns 1, 2,…, N. For a postroll pod, returns -1. Defaults to 0 if this ad is not part of a pod, or this pod is not part of a playlist. DAI live stream: Returns the index of the ad pod. For a preroll pod, returns

  1. For midrolls, returns the break ID. Returns -2 if pod index cannot be determined (internal error). DAI VOD: Returns the index of the ad pod. For a preroll pod, returns 0. For midrolls, returns 1, 2,…,N. For a postroll pod, returns N+1…N+X. Defaults to 0 if this ad is not part of a pod, or this pod is not part of a playlist.

  Declaration

  Swift

  var podIndex: Int { get }

  Objective-C

  @property (nonatomic, readonly) NSInteger podIndex;

• timeOffset

  The position of the pod in the content in seconds. Pre-roll returns 0, post-roll returns -1 and mid-rolls return the scheduled time of the pod.

  Declaration

  Swift

  var timeOffset: TimeInterval { get }

  Objective-C

  @property (nonatomic, readonly) NSTimeInterval timeOffset;

• maxDuration

  The maximum duration of the pod in seconds. For unknown duration, -1 is returned.

  Declaration

  Swift

  var maxDuration: TimeInterval { get }

  Objective-C

  @property (nonatomic, readonly) NSTimeInterval maxDuration;