Rewarded Ads

Ad Request

Placement

Create placement from PlacementFormat with your parameters:

Swift

let placement = try? BidMachineSdk.shared.placement(from: .rewarded) {
  $0.withPlacementId("")
  $0.withCustomParameters([String:Any]())
}

Objective-C

NSError *error = nil;

BidMachinePlacement *placement = [[BidMachineSdk shared] placementFrom:BidMachinePlacementFormatRewarded
                                                                 error:&error
                                                                builder:^(id<BidMachinePlacementBuilderProtocol> _Nonnull builder) {
    [builder withPlacementId:@""];
    [builder withCustomParameters:@{}];
}];

Parameter	Type	Description
placementId	String	Placement ID
customParameters	[String: Any] / NSDictionary	Passed directly to the server

PlacementFormat

The placement format is defined by the PlacementFormat enum:

Swift

@objc(BidMachinePlacementFormat)
public enum PlacementFormat: Int {
    case rewarded
    case rewardedVideo
    case rewardedStatic
}

Objective-C

typedef SWIFT_ENUM_NAMED(NSInteger, BidMachinePlacementFormat, "PlacementFormat", open) {
    BidMachinePlacementFormatRewarded       = 8,
    BidMachinePlacementFormatRewardedVideo  = 9,
    BidMachinePlacementFormatRewardedStatic = 10
};

You can also get a format from a string:

Swift

let format = "rewarded".bidmachine_placement_format

Objective-C

BidMachinePlacementFormat format = [@"rewarded" bidmachine_placement_format];

Registered placement formats

Name	Description
rewarded	Combines VAST and MRAID formats
rewarded_video	VAST (video) ads
rewarded_static	MRAID (static) ads

General Request

Auction request is used to set bidding parameters: The request is created with a special placement and your parameters

Swift

let request = BidMachineSdk.shared.auctionRequest(placement: placement) {
  $0.withUnitConfigurations([BidMachineUnitConfiguration]())
  $0.appendPriceFloor(Double(10), UUID().uuidString)
}

Objective-C

BidMachineAuctionRequest *request = [[BidMachineSdk shared] auctionRequestWithPlacement:placement builder: ^(id<BidMachineAuctionRequestBuilderProtocol> _Nonnull builder) {
    [builder withUnitConfigurations:@[]];
    [builder appendPriceFloor:10.0 identifier:[[NSUUID UUID] UUIDString]];
}];

Parameter	Type	Description
unitConfigurations	[BidMachineUnitConfiguration]	Header bidding unit configurations
priceFloor	(Double, String)	Price floor (value and identifier)

Client Bidding Request

Bid Token

With S2S integration, you will need a token that you need to transfer in the request. To get a token, you can use method:

Swift

 BidMachineSdk.shared.token(placement: placement) { token in }

Objective-C

[BidMachineSdk.shared tokenWithPlacement:placement completion:^(NSString *token) {

}];

Bid Payload

After completing the server-side auction, you will receive a Base64-encoded payload string, which must be passed as a parameter to the AuctionRequest.

Swift

let request = BidMachineSdk.shared.auctionRequest(placement: placement) {
  $0.withPayload("")
}

Objective-C

BidMachineAuctionRequest *request = [[BidMachineSdk shared] auctionRequestWithPlacement:placement builder: ^(id<BidMachineAuctionRequestBuilderProtocol> _Nonnull builder) {
  [builder withPayload:@""];
}];

Parameter	Type	Description
payload	String	Custom BidMachine payload string

Ad Display

The ad object handles downloading and displaying ads.

Prepare the ad object

Request an ad using your auction request:

Swift

BidMachineSdk.shared.rewarded(request: request) { [weak self] ad, error in
  guard let self else { return }
  self.rewarded = ad
}

Objective-C

__weak typeof(self) weakSelf = self;
[[BidMachineSdk shared] rewardedWithRequest:request
                              completion:^(BidMachineRewarded *ad, NSError * _Nullable error) {
    __strong typeof(weakSelf) strongSelf = weakSelf;
    if (!strongSelf) {
        return;
    }
    strongSelf.rewarded = ad;
}];

The loaded ad provides auctionInfo and requestInfo.

Auction Info

The auctionInfo contains information about the auction, such as the winning bidder, price, and other relevant details. The auctionInfo is described here.

Delegate

Assign the delegate to receive ad events:

Swift

ad.delegate = self

Objective-C

ad.delegate = self;

Implement BidMachineAdDelegate methods:

Swift

func didLoadAd(_ ad: BidMachineAdProtocol) {}
func didFailLoadAd(_ ad: BidMachineAdProtocol, _ error: Error) {}
func didPresentAd(_ ad: BidMachineAdProtocol) {}
func didFailPresentAd(_ ad: BidMachineAdProtocol, _ error: Error) {}
func didDismissAd(_ ad: BidMachineAdProtocol) {}
func willPresentScreen(_ ad: BidMachineAdProtocol) {}
func didDismissScreen(_ ad: BidMachineAdProtocol) {}
func didUserInteraction(_ ad: BidMachineAdProtocol) {}
func didExpired(_ ad: BidMachineAdProtocol) {}
func didTrackImpression(_ ad: BidMachineAdProtocol) {}
func didTrackInteraction(_ ad: BidMachineAdProtocol) {}
func didReceiveReward(_ ad: BidMachineAdProtocol) {}

Objective-C

- (void)didLoadAd:(id<BidMachineAdProtocol>)ad {}
- (void)didFailLoadAd:(id<BidMachineAdProtocol>)ad :(NSError *)error {}
- (void)didPresentAd:(id<BidMachineAdProtocol>)ad {}
- (void)didFailPresentAd:(id<BidMachineAdProtocol>)ad :(NSError *)error {}
- (void)didDismissAd:(id<BidMachineAdProtocol>)ad {}
- (void)willPresentScreen:(id<BidMachineAdProtocol>)ad {}
- (void)didDismissScreen:(id<BidMachineAdProtocol>)ad {}
- (void)didUserInteraction:(id<BidMachineAdProtocol>)ad {}
- (void)didExpired:(id<BidMachineAdProtocol>)ad {}
- (void)didTrackImpression:(id<BidMachineAdProtocol>)ad {}
- (void)didTrackInteraction:(id<BidMachineAdProtocol>)ad {}
- (void)didReceiveReward:(id<BidMachineAdProtocol>)ad {}

Loading and presenting rewarded ads

Loading prerequisites

Make sure both the delegate and controller are set before loading.

Example of rewarded ad loading:

Swift

guard let placement = try? BidMachineSdk.shared.placement(from: .rewarded) else { return }
let request = BidMachineSdk.shared.auctionRequest(placement: placement)
BidMachineSdk.shared.rewarded(request: request) { [weak self] ad, error in
  guard let self = self else {
      return
  }
  self.rewarded = ad
  self.rewarded.controller = self
  self.rewarded.delegate = self
  self.rewarded.loadAd()
}

Objective-C

NSError *error = nil;
BidMachinePlacement *placement = [[BidMachineSdk shared] placementFrom:BidMachinePlacementFormatRewarded
                                                                  error:&error
                                                                builder:nil];
if (!placement) {
    return;
}

BidMachineAuctionRequest *request = [[BidMachineSdk shared] auctionRequestWithPlacement:placement
                                                                                builder:nil];

__weak typeof(self) weakSelf = self;
[[BidMachineSdk shared] rewardedWithRequest:request
                                 completion:^(BidMachineRewarded *ad, NSError * _Nullable error) {
    __strong typeof(weakSelf) strongSelf = weakSelf;
    if (!strongSelf) {
        return;
    }
    strongSelf.rewarded = ad;
    strongSelf.rewarded.controller = strongSelf;
    strongSelf.rewarded.delegate = strongSelf;
    [strongSelf.rewarded loadAd];
}];

Present the ad:

Swift

rewarded.presentAd()

Objective-C

[self.rewarded presentAd];

Mediation

If the request is involved in third-party mediation, you can use such methods to notify the SDK about the win or loss events:

Swift

//Where ad - is loaded bidmachine ad
//Mediation WIN ( ad )
BidMachineSdk.shared.notifyMediationWin(ad)
//Mediation LOSS ( winner, price, ad )
BidMachineSdk.shared.notifyMediationLoss("WINNER_NETWORK", 1.0, ad)

Objective-C

//Where ad - is loaded bidmachine ad
//Mediation WIN ( ad )
[BidMachineSdk.shared notifyMediationWin:ad];
//Mediation LOSS ( winner, price, ad )
[BidMachineSdk.shared notifyMediationLoss:@"WINNER_NETWORK" ecpm:1.0 ad:ad];