Integrate BidMachine with mediation

Select platform: Android iOS Unity Flutter Android (Legacy)

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

Supported integrations and ad formats

The AdMob mediation adapter for BidMachine has the following capabilities:

Integration
Bidding
Waterfall  1
Formats
App Open
Banner
Interstitial
Rewarded
Rewarded Interstitial
Native

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 for details.
  • Set up AdMob Mediation.

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

    Sources Dashboard

    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.

    Edit Source Dialog

    Select Bidding as the Placement Type. Fill out the form and click Save.

    Android

    Create Android Placement

    iOS

    Create iOS Placement

    Finally, take note of the Placement ID.

    Android

    Android Placement Details

    iOS

    iOS Placement Details

    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

    Integration through pub.dev

    (Android only) Add the following repositories to the build.gradle file inside your project's android directory:

      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:

    dependencies:
  gma_mediation_bidmachine: ^1.5.0

    Manual Integration

    Download the latest version of Google Mobile Ads mediation plugin for BidMachine, 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:

    dependencies:
  gma_mediation_bidmachine:
    path: path/to/local/package

    Step 4: Implement privacy settings on BidMachine SDK

    To comply with the 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 that consent is propagated to each ad source in your mediation chain.

    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.
    108 com.google.mediation.bidmachine BidMachine doesn't support this banner ad size.

    BidMachine Flutter Mediation Adapter Changelog

    Version 1.5.1 (In progress)

    Version 1.5.0

    Version 1.4.2

    Version 1.4.1

    Version 1.4.0

    Version 1.3.2

    Version 1.3.1

    Version 1.3.0

    Version 1.2.0

    Version 1.1.0

    Version 1.0.0