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 waterfall and Open Bidding mediation. It covers how to add Facebook ads to an ad unit's mediation configuration 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) | |
Open Bidding1 |
1 Open Bidding is currently in a limited beta. Please reach out to your account manager for more information.
Requirements
- Unity 5.6 or higher
- Latest Google Mobile Ads SDK
- [For Open Bidding]: Google Mobile Ads mediation plugin for Facebook 2.11.0 or higher
- To deploy on Android
- Android API level 16 or higher
- To deploy on iOS
- iOS deployment target of 9.0 or higher
- The latest Facebook Audience Network SDK usually requires the latest version of Xcode.
- A working Unity project configured with Google Mobile Ads SDK. See Get Started for details.
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.
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.
Waterfall
Open Bidding
The next step presents an overview of the placement you created. Take note of the Placement ID under the Add placement ID section. Additionally, you will also need your System User Access Token. Simply click the Generate Token button under the Add system user access token section to generate it. You will need both the Placement ID and the System User Access Token when you set up your ad unit ID.
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.
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
Waterfall
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.
Open Bidding
In the Ad Sources card, select Add Ad Network. Select Facebook Audience Network (Open Bidding). Enter the Placement ID obtained in the previous section and 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
Waterfall
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.
Open Bidding
In the Ad Sources card, select Add Ad Network. Select Facebook Audience Network (Open Bidding). Enter the Placement ID obtained in the previous section and 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
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.
Then, select Assets > Play Services Resolver > Android Resolver >
Force Resolve. The Unity Play Services Resolver library will perfrom
dependency resolution from scratch and copy the declared dependencies into the
Assets/Plugins/Android
directory of your Unity app.
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.
Error codes
If the adapter fails to receive an ad from the Facebook Audience Network,
publishers can check the underlying error from the ad response using
ResponseInfo
under the following classes:
Android
com.google.ads.mediation.facebook.FacebookAdapter
com.google.ads.mediation.facebook.FacebookMediationAdapter
iOS
GADMAdapterFacebook
GADMediationAdapterFacebook
Here are the codes and accompanying messages thrown by the Facebook Audience Network adapter when an ad fails to load:
Android
Error code | Reason |
---|---|
101 | Invalid server parameters (e.g. missing Placement ID). |
102 | The requested ad size does not match a Facebook Audience Network supported banner size. |
103 | The publisher must request ads with an Activity context. |
104 | The Facebook Audience Network SDK failed to initialize. |
105 | The publisher did not request for Unified native ads. |
106 | The native ad loaded is a different object than the one expected. |
107 | The Context object used is invalid. |
108 | The loaded ad is missing the required native ad assets. |
109 | Failed to create a native ad from the bid payload. |
110 | The Facebook Audience Network SDK failed to present their interstitial/rewarded ad. |
111 | Exception thrown when creating a Facebook Audience Network AdView object. |
1000-9999 | The Facebook Audience Network returned an SDK-specific error. See Facebook's documentation for more details. |
iOS
Error code | Reason |
---|---|
101 | Invalid server parameters (e.g. missing Placement ID). |
102 | The requested ad size does not match a Facebook Audience Network supported banner size. |
103 | The Facebook Audience Network ad object failed to initialize. |
104 | The Facebook Audience Network SDK failed to present their interstitial/rewarded ad. |
105 | Root view controller of the banner ad is nil . |
106 | The Facebook Audience Network SDK failed to initialize. |
1000-9999 | The Facebook Audience Network returned an SDK-specific error. See Facebook's documentation for more details. |
Facebook Unity Mediation Plugin Changelog
Version 3.2.0
- Supports Facebook Android adapter version 6.2.0.1.
- Supports Facebook iOS adapter version 6.2.1.0.
Version 3.1.0
- Supports Facebook Android adapter version 6.2.0.0.
- Supports Facebook iOS adapter version 6.2.0.0.
Version 3.0.0
- Supports Facebook Android adapter version 6.1.0.0.
- Supports Facebook iOS adapter version 6.0.0.0.
Version 2.12.0
- Supports Facebook Android adapter version 5.11.0.0.
- Supports Facebook iOS adapter version 5.10.1.0.
Version 2.11.1
- Supports Facebook Android adapter version 5.10.1.0.
- Supports Facebook iOS adapter version 5.10.1.0.
Version 2.11.0
- Supports Facebook Android adapter version 5.10.0.0.
- Supports Facebook iOS adapter version 5.10.0.0.
Version 2.10.0
- Supports Facebook Android adapter version 5.9.1.0.
- Supports Facebook iOS adapter version 5.9.0.1.
Version 2.9.2
- Supports Facebook Android adapter version 5.9.0.2.
- Supports Facebook iOS adapter version 5.9.0.1.
Version 2.9.1
- Supports Facebook Android adapter version 5.9.0.1.
- Supports Facebook iOS adapter version 5.9.0.1.
Version 2.9.0
- Supports Facebook Android adapter version 5.9.0.0.
- Supports Facebook iOS adapter version 5.9.0.0.
Version 2.8.1
- Supports Facebook Android adapter version 5.8.0.1.
- Supports Facebook iOS adapter version 5.8.0.2.
Version 2.8.0
- Supports Facebook Android adapter version 5.8.0.0.
- Supports Facebook iOS adapter version 5.8.0.1.
Version 2.7.1 (Deprecated, use 2.8.0 or newer)
- Supports Facebook Android adapter version 5.7.1.0.
- Supports Facebook iOS adapter version 5.7.1.1.
Version 2.7.0 (Deprecated, use 2.8.0 or newer)
- Supports Facebook Android adapter version 5.7.0.0.
- Supports Facebook iOS adapter version 5.7.0.0.
Version 2.6.1 (Deprecated, use 2.8.0 or newer)
- Supports Facebook Android adapter version 5.6.1.0.
- Supports Facebook iOS adapter version 5.6.1.0.
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.