This guide shows you how to use Google Mobile Ads SDK (Legacy) to load and display ads from BidMachine using [mediation](https://developers.google.com/ad-manager/mobile-ads-sdk/android/mediation.md.txt), 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 | Yes | | Waterfall | Yes [^1^](https://developers.google.com/ad-manager/mobile-ads-sdk/android/mediation/bidmachine.md.txt#waterfall-footnote) | | App open | | | Banner | Yes | | Interstitial | Yes | | Rewarded | Yes | | Rewarded Interstitial | | | Native | Yes | ^1^ Waterfall integration is in closed beta, reach out to your account manager to request access. ## Prerequisites Before you continue, verify the following: - Android API level 24 or later. - \[For bidding\]: To integrate all supported ad formats in bidding, use BidMachine adapter `3.4.0.1` or later ([latest version recommended](https://developers.google.com/ad-manager/mobile-ads-sdk/android/mediation/bidmachine.md.txt#bidmachine-android-mediation-adapter-changelog)). - Latest Google Mobile Ads SDK (Legacy) version. - [Set up mediation](https://developers.google.com/ad-manager/mobile-ads-sdk/android/mediation.md.txt). ## Step 1: Set up configurations in BidMachine UI [Log in](https://dashboard.bidmachine.io/) to your BidMachine account dashboard. ### Create new placements Navigate to the **Source** tab and under the **Sources** table, select the **Edit** button. > [!NOTE] > **Note:** BidMachine automatically creates a **Source** for you. If you want to create a new **Source**, please reach out to your account manager.  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.  Select **Bidding** as the **Placement Type** . 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](https://iabtechlab.com/wp-content/uploads/2019/03/app-ads.txt-v1.0-final-.pdf) 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, [create an app-ads.txt file for Ad Manager](https://support.google.com/admanager/answer/7544382). To implement `app-ads.txt` for BidMachine, navigate to the **app-ads.txt** tab from the [Dashboard](https://dashboard.bidmachine.io/). Then, copy the list and append it to your website's `app-ads.txt` file. ## Step 2: Set up BidMachine demand in Ad Manager UI Sign in to your [Ad Manager account](https://admanager.google.com/home/). ### Add BidMachine in Companies ### Bidding This step isn't required for bidding integrations. ### Waterfall Navigate to **Admin** \> **Companies** , then click the **New company** button in the **All companies** tab. Select **Ad network**.  Select **BidMachine** as the **Ad network** , enter a unique **Name** and enable **Mediation**. You don't need to enter a **Username** or **Password** . Click **Save** when done.  ### Enable secure signal sharing ### Bidding Navigate to **Admin** \> **Global settings** . Go to the **Ad Exchange account settings** tab and review and turn on **Secure signal sharing** . Click **Save**.  ### Waterfall This step isn't required for waterfall integrations. ### Share secure signal on bid requests ### Bidding Navigate to **Inventory** \> **Secure Signals** . Under **Secure signals** , search for BidMachine and turn on **Enable app integration**.  Click **Save**. ### Waterfall This step isn't required for waterfall integrations. ### Allow secure signal sharing for SDK Bidding ### Bidding Navigate to **Delivery** \> **Demand channel settings** . In the **Default settings** tab, turn on **Allow secure signal sharing** for **SDK Bidding**.  Click **Save**. ### Waterfall This step isn't required for waterfall integrations. ### Configure BidMachine bidding ### Bidding Navigate to **Delivery** \> **Bidders** , and click **Go to SDK Bidding**.  Click **New bidder**.  Select **BidMachine** as the bidder.  Click **Continue** to enable SDK Bidding for this bidder.  Click **Done**. ### Waterfall This step isn't required for waterfall integrations. ### Configure ad unit mapping ### Bidding Navigate to **Delivery** \> **Bidders** , and click **Go to SDK Bidding**.  Select the company for BidMachine.  Go to the **Ad unit mapping** tab and click **New ad unit mapping**.  Choose **Specific ad unit** . Select an ad unit and format, **Mobile app** as the **Inventory type** , and your **Mobile application** . Then, enter **Source ID** and **Placement ID** obtained in the previous section. Finally, click **Save**. > [!IMPORTANT] > **Important:** Target the selected ad unit by at least one yield group, and the **Source ID** must be associated with the targeted app as in the BidMachine UI.  ### Waterfall Navigate to **Delivery** \> **Yield groups** and click the **New yield group** button. Select your **Inventory** and **App**.  Scroll to **Yield partners** and click **Add mediation partner**.  Select the company you created for BidMachine in the previous section. Choose **Mobile SDK mediation** as the **Integration type** , **Android** as the **Platform** , and **Active** as the **Status**. Enter the **Placement ID** obtained in the previous section, and the **Default CPM** value. Click **Save**. > [!IMPORTANT] > **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] > **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](https://support.google.com/admob/answer/2784628) for details. Follow the steps in [European regulations settings](https://support.google.com/admanager/answer/10113006#adding_ad_partners_to_published_gdpr_messages) and [US state regulations settings](https://support.google.com/admanager/answer/14117973) to add **BidMachine** to the European and US state regulations ad partners list in the Ad Manager UI. ## Step 3: Import the BidMachine SDK and adapter > [!NOTE] > **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 project-level `settings.gradle` (or `settings.gradle.kts`) file, add the following repositories: ```kotlin dependencyResolutionManagement { repositories { google() mavenCentral() maven { url = uri("https://artifactory.bidmachine.io/bidmachine") } } } ``` In your app-level gradle file, add the following implementation dependencies: ### Kotlin ```kotlin dependencies { implementation("com.google.android.gms:play-services-ads:25.5.0") implementation("com.google.ads.mediation:bidmachine:3.8.0.1") } ``` ### Groovy ```groovy dependencies { implementation 'com.google.android.gms:play-services-ads:25.5.0' implementation 'com.google.ads.mediation:bidmachine:3.8.0.1' } ``` ## Step 4: Implement privacy settings on BidMachine SDK To [comply with the Google EU User Consent Policy](https://www.google.com/about/company/consentstaging.html), 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 that consent is propagated to each ad source in your mediation chain. BidMachine Android adapter version 3.3.0.0 and later supports passing GDPR consent signals from consent management platforms that integrate with IAB's Transparency and Consent Framework (TCF) to BidMachine SDK. For more information, see [GDPR](https://developers.bidmachine.io/sdk/general/android/privacy#gdpr). ### US states privacy laws [US states privacy laws](https://support.google.com/admanager/answer/9561023) 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](https://developers.google.com/ad-manager/mobile-ads-sdk/android/privacy/us-states) offers the ability to enable [restricted data processing](https://privacy.google.com/businesses/rdp/) 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](https://developers.google.com/ad-manager/mobile-ads-sdk/android/privacy.md.txt). For more information, see [GPP](https://developers.bidmachine.io/sdk/general/android/privacy#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](https://developers.google.com/ad-manager/mobile-ads-sdk/android/test-ads.md.txt#enable_test_devices) for Ad Manager. Follow the instructions in BidMachine's documentation for [Android](https://developers.bidmachine.io/sdk/general/android/advanced#test-mode) in order to enable test mode for BidMachine. > [!IMPORTANT] > **Important:** Disable test mode for Ad Manager and BidMachine before releasing your app. ### Verify test ads To verify that you are receiving test ads from BidMachine, enable [single ad source testing](https://developers.google.com/ad-manager/mobile-ads-sdk/android/ad-inspector.md.txt#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](https://support.google.com/admanager/answer/6075370) for a [`NativeAd`](https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/nativead/NativeAd.md.txt). | Field | Assets always included by BidMachine adapter | |---|---| | Headline | Yes | | Image | Yes | | Body | Yes | | Icon | Yes | | Call to action | Yes | | Star rating | Yes | | 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()`](https://developers.google.com/ad-manager/mobile-ads-sdk/android/reference/com/google/android/gms/ads/ResponseInfo.md.txt#getAdapterResponses()) under the following classes: ```java 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. | | 107 | com.google.ads.mediation.bidmachine | Source ID is missing or empty. | ## BidMachine Android Mediation Adapter Changelog #### Next Version - Updated the adapter to use the `InitializationCompleteCallback.onInitializationFailed(AdError)` API. - Updated the minimum required Android API level to 24. #### Version 3.8.0.1 - Pin the adapter's Kotlin dependency to 1.9.0 (the min Kotlin version supported by GMA NextGen SDK). Built and tested with: - Google Mobile Ads SDK version 25.4.0. - Google Mobile Ads Next-Gen SDK version 1.4.0. - BidMachine SDK version 3.8.0. #### Version 3.8.0.0 - Verified compatibility with BidMachine SDK version 3.8.0. Built and tested with: - Google Mobile Ads SDK version 25.4.0. - Google Mobile Ads Next-Gen SDK version 1.4.0. - BidMachine SDK version 3.8.0. #### Version 3.7.1.1 - Maps `AgeRestrictedTreatment` to BidMachine's COPPA API. Built and tested with: - Google Mobile Ads SDK version 25.4.0. - Google Mobile Ads Next-Gen SDK version 1.2.1. - BidMachine SDK version 3.7.1. #### Version 3.7.0.0 - Verified compatibility with BidMachine SDK version 3.7.0. Built and tested with: - Google Mobile Ads SDK version 25.1.0. - Google Mobile Ads Next-Gen SDK version 1.1.0. - BidMachine SDK version 3.7.0. #### Version 3.6.1.0 - Added property to build the adapter with GMA Next-Gen SDK dependency. - Verified compatibility with BidMachine SDK version 3.6.1. Built and tested with: - Google Mobile Ads SDK version 25.1.0. - BidMachine SDK version 3.6.1. #### Version 3.5.1.2 - Updated BidMachine Adapter to use AdPlacementConfig. Built and tested with: - Google Mobile Ads SDK version 24.9.0. - BidMachine SDK version 3.5.1. #### 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.