Integrating ironSource with Mediation

This guide is intended for publishers who want to use the Google Mobile Ads SDK to load and display ads from ironSource through mediation. It covers how to add ironSource to an ad unit's mediation configuration, how to set up ad network optimization, and how to integrate the ironSource SDK and adapter into your iOS app.

Supported formats and features

The AdMob mediation adapter for ironSource has the following capabilities:

Formats
Banner
Interstitial
Rewarded
Rewarded Interstitial
Native
Features
Adaptive banner
Ad network optimization (ANO)

Requirements

  • iOS deployment target of 8.0 or higher
  • Latest Google Mobile Ads SDK

Step 1: Set up ironSource

Sign up and sign in to your ironSource account.

To add your application to the ironSource dashboard, click the New App button.

Enter app details

Select Mobile App, enter the App Store URL of your app, and click Import App Info. Once your app information is displayed, click the Add App button.

If your app is not available, select App Not Live in the Application Store and provide a Temporary Name for your app. Select iOS as platform and click Add App.

Take note of your new App Key, which is displayed after the app has been added. You will need this value for setting up your AdMob ad unit ID. Select the ad formats your app supports in the appropriate Live tabs. Then click Done.

Instance ID

Next, configure a network instance for the app you added; ironSource supports multiple network instances for rewarded and interstitial ads.

Navigate to the Ad Units & Placements page from the left nav, select your app in the APPLICATIONS list and click the Edit button.

Select the Add Network Instance link, enter an Instance Name, and click Save.

Once the instance is created, the Instance ID is listed in the Instance Id field.

In addition to the App Key and Instance ID, you'll also need your ironSource Secret Key and Refresh Token to set up your AdMob ad unit ID.

Navigate to My Account in your ironSource publisher dashboard then click the API tab. Take note of your Secret Key and Refresh Token.

Step 2: Configure mediation settings for your AdMob ad unit

To add ironSource to the mediation configuration for your ad unit, first sign in to your AdMob account.

Next, navigate to the Mediation tab. If you have an existing mediation group you'd like to modify, click the name of that mediation group to edit it, and skip ahead to Add ironSource as an ad source.

To create a new mediation group, select Create Mediation Group.

Enter your ad format and platform, then click Continue.

Give your mediation group a name and select locations to target. Next, set the mediation group status to Enabled and click Add Ad Units.

Associate this mediation group with one or more of your existing AdMob ad units. Then click Done.

You should now see the ad units card populated with the ad units you selected as shown below:

Add ironSource as an ad source

In the Ad Sources card, select Add Ad Network. Then select ironSource.

Next, enable the Optimize feature, then enter the Secret Key  and Refresh Token obtained in previous section to set up ANO for ironSource. Then enter an eCPM value and click Continue.

Enter the App Key and Instance ID obtained in the previous section.

Using rewarded ads

In the settings for your rewarded ad unit, provide values for the reward amount and reward type. Then, to ensure you provide the same reward to the user no matter which ad network is served, check the Apply to all networks in Mediation groups box.

If you don't apply this setting, the ironSource adapter passes back the reward specified in the ironSource dashboard when creating the placement.

For more information on setting reward values for AdMob ad units, see Create an ad unit.

Step 3: Import the ironSource SDK and adapter

  • Add the following line to your project's Podfile:

    pod 'GoogleMobileAdsMediationIronSource'

  • From the command line run:

    pod install --repo-update

Manual integration

  • Download the latest version of the ironSource iOS SDK and link IronSource.framework in your project.

  • Download the latest version of the ironSource adapter from the download link in Changelog and link IronSourceAdapter.framework in your project.

Step 4: Additional code required

No additional code is required for ironSource iOS integration.

Step 5: Test your implementation

To enable test ads on ironSource, run your ads integrated app and check the logs for a message that looks like this:

This is the Advertising ID of your test device. Copy it to the clipboard.

Navigate to the MONETIZE tab and click the Testing button. Next, click the New Test Device button.

Enter the Device Name and Advertising ID (from the previous step). Then click Save.

The newly added test device is listed under TEST DEVICES. You can activate or deactivate Test Ads in this module as required.

Optional steps

Under the Google EU User Consent Policy, you must ensure that certain disclosures are given to, and consents obtained from, users in the European Economic Area (EEA) regarding the use of device identifiers and personal data. This policy reflects the requirements of the EU ePrivacy Directive and the General Data Protection Regulation (GDPR). When seeking consent, you must identify each ad network in your mediation chain that may collect, receive, or use personal data and provide information about each network's use. Google currently is unable to pass the user's consent choice to such networks automatically.

The section below shows you how to enable or disable personalized ads for ironSource.

In SDK version 6.7.9, ironSource added a consent API. The following sample code sets consent to YES on the ironSource SDK. If you choose to call this method, it is recommended that you do so prior to requesting ads via the Google Mobile Ads SDK.

#import <IronSource/IronSource.h>
...

[IronSource setConsent:YES];

See ironSource's managing consent documentation for more details.

Error codes

If the adapter fails to receive an ad from ironSource, publishers can check the underlying error from the ad response using GADResponseInfo.adNetworkInfoArray under the following classes:

GADMAdapterIronSource
GADMAdapterIronSourceRewarded

Here are the codes and accompanying messages thrown by the ironSource adapter when an ad fails to load:

Error code Reason
101 ironSource server parameters configured in the AdMob UI are missing/invalid.
102 ironSource Adapter does not support the ad format being requested.
103 An ironSource ad is already loaded for this network configuration.
508-1037 ironSource SDK Errors. See documentation for more details.

IronSource iOS Mediation Adapter Changelog

Version 7.1.7.0

  • Verified compatibility with ironSource SDK version 7.1.7.

Build and tested with:

  • Google Mobile Ads SDK version 8.7.0.
  • IronSource SDK version 7.1.7.

Version 7.1.6.1.0

  • Verified compatibility with ironSource SDK version 7.1.6.1.

Build and tested with:

  • Google Mobile Ads SDK version 8.5.0.
  • IronSource SDK version 7.1.6.1.

Version 7.1.6.0

  • Verified compatibility with ironSource SDK version 7.1.6.

Build and tested with:

  • Google Mobile Ads SDK version 8.5.0.
  • IronSource SDK version 7.1.6.

Version 7.1.5.1.0

  • Verified compatibility with ironSource SDK version 7.1.5.1.
  • Relaxed dependency to Google Mobile Ads SDK version 8.0.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 8.5.0.
  • IronSource SDK version 7.1.5.1.

Version 7.1.5.0

  • Verified compatibility with ironSource SDK version 7.1.5.

Build and tested with:

  • Google Mobile Ads SDK version 8.3.0.
  • IronSource SDK version 7.1.5.

Version 7.1.4.0

  • Verified compatibility with ironSource SDK version 7.1.4.
  • Now requires Google Mobile Ads SDK version 8.3.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 8.3.0.
  • IronSource SDK version 7.1.4.

Version 7.1.3.0

  • Added support for rewarded interstitial ads.
  • Verified compatibility with ironSource SDK version 7.1.3.
  • Now requires Google Mobile Ads SDK version 8.2.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 8.2.0.
  • IronSource SDK version 7.1.3.

Version 7.1.2.0

  • Verified compatibility with ironSource SDK version 7.1.2.

Build and tested with:

  • Google Mobile Ads SDK version 8.1.0.
  • IronSource SDK version 7.1.2.

Version 7.1.1.0

  • Verified compatibility with ironSource SDK version 7.1.1.
  • Now requires Google Mobile Ads SDK version 8.1.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 8.1.0.
  • IronSource SDK version 7.1.1.

Version 7.1.0.1

  • Updated the adapter to use the .xcframework format.
  • Now requires Google Mobile Ads SDK version 8.0.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 8.0.0.
  • IronSource SDK version 7.1.0.

Version 7.1.0.0

  • Verified compatibility with ironSource SDK version 7.1.0.
  • Now requires Google Mobile Ads SDK version 7.69.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 7.69.0.
  • IronSource SDK version 7.1.0.

Version 7.0.4.0

  • Verified compatibility with ironSource SDK version 7.0.4.
  • Now requires Google Mobile Ads SDK version 7.68.0 or higher.
  • Added standardized adapter error codes and messages.

Build and tested with:

  • Google Mobile Ads SDK version 7.68.0.
  • IronSource SDK version 7.0.4.

Version 7.0.3.0

  • Verified compatibility with ironSource SDK version 7.0.3.

Build and tested with:

  • Google Mobile Ads SDK version 7.66.0.
  • IronSource SDK version 7.0.3.

Version 7.0.2.0

  • Verified compatibility with ironSource SDK version 7.0.2.
  • Now requires Google Mobile Ads SDK version 7.66.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 7.66.0.
  • IronSource SDK version 7.0.2.

Version 7.0.1.0

  • Verified compatibility with ironSource SDK version 7.0.1.

Build and tested with:

  • Google Mobile Ads SDK version 7.64.0.
  • IronSource SDK version 7.0.1.

Version 7.0.0.0

  • Verified compatibility with ironSource SDK version 7.0.0.
  • Now requires Google Mobile Ads SDK version 7.64.0 or higher.
  • Now requires minimum iOS version of 9.0.

Build and tested with:

  • Google Mobile Ads SDK version 7.64.0.
  • IronSource SDK version 7.0.0.

Version 6.18.0.2.0

  • Verified compatibility with ironSource SDK version 6.18.0.2.

Build and tested with:

  • Google Mobile Ads SDK version 7.63.0.
  • IronSource SDK version 6.18.0.2.

Version 6.18.0.1.0

  • Verified compatibility with ironSource SDK version 6.18.0.1.
  • Now requires Google Mobile Ads SDK version 7.63.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 7.63.0.
  • IronSource SDK version 6.18.0.1.

Version 6.18.0.0

  • Verified compatibility with ironSource SDK version 6.18.0.
  • Now requires Google Mobile Ads SDK version 7.63.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 7.63.0.
  • IronSource SDK version 6.18.0.

Version 6.17.0.1.0

  • Verified compatibility with ironSource SDK version 6.17.0.1.
  • Now requires Google Mobile Ads SDK version 7.62.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 7.62.0.
  • IronSource SDK version 6.17.0.1.

Version 6.17.0.0

  • Verified compatibility with ironSource SDK version 6.17.0.
  • Now requires Google Mobile Ads SDK version 7.61.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 7.61.0.
  • IronSource SDK version 6.17.0.

Version 6.16.3.0

  • Verified compatibility with ironSource SDK version 6.16.3.

Build and tested with:

  • Google Mobile Ads SDK version 7.60.0.
  • IronSource SDK version 6.16.3.

Version 6.16.2.0

  • Verified compatibility with ironSource SDK version 6.16.2.
  • Now requires Google Mobile Ads SDK version 7.60.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 7.60.0.
  • IronSource SDK version 6.16.2.

Version 6.16.1.0

  • Verified compatibility with ironSource SDK version 6.16.1.

Build and tested with:

  • Google Mobile Ads SDK version 7.58.0.
  • IronSource SDK version 6.16.1.

Version 6.16.0.0

  • Verified compatibility with ironSource SDK version 6.16.0.
  • Now requires Google Mobile Ads SDK version 7.58.0 or higher.

Build and tested with:

  • Google Mobile Ads SDK version 7.58.0.
  • IronSource SDK version 6.16.0.

Version 6.15.0.1.0

  • Verified compatibility with ironSource SDK version 6.15.0.1.

Build and tested with:

  • Google Mobile Ads SDK version 7.57.0.
  • IronSource SDK version 6.15.0.1.

Version 6.15.0.0

  • Verified compatibility with ironSource SDK version 6.15.0.

Build and tested with:

  • Google Mobile Ads SDK version 7.57.0.
  • IronSource SDK version 6.15.0.

Version 6.14.0.0

  • Verified compatibility with ironSource SDK version 6.14.0.
  • Removed support for the i386 architecture.

Build and tested with:

  • Google Mobile Ads SDK version 7.56.0.
  • IronSource SDK version 6.14.0.

Version 6.13.0.1.0

  • Verified compatibility with ironSource SDK version 6.13.0.1.

Build and tested with:

  • Google Mobile Ads SDK version 7.53.1.
  • IronSource SDK version 6.13.0.1.

Version 6.12.0.0

  • Verified compatibility with ironSource SDK version 6.12.0.

Build and tested with:

  • Google Mobile Ads SDK version 7.53.1.
  • IronSource SDK version 6.12.0.

Version 6.11.0.0

  • Verified compatibility with ironSource SDK version 6.11.0.

Build and tested with:

  • Google Mobile Ads SDK version 7.52.0.
  • IronSource SDK version 6.11.0.

Version 6.8.7.0

  • Verified compatibility with ironSource SDK version 6.8.7.

Version 6.8.6.0

  • Verified compatibility with ironSource SDK version 6.8.6.

Version 6.8.5.0

  • Verified compatibility with ironSource SDK version 6.8.5.

Version 6.8.4.1.0

  • Verified compatibility with ironSource SDK version 6.8.4.1.

Version 6.8.4.1

  • Added code to send correct version number to ironSource SDK.

Version 6.8.4.0

  • Verified compatibility with ironSource SDK version 6.8.4.

Version 6.8.3.0

  • Verified compatibility with ironSource SDK 6.8.3.
  • Added support to request multiple interstitial ads.
  • Fix crashes when loading rewarded ads.
  • This version of the adapter requires a Google Mobile Ads SDK of version 7.42.2 or above.

Version 6.8.0.1

  • Updated the adapter to use new rewarded API
  • This version of the adapter requires a Google Mobile Ads SDK of version 7.41.0 or above

Version 6.8.0.0

  • Verified compatibility with ironSource SDK 6.8.0

Version 6.7.12.0

  • Verified compatibility with ironSource SDK 6.7.12

Version 6.7.11.0

  • Verified compatibility with ironSource SDK 6.7.11

Version 6.7.10.0

  • Verified compatibility with ironSource SDK 6.7.10

Version 6.7.9.3.1

  • Added adapterDidCompletePlayingRewardBasedVideoAd: callback to the adapter.

Version 6.7.9.3.0

  • Verified compatibility with ironSource SDK 6.7.9.3

Version 6.7.9.2.0

  • Verified compatibility with ironSource SDK 6.7.9.2

Version 6.7.9.1.0

  • Verified compatibility with ironSource SDK 6.7.9.1

Version 6.7.8.0

  • Verified compatibility with ironSource SDK 6.7.8

Version 6.7.7.0

  • Initiate IronSource SDK once per ad unit.

Version 6.7.5.0

  • Initial release!
  • Supports interstitial and rewarded video ads.