Skip to main content

bfgPlacementDelegate Protocol

Notifies when placement activities occur. More...#import <bfgGameReporting.h>

Instance Methods

(void) - bfgPlacementContentError:error:
 A placement failed to load and will not display. More...
 
(void) - bfgPlacementRewardReceived:rewardName:rewardQuantity:
 The placement would like to reward the player. More...
 
(BOOL) - bfgPlacementStartPurchase:productId:productQuantity:
 A purchase has been requested. Your game should start the purchase. More...
 
(BOOL) - bfgPlacementDidReceiveDataString:scenarioId:
 An interstitial has delivered a data payload to your game. More...
 
(void) - bfgPlacementContentWillDismiss:
 A placement will close. More...
 

Detailed Description

Notifies when placement activities occur.
See also
bfgManagerPauseResumeDelegate
Since
5.10

Method Documentation

◆ bfgPlacementContentError:error:

- (void) bfgPlacementContentError: (NSString *_Nullable) contentName
error:(NSError *_Nullable) error 
optional
A placement failed to load and will not display.
Since
5.7

◆ bfgPlacementContentWillDismiss:

- (void) bfgPlacementContentWillDismiss: ("Use bfgManagerPauseResumeDelegate") __deprecated_msg
optional
A placement will close.
Since
5.10
Deprecated:\n Use bfgManagerPauseResumeDelegate

◆ bfgPlacementDidReceiveDataString:scenarioId:

- (BOOL) bfgPlacementDidReceiveDataString: (NSString *_Nullable) dataString
scenarioId:(NSString *_Nullable) scenarioId 
optional
An interstitial has delivered a data payload to your game.
Parameters
dataStringThe data content in string format.
scenarioIdThe interstitial id that delivered the data.
Returns
YES if your delegate handled the data payload, NO otherwise.
Since
6.1

◆ bfgPlacementRewardReceived:rewardName:rewardQuantity:

- (void) bfgPlacementRewardReceived: (NSString *_Nullable) placementKey
rewardName:(NSString *_Nonnull) rewardName
rewardQuantity:(NSNumber *_Nullable) rewardQuantity 
optional
The placement would like to reward the player. To function safely, the actual rewarding logic should occur on the game's server, and the placement would simply notify the user that the reward was available. A client should never reward purely on the basis of receiving this call, as there are not safeguards in place to prevent fraud.
Note
This is only triggered if the placementDebugMode is enabled in first_launch_settings.json and this is a debug build. This won't be triggered on a production build regardless of the setting being enabled on first_launch_settings.json.
Parameters
placementKeyName of the placement.
rewardNameAn identifier for the reward
rewardQuantityA quantity such as @(100) associated with the reward
Since
5.10

◆ bfgPlacementStartPurchase:productId:productQuantity:

- (BOOL) bfgPlacementStartPurchase: (NSString *_Nullable) placementKey
productId:(NSString *_Nonnull) productId
productQuantity:(NSNumber *_Nullable) productQuantity 
optional
A purchase has been requested. Your game should start the purchase.
Parameters
placementKeyName of the placement.
productIdThe Apple product identifier.
productQuantityThe number of products being requested for purchase (should always be 1).
Note
This is only triggered if the placementDebugMode is enabled in first_launch_settings.json and this is a debug build. This won't be triggered on a production build regardless of the setting being enabled on first_launch_settings.json.
Returns
YES if your delegate will start the purchase flow. If NO, the SDK will start the purchase.
Since
5.10