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 Android app.

Supported ad 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)
Native Advanced
Features
Smart banners
Ad Network Optimization (ANO)
Native Video

Requirements

  • Android SDK 4.0 (API level 14) or higher
  • Google Play services 17.2.0 or later

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.

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 Android as the platform to monetize.

Indicate whether or not your app is live, check the This app is using mediation box and click Submit.

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. Take note of the Placement ID which will be used when setting up your AdMob Ad Unit ID.

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.

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.

If you haven't created a property for your app, click Add to create a new property. Enter your property name in the resulting form and click Next.

Select your app from the list to associate it to the property and click Next.

Add the System User created earlier as a Property Manager and click Save Changes.

Take note of the Property ID as this will be needed in the next step.

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

Select your app from the list, add read_insights and 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.

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.

Mediation details

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.

Mediation group 2

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

Select ad unit

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

Group ad units

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.

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

Add the following implementation dependencies with the latest versions of the Facebook Audience Network SDK and adapter in the app-level build.gradle file:

...
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'androidx.appcompat:appcompat:1.0.2'
    implementation 'com.google.ads.mediation:facebook:5.4.1.1'
}
...

Manual integration

Download the latest version of the Facebook Audience Network SDK for Android and extract the AudienceNetwork.aar under the AudienceNetwork/bin folder and add it to your project.

Download the latest .aar file of the adapter from Bintray, located under the Files tab, and add it to your project.

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

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.

Using native ads

Some Facebook native ad assets don't map one to one to Google native ad assets. Such assets are passed back to the publisher in a bundle in getExtras() method in UnifiedNativeAd. Here's a code example showing how to extract these assets:

Example:

Java

Bundle extras = unifiedNativeAd.getExtras();
if (extras.containsKey(FacebookAdapter.KEY_SOCIAL_CONTEXT_ASSET)) {
    String socialContext = extras.get(FacebookAdapter.KEY_SOCIAL_CONTEXT_ASSET);
    ...
}

Kotlin

val extras = unifiedNativeAd.getExtras()
if (extras.containsKey(FacebookAdapter.KEY_SOCIAL_CONTEXT_ASSET)) {
   var socialContext = extras.get(FacebookAdapter.KEY_SOCIAL_CONTEXT_ASSET)
   ...
}

Using Facebook Native Ads without a MediaView

If your app renders native ads without a MediaView asset, Facebook Audience network requires that you implement their native banner ad format.

By default, the Facebook adapter requests native ads , which require a MediaView asset. To use Facebook's native banner ads instead, you must:

  • Upgrade to version 5.4.1.0 or higher of the Facebook adapter.
  • Pass an extra parameter into the ad request indicating you want to request a native banner ad, as shown below.

Java

Bundle extras = new FacebookExtras()
       .setNativeBanner(true)
       .build();

AdRequest request =  new AdRequest.Builder()
       .addNetworkExtrasBundle(FacebookAdapter.class, extras)
       .build();

Kotlin

var extras = FacebookExtras()
       .setNativeBanner(true)
       .build()

var adrequest = AdRequest.Builder()
       .addNetworkExtrasBundle(FacebookAdapter::class.java, extras)
       .build()

Ad rendering

The Facebook adapter returns its native ads as UnifiedNativeAd objects. It populates the following Native ads advanced field descriptions for a UnifiedNativeAd.

Field Populated by Facebook adapter
Headline
Image error
Body
App icon
Call to action
Advertiser Name
Star rating
Store
Price

The Facebook adapter does not provide direct access to the main image asset for its native ads. Instead, the adapter populates the MediaView with a video or an image.

For Native ads, Facebook Audience Network SDK itself populates its icon view with an image asset. To avoid potential null pointer errors, the Facebook adapter returns an empty NativeAd.Image if your app calls UnifiedNativeAd.getIcon().

Impression and click tracking

Google Mobile Ads SDK uses the Facebook Audience Network SDK's callbacks for impression and click tracking, so the reports on both dashboards should match up with few or no discrepancies.

Şunun hakkında geri bildirim gönderin...

Yardım mı gerekiyor? Destek sayfamızı ziyaret edin.