Integrating Facebook Audience Network with Mediation

This guide is intended for publishers who want to use the Google Mobile Ads SDK to load and display ads from the Facebook Audience Network via mediation. It covers how to add Facebook ads to an ad unit's mediation configuration, how to set up Ad Network Optimization (ANO),and how to integrate the Facebook Audience Network SDK and adapter into an Unity app.

Supported formats and features

The AdMob mediation adapter for the Facebook Audience Network has the following capabilities:

Formats
Banners
Interstitials
Rewarded video
Rewarded video (new APIs)
Features
Smart banners
Ad Network Optimization (ANO)

Requirements

• Unity 4 or higher
• To deploy on Android
  • Android SDK 4.0 (API level 14) or higher
  • Google Play services 17.2.0 or higher
• To deploy on iOS
  • Xcode 9.2 or higher
  • iOS Deployment target of 9.0 or higher
  • Google Mobile Ads SDK 7.42.2 or higher
• A working Unity project configured with Google Mobile Ads SDK. See Quick Start for details.

Note: The latest Facebook Audience Network SDK usually requires the latest version of Xcode.

Step 1: Set up Facebook Audience Network

Sign up and Log in to the Business Manager Start page.

Click Create a new Business Manager account and fill out the required fields with your business details.

Create a Facebook property

Once you've filled out the required information, you'll be prompted to create a property for your app. Enter the desired name of the property for your app and click Go to Monetization Manager.

Next, select the platform you want to monetize.

Note: If your app supports both Android and iOS, you need to add each of them separately.

Indicate whether or not your app is live and click Submit.

Android

iOS

You will be prompted to create an ad placement for your application. Select a format, fill out the form and click Next.

The next step presents an overview of the placement you created. Check the This app is using mediation checkbox and take note of the Placement ID, which will be used when setting up your AdMob Ad Unit ID.

Android

iOS

In addition to the Placement ID, you'll also need the Facebook System User Access Token to set up your AdMob Ad Unit ID for mediation.

Create a Facebook application

Log in to your Facebook developer account. Navigate to the My Apps page by clicking the My Apps button in the top-right corner. Add your app to the Facebook console by clicking the Add a New App button.

Fill out the form and click Create App ID to add your app to Facebook.

Note the App ID of the app you created. This value is used in the next step. You can always find your App ID from the My Apps page.

Note: If your app supports both Android and iOS, you need to create an app for each of them separately.

Generate a system user access token

In order to set up Ad Network Optimization for Facebook Audience Network, you'll need to generate a system user access token and associate it with your property.

To generate a system user access token, sign in to Facebook Business Manager, click the Business Settings icon and navigate to System Users on the left navigation bar. If you don't already have a system user, click Add to create one.

Fill out the System User Name field, select Regular System User as the System User Role, and click Create System User.

To import your apps to Facebook Business, navigate to Accounts > Apps. Click Add and select Add an app.

Enter the App ID created from the previous step and click the Add App to continue.

Navigate to Data Sources > Properties. Take note of the Property ID as this will be needed in the next step. Select the property you created in the previous step and click Add People.

Note: If you haven't created a property for your app, click Add to create a new property and follow the previous step in creating a property.

Select the System User created earlier, turn on Admin Access and click Assign.

Click Add Assets, select your app from the list to associate it to the property and click Add.

Navigate back to System Users, select the user you created, and click Generate New Token.

Select your app from the list, add read_audience_network_insights as the Available Scopes for the token to be generated, and click Generate Token.

Finally, take note of your System User Access Token.

Step 2: Configure mediation settings for your AdMob ad unit

You need to add Facebook to the mediation configuration for your ad unit. First sign in to your AdMob account.

Note: If you're deploying your Unity app to both Android and iOS, you need two AdMob ad units, one for each platform.

Android

Navigate to the Mediation tab. If you have an existing mediation group you'd like to modify, click the name of that mediation group to edit it, and skip ahead to Add Facebook Audience Network as an ad source.

To create a new mediation group, select Create Mediation Group.

Enter your ad format and platform, then click Continue.

Give your mediation group a name, and select locations to target. Next, set the mediation group status to Enabled. Then click Add Ad Units, which will open up the ad unit selection overlay.

Associate this mediation group with your existing AdMob ad unit. Then click Done. You should now see the ad units card populated with the ad units you selected.

Add Facebook Audience Network as an ad source

In the Ad Sources card, select Add Ad Network.

Select Facebook Audience Network. Enable the Optimize switch. Enter the System User Access Token and Property ID obtained in the previous section. App Access Token is deprecated and can be left blank. Review and check the Authorization checkbox to set up Ad Network Optimization (ANO) for Facebook Audience Network. Then enter an eCPM value for Facebook Audience Network and click Continue.

Enter the Placement ID obtained in the previous section. Then click Done.

Finally, click Save.

iOS

Navigate to the Mediation tab. If you have an existing mediation group you'd like to modify, click the name of that mediation group to edit it, and skip ahead to Add Facebook Audience Network as an ad source.

To create a new mediation group, select Create Mediation Group.

Enter your ad format and platform, then click Continue.

Give your mediation group a name, and select locations to target. Next, set the mediation group status to Enabled. Then click Add Ad Units, which will open up the ad unit selection overlay.

Associate this mediation group with your existing AdMob ad unit. Then click Done.

You should now see the ad units card populated with the ad units you selected.

Add Facebook Audience Network as an ad source

In the Ad Sources card, select Add Ad Network.

Select Facebook Audience Network. Enable the Optimize switch. Enter the System User Access Token and Property ID obtained in the previous section. App Access Token is deprecated and can be left blank. Review and check the Authorization checkbox to set up Ad Network Optimization (ANO) for Facebook Audience Network. Then enter an eCPM value for Facebook Audience Network and click Continue.

Enter the Placement ID obtained in the previous section. Then click Done.

Finally, click Save.

Note: Ad network optimization takes a few days to gather data to accurately calculate eCPM for a mediation network. In the meantime, the ANO status will be PENDING, so you must manually set an eCPM value for the network. Once the eCPM can be calculated, ANO will automatically start updating the eCPM on your behalf. If the AdMob Dashboard is showing a PENDING or ERROR status for more than 72 hours, verify that you have added the System User to each of your Properties.

Using rewarded video ads

In the settings for your rewarded video ad unit, provide values for the reward amount and reward type. Then, to ensure you provide the same reward to the user no matter which ad network is served, check the Apply to all networks in Mediation groups box.

If you don't apply this setting, the Facebook adapter defaults to a reward of type "" (empty string) with a value of 1. The Facebook SDK does not provide specific reward values for its rewarded video ads.

For more information on setting reward values for AdMob ad units, see Create an ad unit.

Step 3: Import the Facebook Audience Network SDK and adapter

Download the latest version of the Google Mobile Ads mediation plugin for Facebook and extract the GoogleMobileAdsFacebookMediation.unitypackage from the zip file.

In your Unity project editor, select Assets > Import Package > Custom Package and find the GoogleMobileAdsFacebookMediation.unitypackage file you downloaded. Make sure that all the files are selected and click Import.

Step 4: Additional code required

No additional code required for Facebook integration.

Step 5: Test your implementation

See the Testing Audience Network Implementation guide guide for detailed instructions on how to enable Facebook test ads. You can then use the Mediation Test Suite to verify if your implementation is correct.

That's it! You now have a working mediation integration with Facebook's Audience Network.

Optional steps

EU Consent and GDPR

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.

Please review Facebook's guidance for information about GDPR and Facebook advertising.

Facebook Unity Mediation Plugin Changelog

Version 2.6.0

• Supports Facebook Android adapter version 5.6.0.0.
• Supports Facebook iOS adapter version 5.6.0.0.

Version 2.5.1

• Supports Facebook Android adapter version 5.5.0.0.
• Supports Facebook iOS adapter version 5.5.1.0.

Version 2.5.0

• Supports Facebook Android adapter version 5.5.0.0.
• Supports Facebook iOS adapter version 5.5.0.0.

Version 2.4.1

• Supports Facebook Android adapter version 5.4.1.1.
• Supports Facebook iOS adapter version 5.4.0.0.

Version 2.4.0

• Supports Facebook Android adapter version 5.4.0.0.
• Supports Facebook iOS adapter version 5.4.0.0.

Version 2.3.2

• Supports Facebook Android adapter version 5.3.1.2.
• Supports Facebook iOS adapter version 5.3.2.0.

Version 2.3.1

• Supports Facebook Android adapter version 5.3.1.0.
• Supports Facebook iOS adapter version 5.3.2.0.

Version 2.3.0

• Supports Facebook Android adapter version 5.3.0.0.
• Supports Facebook iOS adapter version 5.3.0.0.

Version 2.2.0

• Updated the plugin to support the new open-beta Rewarded API.
• Supports Facebook Android adapter version 5.2.0.1.
• Supports Facebook iOS adapter version 5.2.0.1.

Version 2.1.1

• Supports Facebook Android adapter version 5.1.0.1.
• Supports Facebook iOS adapter version 5.1.0.0.

Version 2.1.0

• Supports Facebook Android adapter version 5.1.0.0.
• Supports Facebook iOS adapter version 5.1.0.0.

Version 2.0.0

• Supports Facebook Android adapter version 5.0.1.0.
• Supports Facebook iOS adapter version 5.0.1.0.

Version 1.2.1

• Supports Facebook Android adapter version 4.99.3.0.
• Supports Facebook iOS adapter version 4.99.3.0.

Version 1.2.0

• Supports Facebook Android adapter version 4.99.1.1.
• Supports Facebook iOS adapter version 4.99.2.0.

Version 1.1.3

• Supports Facebook Android adapter version 4.28.2.1.
• Supports Facebook iOS adapter version 4.28.1.2.

Version 1.1.2

• Fixed a potential conflict with the Unity Ads Unity mediation plugin.

Version 1.1.1

• Supports Facebook Android adapter version 4.28.2.0.
• Supports Facebook iOS adapter version 4.28.1.1.

Version 1.1.0

• Supports Facebook Android SDK version 4.28.1.
• Supports Facebook iOS SDK version 4.28.1.

Version 1.0.0

• First release!
• Supports Facebook Android SDK version 4.27.0.
• Supports Facebook iOS SDK version 4.27.1.