POBRequest Class Reference

Inherits from NSObject
Declared in POBRequest.h

Overview

Represents an ad request for the given impression/s & profile.

Properties

  versionId

This is used to specify profile version. If this is not specified, live version of the profile is considered. This is used for debug purpose only to test staging profiles. So, it won’t be used in the release mode.

@property (nonatomic, strong) NSNumber *versionId

Declared In

POBRequest.h

  returnAllBidStatus

If true, returns all the rejected bids in response along with the reason for rejection By default returnAllBidStatus is disabled.

@property (nonatomic, assign) BOOL returnAllBidStatus

Declared In

POBRequest.h

  debug

Enable/Disable debug information in the response. By default, debug is disabled & no debug information will be available in bid response.

@property (nonatomic, assign) BOOL debug

Declared In

POBRequest.h

  publisherId

Identifier of the publisher.

@property (strong, readonly) NSString *publisherId

Discussion

Identifier of the publisher.

Declared In

POBRequest.h

  profileId

Profile Identifier of the ad tag.

@property (strong, readonly) NSNumber *profileId

Declared In

POBRequest.h

  impressions

Array of impressions

@property (nonatomic, readonly) NSArray<POBImpression*> *impressions

Declared In

POBRequest.h

  adServerURL

Custom server URL for debugging purpose.

@property (nonatomic, strong) NSString *adServerURL

Declared In

POBRequest.h

  )

Indicates whether this request is a test request.

@property (nonatomic, assign, getter=isTestModeEnabled) BOOL testModeEnabled NS_SWIFT_NAME ( testModeEnabled )

Discussion

By default, ‘Test Mode’ is disabled. When enabled, this request is treated as a test request. SDK may deliver only test ads which are not billable. Please disable the Test Mode for requests before you submit your application to the AppStore.

Declared In

POBRequest.h

  networkTimeout

Sets the network timeout (in seconds) for making an Ad request. Default value is 5 seconds, Different value can be set using this API, given that value is greater/equal to 1.0

@property (nonatomic, assign) NSTimeInterval networkTimeout

Declared In

POBRequest.h

  adFormat

Indicate the ad format to request/render.

@property (nonatomic, readonly) POBAdFormat adFormat

Declared In

POBRequest.h

Instance Methods

– initWithPublisherId:profileId:adFormat:impressions:

Initializes OpenWrap request for given impression/s & profile.

- (instancetype)initWithPublisherId:(NSString *)pubId profileId:(NSNumber *)profileId adFormat:(POBAdFormat)adFormat impressions:(NSArray<POBImpression*> *)impressions

Parameters

pubId

Publisher ID
profileId

Profile ID to be used for the request
adFormat

Indicates the ad format to request/render.
impressions

Array of POBImpression objects representing the ad impressions

Return Value

New instance of POBRequest

See Also

Declared In

POBRequest.h