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

Requirements

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

Step 1: Set up Facebook Audience Network

First, sign up and log in to your Facebook developer account. Navigate to My Apps page by clicking on the My Apps button on the top right corner.

My apps screen

Add your app to the Facebook console by clicking the Add a New App button.

Add new app ID

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

Add product screen

Next, in the Facebook dashboard for your app, add Facebook Audience Network to your app by clicking the Add Product under PRODUCTS on the left sidebar and clicking Set Up for Audience Network.

Get started screen

Once your app is added you will be taken to the Audience Network Apps screen. Click Get Started to create an Ad Space.

Ad spaces screen

To create a new Ad Space click the Create Ad Space button.

Fill out the form and click Create when done.

Once the Ad Space has been created you'll be prompted to create a new Placement. We recommend creating a new placement for mediation with AdMob even if you have one already.

Click the Create Placement button to create a new placement.

For additional instructions on creating an ad placement, select the tab corresponding to your preferred ad format.

Banner

Enter your placement's Name and Steps to Trigger an Ad when prompted.

Select Banner as the Display Format. Toggle the Refresh Rate Handled by Mediation switch to Yes and set your price setting. Double-check that the Status dropdown at the top of the form is set to Enabled, then click Save to create your placement.

Interstitial

Enter your placement's Name and Steps to Trigger an Ad when prompted.

Select Interstitial (App Only) as the Display Format. Set your price setting. Double-check that the Status dropdown at the top of the form is set to Enabled, then click Save to create your placement.

Rewarded

Enter your placement's Name and Steps to Trigger an Ad when prompted.

Select Rewarded Video as the Display Format. Set your price setting. Double-check that the Status dropdown at the top of the form is set to Enabled, then click Save to create your placement.

Native

Enter your placement's Name and Steps to Trigger an Ad when prompted.

Select Native as the Display Format. Set your price setting. Double-check that the Status dropdown at the top of the form is set to Enabled, then click Save to create your placement.

Once the Ad Placement is created, locate the Placement ID by navigating to your new Placement's details (located under your Ad Space).

In addition to the Placement ID, you'll also need the Facebook App Access Token to set up your Android ad unit ID for mediation.

To get your App Access Token, navigate to Facebook Access Token Tool under Tools & Support in the Facebook developer dashboard.

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.

Next, follow the instructions for either AdMob or AdMob Beta depending on which version of the AdMob UI you're using.

AdMob

Navigate to the Monetize tab and select your app from the list of All apps on the left-hand side. A list of ad units associated with your application will be shown.

Mediation ad source

Click the link in the mediation column for the ad unit you'd like to configure with Facebook.

You will be taken to the ad unit's Mediation page.

New ad network

Click NEW AD NETWORK.

A list of supported ad networks will be shown.

Select FB

Select Facebook Audience Network from the list of networks provided and enter the Placement ID obtained in the previous section.

Enter the App Access Token obtained in the previous section. Review and check the Authorization checkbox to set up Ad Network Optimization (ANO) for Facebook Audience Network.

Click Continue at the bottom of the page to complete adding the network. Enter an eCPM value for Facebook Audience Network and click Save.

AdMob Beta

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.

Mediation details

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

Mediation group

Enter your ad format and platform, then click Continue.

Mediation group 2

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.

Select ad unit

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.

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 your App Access Token obtained in the previous section. 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, check the Override reward settings from third-party ad networks when using AdMob mediation so that you provide the same reward to the user no matter which ad network is served.

If you don't override the reward, the Facebook adapter defaults to a reward of type "" (empty string) with value 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 compile 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 'com.android.support:appcompat-v7:xx.x.x'
    implementation 'com.google.android.gms:play-services-ads:11.6.2'
    implementation 'com.facebook.android:audience-network-sdk:4.26.1'
    implementation 'com.google.ads.mediation:facebook:4.26.1.0'
}
...

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

Facebook ads can be tested by adding the tester's Facebook account as a Tester under the Roles tab on the left-hand side in your Facebook app's dashboard (Administrator or Developer role will also be able to test the ads). The tester will need to sign in to the Facebook app on a test device to begin testing. See the Testing Audience Network Implementation guide for more details.

Add testers

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

Optional steps

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 NativeAppInstallAd and NativeContentAd. For example, to use the subtitle asset provided by Facebook, you should call getExtras() to get the extras bundle and then fetch the value for the key FacebookAdapter.KEY_SUBTITLE_ASSET.

Example:

Bundle extras = nativeAppInstallAd.getExtras();
if (extras.containsKey(FacebookAdapter.KEY_SUBTITLE_ASSET)) {
    String subtitle = extras.get(FacebookAdapter.KEY_SUBTITLE_ASSET);
    ...
}

Bundle viewAttributes = extras.getBundle(FacebookAdapter.KEY_AD_VIEW_ATTRIBUTES);
if (viewAttributes != null) {
    boolean autoplay = viewAttributes.getBoolean(FacebookAdapter.KEY_AUTOPLAY);
    ...
}

The following are a list of Extra Keys for Facebook specific assets:

  1. FacebookAdapter.KEY_ID for getId().
  2. FacebookAdapter.KEY_SOCIAL_CONTEXT_ASSET for getAdSocialContext().
  3. FacebookAdapter.KEY_SUBTITLE_ASSET for getAdSubtitle().
  4. View attributes: Facebook native ad view attributes are provided as a bundle in the extras bundle. Use extras.getBundle(FacebookAdapter.KEY_AD_VIEW_ATTRIBUTES) to get the bundle containing the attributes obtained from getAdViewAttributes(). The view attributes bundle contains the following attributes:
    • FacebookAdapter.KEY_AUTOPLAY for getAdViewAttributes().getAutoplay().
    • FacebookAdapter.KEY_BACKGROUND_COLOR for getAdViewAttributes().getBackgroundColor().
    • FacebookAdapter.KEY_BUTTON_BORDER_COLOR for getAdViewAttributes().getButtonBorderColor().
    • FacebookAdapter.KEY_BUTTON_COLOR for getAdViewAttributes().getButtonColor().
    • FacebookAdapter.KEY_BUTTON_TEXT_COLOR for getAdViewAttributes().getButtonTextColor().
    • FacebookAdapter.KEY_DESCRIPTION_TEXT_COLOR for getAdViewAttributes().getDescriptionTextColor().
    • FacebookAdapter.KEY_DESCRIPTION_TEXT_SIZE for getAdViewAttributes().getDescriptionTextSize().
    • FacebookAdapter.KEY_TITLE_TEXT_COLOR for getAdViewAttributes().getTitleTextColor().
    • FacebookAdapter.KEY_TITLE_TEXT_SIZE for getAdViewAttributes().getTitleTextSize().
    • Typeface extras are provided as a bundle inside the attributes bundle. Use the FacebookAdapter.KEY_TYPEFACE key to get the bundle containing typeface information obtained from getAdViewAttributes().getTypeface(). The typeface bundle contains the following extras:
      • FacebookAdapter.KEY_IS_BOLD for getAdViewAttributes().getTypeface().isBold().
      • FacebookAdapter.KEY_IS_ITALIC for getAdViewAttributes().getTypeface().isItalic().
      • FacebookAdapter.KEY_STYLE for getAdViewAttributes().getTypeface().getStyle().

Network-specific parameters

The Facebook adapter supports an additional request parameter for native ads which can be passed to the adapter using the FacebookExtrasBundleBuilder class. The FacebookExtrasBundleBuilder includes the following method:

  • setNativeAdChoicesIconExpandable(bool)
    • Native ads only: Facebook provides an ability to set an expandable AdChoices icon. The AdChoices icon rendered by the adapter is expandable by default.

Here's a code example of how to set these ad request parameters:

Bundle extras = new FacebookAdapter.FacebookExtrasBundleBuilder()
        .setNativeAdChoicesIconExpandable(false)
        .build();
AdRequest adRequest = new AdRequest.Builder()
        .addNetworkExtrasBundle(FacebookAdapter.class, extras)
        .build();
adLoader.loadAd(adRequest);

Ad Rendering

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

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

The Facebook adapter always includes a MediaView with native ads. For non-video ads, the media view displays the main image of the native ad.

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 the dashboard should matchup with little to no discrepancies.

发送以下问题的反馈:

此网页
AdMob for Android
AdMob for Android
需要帮助?请访问我们的支持页面