Integrate BidMachine with Mediation

Select platform: Android New Android iOS Unity Flutter

This guide shows you how to use Google Mobile Ads SDK to load and display ads from BidMachine using 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 iOS app.

Supported integrations and ad formats

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

Requirements

  • iOS deployment target of 13.0 or higher

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

Fill out the form and click Save.

Create Placement

Finally, take note of the Placement ID.

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, create an app-ads.txt file for Ad Manager.

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 Ad Manager UI

Sign in to your Ad Manager account.

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 toggle 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 BidMachineToken and toggle 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, toggle 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.

Waterfall

Navigate to Delivery > Yield groups and click the New yield group button. Select your Mobile application.

Scroll down and click Add yield partner.

Select the company you created for BidMachine in the previous section. Choose Mobile SDK mediation as the Integration type, iOS as the Platform, and Active as the Status.

Enter the Placement ID obtained in the previous section, and the Default CPM value. Click Save.

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 Ad Manager UI.

Step 3: Import the BidMachine SDK and adapter

Use Swift Package Manager

Before you continue, you must have the minimum supported adapter version 3.6.0.0.

To add a package dependency to your project, follow these steps:

  1. In Xcode, navigate to File > Add Package Dependencies....

  2. In the prompt that appears, search the following package URL:

    https://github.com/googleads/googleads-mobile-ios-mediation-bidmachine.git

  3. In Dependency Rule, select Branch.

  4. In the text field, enter main.

Use CocoaPods

  • Add the following line to your project's Podfile:

    pod 'GoogleMobileAdsMediationBidMachine'

  • From the command line run:

    pod install --repo-update

Manual integration

  1. Download the latest version of the BidMachine SDK for iOS and link all the .xcframework files and bundles in your project.

  2. Download the latest version of the BidMachine adapter from the download link in the Changelog and link BidMachineAdapter.xcframework in your project.

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

Implement SKAdNetwork

Follow BidMachine's documentation 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 Ad Manager.

Follow the instructions in BidMachine's documentation for 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).

Optional Steps

Native ads

Ad rendering

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

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 GADResponseInfo.adNetworkInfoArray under the following classes:

GADMediationAdapterBidMachine

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

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 iOS Mediation Adapter Changelog

Version 3.7.0.0

  • Verified compatibility with BidMachine SDK version 3.7.0.

Built and tested with:

  • Google Mobile Ads SDK version 13.4.0.
  • BidMachine SDK version 3.7.0.

Version 3.6.1.1

  • Adapter now forwards the ageRestrictedTreatment Google Mobile Ads SDK flag to BidMachine SDK's COPPA API.
  • Upgrade BidMachine adapter and unit tests to Swift 6.

Built and tested with:

  • Google Mobile Ads SDK version 13.3.0.
  • BidMachine SDK version 3.6.1.

Version 3.6.1.0

  • Verified compatibility with BidMachine SDK version 3.6.1.

Built and tested with:

  • Google Mobile Ads SDK version 13.2.0.
  • BidMachine SDK version 3.6.1.

Version 3.6.0.0

  • Verified compatibility with BidMachine SDK version 3.6.0.
  • Refactored BidMachine banner ad loading and native ad image handling.

Built and tested with:

  • Google Mobile Ads SDK version 13.1.0.
  • BidMachine SDK version 3.6.0.

Version 3.5.1.2

  • Updated the Google Mobile Ads SDK dependency to version 13.0.0.

Built and tested with:

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

Version 3.5.1.1

  • Updated the CocoaPods minimum iOS version to 13.0.
  • Added support for forwarding the tagForUnderAgeOfConsent Google Mobile Ads SDK parameter to the BidMachine SDK.
  • Modified BidMachineAdDelegate conformance sections to align with BidMachine SDK callback behavior.

Built and tested with:

  • Google Mobile Ads SDK version 13.0.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 12.14.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 12.12.0.
  • BidMachine SDK version 3.5.0.

Version 3.4.0.2

  • Added waterfall support for banner, interstitial, rewarded and native ad formats.
  • Removed the isTestMode static property from BidMachineAdapterExtras.
  • Added banner ad size validation for waterfall banner ads.

Built and tested with:

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

Version 3.4.0.1

  • Test mode is now available in Objective-C through the GADMediationAdapterBidMachineExtras.isTestMode property.

Built and tested with:

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

Version 3.4.0.0

  • Initial release.
  • Added bidding support for banner, interstitial, rewarded and native ad formats.
  • Verified compatibility with BidMachine SDK version 3.4.0.

Built and tested with:

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