This guide shows you how to use Google Mobile Ads Flutter Plugin to load and display ads from ironSource Ads using [mediation](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/mediation.md.txt), covering waterfall integrations. It covers how to add ironSource Ads to an ad unit's mediation configuration, and how to integrate the ironSource Ads SDK and adapter into a Flutter app. ## Supported integrations and ad formats The Ad Manager mediation adapter for ironSource Ads has the following capabilities: | Integration || |---|---| | Bidding | Yes | | Waterfall | Yes | | App Open | | | Banner | Yes | | Interstitial | Yes | | Rewarded | Yes | | Rewarded Interstitial | Yes [^1^](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/mediation/ironsource.md.txt#waterfall-format-footnote) | | Native | | ^1^ This format is only supported in waterfall integration. ## Prerequisites Before you continue, verify the following: - Latest Google Mobile Ads Flutter Plugin version. - Flutter framework version 3.7.0 or later. - To deploy on Android - Android API level 24 or later. - To deploy on iOS - iOS deployment target of 13.0 or later. - A working Flutter project configured with Google Mobile Ads Flutter Plugin. See [Set up Google Mobile Ads Flutter Plugin](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/quick-start.md.txt) for details. - [Set up mediation](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/mediation.md.txt). ## Step 1: Set up configurations in ironSource Ads UI - [Sign up](https://platform.ironsrc.com/partners/identity/signup) and [sign in](https://platform.ironsrc.com/partners/identity/login) to your ironSource Ads account. ### Add a new app - To add a new app, navigate to **Ads** \> **Apps** and click **Add app**. -  - Fill out the form and click **Add app**. -  - Take note of the **App Key** , then select the ad formats your app supports and click **Continue**. ### Android  ### iOS  ### Create an instance - Next, configure an instance for the app you added. - Navigate to **Ads** \> **Setup** \> **Instances** . Select the app and click **Create instance**. -  ### Bidding Fill out the form and select **Bidding** for **Pricing** . Click **Save and close**. ### Android  ### iOS  > [!NOTE] > **Note:** ironSource Ads limits the number of instances you can create. If you receive an error saying you are not able to create more instances, [contact the ironSource Ads support > team](https://developers.is.com/submit-a-request/) for assistance. > [!IMPORTANT] > **Key Point:** If you want to support rewarded interstitial ads, select the **Rewarded Video** format, and use that **Instance ID** when adding ironSource Ads as an ad source in [step 2](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/mediation/ironsource.md.txt#step-2). Additionally, you will need to contact the ironSource Ads support team at [`Mobile-is-support@ironsrc.com`](mailto:Mobile-is-support@ironsrc.com) to set up your instance for rewarded interstitial support. Take note of the **Instance ID**. ### Android  ### iOS  ### Waterfall Fill out the form and click **Save and close**.  > [!NOTE] > **Note:** ironSource Ads limits the number of instances you can create. If you receive an error saying you are not able to create more instances, [contact the ironSource Ads support > team](https://developers.is.com/submit-a-request/) for assistance. > [!IMPORTANT] > **Key Point:** If you want to support rewarded interstitial ads, select the **Rewarded Video** format, and use that **Instance ID** when adding ironSource Ads as an ad source in [step 2](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/mediation/ironsource.md.txt#step-2). Additionally, you will need to contact the ironSource Ads support team at [`Mobile-is-support@ironsrc.com`](mailto:Mobile-is-support@ironsrc.com) to set up your instance for rewarded interstitial support. Take note of the **Instance ID**.  ### Locate your Reporting API Key ### Bidding This step isn't required for bidding integrations. ### Waterfall > [!NOTE] > **Note:** Only users with **Contributor** or **Administrator** permissions can access the API Keys. Click the **API** tab in [My Account page](https://platform.ironsrc.com/partners/account/apiDetails) and take note of your **Secret Key** and **Refresh Token**.  ### Update your app-ads.txt - [Authorized Sellers for Apps app-ads.txt](https://iabtechlab.com/wp-content/uploads/2019/03/app-ads.txt-v1.0-final-.pdf) is an IAB Tech Lab initiative that helps ensure your app ad inventory is only sold through channels you've identified as authorized. To prevent a significant loss in ad revenue, you'll need to implement an `app-ads.txt` file. If you haven't done so already, [create an app-ads.txt file for Ad Manager](https://support.google.com/admanager/answer/7544382). - To implement `app-ads.txt` for ironSource, see [ironSource authorized resellers](https://developers.is.com/ironsource-mobile/general/app-ads-txt/#step-5). ### Turn on test mode - Follow the instructions in ironSource Ads's [Integration testing](https://https://developers.is.com/ironsource-mobile/android/integration-testing/) guide on how to enable ironSource Ads test ads. ## Step 2: Set up ironSource Ads demand in Ad Manager UI ### Configure mediation settings for your ad unit ### Android For instructions, see step 2 in the guide for [Android](https://developers.google.com/ad-manager/mobile-ads-sdk/android/mediation/ironsource.md.txt#step-2). ### iOS For instructions, see step 2 in the guide for [iOS](https://developers.google.com/ad-manager/mobile-ads-sdk/ios/mediation/ironsource.md.txt#step-2). ### Add ironSource Mobile to GDPR and US state regulations ad partners list - Follow the steps in [European regulations settings](https://support.google.com/admanager/answer/10113006#adding_ad_partners_to_published_gdpr_messages) and [US state regulations settings](https://support.google.com/admanager/answer/14117973) to add **ironSource Mobile** to the European and US state regulations ad partners list in the Ad Manager UI. ## Step 3: Import the ironSource Ads SDK and adapter > [!NOTE] > **Note:** Failure to integrate the compatible ironSource Ads and Google Mobile Ads Flutter Plugin SDK versions might lead to build issues. ### Integration through pub.dev - (Android only) Add the following repositories to the `build.gradle` file inside your project's `android` directory: ```groovy repositories { google() mavenCentral() maven { url = uri("https://android-sdk.is.com/") } } ``` - Add the following dependency with the latest versions of the ironSource Ads SDK and adapter in your package's `pubspec.yaml` file: ```yaml dependencies: gma_mediation_ironsource: ^2.7.1 ``` ### Manual Integration - Download the latest version of Google Mobile Ads mediation plugin for [ironSource Ads](https://pub.dev/packages/gma_mediation_ironsource/versions), extract the downloaded file, and add the extracted plugin folder (and its contents) to your Flutter project. Then, reference the plugin in your `pubspec.yaml` file by adding the following dependency: ```yaml dependencies: gma_mediation_ironsource: path: path/to/local/package ``` ## Step 4: Implement privacy settings on ironSource Ads SDK ### EU Consent and GDPR - To [comply with the Google EU User Consent Policy](https://www.google.com/about/company/consentstaging.html), you must make certain disclosures to your users in the European Economic Area (EEA), the UK, and Switzerland, and obtain their consent for the use of cookies or other local storage where legally required, and for the collection, sharing, and use of personal data for ads personalization. This policy reflects the requirements of the EU ePrivacy Directive and the General Data Protection Regulation (GDPR). You are responsible for verifying that consent is propagated to each ad source in your mediation chain. - ironSource Ads Flutter adapter version 1.0.0 and later supports passing GDPR consent signals from [UMP SDK](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/privacy.md.txt) and consent management platforms that integrate with [Google's Additional Consent specification](https://support.google.com/admanager/answer/9681920) to ironSource Ads SDK. For more information, see [ironSource GDPR Compliance](https://docs.unity.com/en-us/grow/is-ads/legal-resources/ironsource-gdpr-compliance). ### US state privacy laws - [US states privacy laws](https://support.google.com/admanager/answer/9561023) require giving users the right to opt out of the "sale" of their "personal information" (as the law defines those terms), with the opt-out offered through a prominent "Do Not Sell My Personal Information" link on the "selling" party's homepage. The [US states privacy laws compliance guide](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/privacy/us-states) offers the ability to enable [restricted data processing](https://privacy.google.com/businesses/rdp/) for Google ad serving, but Google is unable to apply this setting to each ad network in your mediation chain. Therefore, you must identify each ad network in your mediation chain that may participate in the sale of personal information and follow guidance from each of those networks to ensure compliance. - The Google Mobile Ads mediation plugin for ironSource Ads includes the `GmaMediationIronsource().setDoNotSell` method. The following sample code shows how to pass consent information to the ironSource Ads SDK. These options must be set before you [initialize Google Mobile Ads Flutter Plugin](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/quick-start.md.txt#initialize_the_sdk) to ensure they get forwarded properly to the ironSource Ads SDK. ```dart import 'package:gma_mediation_ironsource/gma_mediation_ironsource.dart'; // ... GmaMediationIronsource().setDoNotSell(true); ``` - See [ironSource Ads's documentation on Regulation Advanced Settings](https://developers.is.com/ironsource-mobile/android/regulation-advanced-settings/#step-2) for both [Android](https://developers.is.com/ironsource-mobile/android/regulation-advanced-settings/#step-2) and [iOS](https://developers.is.com/ironsource-mobile/ios/regulation-advanced-settings/#step-2) for more details and the values that can be provided in the method. ## Step 5: Add required code ### Android #### Proguard Rules If you [shrink, obfuscate, and optimize your app](https://developer.android.com/studio/build/shrink-code), ironSource Ads requires additional ProGuard rules for your project. Consult [ironSource Ads's Android SDK Integration guide](https://developers.is.com/ironsource-mobile/android/android-sdk/#for-proguard-users-only) for more information on what ProGuard rules are required for your project, and add those rules to your `proguard-user.txt` file. #### Application lifecycle Override the `onPause()` and `onResume()` methods in each of your activities to call the corresponding ironSource Ads methods as follows: ### Java ```java @Override public void onResume() { super.onResume(); IronSource.onResume(this); } @Override public void onPause() { super.onPause(); IronSource.onPause(this); } ``` ### Kotlin ```kotlin public override fun onResume() { super.onResume() IronSource.onResume(this) } public override fun onPause() { super.onPause() IronSource.onPause(this) } ``` ### iOS ### SKAdNetwork integration ## Step 6: Test your implementation ### Enable test ads - Make sure you [register your test device](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/test-ads.md.txt#enable_test_devices) for Ad Manager and [enable test mode](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/mediation/ironsource.md.txt#turn-on-test-mode) in ironSource Ads UI. > [!IMPORTANT] > **Important:** Disable test mode for Ad Manager and ironSource Ads before releasing your app. ### Verify test ads - To verify that you are receiving test ads from ironSource Ads, enable [single ad source testing](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/ad-inspector.md.txt#single_ad_source_testing) in ad inspector using the **ironSource Ads (Bidding) and ironSource Ads (Waterfall)** ad source(s). ## Error codes - If the adapter fails to receive an ad from ironSource Ads, publishers can check the underlying error from the ad response using [`ResponseInfo`](https://developers.google.com/ad-manager/mobile-ads-sdk/flutter/response-info.md.txt) under the following classes: ### Android ```java com.google.ads.mediation.ironsource.IronSourceAdapter com.google.ads.mediation.ironsource.IronSourceRewardedAdapter ``` ### iOS ```objective-c GADMAdapterIronSource GADMAdapterIronSourceRewarded ``` - Here are the codes and accompanying messages thrown by the ironSource Ads adapter when an ad fails to load: ### Android | Error code | Reason | |---|---| | 101 | ironSource Ads server parameters configured in the Ad Manager UI are missing/invalid. | | 102 | ironSource Ads requires an Activity context to initialize their SDK. | | 103 | ironSource Ads can only load 1 ad per ironSource instance ID. | | 105 | The requested banner ad size is not supported by ironSource Ads. | | 106 | ironSource Ads SDK is not initialized. | | 107 | An ad show request was made before the ad loaded successfully. | | 108 | ironSource Ads SDK returned null or empty bidding signals. | | 501-1056 | ironSource Ads SDK Errors. See [documentation](https://developers.is.com/ironsource-mobile/android/advanced-settings/#step-6) for more details. | ### iOS | Error code | Reason | |---|---| | 101 | ironSource Ads server parameters configured in the Ad Manager UI are missing/invalid. | | 102 | ironSource Ads Adapter does not support the ad format being requested. | | 103 | An ironSource ad is already loaded for this network configuration. | | 104 | The requested banner ad size is not supported by ironSource Ads. | | 105 | ironSource Ads failed to show the ad. | | 508-1037 | ironSource Ads SDK Errors. See [documentation](https://developers.is.com/ironsource-mobile-ios/sdk-integration/supersonic-sdk-error-codes/) for more details. | ## ironSource Flutter Mediation Adapter Changelog #### Version 2.8.0 (In progress) #### Version 2.7.1 - Supports [ironSource Android adapter version 9.6.1.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9610). - Supports [ironSource iOS adapter version 9.6.1.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-96100). - Built and tested with the Google Mobile Ads Flutter Plugin version 9.1.0. #### Version 2.7.0 - Supports [ironSource Android adapter version 9.6.0.1](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9601). - Supports [ironSource iOS adapter version 9.6.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-96000). - Built and tested with the Google Mobile Ads Flutter Plugin version 9.1.0. #### Version 2.6.0 - Supports [ironSource Android adapter version 9.6.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9600). - Supports [ironSource iOS adapter version 9.5.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-95000). - Built and tested with the Google Mobile Ads Flutter Plugin version 9.1.0. #### Version 2.5.1 - Updated to support Google Mobile Ads Flutter Plugin version 9.1.0. - Add Swift Package Manager support. - Supports [ironSource Android adapter version 9.5.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9500). - Supports [ironSource iOS adapter version 9.5.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-95000). - Built and tested with the Google Mobile Ads Flutter Plugin version 9.1.0. #### Version 2.5.0 - Updated to support Google Mobile Ads Flutter Plugin version 9.0.0. - Supports [ironSource Android adapter version 9.5.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9500). - Supports [ironSource iOS adapter version 9.5.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-95000). - Built and tested with the Google Mobile Ads Flutter Plugin version 9.0.0. #### Version 2.4.3 - Supports [ironSource Android adapter version 9.4.4.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9440). - Supports [ironSource iOS adapter version 9.4.2.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-94200). - Built and tested with the Google Mobile Ads Flutter Plugin version 8.0.0. #### Version 2.4.2 - Supports [ironSource Android adapter version 9.4.2.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9420). - Supports [ironSource iOS adapter version 9.4.1.0.1](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-94101). - Built and tested with the Google Mobile Ads Flutter Plugin version 8.0.0. #### Version 2.4.1 - Supports [ironSource Android adapter version 9.4.2.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9420). - Supports [ironSource iOS adapter version 9.4.1.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-94100). - Built and tested with the Google Mobile Ads Flutter Plugin version 8.0.0. #### Version 2.4.0 - Updated minimum Flutter version to 3.38.1 - Updated to support Google Mobile Ads Flutter Plugin version 8.0.0 - Supports [ironSource Android adapter version 9.4.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9400). - Supports [ironSource iOS adapter version 9.4.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-94000). - Built and tested with the Google Mobile Ads Flutter Plugin version 8.0.0. #### Version 2.3.0 - Supports [ironSource Android adapter version 9.3.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9300). - Supports [ironSource iOS adapter version 9.2.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-92000). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 2.2.0 - Supports [ironSource Android adapter version 9.1.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9100). - Supports [ironSource iOS adapter version 9.2.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-91000). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 2.1.0 - Supports [ironSource Android adapter version 9.1.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9100). - Supports [ironSource iOS adapter version 9.1.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-91000). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 2.0.1 - Fixed iOS build with new API - Supports [ironSource Android adapter version 9.0.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9000). - Supports [ironSource iOS adapter version 9.0.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-90000). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 2.0.0 - Supports [ironSource Android adapter version 9.0.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-9000). - Supports [ironSource iOS adapter version 9.0.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-90000). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 1.5.0 - Supports [ironSource Android adapter version 8.10.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-81000). - Supports [ironSource iOS adapter version 8.10.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-810000). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 1.4.1 - Supports [ironSource Android adapter version 8.9.1.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-8910). - Supports [ironSource iOS adapter version 8.9.1.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-89100). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 1.4.0 - Supports [ironSource Android adapter version 8.9.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-8900). - Supports [ironSource iOS adapter version 8.9.1.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-89100). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 1.3.1 - Supports [ironSource Android adapter version 8.8.0.1](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-8801). - Supports [ironSource iOS adapter version 8.8.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-88000). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 1.3.0 - Supports [ironSource Android adapter version 8.8.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-8800). - Supports [ironSource iOS adapter version 8.8.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-88000). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 1.2.0 - Supports [ironSource Android adapter version 8.7.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-8700). - Supports [ironSource iOS adapter version 8.6.1.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-86100). - Built and tested with the Google Mobile Ads Flutter Plugin version 5.3.1. #### Version 1.1.0 - iOS plugin is now a static framework. - Supports [ironSource Android adapter version 8.6.1.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-8610). - Supports [ironSource iOS adapter version 8.6.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-86000). - Built and tested with the Google Mobile Ads Flutter Plugin version 5.3.1. #### Version 1.0.0 - Initial release. - Supports [ironSource Android adapter version 8.0.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/ironsource/CHANGELOG.md#version-8000). - Supports [ironSource iOS adapter version 8.0.0.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/IronSource/CHANGELOG.md#version-80000). - Built and tested with the Google Mobile Ads Flutter Plugin version 5.1.0.