OORequestSettings

Objective-C

@interface OORequestSettings : NSObject

Swift

class OORequestSettings : NSObject

Settings about the environment in which the ad will play.

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

    Declaration

    Objective-C

    @property (nonatomic) NSInteger height;

    Swift

    var height: Int { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) NSInteger width;

    Swift

    var width: Int { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) NSInteger maxBitRate;

    Swift

    var maxBitRate: Int { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *IDFA;

    Swift

    var idfa: String! { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *applicationID;

    Swift

    var applicationID: String! { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *applicationName;

    Swift

    var applicationName: String! { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *applicationVersion;

    Swift

    var applicationVersion: String! { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *applicationBundle;

    Swift

    var applicationBundle: String! { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *storeUrl;

    Swift

    var storeUrl: String! { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *gdprConsentString;

    Swift

    var gdprConsentString: String! { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) BOOL enableGdpr;

    Swift

    var enableGdpr: Bool { get set }

  • Set to true if you are passing in personal information when creating the ad request to Pulse. One of the locations where it is possible to pass in personal information is in the OOContentMetadata.customParameters.

    Declaration

    Objective-C

    @property (nonatomic) BOOL gdprPersonalDataIncluded;

    Swift

    var gdprPersonalDataIncluded: Bool { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, copy) NSArray *linearPlaybackPositions;

    Swift

    var linearPlaybackPositions: [Any]! { get set }

  • Overrides the maximum amount of time the player or integration should wait for the ad to start playback before reporting inventory.

    Declaration

    Objective-C

    @property (nonatomic) double startAdTimeout;

    Swift

    var startAdTimeout: Double { get set }

  • Overrides the maximum amount of time the player or integration should wait to unwrap and load a third party ad before reporting inventory.

    Declaration

    Objective-C

    @property (nonatomic) double thirdPartyTimeout;

    Swift

    var thirdPartyTimeout: Double { get set }

  • Overrides the maximum amount of time the passback player should wait to find a working ad in the passback chain before moving to the last ad in the chain or reporting inventory.

    Declaration

    Objective-C

    @property (nonatomic) double totalPassbackTimeout;

    Swift

    var totalPassbackTimeout: Double { get set }

  • Deprecated

    breakNumber is deprecated and has been replaced by midrollBreakNumber

    DEPRECATED! Overrides the number of the ad break targeted by the ad request. Should be Positive Integer.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger breakNumber;

    Swift

    var breakNumber: Int { get set }

  • Overrides the number of the midroll ad break targeted by the ad request. Should be Positive Integer.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger midrollBreakNumber;

    Swift

    var midrollBreakNumber: Int { get set }

  • Overrides the number of the ad break targeted by the ad request. Should be Positive Integer.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger linearSlotSize;

    Swift

    var linearSlotSize: Int { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, copy) NSArray *nonlinearPlaybackPositions;

    Swift

    var nonlinearPlaybackPositions: [Any]! { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) OOInsertionPointType insertionPointFilter;

    Swift

    var insertionPointFilter: OOInsertionPointType { get set }

  • Overrides the HTTP header’s referrer property

    Declaration

    Objective-C

    @property (nonatomic, copy) NSURL *referrerUrl;

    Swift

    var referrerUrl: URL! { get set }

  • The maximum duration in seconds of linear ad breaks.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger maxLinearBreakDuration;

    Swift

    var maxLinearBreakDuration: Int { get set }

  • The minimum duration in seconds of linear ad breaks.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger minLinearBreakDuration;

    Swift

    var minLinearBreakDuration: Int { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) BOOL assetFilteringDisabled;

    Swift

    var assetFilteringDisabled: Bool { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) BOOL enforceCacheBusting;

    Swift

    var enforceCacheBusting: Bool { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) OOSeekMode seekMode;

    Swift

    var seekMode: OOSeekMode { get set }

  • 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 OOLive.DISABLE_ALL. 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.

    Declaration

    Objective-C

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

    Swift

    var liveParameters: NSMutableArray! { get set }

  • Real-time bidding (RTB) persistent ID (PID) anonymizes the standard PID and, if set, will be sent in bid requests to Demand Side Platforms instead of the standard PID, to ensure the privacy of your end users’ information when using Pulse Programmatic (SSP).

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *rtbPid;

    Swift

    var rtbPid: String! { get set }

  • RTB Device Container ID overrides the RTB device type detected in INVIDI Pulse, in order to request ads for a specific RTB device type. You must provide a valid value for one of the available device types as specified in the OpenRTB API Specification. For more information, see INVIDI Pulse SDK parameter reference

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *rtbDcid;

    Swift

    var rtbDcid: String! { get set }