Integrate BidMachine with mediation

Page Summary

• This guide explains how to integrate BidMachine through AdMob Mediation for Android apps, covering both bidding and waterfall integrations across various ad formats.

• The integration requires Android API level 23+, the latest Google Mobile Ads SDK, and completing the AdMob mediation Get started guide.

• Setup involves configuring placements and updating your app-ads.txt file in the BidMachine UI.

• You must also configure BidMachine as an ad source in your AdMob mediation settings and add them to GDPR and US state regulations ad partners lists.

• The guide provides steps for importing the BidMachine SDK and adapter, implementing privacy settings, testing your implementation, and includes a list of potential error codes.

Select platform: Android (beta) Android iOS Unity Flutter

This guide shows you how to use Google Mobile Ads SDK 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 an Android app.

Supported integrations and ad formats

The mediation adapter for BidMachine has the following capabilities:

Integration
Bidding	^1
Waterfall	^3
Formats
App open
Banner
Interstitial
Rewarded
Rewarded Interstitial
Native	^2

¹ Bidding integration is in closed beta, reach out to your account manager to request access.

² Native ad format is in alpha. All other supported ad formats are in beta. Reach out to your account manager to request access.

³ Waterfall integration is in closed beta, reach out to your account manager to request access.

Requirements

• Android API level 23 or higher

• [For bidding]: To integrate all supported ad formats in bidding, use BidMachine adapter 3.4.0.1 or higher (latest version recommended).

• Latest Google Mobile Ads SDK

• 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.

Note: BidMachine automatically creates a Source for you. If you want to create a new Source, please reach out to your account maanger.

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.

Finally, take note of the Placement ID.

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

You need to add BidMachine to the mediation configuration for your ad unit.

First, sign in to your AdMob account. Next, navigate to the Mediation tab. If you have an existing mediation group you'd like to modify, click the name of that mediation group to edit it, and skip ahead to Add BidMachine as an ad source.

To create a new mediation group, select Create Mediation Group.

Enter your ad format and platform, then click Continue.

Give your mediation group a name, and select locations to target. Next, set the mediation group status to Enabled, and then click Add Ad Units.

Associate this mediation group with one or more of your existing AdMob ad units. Then click Done.

You should now see the ad units card populated with the ad units you selected:

Add BidMachine as an ad source

Bidding

Under the Bidding card in the Ad Sources section, select Add ad source. Then select BidMachine .

Click How to sign a partnership agreement and set up a bidding partnership with BidMachine.



Click Acknowledge & agree, then click Continue.



If you already have a mapping for BidMachine, you can select it. Otherwise, click Add mapping.



Next, enter the Placement ID obtained in the previous section. Then click Done.

Important: The Source ID must be associated with the targeted app as in the BidMachine UI.

Waterfall

Under the Waterfall card in the Ad Sources section, select Add Ad Source.

Select BidMachine. Then enter an eCPM value for BidMachine and click Continue.

Note: You only need to set up ad source optimization once per network.

If you already have a mapping for BidMachine, you can select it. Otherwise, click Add mapping.

Next, enter the Placement ID obtained in the previous section. Then click Done.

Important: The Source ID must be associated with the targeted app as in the BidMachine UI.

Add BidMachine to GDPR and US state regulations ad partners list

Important: Verify that you have Account Management permission to complete the configuration for EU Consent and GDPR, US State regulations, and User Messaging Platform. See Manage user access to your account for details.

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

Note: Failure to integrate the compatible BidMachine SDK and Google Mobile Ads SDK versions might lead to build issues.

Android Studio integration (recommended)

In your app-level gradle file, add the following implementation dependencies:

Kotlin

dependencies {
    implementation("com.google.android.gms:play-services-ads:24.9.0")
    implementation("com.google.ads.mediation:bidmachine:3.5.1.1")
}

Groovy

dependencies {
    implementation 'com.google.android.gms:play-services-ads:24.9.0'
    implementation 'com.google.ads.mediation:bidmachine:3.5.1.1'
}

Step 4: Implement privacy settings on BidMachine SDK

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 GDPR.

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 GPP.

Step 5: Add required code

No additional code needed for BidMachine integration.

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 in order to enable test mode for BidMachine.

Important: Disable test mode for AdMob and BidMachine before releasing your app.

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).

Optional Steps

Native ads

Ad rendering

The BidMachine adapter returns its native ads as NativeAd objects. It populates the following fields for a NativeAd.

Field	Assets always included by BidMachine adapter
Headline
Image
Body
Icon
Call to action
Star rating
Store
Price
Advertiser

Error codes

If the adapter fails to receive an ad from BidMachine, you can check the underlying error from the ad response using ResponseInfo.getAdapterResponses() under the following classes:

io.bidmachine
com.google.ads.mediation.bidmachine

Here are the codes and accompanying messages thrown by the BidMachine adapter when an ad fails to load:

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.

BidMachine Android Mediation Adapter Changelog

Version 3.5.1.1

• Added support for forwarding the tagForUnderAgeOfConsent Google Mobile Ads SDK parameter to the BidMachine SDK.

Built and tested with:

• Google Mobile Ads SDK version 24.9.0.
• BidMachine SDK version 3.5.1.

Version 3.5.1.0

• Verified compatibility with BidMachine SDK version 3.5.1.

Built and tested with:

• Google Mobile Ads SDK version 24.9.0.
• BidMachine SDK version 3.5.1.

Version 3.5.0.0

• Verified compatibility with BidMachine SDK version 3.5.0.

Built and tested with:

• Google Mobile Ads SDK version 24.7.0.
• BidMachine SDK version 3.5.0.

Version 3.4.0.1

• Removed class-level references to Context objects to help with memory leak issues.
• Updated adapter to support banner ad requests that are close in size to its supported formats, instead of requiring an exact size match.

Built and tested with:

• Google Mobile Ads SDK version 24.7.0.
• BidMachine SDK version 3.4.0

Version 3.4.0.0

• Added waterfall support for banner, interstitial, rewarded and native ad formats.
• Adapter now forwards onAdOpened() with onAdImpression() for full-screen ads.
• Verified compatibility with BidMachine SDK version 3.4.0.

Built and tested with:

• Google Mobile Ads SDK version 24.6.0.
• BidMachine SDK version 3.4.0.

Version 3.3.0.0

• Initial release.

Built and tested with:

• Google Mobile Ads SDK version 24.5.0.
• BidMachine SDK version 3.3.0.