GoogleInteractiveMediaAds Framework Reference

IMASettings

@interface IMASettings : NSObject <NSCopying>

The IMASettings class stores SDK wide settings.

• ppid

  Publisher Provided Identification (PPID) sent with ads request.

  Declaration

  Swift

  var ppid: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *ppid;

• language

  Language specification used for localization. |Language| must be formatted as a canonicalized IETF BCP 47 language identifier such as would be returned by [NSLocale preferredLanguages]. Setting this property after it has been sent to the IMAAdsLoader will be ignored and a warning will be logged.

  Declaration

  Swift

  var language: String { get set }

  Objective-C

  @property (nonatomic, copy) NSString *_Nonnull language;

• maxRedirects

  Specifies maximum number of redirects after which subsequent redirects will be denied, and the ad load aborted. The number of redirects directly affects latency and thus user experience. This applies to all VAST wrapper ads. If the number of redirects exceeds |maxRedirects|, the ad request will fail with error code 302. The default value is 4.

  Declaration

  Swift

  var maxRedirects: UInt { get set }

  Objective-C

  @property (nonatomic) NSUInteger maxRedirects;

• featureFlags

  Feature flags and their states. Used to control experimental features.

  Declaration

  Swift

  var featureFlags: [String : String] { get set }

  Objective-C

  @property (nonatomic, copy) NSDictionary<NSString *, NSString *> *_Nonnull featureFlags;

• enableBackgroundPlayback

  Enable background audio playback for the SDK. The default value is NO.

  Declaration

  Swift

  var enableBackgroundPlayback: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL enableBackgroundPlayback;

• autoPlayAdBreaks

  Specifies whether to automatically play VMAP and ad rules ad breaks. The default value is YES.

  Declaration

  Swift

  var autoPlayAdBreaks: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL autoPlayAdBreaks;

• disableNowPlayingInfo

  Specifies whether to update the MPNowPlayingInfoCenter content with the title “Advertisement”. If disabled, MPNowPlayingInfoCenter is untouched. The default value is NO.

  Declaration

  Swift

  var disableNowPlayingInfo: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL disableNowPlayingInfo;

• playerType

  The partner specified video player that is integrating with the SDK.

  Declaration

  Swift

  var playerType: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *playerType;

• playerVersion

  The partner specified player version that is integrating with the SDK.

  Declaration

  Swift

  var playerVersion: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *playerVersion;

• sessionID

  The session ID to identify a single user session. This should be a UUID. It is used exclusively for frequency capping across the user session.

  Declaration

  Swift

  var sessionID: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *sessionID;

• sameAppKeyEnabled

  Controls whether Same App Key is enabled. The value set persists across app sessions. The key is enabled by default.

  Declaration

  Swift

  var sameAppKeyEnabled: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL sameAppKeyEnabled;

• enableDebugMode

  Toggles debug mode which will output detailed log information to the console. Debug mode should be disabled in Release and will display a watermark when enabled. The default value is NO.

  Declaration

  Swift

  var enableDebugMode: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL enableDebugMode;