POBBid Class Reference

Inherits from	NSObject
Conforms to	POBAdDescriptor
Declared in	POBBid.h

Overview

Holds information of winning bid along with all the bids that participated in the auction.

Properties

`impressionId`

Impression id

@property (nonatomic, readonly) NSString *impressionId

Declared In

POBBid.h

`bidId`

bid id

@property (nonatomic, readonly) NSString *bidId

Declared In

POBBid.h

`adomain`

Array of advertiser domain names for the ad being served. (e.g., “advertiser.com”)

@property (nonatomic, readonly) NSArray<NSString*> *adomain

Discussion

Array of advertiser domain names for the ad being served. (e.g., “advertiser.com”)

Declared In

POBBid.h

`bundle`

bundle / itunes id of the advertised app

@property (nonatomic, readonly) NSString *bundle

Declared In

POBBid.h

`price`

Net bid price / Net ECPM value

@property (nonatomic, readonly) NSNumber *price

Discussion

Note: This property is updated to return net price from OW SDK v2.4.0.

Declared In

POBBid.h

`size`

Ad size

@property (nonatomic, readonly) CGSize size

Declared In

POBBid.h

`status`

Bid status

@property (nonatomic, readonly) NSNumber *status

Declared In

POBBid.h

`creativeId`

Identifier of the bid creative

@property (nonatomic, readonly) NSString *creativeId

Declared In

POBBid.h

`nurl`

Win notice URL called by the exchange if the bid wins (not necessarily indicative of a delivered, viewed, or billable ad); optional means of serving ad markup.

@property (nonatomic, readonly) NSString *nurl

Declared In

POBBid.h

`lurl`

Loss notice URL called by the exchange when a bid is known to have been lost.

@property (nonatomic, readonly) NSString *lurl

Declared In

POBBid.h

`creativeTag`

Creative tag

@property (nonatomic, readonly) NSString *creativeTag

Declared In

POBBid.h

`rewards`

Available rewards

@property (nonatomic, readonly) NSArray<POBReward*> *rewards

Declared In

POBBid.h

`creativeType`

Creative type

@property (nonatomic, readonly) NSString *creativeType

Declared In

POBBid.h

`partner`

Partner name

@property (nonatomic, readonly) NSString *partner

Declared In

POBBid.h

`dealId`

Deal ID

@property (nonatomic, readonly) NSString *dealId

Declared In

POBBid.h

`expiry`

Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression.

@property (nonatomic, readonly) NSNumber *expiry

Discussion

Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression.

Declared In

POBBid.h

`refreshInterval`

refresh interval in seconds

@property (nonatomic, readonly) NSTimeInterval refreshInterval

Declared In

POBBid.h

`hasWon`

winning status with respect to primary ad server, expected to be updated externally.

@property (nonatomic, readwrite) BOOL hasWon

Declared In

POBBid.h

Instance Methods

`– initWithBidDetails:andRequestDetails:`

Initializes POBBid object with given bid details and partner name

- (instancetype)initWithBidDetails:(NSDictionary *)bidDetails andRequestDetails:(NSDictionary *)requestDetails

Parameters

`bidDetails`	Details of Bid
`requestDetails`	request details

Return Value

Instance of POBBid

Declared In

POBBid.h

`+ bidWithBid:customTargeting:`

Initializes POBBid object with given bid object, targetingParams are copied to target bid if original bid do not have any targetingParams already

+ (POBBid *)bidWithBid:(POBBid *)bid customTargeting:(NSDictionary *)targetingParams

Parameters

`bid`	Existing bid object
`targetingParams`	Targeting parameters

Return Value

Instance of POBBid

Declared In

POBBid.h

`+ bidWithBid:expiresAfter:refreshInterval:customTargeting:`

Initializes POBBid object with given bid object, targetingParams are copied to target bid if original bid do not have any targetingParams already

+ (POBBid *)bidWithBid:(POBBid *)bid expiresAfter:(NSTimeInterval)expiresAfter refreshInterval:(NSTimeInterval)refreshInterval customTargeting:(NSDictionary *)targetingParams

Parameters

`bid`	Existing bid object
`expiresAfter`	time interval in seconds after which bid expires
`refreshInterval`	new refresh interval
`targetingParams`	Targeting parameters

Return Value

Instance of POBBid

Declared In

POBBid.h

`+ bidWithBid:expiry:refreshInterval:impCntMethod:`

Initializes a POBBid object using the given bid object and updates the provided parameters.

+ (POBBid *)bidWithBid:(POBBid *)bid expiry:(NSNumber *)expiry refreshInterval:(NSTimeInterval)refreshInterval impCntMethod:(NSInteger)impCntMethod

Parameters

`bid`	Existing bid object to be used as the base.
`expiry`	Time interval (in seconds) after which the bid expires.
`refreshInterval`	New refresh interval (in seconds).
`impCntMethod`	Impression counting method to be applied to the bid.

Return Value

A new instance of POBBid with updated values.

Discussion

Initializes a POBBid object using the given bid object and updates the provided parameters.

Declared In

POBBid.h

`details`	Instance of NSDictionary with key as String and values ad any objects

`– targetingInfo`

Returns targeting information that needs to be passed to the ad server SDK.

- (NSDictionary *)targetingInfo

Return Value

dictionary of standard key-value pairs for targeting

Declared In

POBBid.h

Returns the POBReward object (if any) from the rewards array under bid extension. It contains the Reward-type and its value. For example: { “seatbid.bid.ext.rewardInfo”: { “rewards”:[{ “rewardType”: “type”, “rewardValue”: “value” }] } }

- (POBReward *)reward

Return Value

POBReward object

Discussion

Note: If SDK don’t receive rewardInfo in response then POBReward object will be returned with default values as type = @“” and value = -1

Declared In

POBBid.h