Migration from Helium 3.X to Chartboost Mediation 4.0.0

Cocoapods

As part of Chartboost’s rebranding efforts, Chartboost Mediation 4.0.0 will be using all new Cocoapod names. Use the tables below to assist in migrating from the old Cocoapod name to the updated name.

Chartboost Mediation SDK

Helium 3.X	Chartboost Mediation 4.0.0
ChartboostHelium	ChartboostMediationSDK

Partner Adapters

Partner Network	Helium 3.X	Chartboost Mediation 4.0.0
AdColony	ChartboostHeliumAdapterAC	ChartboostMediationAdapterAdColony
AdMob	ChartboostHeliumAdapterAdMob	ChartboostMediationAdapterAdMob
Amazon Publisher Services	ChartboostHeliumAdapterAPS	ChartboostMediationAdapterAmazonPublisherServices
AppLovin	ChartboostHeliumAdapterAppLovin	ChartboostMediationAdapterAppLovin
Chartboost	N/A	ChartboostMediationAdapterChartboost
Digital Turbine Exchange	ChartboostHeliumAdapterFyber	hartboostMediationAdapterDigitalTurbineExchange
Google Bidding	ChartboostHeliumAdapterGoogleBidding	ChartboostMediationAdapterGoogleBidding
InMobi	ChartboostHeliumAdapterInMobi	ChartboostMediationAdapterInMobi
IronSource	ChartboostHeliumAdapterIronSource	ChartboostMediationAdapterIronSource
Meta Audience Network	ChartboostHeliumAdapterFAN	ChartboostMediationAdapterMetaAudienceNetwork
Mintegral	ChartboostHeliumAdapterMintegral	ChartboostMediationAdapterMintegral
Pangle	ChartboostHeliumAdapterPangle	ChartboostMediationAdapterPangle
Tapjoy	ChartboostHeliumAdapterTJ	ChartboostMediationAdapterTapjoy
Unity Ads	ChartboostHeliumAdapterUnity	ChartboostMediationAdapterUnityAds
Vungle	ChartboostHeliumAdapterVungle	ChartboostMediationAdapterVungle
Yahoo	ChartboostHeliumAdapterYahoo	ChartboostMediationAdapterYahoo

See Integrate Network SDKs - Adapter Separation for additional information.

Public API

Module Name

As part of the rebranding effort, the name of the module has changed. You can easily perform a find and replace in the code base.

The following table shows the various Objective-C and Swift module imports and their renamed equivalents:

Helium 3.X	Chartboost Mediation 4.0.0
`#import <HeliumSdk/HeliumSdk.h>`	`#import <ChartboostMediationSDK/ChartboostMediationSDK.h>`
`import HeliumSdk`	`import ChartboostMediationSDK`

Load Request Identifier

The load request identifier has been moved from being a return value from loads to a parameter in the load completion delegate callback.

Banner

if let banner = Helium.shared().bannerProvider(with: self, andPlacementName: "your placement", andSize: .standard) {
    let requestIdentifier = banner.load(with: self)
    // Handle `requestIdentifier`
}

HeliumBannerView *banner = [[Helium sharedHelium] bannerProviderWithDelegate:self andPlacementName:@"your placement" andSize:CHBHBannerSize_Standard];
if (banner != nil) {
        NSString *requestIdentifier = [banner loadAdWithViewController:self];
        // Handle `requestIdentifier`
}

func heliumBannerAd(placementName: String, requestIdentifier: String, winningBidInfo: [String : Any]?, didLoadWithError error: ChartboostMediationError?) {
    // Handle `requestIdentifier`
}

- (void)heliumBannerAdWithPlacementName:(NSString * _Nonnull)placementName requestIdentifier:(NSString * _Nonnull)requestIdentifier winningBidInfo:(NSDictionary<NSString *,id> * _Nullable)winningBidInfo didLoadWithError:(ChartboostMediationError * _Nullable)error {
    // Handle `requestIdentifier`
}

Interstitial

if let interstitial = Helium.shared().interstitialAdProvider(with: self, andPlacementName: "your placement") {
    let requestIdentifier = interstitial.load()
    // Handle `requestIdentifier`
}

id<HeliumInterstitialAd> interstitial = [[Helium sharedHelium] interstitialAdProviderWithDelegate:self andPlacementName:@"your placement"];
if (interstitial != nil) {
    NSString *requestIdentifier = [interstitial loadAd];
    // Handle `requestIdentifier`
}

func heliumInterstitialAd(withPlacementName placementName: String, requestIdentifier: String, winningBidInfo: [String : Any]?, didLoadWithError error: ChartboostMediationError?) {
    // Handle `requestIdentifier`
}

- (void)heliumInterstitialAdWithPlacementName:(NSString * _Nonnull)placementName requestIdentifier:(NSString * _Nonnull)requestIdentifier winningBidInfo:(NSDictionary<NSString *,id> * _Nullable)winningBidInfo didLoadWithError:(ChartboostMediationError * _Nullable)error {
    // Handle `requestIdentifier`
}

Rewarded

if let rewarded = Helium.shared().rewardedAdProvider(with: self, andPlacementName: "your placement") {
    let requestIdentifier = rewarded.load()
    // Handle `requestIdentifier`
}

id<HeliumRewardedAd> rewarded = [[Helium sharedHelium] rewardedAdProviderWithDelegate:self andPlacementName:@"your placement"];
if (rewarded != nil) {
    NSString *requestIdentifier = [rewarded loadAd];
    // Handle `requestIdentifier`
}

func heliumRewardedAd(withPlacementName placementName: String, requestIdentifier: String, winningBidInfo: [String : Any]?, didLoadWithError error: ChartboostMediationError?) {
    // Handle `requestIdentifier`
}

- (void)heliumRewardedAdWithPlacementName:(NSString * _Nonnull)placementName requestIdentifier:(NSString * _Nonnull)requestIdentifier winningBidInfo:(NSDictionary<NSString *,id> * _Nullable)winningBidInfo didLoadWithError:(ChartboostMediationError * _Nullable)error {
    // Handle `requestIdentifier`
}

Clear Loaded Ad

The return value for clearLoadedAd() has been removed, and it is assumed to succeed.

Banner

let success = banner.clear()

BOOL success = [banner clearAd];

// The result of `clear` is assumed to succeed.
banner.clear()

// The result of `clearAd` is assumed to succeed.
[banner clearAd];

Interstitial

let success = interstitial.clearLoadedAd()

BOOL success = [interstitial clearLoadedAd];

// The result of `clearLoadedAd` is assumed to succeed.
interstitial.clearLoadedAd()

// The result of `clearLoadedAd` is assumed to succeed.
[interstitial clearLoadedAd];

Rewarded

let success = rewarded.clearLoadedAd()

BOOL success = [rewarded clearLoadedAd];

// The result of `clearLoadedAd` is assumed to succeed.
rewarded.clearLoadedAd()

// The result of `clearLoadedAd` is assumed to succeed.
[rewarded clearLoadedAd];

Merge Winning Bid Information with Load Completion

The optional winning bid delegates have been merged into the load completion delegate callbacks.

Banner

func heliumBannerAd(placementName: String, didLoadWinningBidWithInfo bidInfo: [String : Any]) {
    // Handle `bidInfo`
}

- (void)heliumBannerAdWithPlacementName:(NSString *)placementName didLoadWinningBidWithInfo:(NSDictionary<NSString *,id> *)bidInfo {
    // Handle `bidInfo`
}

func heliumBannerAd(placementName: String, requestIdentifier: String, winningBidInfo: [String : Any]?, didLoadWithError error: ChartboostMediationError?) {
    // Handle `winningBidInfo`
}

- (void)heliumBannerAdWithPlacementName:(NSString * _Nonnull)placementName requestIdentifier:(NSString * _Nonnull)requestIdentifier winningBidInfo:(NSDictionary<NSString *,id> * _Nullable)winningBidInfo didLoadWithError:(ChartboostMediationError * _Nullable)error {
    // Handle `winningBidInfo`
}

Interstitial

func heliumInterstitialAd(withPlacementName placementName: String, didLoadWinningBidWithInfo bidInfo: [String : Any]) {
    // Handle `bidInfo`
}

- (void)heliumInterstitialAdWithPlacementName:(NSString *)placementName didLoadWinningBidWithInfo:(NSDictionary<NSString *,id> *)bidInfo {
    // Handle `bidInfo`
}

func heliumInterstitialAd(withPlacementName placementName: String, requestIdentifier: String, winningBidInfo: [String : Any]?, didLoadWithError error: ChartboostMediationError?) {
    // Handle `winningBidInfo`
}

- (void)heliumInterstitialAdWithPlacementName:(NSString * _Nonnull)placementName requestIdentifier:(NSString * _Nonnull)requestIdentifier winningBidInfo:(NSDictionary<NSString *,id> * _Nullable)winningBidInfo didLoadWithError:(ChartboostMediationError * _Nullable)error {
    // Handle `winningBidInfo`
}

Rewarded

func heliumRewardedAd(withPlacementName placementName: String, didLoadWinningBidWithInfo bidInfo: [String : Any]) {
    // Handle `bidInfo`
}

- (void)heliumRewardedAdWithPlacementName:(NSString *)placementName didLoadWinningBidWithInfo:(NSDictionary<NSString *,id> *)bidInfo {
    // Handle `bidInfo`
}

func heliumRewardedAd(withPlacementName placementName: String, requestIdentifier: String, winningBidInfo: [String : Any]?, didLoadWithError error: ChartboostMediationError?) {
    // Handle `winningBidInfo`
}

- (void)heliumRewardedAdWithPlacementName:(NSString * _Nonnull)placementName requestIdentifier:(NSString * _Nonnull)requestIdentifier winningBidInfo:(NSDictionary<NSString *,id> * _Nullable)winningBidInfo didLoadWithError:(ChartboostMediationError * _Nullable)error {
    // Handle `winningBidInfo`
}

New Rewarded Callback

The integer value from the old reward callback has been removed since it never provided useful information.

Rewarded

func heliumRewardedAd(withPlacementName placementName: String, didGetReward reward: Int) {
    // Old reward was an integer and never provided useful information
}

- (void)heliumRewardedAdWithPlacementName:(NSString *)placementName didGetReward:(NSInteger)reward {
    // Old reward was an integer and never provided useful information
}

func heliumRewardedAdDidGetReward(withPlacementName placementName: String) {
    // Rewarding was successful
}

- (void)heliumRewardedAdDidGetRewardWithPlacementName:(NSString * _Nonnull)placementName {
    // Rewarding was successful
}

Error Codes

Helium 4.0.0 introduces a new system of errors (plus dozens of brand new ones) complete with diagnosis and recommendation.

See Error Codes for more information.