This guide shows you how to use the Google Mobile Ads SDK to load and display ads from Unity Ads using AdMob 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 iOS app.
Supported integrations and ad formats
The mediation adapter for Unity Ads has the following capabilities:
Integration | |
---|---|
Bidding | 1 |
Waterfall | |
Formats | |
Banner | |
Interstitial | |
Rewarded | |
Native |
Requirements
- iOS deployment target of 12.0 or higher
Latest Google Mobile Ads SDK
Complete the mediation Get started guide
Step 1: Set up configurations in Unity Ads UI
Zarejestruj się lub zaloguj w Unity Ads.
Tworzenie projektu
W panelu reklam Unity otwórz Projects (Projekty) i kliknij Create Project (Utwórz projekt).
Wypełnij formularz i kliknij Create Project (Utwórz projekt), aby dodać projekt.
Otwórz Zarabianie > Rozpocznij, a potem kliknij Rozpocznij.
W oknie Konfiguracja projektu wybierz Chcę korzystać z zapośredniczenia i Google AdMob w polu Partner zapośredniczenia, a potem kliknij Dalej.
Wybierz ustawienia reklam i kliknij Dalej.
Wypełnij formularz i kliknij Add Project (Dodaj projekt).
Zanotuj identyfikator gry.
Utwórz jednostkę reklamową
Otwórz Zarabianie > Jednostki reklamowe, a następnie kliknij Dodaj jednostkę reklamową.
Wpisz nazwę jednostki reklamowej, a potem wybierz opcje Platforma i Format reklamy.
Na koniec kliknij Utwórz, aby zapisać jednostkę reklamową.
Dodaj miejsce docelowe
Ustalanie stawek
Aby utworzyć miejsca docelowe z ustalaniem stawek, skontaktuj się z menedżerem konta Unity Ads.
Wodospad
Po utworzeniu projektu kliknij Generowanie przychodu > Miejsca docelowe. Aby utworzyć nowe miejsce docelowe, kliknij Dodaj miejsce docelowe obok jednostki reklamowej.
Podaj niezbędne informacje i kliknij Dodaj miejsce docelowe.
Zanotuj identyfikator miejsca docelowego.
Znajdź klucz interfejsu Unity Ads Reporting API
Ustalanie stawek
Nie musisz tego robić w przypadku integracji z określaniem stawek.
Wodospad
Oprócz identyfikatora gry i identyfikatora miejsca docelowego do skonfigurowaniaAdMob identyfikatora jednostki reklamowej będą też potrzebne klucz interfejsu API Unity Ads i główny identyfikator organizacji.
Kliknij Zarabianie > Konfiguracja > Zarządzanie interfejsem API i zanotuj klucz dostępu do interfejsu Monetization Stats API.
Następnie otwórz Zarabianie > Ustawienia organizacji i zanotuj podstawowy identyfikator organizacji.
Włącz tryb testowy
Tryb testowy możesz włączyć w panelu Unity Ads. W ustawieniach projektu kliknij kartę Testowanie.
Aby wymusić tryb testowy w swojej aplikacji, kliknij przycisk edycji obok: Apple App Store , zaznacz Zastąp tryb testowy klienta i wybierz Wymuś włączenie trybu testowego (czyli używaj reklam testowych) na wszystkich urządzeniach.
Możesz też włączyć tryb testowy na konkretnych urządzeniach, klikając przycisk Dodaj urządzenie testowe.
Wypełnij formularz i kliknij Zapisz.
Step 2: Set up Unity Ads demand in AdMob UI
Konfigurowanie ustawień zapośredniczenia dla jednostki reklamowej
Musisz dodać Unity Ads do konfiguracji zapośredniczenia jednostki reklamowej.
Najpierw zaloguj się na swoje konto AdMob. Następnie otwórz kartę Zapośredniczenie. Jeśli masz istniejącą grupę zapośredniczenia, którą chcesz zmodyfikować, kliknij jej nazwę, aby ją edytować, i przejdź od razu do sekcji Dodawanie Unity Ads jako źródła reklam.
Aby utworzyć nową grupę zapośredniczenia, wybierz Utwórz grupę zapośredniczenia.
Podaj format reklamy i platformę, a następnie kliknij Dalej.
Nazwij grupę zapośredniczenia i wybierz lokalizacje, na które chcesz kierować reklamy. Następnie ustaw stan grupy zapośredniczenia na Włączona i kliknij Dodaj jednostki reklamowe.
Powiąż tę grupę zapośredniczenia z co najmniej jedną istniejącą jednostką reklamowąAdMob . Następnie kliknij Gotowe.
Na karcie jednostek reklamowych powinny się pojawić wybrane przez Ciebie jednostki reklamowe:
Dodaj Unity Ads jako źródło reklam
Ustalanie stawek
Na karcie Określanie stawek w sekcji Źródła reklam kliknij Dodaj źródło reklam. Następnie kliknij Unity Ads.
Kliknij Jak podpisać umowę partnerską i zawrzeć umowę partnerską z firmąUnity Ads.
Kliknij Potwierdzam i akceptuję, a następnie kliknij Dalej.
Jeśli masz już mapowanie Unity Ads, możesz je wybrać. W przeciwnym razie kliknij Dodaj mapowanie.
Następnie wpisz dane Game ID and Placement IDotrzymane w poprzedniej sekcji. Następnie kliknij Gotowe.
Ważne: Game ID musi być powiązany z aplikacją docelową, tak jak w interfejsieUnity Ads .Wodospad
Na karcie Kaskada w sekcji Źródła reklam kliknij Dodaj źródło reklamy. Następnie kliknij Unity Ads.
Kliknij Unity Ads i włącz przełącznik Optymalizuj. Wpisz API Key and Organization core IDuzyskane w poprzedniej sekcji, aby skonfigurować optymalizację źródła reklam dla:Unity Ads. Następnie wpisz wartość eCPM dlaUnity Ads i kliknij Dalej.Jeśli masz już mapowanie Unity Ads, możesz je wybrać. W przeciwnym razie kliknij Dodaj mapowanie.
Następnie wpisz dane Game ID and Placement IDotrzymane w poprzedniej sekcji. Następnie kliknij Gotowe.
Add Unity Ads to GDPR and US state regulations ad partners list
Wykonaj czynności opisane w sekcji Ustawienia RODO i Ustawienia amerykańskich przepisów stanowych , aby dodać Unity Ads do listy partnerów reklamowych zgodnych z RODO i amerykańskimi przepisami stanowymi w AdMob UI.
Step 3: Import the Unity Ads SDK and adapter
Using CocoaPods (recommended)
Add the following line to your project's Podfile:
pod 'GoogleMobileAdsMediationUnity'
From the command line run:
pod install --repo-update
Manual integration
Download the latest version of the Unity Ads SDK, and link UnityAds.framework in your project.
Download the latest version of the Unity Ads adapter from the download link in the Changelog and link UnityAdapter.framework in 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.
Swift
import UnityAds
// ...
let gdprMetaData = UADSMetaData()
gdprMetaData.set("gdpr.consent", value: true)
gdprMetaData.commit()
Objective-C
#import <UnityAds/UnityAds.h>
// ...
UADSMetaData *gdprMetaData = [[UADSMetaData alloc] init];
[gdprMetaData set:@"gdpr.consent" value:@YES];
[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.
Swift
import UnityAds
// ...
let ccpaMetaData = UADSMetaData()
ccpaMetaData.set("privacy.consent", value: true)
ccpaMetaData.commit()
Objective-C
#import <UnityAds/UnityAds.h>
// ...
UADSMetaData *ccpaMetaData = [[UADSMetaData alloc] init];
[ccpaMetaData set:@"privacy.consent" value:@YES];
[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
SKAdNetwork integration
Follow Unity Ads's documentation
to add the SKAdNetwork identifiers to your project's Info.plist
file.
Compile errors
Swift
No additional code is required for Swift integrations.
Objective-C
For Unity Ads adapter 4.4.0.0 or higher, you must follow the integration steps in the Unity documentation.
Step 6: Test your implementation
Włącz reklamy testowe
Zarejestruj urządzenie testowe na potrzeby AdMob i włącz tryb testowy w Unity Ads interfejsie użytkownika.
Weryfikacja reklam testowych
Aby sprawdzić, czy otrzymujesz reklamy testowe z witrynyUnity Ads, włącz w inspektorze reklam testowanie pojedynczego źródła reklam, korzystając z Unity Ads (Waterfall) źródeł reklam.
Error codes
If the adapter fails to receive an ad from Unity Ads,
publishers can check the underlying error from the ad response using
GADResponseInfo.adNetworkInfoArray
under the following classes:
GADMAdapterUnity
GADMediationAdapterUnity
Here are the codes and accompanying messages thrown by the UnityAds adapter when an ad fails to load:
Error code | Reason |
---|---|
0-9 | UnityAds SDK returned an error. See Unity's documentation for more details. |
101 | UnityAds server parameters configured in the AdMob UI are missing/invalid. |
102 | Device not supported by UnityAds. |
103 | UnityAds finished presenting with error state kUnityAdsFinishStateError. |
104 | The Unity ad object is nil after calling its initializer. |
105 | Failed to show Unity Ads due to ad not ready. |
106 | UnityAds called a placement changed callback with placement state kUnityAdsPlacementStateNoFill. |
107 | UnityAds called a placement changed callback with placement state kUnityAdsPlacementStateDisabled. |
108 | An ad was already loaded for this placement. UnityAds SDK does not support loading multiple ads for the same placement. |
Unity Ads iOS Mediation Adapter Changelog
Version 4.12.1.0
- Verified compatibility with Unity Ads SDK 4.12.1.
Built and tested with:
- Google Mobile Ads SDK version 11.6.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 11.5.0.
- Unity Ads SDK version 4.12.0.
Version 4.11.3.1
- Added bidding support for banner, interstitial and rewarded ad formats.
Built and tested with:
- Google Mobile Ads SDK version 11.5.0.
- Unity Ads SDK version 4.11.3.
Version 4.11.3.0
- Verified compatibility with Unity Ads SDK 4.11.3.
Built and tested with:
- Google Mobile Ads SDK version 11.4.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 11.4.0.
- Unity Ads SDK version 4.11.2.
Version 4.10.0.0
- Verified compatibility with Unity Ads SDK 4.10.0.
Built and tested with:
- Google Mobile Ads SDK version 11.2.0.
- Unity Ads SDK version 4.10.0.
Version 4.9.3.0
- Verified compatibility with Unity Ads SDK 4.9.3.
- Now requires minimum iOS version 12.0.
- Now requires Google Mobile Ads SDK version 11.0 or higher.
- Included
Info.plist
in the frameworks withinUnityAdapter.xcframework
.
Built and tested with:
- Google Mobile Ads SDK version 11.0.1.
- 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 10.13.0.
- Unity Ads SDK version 4.9.2.
Version 4.9.1.0
- Verified compatibility with Unity Ads SDK 4.9.1.
Built and tested with:
- Google Mobile Ads SDK version 10.12.0.
- Unity Ads SDK version 4.9.1.
Version 4.9.0.0
- Removed
GADMAdNetworkAdapter
conformance and dependency from the Unity adapter. - Added report impression method invocation in
unityAdsShowStart
delegate method. - Verified compatibility with Unity Ads SDK 4.9.0.
Built and tested with:
- Google Mobile Ads SDK version 10.12.0.
- Unity Ads SDK version 4.9.0.
Version 4.8.0.0
- Added support for impression events for banner ads.
- Verified compatibility with Unity Ads SDK 4.8.0.
Built and tested with:
- Google Mobile Ads SDK version 10.7.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 10.5.0.
- Unity Ads SDK version 4.7.1.
Version 4.7.0.0
- Verified compatibility with Unity Ads SDK 4.7.0.
- Now requires minimum iOS version 11.0.
- Now requires Google Mobile Ads SDK version 10.4.0 or higher.
Built and tested with:
- Google Mobile Ads SDK version 10.4.0.
- Unity Ads SDK version 4.7.0.
Version 4.6.1.0
- Verified compatibility with Unity Ads SDK 4.6.1.
Built and tested with:
- Google Mobile Ads SDK version 10.2.0.
- Unity Ads SDK version 4.6.1.
Version 4.6.0.0
- Verified compatibility with Unity Ads SDK 4.6.0.
- Added support for forwarding COPPA information to the Unity Ads SDK.
- Removed support for the
armv7
architecture. - Now requires Google Mobile Ads SDK version 10.0.0 or higher.
Built and tested with:
- Google Mobile Ads SDK version 10.2.0.
- Unity Ads SDK version 4.6.0.
Version 4.5.0.0
- Verified compatibility with Unity Ads SDK 4.5.0.
Built and tested with:
- Google Mobile Ads SDK version 9.14.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 9.11.0.
- Unity Ads SDK version 4.4.1.
Version 4.4.0.0
- Updated the adapter to use the
didRewardUser
API. - Now requires Google Mobile Ads SDK version 9.8.0 or higher.
- Verified compatibility with Unity Ads SDK 4.4.0.
Built and tested with:
- Google Mobile Ads SDK version 9.10.0.
- Unity Ads SDK version 4.4.0.
Version 4.3.0.0
- Verified compatibility with Unity Ads SDK 4.3.0.
Built and tested with:
- Google Mobile Ads SDK version 9.8.0.
- Unity Ads SDK version 4.3.0.
Version 4.2.1.0
- Verified compatibility with Unity Ads SDK 4.2.1.
Built and tested with:
- Google Mobile Ads SDK version 9.4.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 9.2.0.
- Unity Ads SDK version 4.1.0.
Version 4.0.1.0
- Verified compatibility with Unity Ads SDK 4.0.1.
Built and tested with:
- Google Mobile Ads SDK version 9.0.0.
- Unity Ads SDK version 4.0.1.
Version 4.0.0.2
- Added support for the arm64 simulator architecture.
Built and tested with:
- Google Mobile Ads SDK version 9.0.0.
- Unity Ads SDK version 4.0.0.
Version 4.0.0.1
- Verified compatibility with Google Mobile Ads SDK version 9.0.0.
- Now requires Google Mobile Ads SDK version 9.0.0 or higher.
Built and tested with:
- Google Mobile Ads SDK version 9.0.0.
- Unity Ads SDK version 4.0.0.
Version 4.0.0.0
- Verified compatibility with Unity Ads SDK 4.0.0.
- Now requires minimum iOS version 10.0.
Built and tested with
- Google Mobile Ads SDK version 8.13.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 8.8.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 8.7.0.
- Unity Ads SDK version 3.7.4.
Version 3.7.2.0
- Verified compatibility with Unity Ads SDK 3.7.2.
- Relaxed dependency to Google Mobile Ads SDK version 8.0.0 or higher.
Built and tested with
- Google Mobile Ads SDK version 8.5.0.
- Unity Ads SDK version 3.7.2.
Version 3.7.1.0
- Verified compatibility with Unity Ads SDK 3.7.1.
- Now requires Google Mobile Ads SDK version 8.4.0 or higher.
Built and tested with
- Google Mobile Ads SDK version 8.4.0.
- Unity Ads SDK version 3.7.1.
Version 3.6.2.0
- Updated the adapter to use the
.xcframework
format. - Verified compatibility with Unity Ads SDK 3.6.2.
- Now requires Google Mobile Ads SDK version 8.2.0 or higher.
Built and tested with
- Google Mobile Ads SDK version 8.2.0.
- Unity Ads SDK version 3.6.2.
Version 3.6.0.0
- Verified compatibility with Unity Ads SDK 3.6.0.
- Now requires Google Mobile Ads SDK version 7.69.0 or higher.
Built and tested with
- Google Mobile Ads SDK version 7.69.0.
- Unity Ads SDK version 3.6.0.
Version 3.5.1.1
- Fixed a crash that sometimes occurred when the Unity Ads SDK finished initializing.
Built and tested with
- Google Mobile Ads SDK version 7.68.0.
- Unity Ads SDK version 3.5.1.
Version 3.5.1.0
- Verified compatibility with Unity Ads SDK 3.5.1.
Built and tested with
- Google Mobile Ads SDK version 7.68.0.
- Unity Ads SDK version 3.5.1.
Version 3.5.0.0
- Verified compatibility with Unity Ads SDK 3.5.0.
- Added support for Adaptive Banner ads.
- Now requires Google Mobile Ads SDK version 7.68.0 or higher.
Built and tested with
- Google Mobile Ads SDK version 7.68.0.
- Unity Ads SDK version 3.5.0.
Version 3.4.8.0
- Verified compatibility with Unity Ads SDK 3.4.8.
- Now requires Google Mobile Ads SDK version 7.63.0 or higher.
Built and tested with
- Google Mobile Ads SDK version 7.63.0.
- Unity Ads SDK version 3.4.8.
Version 3.4.6.0
- Verified compatibility with Unity Ads SDK 3.4.6.
- Now requires Google Mobile Ads SDK version 7.60.0 or higher.
Built and tested with
- Google Mobile Ads SDK version 7.60.0.
- Unity Ads SDK version 3.4.6.
Version 3.4.2.2
- Added standardized adapter error codes and messages.
- Updated the minimum required Google Mobile Ads SDK version to 7.59.0.
Built and tested with
- Google Mobile Ads SDK version 7.59.0.
- 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.
- Removed support for the i386 architecture.
Built and tested with
- Google Mobile Ads SDK version 7.57.0.
- Unity Ads SDK version 3.4.2.
Version 3.4.2.0
- Verified compatibility with Unity Ads SDK 3.4.2.
Built and tested with
- Google Mobile Ads SDK version 7.55.1.
- Unity Ads SDK version 3.4.2.
Version 3.4.0.0
- Verified compatibility with Unity Ads SDK 3.4.0.
- Now supports loading multiple banner ads at once.
Built and tested with
- Google Mobile Ads SDK version 7.53.0.
- Unity Ads SDK version 3.4.0.
Version 3.3.0.0
- Verified compatibility with Unity Ads SDK 3.3.0.
- Now supports loading multiple banner ads at once.
Built and tested with
- Google Mobile Ads SDK version 7.51.0.
- Unity Ads SDK version 3.3.0.
Version 3.2.0.1
- Verified compatibility with Unity Ads SDK 3.2.0.
- Now requires Google Mobile Ads SDK version 7.46.0 or higher.
- Fixed an issue where Unity Banner ads would fail to show when loaded.
- Fixed an issue where the adapter was not properly forwarding the
unityAdsReady
callback.
Version 3.2.0.0
- Release was removed due to a regression on no-fill reporting.
Version 3.1.0.0
- Verified compatibility with Unity Ads SDK 3.1.0.
Version 3.0.3.0
- Verified compatibility with Unity Ads SDK 3.0.3.
- Now requires Google Mobile Ads SDK version 7.42.2 or higher.
- Added support for flexible banner ad sizes.
- Fixed an issue where Unity Banner ads would only successfully load once per session.
Version 3.0.1.0
- Verified compatibility with Unity Ads SDK 3.0.1.
- Fixed a crash that occurred when deallocating rewarded ads.
Version 3.0.0.3
- Updating adapter to use new rewarded API.
- Now requires Google Mobile Ads SDK version 7.41.0 or higher.
Version 3.0.0.2
- Added support for banner ads.
Version 3.0.0.1
- Fixed an issue where the adapter stores the 'placementId' of previous request.
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
- Added
adapterDidCompletePlayingRewardBasedVideoAd:
callback to the adapter.
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.
- Removed the support for 'armv7s' architecture.
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
- Adapter now tracks Unity Ads clicks so the AdMob and the Unity Ads click statistics can match up.
- Apps now get
interstitialWillLeaveApplication:
andrewardBasedVideoAdWillLeaveApplication:
callbacks.
Version 2.0.6.0
- Verified compatibility with Unity Ads SDK 2.0.6.
Version 2.0.5.0
- Verified compatibility with Unity Ads SDK 2.0.5.
Version 2.0.4.0
- Changed the version naming system to [Unity Ads SDK version].[adapter patch version].
- Updated the minimum required Unity Ads SDK to v2.0.4.
- Updated the minimum required Google Mobile Ads SDK to v7.10.1.
Version 1.0.2
- Made the user reward item's key non nil. The reward key will always be an empty or a valid string.
Version 1.0.1
- Fixed bug where the
rewardBasedVideoAdDidOpen:
callback wasn’t getting called.
Version 1.0.0
- Supports interstitial and reward-based video ads.