ProgrammaticAccessLibrary Framework Reference

    PALNonceRequest

      @interface 
 PALNonceRequest 
 : 
 NSObject

    The PALNonceRequest class contains data needed to create a programmatic access nonce.

    A PALNonceRequest instance is passed into a PALNonceLoader ‘s loadNonceManagerWithRequest : method to load a new PALNonceManager , containing the result nonce.

    • Whether the player intends to continuously play the content videos one after another similar to a TV broadcast or video playlist. PALFlagNull by default.

      Declaration

      Swift

        var 
 continuousPlayback 
 : 
 Flag 
 { 
 get 
 set 
 }

      Objective-C

        @property 
 ( 
 nonatomic 
 , 
 assign 
 , 
 unsafe_unretained 
 , 
 readwrite 
 , 
 getter 
 = 
 isContinuousPlayback 
 ) 
  PALFlag 
 
 continuousPlayback 
 ;

    • The description URL of the video being played. Any description URL string longer than 500 characters will be ignored and excluded from the nonce.

      Declaration

      Swift

        var 
 descriptionURL 
 : 
 URL 
 ? 
 { 
 get 
 set 
 }

      Objective-C

        @property 
 ( 
 nonatomic 
 , 
 copy 
 , 
 nullable 
 ) 
 NSURL 
 * 
 descriptionURL 
 ;

    • Whether VAST icons are supported by the video player. NO by default.

      Declaration

      Swift

        var 
 isIconsSupported 
 : 
 Bool 
 { 
 get 
 set 
 }

      Objective-C

        @property 
 ( 
 nonatomic 
 , 
 assign 
 , 
 unsafe_unretained 
 , 
 readwrite 
 , 
 getter 
 = 
 isIconsSupported 
 ) 
 BOOL 
 iconsSupported 
 ;

    • The name of the OMID Integration Partner. Any partner name string longer than 200 characters will be ignored and excluded from the nonce.

      This must match the name supplied to the OM SDK for the ad session. For further details, see the OM SDK Onboarding Guide .

      To successfully include the omid_p= value in a nonce, both this OMIDPartnerName and OMIDPartnerVersion must be set.

      Declaration

      Swift

        var 
 omidPartnerName 
 : 
 String 
 ? 
 { 
 get 
 set 
 }

      Objective-C

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

    • The OMID Integration Partner’s version string. Any partner version string longer than 200 characters will be ignored and excluded from the nonce.

      This must match the string supplied to the OM SDK for the ad session.

      To successfully include the omid_p= value in a nonce, both this OMIDPartnerVersion and OMIDPartnerName must be set.

      Declaration

      Swift

        var 
 omidPartnerVersion 
 : 
 String 
 ? 
 { 
 get 
 set 
 }

      Objective-C

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

    • The maximum allowed length for the generated nonce. By default there is no limit. Choosing a shorter nonce length limit may cause various targeting properties to be excluded from the nonce.

      Declaration

      Swift

        var 
 nonceLengthLimit 
 : 
 UInt 
 { 
 get 
 set 
 }

      Objective-C

        @property 
 ( 
 nonatomic 
 ) 
 NSUInteger 
 nonceLengthLimit 
 ;

    • The name of the partner player being used to play the ad. Any player type string longer than 200 characters will be ignored and excluded from the nonce.

      Declaration

      Swift

        var 
 playerType 
 : 
 String 
 ? 
 { 
 get 
 set 
 }

      Objective-C

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

    • The version of the partner player being used to play the ad. Any player version string longer than 200 characters will be ignored and excluded from the nonce.

      Declaration

      Swift

        var 
 playerVersion 
 : 
 String 
 ? 
 { 
 get 
 set 
 }

      Objective-C

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

    • The publisher provided ID. Any PPID longer than 200 characters will be ignored and excluded from the nonce.

      Declaration

      Swift

        var 
 ppid 
 : 
 String 
 ? 
 { 
 get 
 set 
 }

      Objective-C

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

    • The session ID is a temporary random ID. It is used exclusively for frequency capping. A session ID must be a UUID.

      Declaration

      Swift

        var 
 sessionID 
 : 
 String 
 ? 
 { 
 get 
 set 
 }

      Objective-C

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

    • A set of integers representing a player’s supported frameworks. These values are defined in the AdCOM 1.0 “API Frameworks” list: https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM-v1.0-FINAL.md#list–api-frameworks- . Example: “2,7,9” indicates supports for VPAID 2.0, OMID 1.0, and SIMID 1.1.

      Declaration

      Swift

        var 
 supportedAPIFrameworks 
 : 
 NSMutableSet 
 ? 
 { 
 get 
 set 
 }

      Objective-C

        @property 
 ( 
 nonatomic 
 , 
 nullable 
 ) 
 NSMutableSet 
 < 
 NSNumber 
 *> 
 * 
 supportedAPIFrameworks 
 ;

    • An optional reference to pass through to identify requests upon completion.

      Declaration

      Swift

        var 
 userInfo 
 : 
 Any 
 ? 
 { 
 get 
 set 
 }

      Objective-C

        @property 
 ( 
 nonatomic 
 , 
 copy 
 , 
 nullable 
 ) 
 id 
 userInfo 
 ;

    • The height of the video player, in pixels. Not included in the nonce by default.

      This must be a positive integer to represent a valid ad size in pixels, not points. See Google Ad Manager documentation for details.

      Declaration

      Swift

        var 
 videoPlayerHeight 
 : 
 UInt 
 { 
 get 
 set 
 }

      Objective-C

        @property 
 ( 
 nonatomic 
 ) 
 NSUInteger 
 videoPlayerHeight 
 ;

    • The width of the video player, in pixels. Not included in the nonce by default.

      This must be a positive integer to represent a valid ad size in pixels, not points. See Google Ad Manager documentation for details.

      Declaration

      Swift

        var 
 videoPlayerWidth 
 : 
 UInt 
 { 
 get 
 set 
 }

      Objective-C

        @property 
 ( 
 nonatomic 
 ) 
 NSUInteger 
 videoPlayerWidth 
 ;

    • Whether the ad will be played automatically. PALFlagNull by default.

      Declaration

      Swift

        var 
 willAdAutoPlay 
 : 
 Flag 
 { 
 get 
 set 
 }

      Objective-C

        @property 
 ( 
 nonatomic 
 ) 
  PALFlag 
 
 willAdAutoPlay 
 ;

    • Whether the ad will be play while muted. PALFlagNull by default.

      Declaration

      Swift

        var 
 willAdPlayMuted 
 : 
 Flag 
 { 
 get 
 set 
 }

      Objective-C

        @property 
 ( 
 nonatomic 
 ) 
  PALFlag 
 
 willAdPlayMuted 
 ;
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: