This guide shows you how to use Google Mobile Ads Unity Plugin to load and display ads from BidMachine using AdMob Mediation, covering bidding integrations. It covers how to add BidMachine to an ad unit's mediation configuration and how to integrate the BidMachine SDK and adapter into a Unity app.
Supported integrations and ad formats
The AdMob mediation adapter for BidMachine has the following capabilities:
| Integration | |
|---|---|
| Bidding | 1 |
| Waterfall | |
| Formats | |
| App Open | |
| Banner | |
| Interstitial | |
| Rewarded | |
| Rewarded Interstitial | |
1 Bidding integration is in closed beta, reach out to your account manager to request access.
2 Native ad format is in alpha. All other supported ad formats are in beta. Reach out to your account manager to request access.
Requirements
- Latest Google Mobile Ads Unity Plugin
- Unity 2019.4 or higher
- To deploy on Android
- Android API level 23 or higher
- To deploy on iOS
- iOS deployment target of 13.0 or higher
- A working Unity project configured with Google Mobile Ads Unity Plugin. See Get Started for details.
- Complete the mediation Get started guide
Step 1: Set up configurations in BidMachine UI
Log in to your BidMachine account dashboard.
Create new placements
Navigate to the Source tab and under the Sources table, select the Edit button.
You will be shown a list of all the placements you have. To create a new placement, click the Add Placement button on the dialog.
Fill out the form and click Save.
Android
iOS
Finally, take note of the Placement ID.
Android
iOS
Update your app-ads.txt
Authorized Sellers for Apps app-ads.txt 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,
set up an app-ads.txt file for your app.
To implement app-ads.txt for BidMachine, navigate to the app-ads.txt
tab from the Dashboard. Then, copy the list and
append it to your website's app-ads.txt file.
Step 2: Set up BidMachine demand in AdMob UI
Configure mediation settings for your ad unit
Android
For instructions, see step 2 in the guide for Android.
iOS
For instructions, see step 2 in the guide for iOS.
Add BidMachine to GDPR and US state regulations ad partners list
Follow the steps in European regulations settings and US state regulations settings to add BidMachine to the European and US state regulations ad partners list in the AdMob UI.
Step 3: Import the BidMachine SDK and adapter
OpenUPM-CLI
If you have OpenUPM-CLI installed, you can install the Google Mobile Ads BidMachine Mediation Plugin for Unity to your project by running the following command from your project's root directory:
openupm add com.google.ads.mobile.mediation.bidmachineOpenUPM
In your Unity project editor, select Edit > Project Settings > Package Manager to open the Unity Package Manager Settings.
Under the Scoped Registries tab, add OpenUPM as a scoped registry with the following details:
- Name:
OpenUPM - URL:
https://package.openupm.com - Scope(s):
com.google
Then, navigate to Window > Package Manager to open the Unity Package Manager and select My Registries from the drop-down menu.
Select the Google Mobile Ads BidMachine Mediation package and click Install.
Unity Package
Download the latest version of Google Mobile Ads mediation plugin for
BidMachine from the download link in
the
Changelog
and extract the
GoogleMobileAdsBidMachineMediation.unitypackage from the zip
file.
In your Unity project editor, select Assets > Import Package >
Custom Package and find the
GoogleMobileAdsBidMachineMediation.unitypackage
file you downloaded. Make sure that all the files are selected and click
Import.
Then, select Assets > External Dependency Manager >
Android Resolver > Force Resolve. The External Dependency Manager
library will perform dependency resolution from scratch and copy the
declared dependencies into the Assets/Plugins/Android directory of your
Unity app.
Step 4: Implement privacy settings on BidMachine SDK
EU Consent and GDPR
To comply with Google EU User Consent Policy, 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 consent is propagated to each ad source in your mediation chain. Google is unable to pass the user's consent choice to such networks automatically.
BidMachine automatically reads GDPR consent set by consent management platforms including the UMP SDK. For more information, see BidMachine's GDPR guide for Android and iOS.
US states privacy laws
US 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 through a prominent "Do Not Sell My Personal Information" link on the "selling" party's homepage. The US 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.
BidMachine automatically reads GPP consent set by consent management platforms including the UMP SDK. For more information, see BidMachine's GPP guide for Android and iOS.
Step 5: Add required code
Android
No additional code required for BidMachine integration.
iOS
SKAdNetwork integration
Follow BidMachine's documentation on
SKAdNetwork Support
to add the SKAdNetwork identifiers to your project's Info.plist file.
Step 6: Test your implementation
Enable test ads
Make sure you register your test device for AdMob.
Follow the instructions in BidMachine's documentation for Android and iOS in order to enable test mode for BidMachine.
Verify test ads
To verify that you are receiving test ads from BidMachine, enable single ad source testing in ad inspector using the BidMachine (Bidding) ad source(s).
Error codes
If the adapter fails to receive an ad from BidMachine, publishers can check
the underlying error from the ad response using
ResponseInfo under the
following classes:
Android
io.bidmachine
com.google.ads.mediation.bidmachine
iOS
GADMediationAdapterBidMachine
Here are the codes and accompanying messages thrown by the BidMachine adapter when an ad fails to load:
Android
| Error code | Domain | Reason |
|---|---|---|
| 100 | com.google.ads.mediation.bidmachine | Invalid or empty placement ID received. |
| 101 | com.google.ads.mediation.bidmachine | Error during signal collection: No Signal Data Configuration found. |
| 102 | com.google.ads.mediation.bidmachine | Invalid ad format received during signal collection. |
| 103 | com.google.ads.mediation.bidmachine | Requested ad size couldn't be mapped to bidmachine.BannerSize |
| 104 | com.google.ads.mediation.bidmachine | Loaded BidMachine ad request has expired. |
| 105 | com.google.ads.mediation.bidmachine | Fullscreen ad couldn't be shown. |
| 106 | com.google.ads.mediation.bidmachine | BidMachine SDK returned an onAdLoaded() callback with null ad data. |
iOS
| Error code | Domain | Reason |
|---|---|---|
| 101 | com.google.mediation.bidmachine | Server configuration missing a required publisher ID. |
| 102 | com.google.mediation.bidmachine | The bidding signal collection request failed because the RTB parameters don't contains ad format or specified format is not supported. |
| 103 | com.google.mediation.bidmachine | Invalid ad configuration for loading an ad. |
| 104 | com.google.mediation.bidmachine | BidMachine SDK returned non-banner ad to the banner ad's BidMachineAdProtocol didLoadAd delegate method. Should never happen. |
| 105 | com.google.mediation.bidmachine | Fullscreen ad is not ready for presentation. |
| 106 | com.google.mediation.bidmachine | Bid Machine SDK returned non-native ad to the native ad's BidMachineAdProtocol didLoadAd delegate method. Should never happen. |
| 107 | com.google.mediation.bidmachine | Failed to load one of the native ad image sources. |
BidMachine Unity Mediation Plugin Changelog
Version 1.0.1
- Initial Release!
- Supports BidMachine Android adapter version 3.5.1.1.
- Supports BidMAchine iOS adapter version 3.5.1.0.
- Built and tested with the Google Mobile Ads Unity Plugin version 10.7.0.
Version 1.0.0
- Initial Release!
- Supports BidMachine Android adapter version 3.5.1.0.
- Supports BidMAchine iOS adapter version 3.5.1.0.
- Built and tested with the Google Mobile Ads Unity Plugin version 10.6.0.