This guide shows you how to use the Google Mobile Ads SDK to load and display ads from ironSource Ads using mediation, 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 AdMob mediation adapter for ironSource Ads has the following capabilities:
Integration | |
---|---|
Bidding | 1 |
Waterfall | |
Formats | |
Banner | 2 |
Interstitial | |
Rewarded | |
Rewarded Interstitial | 2 |
1 Bidding integration is in closed beta, reach out to your account manager to request access.
2 This format is only supported in waterfall integration.
Requirements
- Latest Google Mobile Ads SDK
- Flutter 3.7.0 or higher
- To deploy on Android
- Android API level 21 or higher
- To deploy on iOS
- iOS deployment target of 12.0 or higher
- A working Flutter project configured with Google Mobile Ads SDK. See Get Started for details.
- Complete the mediation Get started guide
Step 1: Set up configurations in ironSource Ads UI
如需将应用添加到 ironSource Ads 信息中心,请点击 New App 按钮。
输入应用详情
选择 Live App,输入应用的 网址,然后点击 Import App Info。
如果您的应用不可用,请选择 App Not Live in the App Store 并为您的应用提供一个临时名称。选择您的平台。
填写表单的其余部分,然后点击添加应用。
记下新的应用密钥,此密钥会在添加应用后显示。在设置广告单元 ID 时,您需要使用此值。AdMob 选择您的应用支持的广告格式。然后点击继续。
Android
iOS
创建实例
接下来,为您添加的应用配置网络实例。
出价
依次前往 LevelPlay > 设置 > SDK 广告联盟,然后选择您的应用。在出价下,点击“修改”图标以查看出价实例 ID。
Android
iOS
记下实例 ID。
Android
iOS
瀑布
依次前往广告 > 设置 > 实例。选择该应用,然后点击创建实例。
输入必要的详细信息,然后点击保存并关闭。
创建实例后,实例 ID 字段中会列出实例 ID。
找到您的 Reporting API 密钥
出价
出价集成不需要执行此步骤。
瀑布
除了应用密钥和实例 ID 之外,您还需要 ironSource Ads 密钥和刷新令牌来设置您的AdMob 广告单元 ID。
在 ironSource Ads 发布商信息中心内前往我的帐号,然后点击 API 标签页。记下您的密钥和刷新令牌。
开启测试模式
请按照 ironSource Ads 的集成测试指南中的说明启用 ironSource Ads 测试广告。
Step 2: Set up ironSource Ads demand in AdMob UI
为广告单元配置中介设置
Add ironSource Mobile to GDPR and US state regulations ad partners list
按照 GDPR 设置 和 美国州级法规设置 中的步骤,将 ironSource Mobile 添加到 AdMob 界面中的 GDPR 和美国州级法规广告合作伙伴列表中。
Step 3: Import the ironSource Ads SDK and adapter
通过 pub.dev 进行集成
(仅限 Android)将以下代码库添加到 build.gradle
文件中
项目的 android
目录:
repositories {
google()
mavenCentral()
maven {
url = uri("https://android-sdk.is.com/")
}
}
将以下依赖项与最新版本的
IronSource
软件包的
pubspec.yaml
文件:
dependencies:
gma_mediation_ironsource: ^1.0.0
手动集成
下载针对以下指标的最新版 Google 移动广告中介插件:
IronSource
,
将下载的文件解压缩,然后添加提取的插件文件夹
(及其内容)添加到您的 Flutter 项目中。然后,在
pubspec.yaml
文件,通过添加以下依赖项:
dependencies:
gma_mediation_ironsource:
path: path/to/local/package
Step 4: Implement privacy settings on ironSource Ads SDK
EU Consent and GDPR
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 Google Mobile Ads mediation plugin for ironSource Ads
includes the
GmaMediationIronsource().SetConsent()
method. The following sample code shows how to pass
consent information to the ironSource Ads SDK. If you choose to call this
method, it is recommended that you do so prior to requesting ads through the
Google Mobile Ads SDK.
import 'package:gma_mediation_ironsource/gma_mediation_ironsource.dart';
// ...
GmaMediationIronsource().setConsent(true);
See ironSource Ads's documentation on Regulation Advanced Settings for more details.
US state privacy laws
U.S. states privacy laws 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 via a prominent "Do Not Sell My Personal Information" link on the "selling" party's homepage. The U.S. states privacy laws compliance guide offers the ability to enable restricted data processing 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 the Google Mobile Ads
SDK
to ensure they get forwarded properly to the ironSource Ads SDK.
import 'package:gma_mediation_ironsource/gma_mediation_ironsource.dart';
// ...
GmaMediationIronsource().setDoNotSell(true);
See ironSource Ads's documentation on Regulation Advanced Settings for both Android and iOS 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, IronSource Ads requires additional ProGuard rules for your project.
Consult
IronSource Ads's Android SDK Integration guide
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
@Override
public void onResume() {
super.onResume();
IronSource.onResume(this);
}
@Override
public void onPause() {
super.onPause();
IronSource.onPause(this);
}
Kotlin
public override fun onResume() {
super.onResume()
IronSource.onResume(this)
}
public override fun onPause() {
super.onPause()
IronSource.onPause(this)
}
iOS
SKAdNetwork integration
Follow ironSource Ads's documentation to add the SKAdNetwork identifiers to your
project's Info.plist
file.
Step 6: Test your implementation
启用测试广告
请务必为AdMob 注册您的测试设备,并在 IronSource 界面中启用测试模式。
验证测试广告
如需验证您收到的是来自 IronSource 的测试广告,请使用相应广告来源在广告检查器中启用单一广告来源测试。 ironSource Ads (Waterfall)
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
under the
following classes:
Android
com.google.ads.mediation.ironsource.IronSourceAdapter
com.google.ads.mediation.ironsource.IronSourceRewardedAdapter
iOS
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 AdMob 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. |
501-1056 | ironSource Ads SDK Errors. See documentation for more details. |
iOS
Error code | Reason |
---|---|
101 | ironSource Ads server parameters configured in the AdMob 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. |
508-1037 | ironSource Ads SDK Errors. See documentation for more details. |
ironSource Flutter Mediation Adapter Changelog
1.0.0
- Initial release.
- Verified compatibility with ironSource Android adapter version 8.0.0.0
- Verified compatibility with ironSource iOS adapter version 8.0.0.0.0
- Built and tested with the Google Mobile Ads Flutter Plugin version 5.1.0.