Facebook Audience
This guide is intended for publishers who want to use the Google Mobile Ads SDK to load and display ads from Facebook Audience Network via mediation.
Step 1: Set up Facebook Audience Network
The Google documentation contains a very detailed guide as to the process to setup your properties and Facebook account to display adverts.
Make sure you follow this guide closely.
- Android: https://developers.google.com/admob/android/mediation/facebook#step_1_set_up_facebook_audience_network
- iOS: https://developers.google.com/admob/ios/mediation/facebook#step_1_set_up_facebook_audience_network
Step 2: Configure mediation settings for your AdMob ad unit
You need to add Facebook to the mediation configuration for your ad unit.
- Android: https://developers.google.com/admob/android/mediation/facebook#step_2_configure_mediation_settings_for_your_ad_unit
- iOS: https://developers.google.com/admob/ios/mediation/facebook#step_2_configure_mediation_settings_for_your_ad_unit
Step 3: Import the Facebook Audience Network 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
- APM
- Manual
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.FacebookAudience
This will download and install the extension, required assets, and all dependencies.
Once complete apm
will have created something like the following file structure:
.
|____ assets
| |____ android
| | |____ audience_network.dex
| |____ ios
| | |____ Frameworks
| | | |____ [dynamic frameworks]
|____ ane
| |____ com.distriqt.admob.FacebookAudience.ane # Facebook Audience 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 theassets/android
folder to the root of your Android application package and theassets/ios
folder to the root of your iOS application package. (Theandroid
folder contains theaudience_network.dex
file that is required on Android and theios
folder contains aFrameworks
folder with the required iOS dynamic frameworks).
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.
The following guide is used to manually install the extension, download dependencies and update the application descriptor. We highly recommend installing extensions using apm
. Using apm
will automate the installation and automatically handle updates and dependencies along with greatly simplifying the application descriptor generation.
The com.distriqt.admob.FacebookAudience
ANE includes the Facebook Audience SDK and the AdMob Facebook mediation adapter. This is everything you need to get Facebook mediation working in your application.
To add the ANE download it from the repository and add it to your application:
More information on adding ANEs in this tutorial
Dependencies
Android Support
The Android Support libraries encompass the Android Support, Android X and common Google libraries.
These libraries are specific to Android. There are no issues including these on all platforms, they are just required for Android.
This extension requires the following extensions:
You can access these extensions here: https://github.com/distriqt/ANE-AndroidSupport.
Application Descriptor
- APM
- Manual
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.
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
Extension IDs
The following should be added to your extensions
node in your application descriptor to identify all the required ANEs in your application:
<extensions>
<extensionID>com.distriqt.admob.FacebookAudience</extensionID>
<extensionID>org.jacoco</extensionID>
<extensionID>org.ow2.asm</extensionID>
<!-- ADVERTS EXTENSIONS -->
<extensionID>com.distriqt.Adverts</extensionID>
<extensionID>com.distriqt.Core</extensionID>
<extensionID>com.distriqt.playservices.Base</extensionID>
<extensionID>com.distriqt.playservices.Ads</extensionID>
<extensionID>com.distriqt.playservices.AppSet</extensionID>
<extensionID>androidx.appcompat</extensionID>
<extensionID>androidx.browser</extensionID>
<extensionID>androidx.core</extensionID>
<extensionID>androidx.constraintlayout</extensionID>
<extensionID>androidx.vectordrawable</extensionID>
<extensionID>androidx.room</extensionID>
<extensionID>androidx.work</extensionID>
<extensionID>com.google.code.gson</extensionID>
<extensionID>com.google.guava</extensionID>
<extensionID>com.jetbrains.kotlin</extensionID>
</extensions>
Android
There is an assets
directory alongside the extension in the repository 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.
Add the audience_network.dex
file to the root of your application package.
(This file is located in the repository, this must be the same version as the extension,
i.e. if you update the extension ensure you update this file).
Manifest Additions
Add the following to your manifest additions, ensuring you only have one application
tag in your additions.
Ensure you replace:
APPLICATION_PACKAGE
with your AIR application's Java package name, something likeair.com.distriqt.test
. Generally this is your AIR application id prefixed byair.
unless you have specified no air flair in your build options.
<queries>
<package android:name="com.facebook.katana" />
</queries>
<application>
<activity
android:name="com.facebook.ads.AudienceNetworkActivity"
android:configChanges="keyboardHidden|orientation|screenSize"
android:exported="false"
android:theme="@android:style/Theme.Translucent.NoTitleBar" />
<provider
android:name="com.facebook.ads.AudienceNetworkContentProvider"
android:authorities="APPLICATION_PACKAGE.AudienceNetworkContentProvider"
android:exported="false" />
</application>
iOS
Dynamic Frameworks
We have been able to switch to the static version of the Facebook Audience framework.
This means you must remove the FBAudienceNetwork.framework
from your Frameworks
FileSystemDirectoryReader.
Info Additions
Add the following to your info additions. If you already have an SKAdNetworkItems
then append the dict
items to the array
.
<key>SKAdNetworkItems</key>
<array>
<dict>
<key>SKAdNetworkIdentifier</key>
<string>v9wttpbfk9.skadnetwork</string>
</dict>
<dict>
<key>SKAdNetworkIdentifier</key>
<string>n38lu8286q.skadnetwork</string>
</dict>
</array>
You should only have one SKAdNetworkItems
entry. If you have multiple extensions adding these values you must combine them into a single array.
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.
Facebook Testing
You will need to enable testing in your Facebook account, by adding your test device and enabling an test advert type to serve the device.
See the Testing Audience Network Implementation guide for detailed instructions on how to enable Facebook test ads.
Forcing Mediation Network
The easiest way we have found to force a mediation network during testing is to disable automatic optimisations and set the eCPM manually.
Doing this you can give the mediation network you are wanting to test a high eCPM value ( eg $1000) and all others (including AdMob) a very low eCPM (eg $0.01).