Integrate Network SDKs

Partner Network Supported SDK Versions 🔗

Please visit our Chartboost Mediation Adapter Integration Manager for the latest partner network supported SDK versions. The specific network’s supported ad formats and adapter integration instructions are also provided there.

Mediation 4.0.0 Changes 🔗

As part of the Marketing team’s efforts to clearly articulate the use cases and customers we support by being more descriptive with our product branding, Helium is being rebranded as Chartboost Mediation.

Starting in 4.0.0, the Chartboost Mediation brand will be used in place of Helium for new additions. In the coming 4.X releases, the old Helium branding will be deprecated and the new Chartboost Mediation branding will be used to give publishers a smoother transition.

Adapter Separation 🔗

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.

The supported open-source adapter repositories are:

Adapter Versioning Scheme 🔗

With Chartboost Mediation 4.0.0, the partner adapter versions are as follows:

<chartboost_mediation_sdk_major_version>.<partner_sdk_version>.<adapter_revision>

Our adapter versioning uses floating pegs.

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 version of the adapter. Typically this will start at 0 and will increment as there are hotfixes that are specific to this version of the adapter.

Examples 🔗

The following are some examples of adapter versions for Chartboost Mediation SDK 4.0.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 for ad network versions. Chartboost Mediation SDK 4.x series is compatible with any adapter also in the 4.x series. These are only the initial adapters released with version 4.0.0.

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'

AdMob 🔗

To integrate with AdMob SDK, refer to (AdMob Android SDK documentation).

• The latest versions of AdMob now require the usage of AndroidX support libraries.

Amazon Publisher Services 🔗

Amazon Publisher Services network is currently in private beta. Please reach out to Chartboost to inquire.

AppLovin 🔗

To integrate with AppLovin SDK, refer to (AppLovin Android SDK documentation).

Chartboost 🔗

To integrate with Chartboost SDK, refer to Chartboost Android SDK documentation.

Digital Turbine 🔗

To integrate with Digital Turbine (formerly Fyber) Android SDK, refer to Digital Turbine Android SDK documentation).

HyprMX 🔗

To integrate with HyprMX Android SDK, refer to HyprMX Android SDK documentation.

• HyprMX requires a unique generated identifier that needs to be static across sessions during its SDK initialization.
• The ageRestrictedUser flag needs to be set before the Chartboost Mediation initializes to appropriately apply child-directed treatment to a user.

ironSource 🔗

To integrate with ironSource SDK, refer to (ironSource Android SDK documentation).

• ironSource provides their own Maven Repository, therefore does not use Maven Central to distribute their SDKs.

Meta Audience Network 🔗

To integrate with Meda Audience Network Android SDK, refer to (Meta Android SDK documentation).

In addition, publishers may be needed to include the following in their network security config file (network_security_config.xml).

<?xml version="1.0" encoding="utf-8"?>
<network-security-config>
  <domain-config cleartextTrafficPermitted="true">
    <domain includeSubdomains="true">127.0.0.1</domain>
  </domain-config>
</network-security-config>

And update AndroidManifest.xml

<?xml version="1.0" encoding="utf-8"?>
<manifest ... >
<application android:networkSecurityConfig="@xml/network_security_config"
... >
...
</application>
</manifest>

For more information on Meta network security configuration check Network Security Config

Mintegral 🔗

To integrate with Mintegral SDK, refer to (Mintegral Android SDK documentation).

• Mintegral provides their own Maven Repository, therefore does not use Maven Central to distribute their SDKs.

Pangle 🔗

To integrate with Pangle SDK, refer to Pangle’s Android SDK Integration documentation.

Unity Ads 🔗

To integrate with Unity Ads SDK, refer to (Unity Android SDK documentation).

Vungle 🔗

To integrate with Vungle SDK, refer to (Vungle Android SDK documentation).

Setting Individual Partner Consents 🔗

Partner consent can be set on an individual basis using the following API. Using these partner consents will override the global GDPR and CCPA consent used for the Chartboost Mediation SDK with the partner-specific values.

Get the PartnerConsents object to be able to set consent on a per-partner basis.

HeliumSdk.partnerConsents: PartnerConsent

PartnerConsent {
    /**
     * Gets a copy of the partner ID to consent given map.
     */
    fun getPartnerIdToConsentGivenMapCopy(): Map<String, Boolean>

    /**
     * Adds a single partner's consent. This value is persisted between app launches.
     *
     * @param partnerId The partner ID.
     * @param consentGiven True if there is consent for this partner, false otherwise.
     */
    fun setPartnerConsent(partnerId: String, consentGiven: Boolean)

    /**
     * Adds a map of partner IDs to consent given. These values are persisted between app launches.
     * This is only additive. If you'd like to remove a consent for a particular partner, please
     * use removePartnerConsent().
     *
     * @param partnerIdToConsentGivenMap The map of partner IDs to consent given.
     */
    fun addPartnerConsents(partnerIdToConsentGivenMap: Map<String, Boolean>)

    /**
     * Remove a partner consent.
     *
     * @param partnerId The partner ID.
     * @return The previous consent state of this partner.
     */
    fun removePartnerConsent(partnerId: String): Boolean?

    /**
     * Clears and adds a map of partner IDs to consent given. These values are persisted between app
     * launches.
     */
    fun replacePartnerConsents(partnerIdToConsentGivenMap: Map<String, Boolean>)

    /**
     * Clears all partner consents. This change will persist to disk.
     */
    fun clear()
}

Getting Current Partner Consents 🔗

val partnerConsents = HeliumSdk.getPartnerConsents(context)

Setting Single Partner Consent 🔗

partnerConsents.setPartnerConsent("admob", true)

Setting Multiple Partner Consents 🔗

partnerConsents.addPartnerConsents(mapOf("chartboost" to true, "admob" to false))

Removing Partner Consent 🔗

val previousConsent = partnerConsents.removePartnerConsent("chartboost")

Replacing All Partner Consents 🔗

partnerConsents.replacePartnerConsents(mapOf("chartboost" to "false", "admob" to "true"))

Clearing All Partner Consents 🔗

Globally set consents will re-apply if partner consents are cleared.

partnerConsents.clear()

Partner Identifiers 🔗