This guide shows you how to use Google Mobile Ads Flutter Plugin to load and display ads from BidMachine using [AdMob Mediation](https://developers.google.com/admob/flutter/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 a Flutter app. ## Supported integrations and ad formats The AdMob mediation adapter for BidMachine has the following capabilities: | Integration || |---|---| | Bidding | Yes | | Waterfall | Yes [^1^](https://developers.google.com/admob/flutter/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: - Latest Google Mobile Ads Flutter Plugin version. - Flutter framework version 3.7.0 or later. - To deploy on Android - Android API level 24 or later. - To deploy on iOS - iOS deployment target of 13.0 or later. - A working Flutter project configured with Google Mobile Ads Flutter Plugin. See [Get Started](https://developers.google.com/admob/flutter/quick-start.md.txt) for details. - [Set up AdMob Mediation](https://developers.google.com/admob/flutter/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**. ### Android  ### iOS  - Finally, take note of the **Placement ID**. ### Android  ### iOS  ### 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, [set up an app-ads.txt file for your app](https://support.google.com/admob/answer/9363762). - 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 AdMob UI ### Configure mediation settings for your ad unit ### Android For instructions, see step 2 in the guide for [Android](https://developers.google.com/admob/android/mediation/bidmachine.md.txt#step-2). ### iOS For instructions, see step 2 in the guide for [iOS](https://developers.google.com/admob/ios/mediation/bidmachine.md.txt#step-2). ### 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/admob/answer/10113004#adding_ad_partners_to_published_gdpr_messages) and [US state regulations settings](https://support.google.com/admob/answer/14125907) 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] > **Note:** Failure to integrate the compatible BidMachine and Google Mobile Ads Flutter Plugin versions might lead to build issues. ### Integration through pub.dev - (Android only) Add the following repositories to the `build.gradle` file inside your project's `android` directory: ```groovy repositories { google() mavenCentral() maven { url = uri("https://artifactory.bidmachine.io/bidmachine") } } ``` - Add the following dependency with the latest versions of the BidMachine SDK and adapter in your package's `pubspec.yaml` file: ```yaml dependencies: gma_mediation_bidmachine: ^1.5.1 ``` ### Manual Integration - Download the latest version of Google Mobile Ads mediation plugin for [BidMachine](https://pub.dev/packages/gma_mediation_bidmachine/versions), extract the downloaded file, and add the extracted plugin folder (and its contents) to your Flutter project. Then, reference the plugin in your `pubspec.yaml` file by adding the following dependency: ```yaml dependencies: gma_mediation_bidmachine: path: path/to/local/package ``` ## Step 4: Implement privacy settings on BidMachine SDK ### EU consent and GDPR - 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 Flutter adapter version 1.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 BidMachine's [Android](https://developers.bidmachine.io/sdk/general/android/privacy#gdpr) and [iOS](https://developers.bidmachine.io/sdk/general/ios/privacy#gdpr) GDPR documentation. ### US states privacy laws - [US states privacy laws](https://support.google.com/admob/answer/9561022) 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/admob/flutter/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/admob/flutter/privacy.md.txt). For more information, see BidMachine's GPP guide for [Android](https://developers.bidmachine.io/sdk/general/android/privacy#gpp) and [iOS](https://developers.bidmachine.io/sdk/general/ios/privacy#gpp). ## Step 5: Add required code ### Android No additional code required for BidMachine integration. ### iOS ### SKAdNetwork integration Follow BidMachine's documentation on [SKAdNetwork Support](https://developers.bidmachine.io/sdk/general/ios/overview#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](https://developers.google.com/admob/flutter/test-ads.md.txt#enable_test_devices) for AdMob. - Follow the instructions in BidMachine's documentation for [Android](https://developers.bidmachine.io/sdk/general/android/advanced#test-mode) and [iOS](https://developers.bidmachine.io/sdk/general/ios/advanced#test-mode) in order to enable test mode for BidMachine. > [!IMPORTANT] > **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](https://developers.google.com/admob/flutter/ad-inspector.md.txt#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`](https://developers.google.com/admob/flutter/response-info.md.txt) under the following classes: ### Android ```java io.bidmachine com.google.ads.mediation.bidmachine ``` ### iOS ```objective-c 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. | | 107 | com.google.ads.mediation.bidmachine | Source ID is missing or empty. | ### 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. | | 108 | com.google.mediation.bidmachine | BidMachine doesn't support this banner ad size. | ## BidMachine Flutter Mediation Adapter Changelog #### Version 1.5.2 (In progress) #### Version 1.5.1 - Supports [BidMachine Android adapter version 3.8.0.1](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/bidmachine/CHANGELOG.md#version-3801). - Supports [BidMachine iOS adapter version 3.8.1.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/BidMachine/CHANGELOG.md#version-3810). - Built and tested with the Google Mobile Ads Flutter Plugin version 9.1.0. #### Version 1.5.0 - Supports [BidMachine Android adapter version 3.8.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/bidmachine/CHANGELOG.md#version-3800). - Supports [BidMachine iOS adapter version 3.8.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/BidMachine/CHANGELOG.md#version-3800). - Built and tested with the Google Mobile Ads Flutter Plugin version 9.1.0. #### Version 1.4.2 - Updated to support Google Mobile Ads Flutter Plugin version 9.1.0. - Added Swift Package Manager support. - Supports [BidMachine Android adapter version 3.7.1.1](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/bidmachine/CHANGELOG.md#version-3711). - Supports [BidMachine iOS adapter version 3.7.1.0.1](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/BidMachine/CHANGELOG.md#version-3710). - Built and tested with the Google Mobile Ads Flutter Plugin version 9.1.0. #### Version 1.4.1 - Supports [BidMachine Android adapter version 3.7.1.1](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/bidmachine/CHANGELOG.md#version-3711). - Supports [BidMachine iOS adapter version 3.7.1.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/BidMachine/CHANGELOG.md#version-3710). - Built and tested with the Google Mobile Ads Flutter Plugin version 9.0.0. #### Version 1.4.0 - Updated to support Google Mobile Ads Flutter Plugin version 9.0.0 - Supports [BidMachine Android adapter version 3.7.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/bidmachine/CHANGELOG.md#version-3700). - Supports [BidMachine iOS adapter version 3.7.1.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/BidMachine/CHANGELOG.md#version-3710). - Built and tested with the Google Mobile Ads Flutter Plugin version 9.0.0. #### Version 1.3.2 - Updated minimum Flutter version to 3.38.1 - Updated to support Google Mobile Ads Flutter Plugin version 8.0.0 - Supports [BidMachine Android adapter version 3.6.1.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/bidmachine/CHANGELOG.md#version-3610). - Supports [BidMachine iOS adapter version 3.6.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/BidMachine/CHANGELOG.md#version-3600). - Built and tested with the Google Mobile Ads Flutter Plugin version 8.0.0. #### Version 1.3.1 - Supports [BidMachine Android adapter version 3.5.1.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/bidmachine/CHANGELOG.md#version-3501). - Supports [BidMachine iOS adapter version 3.5.1.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/BidMachine/CHANGELOG.md#version-3501). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 1.3.0 - Supports [BidMachine Android adapter version 3.5.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/bidmachine/CHANGELOG.md#version-3500). - Supports [BidMachine iOS adapter version 3.5.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/BidMachine/CHANGELOG.md#version-3500). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 1.2.0 - Supports [BidMachine Android adapter version 3.5.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/bidmachine/CHANGELOG.md#version-3500). - Supports [BidMachine iOS adapter version 3.4.0.2](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/BidMachine/CHANGELOG.md#version-3402). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 1.1.0 - Supports [BidMachine Android adapter version 3.4.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/bidmachine/CHANGELOG.md#version-3400). - Supports [BidMachine iOS adapter version 3.4.0.1](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/BidMachine/CHANGELOG.md#version-3401). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0. #### Version 1.0.0 - Initial release. - Supports [BidMachine Android adapter version 3.3.0.0](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/bidmachine/CHANGELOG.md#version-3300). - Supports [BidMachine iOS adapter version 3.4.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/BidMachine/CHANGELOG.md#version-3400). - Built and tested with the Google Mobile Ads Flutter Plugin version 6.0.0.