CSAI

Client Side ad Insertion

THEOplayer exposes THEOAdDescription, GoogleImaAdDescription and SpotXAdDescription that could be used to achieve Client side ad insertion. If you need to use Server Side Ad Insertion (SSAI), please consider checking its documentations here.

GoogleInteractiveMediaAds.framework

The following is the supportMatrix for the GoogleInteractiveMediaAds SDK versions that THEOplayer is linked against. Although using a different version might work, we advise to use the exact same version that THEOplayer is using to avoid any compatibility issues.

PlayerVersion playerSuiteVersion GoogleInteractiveMediaAds verions
2.84.0+ 2021.2.0+ iOS 3.14.1 - tvOS 4.4.1

  • Provides additional information for an advertisement.

    Remark

    The description can be of type THEOAdDescription, SpotXAdDescription or GoogleImaAdDescription.
    See more

    Declaration

    Swift

    public protocol AdDescription

  • An AdDescription object that will be added to the player when using the Google Ima ad integration.

    See more

    Declaration

    Swift

    @objc(THEOplayerGoogleImaAdDescription)
open class GoogleImaAdDescription : NSObject, AdDescription, AdDescription_Objc, Codable

  • A GoogleImaAd is a concrete implementation of an Ad which represents a Google IMA ad.

    See more

    Declaration

    Swift

    public protocol GoogleImaAd : Ad

  • A THEOplayerAdDescription object contains a description of an advertisement that will be added to the player.

    See more

    Declaration

    Swift

    @objc(THEOplayerTHEOAdDescription)
public class THEOAdDescription : NSObject, _AdDescription, Codable

  • The advertisement configuration of the player.

    See more

    Declaration

    Swift

    @objc(THEOplayerAdsConfiguration)
public class AdsConfiguration : NSObject, Encodable

  • Describes the configuration of the Google Interactive Media Ads.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "Renamed to GoogleIMAAdsConfiguration. Swift code can migrate to use GoogleIMAAdsConfiguration; for Objective-C THEOplayerGoogleIMAAdsConfiguration will be available starting the next major version update.")
@objc(THEOplayerGoogleIMAConfiguration)
public class GoogleIMAConfiguration : NSObject, Codable