OORequestSettings Class Reference

Inherits from NSObject
Declared in OORequestSettings.h

Overview

Settings about the environment in which the ad will play.

– copyExistingProperties:OverrrideRequestSetting:

- (id)copyExistingProperties:(OORequestSettings *)sourceRequestSetting OverrrideRequestSetting:(OORequestSettings *)overrideRs

  height

Height in pixels of the video area where ads will be shown.

@property (nonatomic, assign) NSInteger height

Declared In

OORequestSettings.h

  width

Width in pixels of the video area where ads will be shown.

@property (nonatomic, assign) NSInteger width

Declared In

OORequestSettings.h

  maxBitRate

The maximum bitrate of the media files in the ad response.

@property (nonatomic, assign) NSInteger maxBitRate

Declared In

OORequestSettings.h

  IDFA

The advertising identifier unique for each iOS device. If RTB ads are configured in Pulse, this information will be forwarded to the DSP.

@property (nonatomic, copy) NSString *IDFA

Declared In

OORequestSettings.h

  applicationID

The id of the application using this SDK in the format “A1B2C3D4E5.com.domainame.applicationname”. If RTB ads are configured in Pulse, this information will be forwarded to the DSP.

@property (nonatomic, copy) NSString *applicationID

Declared In

OORequestSettings.h

  applicationName

The name of the application using this SDK. An example would be: “pulseplayer”. If RTB ads are configured in Pulse, this information will be forwarded to the DSP.

@property (nonatomic, copy) NSString *applicationName

Declared In

OORequestSettings.h

  applicationVersion

The version of the application using this SDK. An example would be: “1.0.0”. If RTB ads are configured in Pulse, this information will be forwarded to the DSP.

@property (nonatomic, copy) NSString *applicationVersion

Declared In

OORequestSettings.h

  applicationBundle

The bundle id of the application using this SDK, in the format “com.domainname.applicationname” If RTB ads are configured in Pulse, this information will be forwarded to the DSP.

@property (nonatomic, copy) NSString *applicationBundle

Declared In

OORequestSettings.h

  storeUrl

The App Store URL where you can download the application using this SDK. An example would be: “https://itunes.apple.com/us/app/keynote/id361285480?mt=8” If RTB ads are configured in Pulse, this information will be forwarded to the DSP.

@property (nonatomic, copy) NSString *storeUrl

Declared In

OORequestSettings.h

  gdprConsentString

Pass in the user’s URL safe and base64 encoded consent string related to GDPR regulations, which may be obtained through the Mobile In-App Consent Management Provider (CMP) API. This string is built up according to the data structure developed by the GDPR Consent Working Group under the auspices of IAB Europe. The data structure specification can be found at Consent string and vendor list format. For more information on the API, refer to Mobile In-App Consent APIs.

@property (nonatomic, copy) NSString *gdprConsentString

Declared In

OORequestSettings.h

  enableGdpr

Set to true if the ad request is subject to GDPR regulations. See Implementation Guidelines for implementation guidelines.

@property (nonatomic, assign) BOOL enableGdpr

Declared In

OORequestSettings.h

  gdprPersonalDataIncluded

Set to true if you are passing in personal information when creating the ad request to Pulse. The only location where it is possible to pass in personal information is in the [OOContentMetadata customParameters].

@property (nonatomic, assign) BOOL gdprPersonalDataIncluded

Declared In

OORequestSettings.h

  linearPlaybackPositions

An array of numbers which defines points in time when linear ads should be shown.

@property (nonatomic, copy) NSArray *linearPlaybackPositions

Declared In

OORequestSettings.h

  nonlinearPlaybackPositions

An array of numbers which defines points in time when non-linear ads should be shown.

@property (nonatomic, copy) NSArray *nonlinearPlaybackPositions

Declared In

OORequestSettings.h

  insertionPointFilter

A bitmask that determines which kinds of insertion points will be requested. If not set, all types will be requested.

@property (nonatomic, assign) OOInsertionPointType insertionPointFilter

Declared In

OORequestSettings.h

  referrerUrl

Overrides the HTTP header’s referrer property

@property (nonatomic, copy) NSURL *referrerUrl

Declared In

OORequestSettings.h

  maxLinearBreakDuration

The maximum duration in seconds of linear ad breaks.

@property (nonatomic, assign) NSInteger maxLinearBreakDuration

Declared In

OORequestSettings.h

  assetFilteringDisabled

Indicates whether all the media files/assets for an ad should be returned. If true, the assets will not be filtered out based on the user agent.

@property (nonatomic, assign) BOOL assetFilteringDisabled

Declared In

OORequestSettings.h

  enforceCacheBusting

Indicates whether cache busting is enforced on all tracking request URLs.

@property (nonatomic, assign) BOOL enforceCacheBusting

Declared In

OORequestSettings.h

  seekMode

Determines the Pulse SDK’s behaviour when the viewer seeks past one or more ad breaks. If not set, the behaviour defaults to the IGNORE OOSeekMode.

@property (nonatomic, assign) OOSeekMode seekMode

Declared In

OORequestSettings.h

  liveParameters

A list of live parameters indicating which behaviours should be disabled for a live event. If an empty list is set, the behaviour defaults to the DISABLE_ALL OOLive. Notice that if all parameters are sent at once, then no action would be taken, i.e DISABLE_ALL would disable everything and other parameters would re-enable them.

@property (nonatomic, strong) NSMutableArray<NSNumber*> *liveParameters

Declared In

OORequestSettings.h