This guide shows you how to use the Google Mobile Ads SDK to load and display ads from Unity Ads using mediation, covering waterfall integrations. It covers how to add Unity Ads to an ad unit's mediation configuration, and how to integrate the Unity Ads SDK and adapter into an Android app.
Supported integrations and ad formats
The mediation adapter for Unity Ads has the following capabilities:
Integration | |
---|---|
Bidding | |
Waterfall | |
Formats | |
Banner | |
Interstitial | |
Rewarded | |
Native |
Requirements
- Android API level 21 or higher
Latest Google Mobile Ads SDK
Complete the mediation Get started guide
Step 1: Set up configurations in Unity Ads UI
Unity 広告にお申し込みまたはログインしてください。
プロジェクトを作成する
Unity 広告ダッシュボードの [プロジェクト] をクリックし、[プロジェクトを作成] をクリックします。
フォームに入力し、[プロジェクトを作成] をクリックしてプロジェクトを追加します。
[収益化] >[開始] をクリックし、[開始] をクリックします。
[Project Setup](プロジェクトの設定)モーダルで [I plan to use Mediation](メディエーションを使用する)を選択し、[Google メディエーション パートナーの AdMob を選択し、[次へ] をクリックします。
広告設定を選択し、[次へ] をクリックします。
フォームに入力し、[プロジェクトを追加] をクリックします。
ゲーム ID をメモしておきます。
広告ユニットを作成する
[収益化] >[広告ユニット] で [広告ユニットを追加] をクリックします。
[広告ユニット名] を入力し、[プラットフォーム] と [広告フォーマット] を選択します。
最後に、[作成] をクリックして広告ユニットを保存します。
プレースメントを追加
プロジェクトが作成されたら、[収益化] >プレースメント。宛先 新しいプレースメントを作成するには、広告ユニットに [プレースメントを追加] をクリックします。
必要な情報を入力して [プレースメントを追加] をクリックします。
プレースメント ID をメモします。
Unity Ads Reporting API キーの場所を確認する
単価設定
入札の統合では不要です。
滝
[ゲーム ID] と [プレースメント ID] に加えて、 Unity Ads の API キーと組織コア ID を設定します。 Ad Manager 広告ユニット ID。
[収益化] >設定 >API 管理] に移動し、 Monetization Stats API アクセスキー。
次に、[収益化] >[Organization Settings] に移動し、 Organization Core ID の値です。
テストモードをオンにする
テストモードは Unity 広告ダッシュボード。プロジェクトの [テスト] タブを選択します。
アプリの横にある編集ボタンをクリックすると、強制的にテストモードにできます。 Google Play ストア [Override client test mode] をオンにして、 すべてのデバイスで強制的にテストモードをオン(テスト広告を使用)します。
または、 [Add Test Device] ボタン。
フォームに記入して [保存] をクリックします。
Step 2: Set up Unity Ads demand in Ad Manager UI
広告ユニットのメディエーション設定を行う
アド マネージャー アカウントにログインします。
[配信] > [収益グループ] に移動して、[新しい収益グループ] ボタンをクリックします。
収益グループの一意の名前を入力し、[ステータス] を [有効] に設定して [広告フォーマット] を選択し、[広告枠のタイプ] を [モバイルアプリ] に設定します。[ターゲティング] > [広告枠] で、[広告枠] と [モバイル アプリケーション] でメディエーションを追加する広告ユニットを選択します。
次に、[収益パートナーを追加] ボタンをクリックします。
「Unity Ads」の収益パートナーがすでにある場合は、そのパートナーを選択できます。それ以外の場合は、[新しい収益パートナーを作成] を選択します。
[広告ネットワーク] として Unity Ads を選択し、固有の名前を入力して [メディエーション] を有効にします。
[自動データ収集] をオンにして、前のセクションで取得したAPI Key and Organization core ID を入力します。
[収益パートナー] を選択したら、[統合タイプ] として [モバイル SDK メディエーション]、[プラットフォーム] として [Android]、[ステータス] として [有効] を選択します。前のセクションで取得したGame ID and Placement ID を入力します。[デフォルト CPM] の値を入力します。
完了したら、ページの下部にある [保存] をクリックします。
Add Unity Ads to GDPR and US state regulations ad partners list
GDPR 設定 米国の州規制の設定 の手順に沿って、 Ad Manager UI の GDPR および米国の州規制の広告パートナーのリストに Unity Ads を追加します。
Step 3: Import the Unity Ads SDK and adapter
Android Studio integration (recommended)
In your app-level build.gradle.kts
file, add the following implementation
dependencies and configurations. Use the latest versions of the Unity Ads SDK
and adapter:
dependencies {
implementation("com.google.android.gms:play-services-ads:23.3.0")
implementation("com.unity3d.ads:unity-ads:4.12.1")
implementation("com.google.ads.mediation:unity:4.12.2.0")
}
Manual integration
Download the latest Unity Ads SDK (
unity-ads.aar
) from their GitHub repository and add it to your project.Navigate to the Unity Ads adapter artifacts on Google's Maven Repository. Select the latest version, download the Unity Ads adapter's
.aar
file, and add it to your project.
Step 4: Implement privacy settings on Unity 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.
In SDK version 2.0.0, Unity Ads added an API to support privacy settings. The following sample code shows how to pass this consent information to the Unity Ads SDK. Should you choose to pass consent information to the Unity Ads SDK manually, it is recommended that this code is called prior to requesting ads through the Google Mobile Ads SDK.
Java
import com.unity3d.ads.metadata.MetaData;
// ...
MetaData gdprMetaData = new MetaData(this);
gdprMetaData.set("gdpr.consent", true);
gdprMetaData.commit();
Kotlin
import com.unity3d.ads.metadata.MetaData
// ...
val gdprMetaData = MetaData(this)
gdprMetaData["gdpr.consent"] = true
gdprMetaData.commit()
See Unity Ads' Privacy Consent and data APIs and Complying with GDPR guides for more details and the values that can be provided in each method.
US states 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.
In SDK version 2.0.0, Unity Ads added an API to support privacy settings. The following sample code shows how to pass this consent information to the Unity Ads SDK. Should you choose to pass consent information to the Unity Ads SDK manually, it is recommended that this code is called prior to requesting ads through the Google Mobile Ads SDK.
Java
import com.unity3d.ads.metadata.MetaData;
// ...
MetaData ccpaMetaData = new MetaData(this);
ccpaMetaData.set("privacy.consent", true);
ccpaMetaData.commit();
Kotlin
import com.unity3d.ads.metadata.MetaData
// ...
val ccpaMetaData = MetaData(this)
ccpaMetaData["privacy.consent"] = true
ccpaMetaData.commit()
See Unity Ads' Privacy Consent and data APIs and Complying with CCPA guides for more details and the values that can be provided in each method.
Step 5: Add required code
No additional code is required for Unity Ads integrations.
Step 6: Test your implementation
テスト広告を有効にする
Ad Manager にテストデバイスを登録し、 Unity Ads UI でテストモードを有効にします。
テスト広告を確認する
Unity Adsからテスト広告を受信していることを確認するには、広告インスペクタで Unity Ads (Waterfall) 広告ソースを使用して単独の広告ソースのテストを有効にします。
Error codes
If the adapter fails to receive an ad from Unity Ads,
publishers can check the underlying error from the ad response using
ResponseInfo.getAdapterResponses()
under the following classes:
com.google.ads.mediation.unity.UnityAdapter
com.google.ads.mediation.unity.UnityMediationAdapter
Here are the codes and accompanying messages thrown by the UnityAds adapter when an ad fails to load:
Error code | Reason |
---|---|
0-10 | UnityAds SDK returned an error. See code for more details. |
101 | UnityAds server parameters configured in the Ad Manager UI are missing/invalid. |
102 | UnityAds returned a placement with a NO_FILL state. |
103 | UnityAds returned a placement with a DISABLED state. |
104 | UnityAds tried to show an ad with a null context. |
105 | Context used to initialize, load and/or show ads from Unity Ads is not an Activity instance. |
106 | UnityAds tried to show an ad that's not ready to be shown. |
107 | UnityAds is not supported on the device. |
108 | UnityAds can only load 1 ad per placement at a time. |
109 | UnityAds finished with an ERROR state. |
200-204 | UnityAds Banner specific error. See code for more details. |
Unity Ads Android Mediation Adapter Changelog
Version 4.12.2.0
- Verified compatibility with Unity Ads SDK 4.12.2.
Built and tested with:
- Google Mobile Ads SDK version 23.2.0.
- Unity Ads SDK version 4.12.2.
Version 4.12.1.0
- Verified compatibility with Unity Ads SDK 4.12.1.
Built and tested with:
- Google Mobile Ads SDK version 23.2.0.
- Unity Ads SDK version 4.12.1.
Version 4.12.0.0
- Verified compatibility with Unity Ads SDK 4.12.0.
Built and tested with:
- Google Mobile Ads SDK version 23.1.0.
- Unity Ads SDK version 4.12.0.
Version 4.11.3.0
- Added bidding support for banner, interstitial and rewarded ad formats.
- Verified compatibility with Unity Ads SDK 4.11.3.
Built and tested with:
- Google Mobile Ads SDK version 23.1.0.
- Unity Ads SDK version 4.11.3.
Version 4.11.2.0
- Verified compatibility with Unity Ads SDK 4.11.2.
Built and tested with:
- Google Mobile Ads SDK version 23.0.0.
- Unity Ads SDK version 4.11.2.
Version 4.10.0.0
- Updated the minimum required Google Mobile Ads SDK version to 23.0.0.
- Verified compatibility with Unity Ads SDK 4.10.0.
Built and tested with:
- Google Mobile Ads SDK version 23.0.0.
- Unity Ads SDK version 4.10.0.
Version 4.9.3.0
- Verified compatibility with Unity Ads SDK 4.9.3.
Built and tested with:
- Google Mobile Ads SDK version 22.6.0.
- Unity Ads SDK version 4.9.3.
Version 4.9.2.0
- Verified compatibility with Unity Ads SDK 4.9.2.
Built and tested with:
- Google Mobile Ads SDK version 22.3.0.
- Unity Ads SDK version 4.9.2.
Version 4.9.1.0
- Updated the minimum required Google Mobile Ads SDK version to 22.3.0.
- Verified compatibility with Unity Ads SDK 4.9.1.
Built and tested with:
- Google Mobile Ads SDK version 22.3.0.
- Unity Ads SDK version 4.9.1.
Version 4.8.0.0
- Reports ad impression when Unity Ads SDK invokes its new onBannerShown() callback method.
- Verified compatibility with Unity Ads SDK 4.8.0.
Built and tested with:
- Google Mobile Ads SDK version 22.2.0.
- Unity Ads SDK version 4.8.0.
Version 4.7.1.0
- Verified compatibility with Unity Ads SDK 4.7.1.
Built and tested with:
- Google Mobile Ads SDK version 22.1.0.
- Unity Ads SDK version 4.7.1.
Version 4.7.0.0
- Verified compatibility with Unity Ads SDK 4.7.0.
Built and tested with:
- Google Mobile Ads SDK version 22.0.0.
- Unity Ads SDK version 4.7.0.
Version 4.6.1.1
- Updated adapter to use new
VersionInfo
class. - Updated the minimum required Google Mobile Ads SDK version to 22.0.0.
Built and tested with:
- Google Mobile Ads SDK version 22.0.0.
- Unity Ads SDK version 4.6.1.
Version 4.6.1.0
- Verified compatibility with Unity Ads SDK 4.6.1.
Built and tested with:
- Google Mobile Ads SDK version 21.5.0
- Unity Ads SDK version 4.6.1.
Version 4.6.0.0
- Added support for forwarding COPPA information to the Unity Ads SDK.
- Verified compatibility with Unity Ads SDK 4.6.0.
- Updated the minimum required Google Mobile Ads SDK version to 21.5.0.
Built and tested with:
- Google Mobile Ads SDK version 21.5.0
- Unity Ads SDK version 4.6.0.
Version 4.5.0.0
- Verified compatibility with Unity Ads SDK 4.5.0.
- Updated the minimum required Google Mobile Ads SDK version to 21.4.0.
Built and tested with:
- Google Mobile Ads SDK version 21.4.0
- Unity Ads SDK version 4.5.0.
Version 4.4.1.0
- Verified compatibility with Unity Ads SDK 4.4.1.
Built and tested with:
- Google Mobile Ads SDK version 21.2.0
- Unity Ads SDK version 4.4.1.
Version 4.4.0.0
- Verified compatibility with Unity Ads SDK 4.4.0.
- Updated the minimum required Google Mobile Ads SDK version to 21.2.0.
Built and tested with:
- Google Mobile Ads SDK version 21.2.0
- Unity Ads SDK version 4.4.0.
Version 4.3.0.0
- Verified compatibility with Unity Ads SDK 4.3.0.
- The
onAdOpened()
callback is now forwarded when interstitial and rewarded ads start playing.
Built and tested with:
- Google Mobile Ads SDK version 21.1.0
- Unity Ads SDK version 4.3.0.
Version 4.2.1.1
- Updated
compileSdkVersion
andtargetSdkVersion
to API 31. - Updated the minimum required Google Mobile Ads SDK version to 21.0.0.
Built and tested with:
- Google Mobile Ads SDK version 21.0.0.
- Unity Ads SDK version 4.2.1.
Version 4.2.1.0
- Verified compatibility with Unity Ads SDK 4.2.1.
Built and tested with:
- Google Mobile Ads SDK version 20.6.0.
- Unity Ads SDK version 4.2.1.
Version 4.1.0.0
- Verified compatibility with Unity Ads SDK 4.1.0.
Built and tested with:
- Google Mobile Ads SDK version 20.6.0.
- Unity Ads SDK version 4.1.0.
Version 4.0.1.0
- Verified compatibility with Unity Ads SDK 4.0.1.
- Updated the minimum required Google Mobile Ads SDK version to 20.6.0.
Built and tested with:
- Google Mobile Ads SDK version 20.6.0.
- Unity Ads SDK version 4.0.1.
Version 4.0.0.0
- Verified compatibility with Unity Ads SDK 4.0.0.
- Updated the minimum required Google Mobile Ads SDK version to 20.5.0.
Built and tested with:
- Google Mobile Ads SDK version 20.5.0.
- Unity Ads SDK version 4.0.0.
Version 3.7.5.0
- Verified compatibility with Unity Ads SDK 3.7.5.
Built and tested with:
- Google Mobile Ads SDK version 20.2.0.
- Unity Ads SDK version 3.7.5.
Version 3.7.4.0
- Verified compatibility with Unity Ads SDK 3.7.4.
Built and tested with:
- Google Mobile Ads SDK version 20.2.0.
- Unity Ads SDK version 3.7.4.
Version 3.7.2.0
- Verified compatibility with Unity Ads SDK 3.7.2.
- Updated the minimum required Google Mobile Ads SDK version to 20.2.0.
Built and tested with:
- Google Mobile Ads SDK version 20.2.0.
- Unity Ads SDK version 3.7.2.
Version 3.7.1.0
- Verified compatibility with Unity Ads SDK 3.7.1.
- Updated the minimum required Google Mobile Ads SDK version to 20.1.0.
Built and tested with:
- Google Mobile Ads SDK version 20.1.0.
- Unity Ads SDK version 3.7.1.
Version 3.6.2.0
- Verified compatibility with Unity Ads SDK 3.6.2.
- Fixed an issue where rewarded ads were not forwarding click callbacks.
- The UnityAds SDK has been removed from the bundled adapter build. Publishers are now required to manually include the UnityAds SDK as an additional dependency.
- Updated the minimum required Google Mobile Ads SDK version to 19.8.0.
Built and tested with:
- Google Mobile Ads SDK version 19.8.0.
- Unity Ads SDK version 3.6.2.
Version 3.6.0.0
- Verified compatibility with Unity Ads SDK 3.6.0.
- Updated the minimum required Google Mobile Ads SDK version to 19.6.0.
Built and tested with:
- Google Mobile Ads SDK version 19.6.0.
- Unity Ads SDK version 3.6.0.
Version 3.5.1.1
- Fixed an issue where when trying to request for multiple interstitial and rewarded ads.
Built and tested with:
- Google Mobile Ads SDK version 19.5.0.
- Unity Ads SDK version 3.5.1.
Version 3.5.1.0
- Verified compatibility with Unity Ads SDK 3.5.1.
- Fixed an issue that causes smart banner ad requests to fail.
Built and tested with:
- Google Mobile Ads SDK version 19.5.0.
- Unity Ads SDK version 3.5.1.
Version 3.5.0.0
- Verified compatibility with Unity Ads SDK 3.5.0.
- Added adaptive banner support.
- Updated the minimum required Google Mobile Ads SDK version to 19.5.0.
Built and tested with:
- Google Mobile Ads SDK version 19.5.0.
- Unity Ads SDK version 3.5.0.
Version 3.4.8.0
- Fixed a
NullPointerException
error that occurs when a banner ad is destroyed. - Updated the minimum required Google Mobile Ads SDK version to 19.3.0.
Built and tested with:
- Google Mobile Ads SDK version 19.3.0.
- Unity Ads SDK version 3.4.8.
Version 3.4.6.1
- Created an adapter build that does not include the Unity Ads SDK bundled in.
This gives publishers an option to use the Unity Ads Services when mediating on
Unity to avoid conflicting dependency issues.
- Publishers may opt to use this by including the
com.google.ads.mediation:unity-adapter-only:x.y.z.p
dependency on their app-levelbuild.gradle
file.
- Publishers may opt to use this by including the
Built and tested with:
- Google Mobile Ads SDK version 19.1.0.
- Unity Ads SDK version 3.4.6.
Version 3.4.6.0
- Verified compatibility with Unity Ads SDK 3.4.6.
- Adapter now forwards the
onAdOpened()
callback when a banner ad is clicked.
Built and tested with:
- Google Mobile Ads SDK version 19.1.0.
- Unity Ads SDK version 3.4.6.
Version 3.4.2.3
- Added descriptive error codes and reasons for adapter load/show failures.
- Updated the minimum required Google Mobile Ads SDK version to 19.1.0.
Built and tested with:
- Google Mobile Ads SDK version 19.1.0.
- Unity Ads SDK version 3.4.2.
Version 3.4.2.2
- Fixed a
ConcurrentModificationException
crash that occurred when Unity Ads returns an error.
Built and tested with:
- Google Mobile Ads SDK version 19.0.1.
- Unity Ads SDK version 3.4.2.
Version 3.4.2.1
- Improved forwarding of Unity's errors to recognize initialization and ad load failures earlier and reduce timeouts.
- Updated the minimum required Google Mobile Ads SDK version to 19.0.1.
Built and tested with:
- Google Mobile Ads SDK version 19.0.1.
- Unity Ads SDK version 3.4.2.
Version 3.4.2.0
- Verified compatibility with Unity Ads SDK 3.4.2.
- Updated the minimum required Google Mobile Ads SDK version to 18.3.0.
Built and tested with:
- Google Mobile Ads SDK version 18.3.0.
- Unity Ads SDK version 3.4.2.
Version 3.4.0.0
- Verified compatibility with Unity Ads SDK 3.4.0.
- Updated the minimum required Google Mobile Ads SDK version to 18.3.0.
Built and tested with:
- Google Mobile Ads SDK version 18.3.0.
- Unity Ads SDK version 3.4.0.
Version 3.3.0.0
- Verified compatibility with Unity Ads SDK 3.3.0.
Built and tested with:
- Google Mobile Ads SDK version 18.2.0.
- Unity Ads SDK version 3.3.0.
Version 3.2.0.1
- Fixed a null pointer exception crash that occurred when calling
loadAd()
before callingUnityAds.initialize()
. - Updated the minimum required Google Mobile Ads SDK version to 18.2.0.
Version 3.2.0.0
- Fixed an issue that caused Banner Ad requests to fail.
- Verified compatibility with Unity Ads SDK 3.2.0.
- Migrated the adapter to AndroidX.
- Updated the minimum required Google Mobile Ads SDK version to 18.1.1.
Version 3.1.0.0
- Added support for flexible banner ad sizes.
- Adapter fails the ad request if the requested size isn't compatible with any Unity Ads banner sizes
- Verified compatibility with Unity Ads SDK 3.1.0.
Version 3.0.1.0
- Verified compatibility with Unity Ads SDK 3.0.1.
- Fixed a bug that caused 'NPE' while showing an interstitial ad.
Version 3.0.0.2
- Updated adapter to support new open-beta Rewarded API.
- Updated the minimum required Google Mobile Ads SDK version to 17.2.0.
Version 3.0.0.1
- Added support for Unity Ads Banner.
Version 3.0.0.0
- Verified compatibility with Unity Ads SDK 3.0.0.
Version 2.3.0.0
- Verified compatibility with Unity Ads SDK 2.3.0.
Version 2.2.1.1
- Updated the adapter to invoke the
onRewardedVideoComplete()
ad event.
Version 2.2.1.0
- Verified compatibility with Unity Ads SDK 2.2.1.
Version 2.2.0.0
- Verified compatibility with Unity Ads SDK 2.2.0.
Version 2.1.2.0
- Verified compatibility with Unity Ads SDK 2.1.2.
Version 2.1.1.0
- Verified compatibility with Unity Ads SDK 2.1.1.
Version 2.1.0.0
- Updated the adapter to make it compatible with Unity Ads SDK 2.1.0.
Version 2.0.8.0
- Verified compatibility with Unity Ads SDK 2.0.8.
Version 2.0.7.0
- Using Unity Ads's click reporting (AdMob and Unity Ads click statistics will match up).
- Added onAdLeftApplication callback support.
Version 2.0.6.0
- Verified compatibility with Unity Ads SDK 2.0.6.
Version 2.0.5.0
- The adapters can now be added as a compile dependency by adding the following
to the build.gradle file's dependencies tag:
compile 'com.google.ads.mediation:unity:2.0.5.0'
- Moved to distributing the adapter as an aar instead of a jar file (see README for additional instructions).
Version 2.0.4.0
- Fixed a bug that caused rewarded video ads to fail to load when an interstitial ad was loaded first.
Version 2.0.2.0
- Changed the version naming system to [Unity Ads SDK version].[adapter patch version].
- Updated the minimum required Unity Ads SDK to v2.0.2.
- Updated the minimum required Google Mobile Ads SDK to v9.0.0.
- Apps are no longer required to call UnityAds.changeActivity(this).
Version 1.0.0
- Initial release. Supports reward-based video ads and interstitial ads.