Mediation Test Suite

The Google Mobile Ads Mediation Test Suite allows you to test whether you have correctly configured your app and ad units to be able to display ads from third-party networks through mediation. This guide outlines how to use the Google Mobile Ads Mediation Test Suite in your iOS app by integrating the tool into your app.

Prerequisites

  • Use Xcode 12 or higher.
  • Target iOS 8.0 or higher.
  • Create an Ad Manager account and register an app.
  • Ensure you have correctly entered your app ID in your Info.plist.

Installation

The Mediation Test Suite is installed using CocoaPods. To do this, add the following line to your Podfile:

pod 'GoogleMobileAdsMediationTestSuite'

This configures the test suite as well as the required Material Components dependencies. Run pod install to complete the installation.

Update your Info.plist

Mediation Test Suite requires that you set your Ad Manager app ID in order to launch Mediation Test Suite for Ad Manager.

Launching the Mediation Test Suite

To display the tool, first import the framework:

Swift

import GoogleMobileAdsMediationTestSuite

Objective-C

@import GoogleMobileAdsMediationTestSuite;

Next, after your view has appeared, show the test suite as follows:

Swift


GoogleMobileAdsMediationTestSuite.presentForAdManager(on:self, delegate:nil)

Objective-C


[GoogleMobileAdsMediationTestSuite presentForAdManagerOnViewController:self delegate:nil];

This optional delegate notifies you when the Mediation Test Suite is dismissed. To implement the delegate callback, conform to the GMTSMediationTestSuiteDelegate protocol and implement the mediationTestSuiteWasDismissed method.

The tool opens with the following disclaimer:

Tick the checkbox and press Agree to proceed.

You're then presented with two tabs: Yield Groups and Open Bidding Partners.

Yield Groups represents all the Yield Groups configured for the app.

Open Bidding partners is a list of all Yield Partners configured for Open Bidding that have their own SDK for ad rendering and have an associated ad unit mapping configured in your account.

If you don't see a list of yield groups, either the network call failed or no yield groups were found.

The list in each tab is separated into three sections:

  • Implementation Errors: Entries with an issue with the integration of the SDK or Adapter for one of the networks.
  • Configuration Errors: Generally these are untested and as such it is unknown whether the credentials configured for all networks are valid.
  • Working: All network entries have had a successful ad load.

Yield groups are listed by their ID. This ID is the same as the yield_group_id parameter in the URL when viewing the yield group in your Ad Manager UI.

For the URL:

https://admanager.google.com/6499#delivery/yield_group/detail/yield_group_id=140356`

the yield group ID is 140356.

After all of a yield group's networks are tested successfully, the yield group will move from the Configuration Errors section to the Working section.

To search the list of yield groups, press the search icon at the top and enter a yield group ID. You can also search by network name or by ad format.

For each yield group, this screen provides warnings if:

  • An ad source SDK is not installed
  • An ad source adapter is not installed

If testing is possible, the screen also shows overall test result status for all ad sources.

Select a yield group to move to the Yield Group Details screen.

Yield group details

This screen shows the details for the yield group, including the yield group ID, the ad format, and the mediation waterfall configured for the yield group:

Note the following aspects on this screen:

Ad source summary

For each ad source, there are indicators showing whether the SDK and adapter is installed and the result of the last test for this configuration in this session.

For custom events, a Custom Event: custom event label is used. The adapter status indicator for a custom event will be positive if the class you've specified for the custom event is found. You can load and view ads for custom events in the same way as other networks.

Search

Pressing the search icon presents a search screen where you can search for ad sources according to their name.

Batch testing

Each ad source can be selected to be tested in a batch by checking the checkbox to the left of the ad source name. A new option then appears in the navigation bar:

Press the Load Ads button in the top right to load ads for the selected ad sources in sequence. A progress indicator is displayed while testing takes place. Pressing the back icon in the top left clears the selection.

Loading and displaying ads

Tap on an ad source entry to see the ad source details screen:

The screen indicates, for the given ad source:

  • If the SDK is installed and, if available, the SDK version.
  • If the adapter is installed and, if available, the adapter version.
  • The adapter initialization status, if available.
  • The parameters for the configuration that were entered in the Ad Manager console.

After you've installed all required components, you can proceed to test loading an ad. Tap on Load Ad to send an ad request to the ad source's SDK. Once the ad request completes, an update saying whether the request succeeded or failed is presented.

If the request failed, check your console logs for messages from the SDK being tested.

If the request succeeded:

  • For banner ads, the ad is shown inline.
  • For interstitial or rewarded ads, you can show the ad by tapping on Show Ad.
  • For native ads, the assets returned are shown inline.

    The ad opens in a new screen, for example:

When you return to the Details screen, the results of the last time you tested the ad in the yield groups list screen are displayed. The successfully loaded ad sources are moved to the bottom of the list surfacing the ad sources needing further testing.

Open Bidding partners

See the Verify Open Bidding Setup guide for details on testing Open Bidding.

Enabling testing in production

By default, the Mediation Test Suite will only launch in development, adhoc, and enterprise builds. This is meant to prevent end users from inadvertently launching the test suite.

If you need to run the Mediation Test Suite on a device once your app is in production, register your device as a test device with the SDK.

When including the Mediation Test Suite in a production app, you'll need a hidden way to launch the test suite (for example, a secret gesture or debug menu). You'll then be able to launch the test suite on any device that's been allowlisted in the build.

Configuring ad requests with network extras (optional)

Certain mediated networks, such as Vungle, have the option to provide a custom network extras object to provide additional information to requests to their network.

If you need to provide network extras for your mediation requests, you can set an ad request for the test suite to use with the [GoogleAdsMediationTestSuite setAdRequest:] class method:

Swift

let request = DFPRequest()
...
// Set your network extras for your chosen networks here.
// I.e., for each network extras object, call
// 'request.register(\)'
...
GoogleAdsMediationTestSuite.setAdRequest(request);

Objective-C

DFPRequest request = [DFPRequest request];
...
// Set your network extras for your chosen networks here.
// I.e., for each network extras object, call
// '[request registerAdNetworkExtras:\];'
...
[GoogleAdsMediationTestSuite setAdRequest:request];

Ensure that you do this before launching the Mediation Test Suite.

This enables you to instantiate and configure an ad request with any required extras, which the test suite can then use in its request to the mediated network.

Advanced CocoaPods configuration (optional, debug only)

If you only want to include the pod in the debug version of your app, you can specify this in your Podfile as a pod for only the Debug build configuration. You need to also guard any code that calls the tool with #ifdef DEBUG statements or similar.

To include the pod only in the Debug configuration, use the following line:

pod 'GoogleMobileAdsMediationTestSuite', :configurations => ['Debug']

Make sure to wrap all references to the framework and its classes with #ifdef DEBUG:

Swift

import UIKit
#if DEBUG
import GoogleMobileAdsMediationTestSuite
#endif
import GoogleMobileAds

let APP_ID = "ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
    }

  @IBAction func presentMediationController(_ sender: AnyObject) {
      #if DEBUG
        GoogleMobileAdsMediationTestSuite.present(withAppId:APP_ID, on:self, delegate:nil)
      #endif
    }

Objective-C

#import "ViewController.h"
#ifdef DEBUG
@import GoogleMobileAdsMediationTestSuite;
#endif
#import <GoogleMobileAds/GoogleMobileAds.h>

static NSString *APP_ID = @"ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy";

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
}

- (IBAction)presentMediationController:(id)sender {
#ifdef DEBUG
    [GoogleMobileAdsMediationTestSuite presentWithAppId:APP_ID
                                       onViewController:self
                                               delegate:nil];
  }
#endif
}