Skip to main content

UnityAds

This guide is intended for publishers who want to use the Google Mobile Ads SDK to load and display ads from Unity Ads via mediation.

Step 1: Set up Unity ads​

The Google documentation contains a very detailed guide as to the process to setup your properties and Unity Ads account to display adverts.

Make sure you follow this guide closely.

https://developers.google.com/admob/android/mediation/unity#step_1_set_up_unity_ads

Step 2: Configure mediation settings for your AdMob ad unit​

You need to add Unity Ads to the mediation configuration for your ad unit.

Step 3: Import the Unity Ads SDK and adapter ANE​

The simplest way to install and manage your AIR native extensions and libraries is to use the AIR Package Manager (apm). We highly recommend using apm, as it will handle downloading all required dependencies and manage your application descriptor (Android manifest additions, iOS info additions etc).

However you can choose to install it manually, as you would have done in the past.

Add the Extension​

info

Note: All of the commands below should be run in a terminal / command prompt in the root directory of your application, generally the level above your source directory.

If you don't have an APM project setup, expand the guide below to setup an APM project before installing the extension.

Setup APM

Install APM​

If you haven't installed apm follow the install guide on airsdk.dev.

Setup an APM project​

You will need an APM project for your application.

There are many ways to do this and for more options see the APM documentation. Here we will just initialise a new empty project:

apm init

Check your github token​

We use github to secure our extensions so you must have created a github personal access token and configured apm to use it.

To do this create a token using this guide from github and then set it in your apm config using:

apm config set github_token ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXX

If you don't do this correctly you may find the install will fail.

Install the extension​

Install the extension by running: 

apm install com.distriqt.admob.UnityAds

This will download and install the extension, required assets, and all dependencies.

Once complete apm will have created something like the following file structure: 

.
|____ ane
| |____ com.distriqt.admob.UnityAds.ane # UnityAds AdMob mediation extension
| |____ [dependencies]
|____ apm_packages                      # cache directory - ignore
|____ project.apm                       # apm project file

  • Add the ane directory to your IDE. See the tutorials located here on adding an extension to your IDE.

  • You will have an assets directory that contains required assets for the installed extensions. You must add the files in the assets/android folder to the root of your Android application package and the assets/ios folder to the root of your iOS application package (contains the Frameworks folder with required dynamic frameworks). If these folders don't exist there are no required assets for that platform.

info

We suggest you use the locations directly in your builds rather than copying the files elsewhere. The reason for this is if you ever go to update the extensions using apm that these updates will be pulled into your build automatically.

Application Descriptor​

Updating your application descriptor will insert the required extensionID's and generate the manifest and info additions for your application.

You update your application descriptor by running:

apm generate app-descriptor src/MyApp-app.xml

Change the path (src/MyApp-app.xml) to point to your application descriptor.

caution

This will modify your application descriptor replacing the manifest additions and info additions with the ones generated from apm.

You should backup your application descriptor before running this command to ensure you don't lose any information.

If you need to insert custom data into these sections see the guides for Android and iOS

Step 4: Additional code required​

There is no additional code required.

Step 5: Test your implementation​

When testing always make sure you are adding your test device id to the request to ensuring AdMob do not block your account for policy violations:

new AdRequestBuilder()
    .addTestDevice( "XXXXXXXXXXXXXXXXXX" )
    .build()

See the Adverts docs for more details.

Optional Steps​

Under the Google EU User Consent Policy, you must ensure that certain disclosures are given to, and consents obtained from, users in the European Economic Area (EEA) regarding the use of device identifiers and personal data. This policy reflects the requirements of the EU ePrivacy Directive and the General Data Protection Regulation (GDPR). When seeking consent, you must identify each ad network in your mediation chain that may collect, receive, or use personal data and provide information about each network's use. Google currently is unable to pass the user's consent choice to such networks automatically.

Follow the instructions below to enable or disable personalized ads for Unity Ads.

Unity Ads provides a GDPR Compliance guide that describes both automatic and manual solutions for user consent.

The following sample code shows how to pass consent information to the Unity Ads SDK manually. Should you choose to pass consent information to the Unity Ads SDK manually, it is recommended that this code is called prior to requesting ads via the Google Mobile Ads SDK.

AdMobUnityAds.instance.setConsent(true);