Facebook Audience Network Mediation Integration Guide

Before You Start
Make sure you have correctly integrated ironSource’s InterstitialRewarded Video or Banner Mediation in your application.

Step 1. Create a Facebook Account

  • First Time Setup
    • Go to Facebook for Developers and register with your Facebook account.
    • Follow the procedure and set your application name.
    • Click ‘Register‘.

10

  • Registered Users
    • Sign into your Facebook account.
    • On the right sidebar you will see ‘My Apps’. Click on Your app.

11

Step 2. Create Business

A Business is the top entity through which you can manage your business on Facebook including Facebook advertising and Audience Network monetization. To create your business go to Monetization Manager

Step 3. Create Property

A Property in Monetization Manager is a group of products with the same brand. If you have different products for different operating systems, platforms or devices, you can group them into a Property for combined reporting and management in Monetization Manager.

  1. Go to Monetization Manager
  2. Choose your business or create a new business
  3. Click Create Property +
    1
  4. Name your Property based on the brand for the group of apps or websites you’ll be adding to it
  5. Click Create Property
    2

Step 4. Choose your Platform and display format

Choose your platform and display format

Platforms are the various types of products and surfaces you can monetize with Audience Network.
After you created your property your next step is to add the platform you want to monetize:
3

Step 5. Create Ad Space

Ad Spaces help you organize ad placements in a way that accurately reflects what a person is doing when they see an ad in your app. To create an ad placement, you’ll need to create an Ad Space first. You can create up to 4 Ad Spaces per platform.

  1. Go to Monetization Manager.
  2. Search for your Property in the search bar using your property name or property ID, then click on Manage Property next to the Property you want to create an Ad Space for.
  3. Select the Platform for where you want to create an Ad Space. If the Platform you want to use does not exist, click on Add Platforms (located on the upper right hand corner) to create it.
    4
  4. Add a video and description of when your ad would be triggered. Click Create Ad Space.
    5
  5. Now that you’ve created your Ad Space, you can create ad placements by clicking on the edit icon and Create placement.

    6

Step 6. Create Ad Placement

Audience Network offers different types of ad units. Each ad unit in your app or mobile website is identified using a unique placement ID.

  1. Go to Monetization Manager.
  2. Find and select the Property for which you want to create an ad placement. Click Manage Property on the right.
  3. Scroll down to the Placements section and click Create placement.
    7
    you can also create ad placements by clicking on the edit icon and Create placement as mentioned on Step 5.5 above.
  4. Type in your placement name, select the Ad Space, select the ad Display format and add an optional description.
    8
  5. Choose how you want to optimize your ad placement. The optimization determines how we run the auction for each impression on your app or site:

    9
  6. Click Create placement to finish.
     Note: An ad placement can only be used by one Ad Space and needs to match the same platform as the Ad Space. 

     

    Add Placements to Your App

    1. Go to Monetization Manager.
    2. Click on Managed property
    3. Click on Ad Spaces then scroll down to Placements, or filter to find the placement that you need
    4. In the Placement ID column click Get Code or Copy ID
      9

     Note: Your app won’t be able to receive Audience Network ads until payout information has been added and it was sent for review.

    Step 7. Activate Facebook on the ironSource SDK Network Module

    There are 3 pieces of Data from the Facebook Audience Network account which need to be inserted into your ironSource Network Setup Module in order for Facebook Audience Network to work correctly in connection with ironSource:

    App ID This is the unique identifier of your app in Facebook Audience Network’s system.
    Placement ID  This is the unique identifier of a specific placement in your app in Facebook Audience Network’s system.
    System User Access Token The user token is the most commonly used type of token. This kind of access token is needed any time the app calls an API to read, modify or write a specific person’s Facebook data on their behalf. 

    Once you obtain this information, you must configure Facebook Audience Network’s Parameters in your ironSource Account. By adding the above information correctly, you will be able to take full advantage of Facebook’s Interstitial or Banner ad inventory and reporting data on ironSource’s Mediation platform.

    1. App ID
      1. To retrieve your app ID, hover over ‘≡’ in the upper-left corner, and click on ‘App Dashboard’:
        9-facebook-access-to-appid
      2. Choose the application of which you want to see the App ID. this will navigate you to your Facebook Audience Network dashboard. there you should see the specific App ID located on the center of the upper bar
        9-facebook-appid
    2. System User Access Token
      To retrieve your System User Access Token, please follow Facebook’s Guide. On Step 3. make sure you to check read_insights as well as read_audience_network_insights in Available Scopes.
    3. Placement ID
      1. To retrieve your Placement ID, click on ‘Audience Network’ on the left sidebar in the dashboard
      2. you should be asked to navigate to ‘Monetization Manager’, click on the link:
        9-facebook-access-to-placementid
      3. Under your application review you find a list of your placements, click on the one you want to retrieve it’s PlacementID
        10-facebook-monetization-manager
      4. Now click over the ‘Get Code’ and there you will find your ID
        11-facebook-get-placement-id

    Configure Facebook’s Parameters into ironSource Account

    • Once you have all these parameters, log in to your ironSource account and go to ‘Monetize‘ ➣ ‘Setup‘ ➣ ‘SDK Networks‘.
      iron-source-networks
    • Select Facebook from the list of Available Ad Networks and click on ‘Activate’.
      Note: To run Mediation with Facebook, you must have an active Facebook Audience Network Account. When you select Facebook as a network, you will see the below pop-up. If you have an active Facebook account, simply click activate and Save. If you do not have an active Facebook account, you must register at Facebook Audience Network and follow this documentation from Step 1.
      12
    • Select the app on which you’d like to run ironSource‘s Interstitial, Rewarded Video or Banner Mediation with Facebook.13
    • Select Facebook Audience Network from the Setup list of Ad Networks, click on the Define icon and insert the App ID, Placement ID and System User Access Token in the relevant fields.9-facebook-system-user-access-token
    • Then click ‘Save’, you will then see Facebook as Active for the ad unit of choice on your Mediation Dashboard.

      facebook-network-in-list-verified
    • Verify your integration with the Reporting API; this column will check your integration through the Reporting API and return three possible responses: Verified, Failed and No Response. Double check your integration and the information you entered above; then click ‘Retry‘ until you see ‘Verified’.

    Step 8. Add the Facebook Adapter to Your Build

    Adobe Air Plugin

    1. Download the Facebook ANE
      Add the Facebook Adobe Native Extension to your build. You can find the latest Facebook ANE here.
    2. Add the Facebook ANE to Your Project
      1. To add the ANE, simply add it to your project by clicking on project properties ➣ Flex build path ➣ Native Extension Tab. Click on add ANE and choose file you have downloaded in the previous step.
      2. Make sure you mark the ANE to be packaged into your application on Flex Build Packaging  Native Extension Tab, select the checkbox of ‘package‘.
      3. For Android Users Only
        Update AndroidManifest.xml

        Manifest Activities
        Add the following activities inside the <application> tag in your manifest:

        <!-- Facebook -->
        <activity
                android:name="com.facebook.ads.InterstitialAdActivity"
                android:hardwareAccelerated="true"
                android:configChanges="keyboardHidden|orientation|screenSize" />
        <activity
                android:name="com.facebook.ads.AudienceNetworkActivity"
                android:hardwareAccelerated="true"
                android:configChanges="keyboardHidden|orientation|screenSize" />

    Verify Your Ad Network Integration
    The ironSource SDK provides an easy way to verify that your mediation integration was completed successfully. To verify your ironSource and additional Ad Networks integration, follow this document.

     Note: if you are using Facebook Audience Network’s server-to-server callbacks and are leveraging the DynamicUserID parameter to verify AdRewarded events, you will see this parameter reflected in their server-side callbacks. In addition, you can also see this parameter in the ironSource server-to-server callbacks.

    Done!
    You are now all set to deliver Facebook Audience Network Ads through the ironSource Mediation platform!


    What’s Next?
    To leverage additional ad networks through ironSource Mediation, integrate the adapters and follow our integration guides.