GoogleInteractiveMediaAds Framework Reference

Classes

The following classes are available globally.

  • An implementation of IMAContentPlayhead for AVPlayer. Use this class to provide content tracking if your content player of choice is an AVPlayer or its subclass.

    Declaration

    Swift

    classIMAAVPlayerContentPlayhead:NSObject,IMAContentPlayhead

    Objective-C

    @interfaceIMAAVPlayerContentPlayhead:NSObject<IMAContentPlayhead>

  • An implementation of the IMAVideoDisplay protocol. This object is intended to be initialized with the content player, and will reuse the player for playing ads.

    Declaration

    Swift

    classIMAAVPlayerVideoDisplay:NSObject,IMAVideoDisplay

    Objective-C

    @interfaceIMAAVPlayerVideoDisplay:NSObject<IMAVideoDisplay>

  • Data object representing a single ad.

    Declaration

    Swift

    classIMAAd:NSObject

    Objective-C

    @interfaceIMAAd:NSObject

  • The IMAAdDisplayContainer is responsible for managing the ad container view and companion ad slots used for ad playback.

    Declaration

    Swift

    classIMAAdDisplayContainer:NSObject

    Objective-C

    @interfaceIMAAdDisplayContainer:NSObject

IMAAdError

  • Surfaces an error that occurred during ad loading or playing.

    Declaration

    Swift

    classIMAAdError:NSObject

    Objective-C

    @interfaceIMAAdError:NSObject

IMAAdEvent

  • Simple data class used to transport ad playback information.

    Declaration

    Swift

    classIMAAdEvent:NSObject

    Objective-C

    @interfaceIMAAdEvent:NSObject

  • Simple data object containing podding metadata.

    Declaration

    Swift

    classIMAAdPodInfo:NSObject

    Objective-C

    @interfaceIMAAdPodInfo:NSObject

IMAAdsLoadedData

  • Ad data that is returned when the ads loader loads the ad.

    Declaration

    Swift

    classIMAAdsLoadedData:NSObject

    Objective-C

    @interfaceIMAAdsLoadedData:NSObject

IMAAdLoadingErrorData

  • Ad error data that is returned when the ads loader fails to load the ad.

    Declaration

    Swift

    classIMAAdLoadingErrorData:NSObject

    Objective-C

    @interfaceIMAAdLoadingErrorData:NSObject

IMAAdsLoader

  • The IMAAdsLoader class allows the requesting of ads from the ad server. Use the delegate to receive the loaded ads or loading error in case of failure.

    Declaration

    Swift

    classIMAAdsLoader:NSObject

    Objective-C

    @interfaceIMAAdsLoader:NSObject

IMAAdsManager

  • The IMAAdsManager class is responsible for playing ads.

    Declaration

    Swift

    classIMAAdsManager:NSObject

    Objective-C

    @interfaceIMAAdsManager:NSObject

IMAAdsRenderingSettings

  • Set of properties that influence how ads are rendered.

    Declaration

    Swift

    classIMAAdsRenderingSettings:NSObject

    Objective-C

    @interfaceIMAAdsRenderingSettings:NSObject

  • Data class describing the ad request.

    Declaration

    Swift

    classIMAAdsRequest:NSObject

    Objective-C

    @interfaceIMAAdsRequest:NSObject

  • An object that holds data corresponding to the companion ad.

    Declaration

    Swift

    classIMACompanionAd:NSObject

    Objective-C

    @interfaceIMACompanionAd:NSObject

IMACompanionAdSlot

  • Ad slot for companion ads. The SDK will put a subview inside the provided UIView container. The companion will be matched to the width and height provided here. This class cannot be instantiated on tvOS, where companion ads are not available.

    Declaration

    Swift

    classIMACompanionAdSlot:NSObject

    Objective-C

    @interfaceIMACompanionAdSlot:NSObject

  • Data object representation of a cuepoint for a single ad break.

    Declaration

    Swift

    classIMACuepoint:NSObject

    Objective-C

    @interfaceIMACuepoint:NSObject

  • An obstruction that is marked as “friendly” for viewability measurement purposes.

    Declaration

    Swift

    classIMAFriendlyObstruction:NSObject

    Objective-C

    @interfaceIMAFriendlyObstruction:NSObject

  • Data object describing a live stream request.

    Declaration

    Swift

    classIMALiveStreamRequest:IMAStreamRequest

    Objective-C

    @interfaceIMALiveStreamRequest:IMAStreamRequest

  • Undocumented

    Declaration

    Swift

    classIMAPictureInPictureProxy:NSProxy,AVPictureInPictureControllerDelegate,AVPlayerViewControllerDelegate

    Objective-C

    @interfaceIMAPictureInPictureProxy:NSProxy<AVPictureInPictureControllerDelegate,AVPlayerViewControllerDelegate>#else @interfaceIMAPictureInPictureProxy:NSObject#endif /** * Whether or not Picture-in-Picture is currently active. */@property(nonatomic,readonly,getter=isPictureInPictureActive)BOOLpictureInPictureActive;/** * Whether or not Picture-in-Picture is supported on this device. */+(BOOL)isPictureInPictureSupported;/** * Instantiates an IMAPictureInPictureProxy that will proxy delegate * messages from an AVPictureInPictureController, and forward them * to the AVPictureInPictureControllerDelegate passed on init. * * @param delegate the AVPictureInPictureControllerDelegate * * @return an IMAPictureInPictureProxy instance */-(instancetype)initWithAVPictureInPictureControllerDelegate:(id<AVPictureInPictureControllerDelegate>)delegateAPI_AVAILABLE(ios(9.0),tvos(14.0));/** * Instantiates an IMAPictureInPictureProxy that will proxy delegate * messages from an AVPlayerViewController, and forward them to the * AVPlayerViewControllerDelegate passed on init. * * @param delegate the AVPlayerViewControllerDelegate * * @return an IMAPictureInPictureProxy instance */-(instancetype)initWithAVPlayerViewControllerDelegate:(id<AVPlayerViewControllerDelegate>)delegateAPI_AVAILABLE(ios(9.0),tvos(14.0));@end

  • Data object describing a stream request for a pod serving stream.

    Declaration

    Swift

    classIMAPodStreamRequest:IMAStreamRequest

    Objective-C

    @interfaceIMAPodStreamRequest:IMAStreamRequest

  • Data object describing a stream request for a third party stitched server-side ad insertion pod serving VOD stream.

    Declaration

    Swift

    classIMAPodVODStreamRequest:IMAStreamRequest

    Objective-C

    @interfaceIMAPodVODStreamRequest:IMAStreamRequest

  • Undocumented

    Declaration

    Swift

    classIMASecureSignals:NSObject

    Objective-C

    @interfaceIMASecureSignals:NSObject/** * Secure Signal with custom data sent with ads request. Secure Signal with custom * data is an encrypted blob containing signals collected by the publisher and previously agreed * upon by the publisher and bidder。 */@property(nonatomic,copy,readonly)NSString*customData;-(instancetype)initWithCustomData:(NSString*)customDataNS_DESIGNATED_INITIALIZER;/** * :nodoc: */-(instancetype)initNS_UNAVAILABLE;@end

  • The IMASettings class stores SDK wide settings.

    Declaration

    Swift

    classIMASettings:NSObject,NSCopying

    Objective-C

    @interfaceIMASettings:NSObject<NSCopying>

IMAStreamManager

  • The IMAStreamManager class is responsible for playing streams.

    Declaration

    Swift

    classIMAStreamManager:NSObject

    Objective-C

    @interfaceIMAStreamManager:NSObject

  • Data class describing the stream request.

    Declaration

    Swift

    classIMAStreamRequest:NSObject

    Objective-C

    @interfaceIMAStreamRequest:NSObject

  • Simple data object containing universal ad ID information.

    Declaration

    Swift

    classIMAUniversalAdID:NSObject

    Objective-C

    @interfaceIMAUniversalAdID:NSObject

  • Data object describing a VOD stream request.

    Declaration

    Swift

    classIMAVODStreamRequest:IMAStreamRequest

    Objective-C

    @interfaceIMAVODStreamRequest:IMAStreamRequest

  • Undocumented

    Declaration

    Swift

    classIMAVersion:NSObject

    Objective-C

    @interfaceIMAVersion:NSObject/** Major version. */@property(nonatomic)NSIntegermajorVersion;/** Minor version. */@property(nonatomic)NSIntegerminorVersion;/** Patch version. */@property(nonatomic)NSIntegerpatchVersion;@end

  • Data object describing a stream request for a Google video stitcher live serving stream.

    Declaration

    Swift

    classIMAVideoStitcherLiveStreamRequest:IMAPodStreamRequest

    Objective-C

    @interfaceIMAVideoStitcherLiveStreamRequest:IMAPodStreamRequest

  • Data object describing a stream request for a Google video stitcher video on demand serving stream.

    Declaration

    Swift

    classIMAVideoStitcherVODStreamRequest:IMAStreamRequest

    Objective-C

    @interfaceIMAVideoStitcherVODStreamRequest:IMAStreamRequest
close