# Migration from Helium 3.X to Chartboost Mediation 4.X ## Artifactory As part of Chartboost’s rebranding efforts, Chartboost Mediation 4.0.0 will be using all new maven packages. Use the tables below to assist in migrating from the old maven packages to the updated maven packages. ### Chartboost Mediation SDK | Helium 3.X | Chartboost Mediation 4.0.0 | | :-------------------- | :-------------------------------------- | | com.chartboost:helium | com.chartboost:chartboost-mediation-sdk | ### Partner Adapters Beginning with Chartboost Mediation SDK 4.0.0, the partner network adapters will no longer be bundled with the main Chartboost Mediation SDK distribution. This decoupling of the Helium SDK releases from the partner network adapter releases will allow for more rapid iterations of the adapters as the adapters will reside in their own open-source repositories. | Partner Network | Helium 3.X | Chartboost Mediation 4.0.0 | | :------------------------ | :---------------------------------- | :-------------------------------------------------------------------- | | AdMob | com.chartboost:helium-admob | com.chartboost:chartboost-mediation-adapter-admob | | Amazon Publisher Services | com.chartboost:helium-aps | com.chartboost:chartboost-mediation-adapter-amazon-publisher-services | | AppLovin | com.chartboost:helium-applovin | com.chartboost:chartboost-mediation-adapter-applovin | | Chartboost | com.chartboost:helium-chartboost | com.chartboost:chartboost-mediation-adapter-chartboost | | Digital Turbine Exchange | com.chartboost:helium-fyber | com.chartboost:chartboost-mediation-adapter-digital-turbine-exchange | | Google Bidding | com.chartboost:helium-googlebidding | com.chartboost:chartboost-mediation-adapter-google-bidding | | InMobi | com.chartboost:helium-inmobi | com.chartboost:chartboost-mediation-adapter-inmobi | | IronSource | com.chartboost:helium-ironsource | com.chartboost:chartboost-mediation-adapter-ironsource | | Meta Audience Network | com.chartboost:helium-facebook | com.chartboost:chartboost-mediation-adapter-meta-audience-network | | Mintegral | com.chartboost:helium-mintegral | com.chartboost:chartboost-mediation-adapter-mintegral | | Pangle | com.chartboost:helium-pangle | com.chartboost:chartboost-mediation-adapter-pangle | | Unity Ads | com.chartboost:helium-unityads | com.chartboost:chartboost-mediation-adapter-unity-ads | | Vungle | com.chartboost:helium-vungle | com.chartboost:chartboost-mediation-adapter-vungle | ### Partner Adapter Repositories | Partner Network | Android Repository | | :------------------------ | :--------------------------------------------------------------------------------------------- | | AdMob | | | Amazon Publisher Services | | | AppLovin | | | Chartboost | | | Digital Turbine Exchange | | | Google Bidding | | | HyprMX | | | InMobi | | | IronSource | | | Meta Audience Network | | | Mintegral | | | Pangle | | | Unity Ads | | | Vungle | | ### Adapter Versioning Scheme With Chartboost Mediation 4.X+, the partner adapter versions uses floating pegs and are formatted as follows: ``` .. ``` - **Chartboost Mediation SDK Major Version**: This is the major version of the Chartboost Mediation SDK that the adapter is compatible with. - **Partner SDK Version**: This is the full partner SDK version that the adapter is compatible with. Note that this could be the traditional `major.minor.patch` version scheme, but there are some partners that have a `major.minor.patch.revision` version scheme. - **Adapter Revision**: This is the full partner SDK version that the adapter is compatible with. Note that this could be the traditional `major.minor.patch` version scheme, but there are some partners that have a `major.minor.patch.revision` version scheme. The following are some examples of adapter versions for Chartboost Mediation SDK 4.0.0. | Partner | Adapter Version | Chartboost Mediation SDK Major Version | Compatible Partner SDK Version | Adapter Revision | | :--------- | :-------------- | :------------------------------------- | :----------------------------- | :--------------- | | AdMob | 4.21.5.0.2 | 4 | 21.5.0 | 2 | | IronSource | 4.7.2.5.1.0 | 4 | 7.2.5.1 | 0 | #### Adding Ad Network SDKs To integrate other ad networks via Mediation, you will need to include the Mediation adapters: Please check each respective repository or refer to our [Chartboost Mediation Adapters](https://adapters.chartboost.com/){:target="_blank"} for ad network versions. Chartboost Mediation SDK 4.x series is compatible with any adapter also in the 4.x series. The following are only the initial adapters released with version 4.0.0. ```groovy implementation 'com.chartboost:chartboost-mediation-adapter-admob:4.21.3.0.0' implementation 'com.chartboost:chartboost-mediation-adapter-amazon-publisher-services:4.9.6.2.0' implementation 'com.chartboost:chartboost-mediation-adapter-applovin:4.11.5.5.0' implementation 'com.chartboost:chartboost-mediation-adapter-chartboost:4.9.2.0.0' implementation 'com.chartboost:chartboost-mediation-adapter-digital-turbine-exchange:4.8.2.1.0' implementation 'com.chartboost:chartboost-mediation-adapter-google-bidding:4.21.3.0.0' implementation 'com.chartboost:chartboost-mediation-adapter-hyprmx:4.6.0.3.0' implementation 'com.chartboost:chartboost-mediation-adapter-inmobi:4.10.1.1.0' implementation 'com.chartboost:chartboost-mediation-adapter-ironsource:4.7.2.5.0.0' implementation 'com.chartboost:chartboost-mediation-adapter-meta-audience-network:4.6.12.0.0' implementation 'com.chartboost:chartboost-mediation-adapter-mintegral:4.16.0.31.0' implementation 'com.chartboost:chartboost-mediation-adapter-pangle:4.4.3.0.4.0' implementation 'com.chartboost:chartboost-mediation-adapter-unity-ads:4.4.4.1.0' implementation 'com.chartboost:chartboost-mediation-adapter-vungle:4.6.12.0.0' ``` ## Public API ### Helium Name The HeliumSdk name will currently stay for the duration of 4.x. We will deprecate this during the 4.x series and provide migration docs when we move over to the new Chartboost Mediation APIs. ### Constructors #### Interstitial The constructor for `HeliumInterstitialAd` has been changed to include `Context` as the first parameter. The placement name param (String) is now the second parameter. Helium 3.x 
  • HeliumInterstitialAd(String, HeliumInterstitialAdListener)

  • HeliumInterstitialAd(@NonNull String, @Nullable HeliumInterstitialAdListener)
Mediation 4.x 
  • HeliumInterstitialAd(Context, String, HeliumFullscreenAdListener?)

  • HeliumInterstitialAd(@NonNull Context, @NonNull String, @Nullable HeliumFullscreenAdListener)
#### Rewarded The constructor for `HeliumRewardedAd` has been changed to include `Context` as the first parameter. The placement name param (String) is now the second parameter. Helium 3.x 
  • HeliumRewardedAd(String, HeliumRewardedAdListener)

  • HeliumRewardedAd(@NonNull String, @Nullable HeliumRewardedAdListener)
Mediation 4.x 
  • HeliumRewardedAd(Context, String, HeliumFullscreenAdListener?)

  • HeliumRewardedAd(@NonNull Context, @NonNull String, @Nullable HeliumFullscreenAdListener)
### Load Request Identifier The load request identifier has been moved from being a return value from loads to a parameter in the load completion listener callback. #### Banner Helium 3.x 
  • val banner = HeliumBannerAd([params])
val loadId = banner.load()
// loadId holds the request identifier

  • HeliumBannerAd banner = new HeliumBannerAd([params])
String loadId = banner.load()
// loadId holds the request identifier
Mediation 4.x 
  • // in HeliumBannerAdListener
fun onAdCached(placementName: String, loadId: String, winningBidInfo: Map<String, String>, error: ChartboostMediationAdException?) {
    // loadId holds the request identifier
}

  • // in HeliumBannerAdListener
public void onAdCached(String placementName, String loadId, Map<String, String> winningBidInfo, ChartboostMediationAdException error) {
    // loadId holds the request identifier
}
#### Interstitial Helium 3.x 
  • val interstitial = HeliumInterstitialAd([params])
val loadId = interstitial.load()
// loadId holds the request identifier

  • HeliumInterstitialAd interstitial = new HeliumInterstitialAd([params]);
String loadId = interstitial.load();
// loadId holds the request identifier
Mediation 4.x 
  • // in HeliumFullscreenAdListener
fun onAdCached(placementName: String, loadId: String, winningBidInfo: Map<String, String>, error: ChartboostMediationAdException?) {
    // loadId holds the request identifier
}

  • // in HeliumFullscreenAdListener
public void onAdCached(String placementName, String loadId, Map<String, String> winningBidInfo, ChartboostMediationAdException error) {
    // loadId holds the request identifier
}
#### Rewarded Helium 3.x 
  • val rewardedAd = HeliumRewardedAd([params])
val loadId = rewardedAd.load()
// loadId holds the request identifier

  • HeliumRewardedAd rewardedAd = new HeliumRewardedAd([params]);
String loadId = rewardedAd.load();
// loadId holds the request identifier
Mediation 4.x 
  • // in HeliumFullscreenAdListener
fun onAdCached(placementName: String, loadId: String, winningBidInfo: Map<String, String>, error: ChartboostMediationAdException?) {
    // loadId holds the request identifier
}

  • // in HeliumFullscreenAdListener
public void onAdCached(String placementName, String loadId, Map<String, String> winningBidInfo, ChartboostMediationAdException error) {
    // loadId holds the request identifier
}
### Clear Loaded Ad #### Banner Helium 3.x 
  • val success = banner.clearAd()

  • boolean success = banner.clearAd();
Mediation 4.x 
  • // The result of `clearAd()` is assumed to succeed.
banner.clearAd()

  • // The result of `clearAd()` is assumed to succeed.
banner.clearAd();
#### Interstitial Helium 3.x 
  • val success = interstitial.clearLoaded()

  • boolean success = interstitial.clearLoaded();
Mediation 4.x 
  • // The result of `clearLoaded()` is assumed to succeed.
interstitial.clearLoadedAd()

  • // The result of `clearLoaded()` is assumed to succeed.
interstitial.clearLoaded();
#### Rewarded Helium 3.x 
  • val success = rewardedAd.clearLoaded()

  • boolean success = rewardedAd.clearLoaded();
Mediation 4.x 
  • // The result of `clearLoaded()` is assumed to succeed.
rewarded.clearLoaded()

  • // The result of `clearLoaded()` is assumed to succeed.
rewardedAd.clearLoaded();
### Merge Winning Bid Information with Load Completion The optional winning bid delegates have been merged into the load completion delegate callbacks. #### Banner Helium 3.x 
  • // in HeliumBannerAdListener
fun didReceiveWinningBid(placementName: String, bidInfo: HashMap<String, String>) {
    // handle bidInfo
}

  • // in HeliumBannerAdListener
public void didReceiveWinningBid(String placementName, HashMap<String, String> bidInfo) {
    // handle bidInfo
}
Mediation 4.x 
  • // in HeliumBannerAdListener
fun onAdCached(placementName: String, loadId: String, winningBidInfo: Map<String, String>, error: ChartboostMediationAdException?) {
    // handle winningBidInfo
}

  • // in HeliumBannerAdListener
public void onAdCached(String placementName, String loadId, Map<String, String> winningBidInfo, ChartboostMediationAdException error) {
    // handle winningBidInfo
}
#### Interstitial Helium 3.x 
  • // in HeliumInterstitialAdListener
fun didReceiveWinningBid(placementName: String, bidInfo: HashMap<String, String>) {
    // handle bidInfo
}

  • // in HeliumInterstitialAdListener
public void didReceiveWinningBid(String placementName, HashMap<String, String> bidInfo) {
    // handle bidInfo
}
Mediation 4.x 
  • // in HeliumFullscreenAdListener
fun onAdCached(placementName: String, loadId: String, winningBidInfo: Map<String, String>, error: ChartboostMediationAdException?) {
    // handle winningBidInfo
}

  • // in HeliumFullscreenAdListener
public void onAdCached(String placementName, String loadId, Map<String, String> winningBidInfo, ChartboostMediationAdException error) {
    // handle winningBidInfo
}
#### Rewarded Helium 3.x 
  • // in HeliumRewardedAdListener
fun didReceiveWinningBid(placementName: String, bidInfo: HashMap<String, String>) {
    // handle bidInfo
}

  • // in HeliumRewardedAdListener
public void didReceiveWinningBid(String placementName, HashMap<String, String> bidInfo) {
    // handle bidInfo
}
Mediation 4.x 
  • // in HeliumFullscreenAdListener
fun onAdCached(placementName: String, loadId: String, winningBidInfo: Map<String, String>, error: ChartboostMediationAdException?) {
    // handle winningBidInfo
}

  • // in HeliumFullscreenAdListener
public void onAdCached(String placementName, String loadId, Map<String, String> winningBidInfo, ChartboostMediationAdException error) {
    // handle winningBidInfo
}
### New Rewarded Callback The string value from the old reward callback has been removed since it never provided useful information. #### Rewarded Helium 3.x 
  • // in HeliumRewardedAdListener
fun didReceiveReward(placementName: String, reward: String) {
    // Old reward was a String and never provided useful information
}

  • // in HeliumFullscreenAdListener
public void didReceiveReward(String placementName, String reward) {
    // Old reward was a String and never provided useful information
}
Mediation 4.x 
  • // in HeliumFullscreenAdListener
fun onAdRewarded(placementName: String) {
    // Rewarding was successful
}

  • // in HeliumFullscreenAdListener
public void onAdRewarded(String 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](/en/mediation/integrate/android/error-codes/) for more information.