Meta Audience Network 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 Meta account

  • First time setup
    • Go to Meta for Developers and register with your Meta account.
    • Follow the procedure and set your application name.
    • Click ‘Register‘.

Meta for Developers homepage

  • Registered users
    • Sign into your Meta account.
    • On the right sidebar click on ‘My Apps’.

  • Choose your app

Step 2. Create Business

A Business is the top entity through which you can manage your business on Meta including Meta 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 +

  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

Step 4. 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:

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. Add a video and description of when your ad would be triggered. Click Create Ad Space.

  5. Now that you’ve created your Ad Space, you can create ad placements by clicking on the edit icon and Create placement.


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 
      9
    5. Copy the Placement ID until the underscore (_). You’ll need this later for the App ID parameter on LevelPlay
    6. Copy the entire Placement ID. You’ll need this later for the Placement ID parameter on LevelPlay

    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 Meta Audience Network on the ironSource platform

    Complete the following steps to activate Meta Audience Network as a mediated network on LevelPlay. You’ll be required to add the app ID parameter on the app level and the placement ID on the instance level.

    • Log into your ironSource account and go to ‘Monetize‘ ➣ ‘Setup‘ ➣ ‘SDK Networks‘.
    • Click on Manage Networks to open the following list

    • Select Meta Audience Network from the list of available ad networks
    • Click Login with Facebook 

    • Login with your approved Meta developer account
      Important!
      To get access to the application reporting API, make sure the logged-in user is connected to all applications in Meta business settings (as described at the end of this article)

       

    • Enable read Audience Network insights

    Note: Once you approve the permissions, your ironSource account will be authorized to call the Meta Audience Network Reporting API.

    • Select the app where you’d like to run interstitial, rewarded video, or banner ads from Meta Audience Network

    • Select Meta Audience Network from the Setup list of Ad Networks, click on the Define icon and insert the App ID and Placement ID in the relevant fields. See step 6

    Click ‘Save’, you will then see Meta Audience Network as Active for the ad unit of choice on your Mediation Dashboard.

    Important!  To get access to the application reporting API, make sure the app/property (only one is required) is connected to the logged-in user. Connecting the app/property is done on the Meta for Developers platform.This step is required whenever you add a new application to the mediation platform

     

     To connect a property to the logged-in user:

    1. Go to Business settings
    2. Click Users then People in the side menu
    3. Search for the user you want to be linked to the relevant properties 
    4. Click the 3 dots and then Add Assets
    5. In the pop-up, select Properties 
    6. Click all the assets you want to link
    7. Under Full Control, toggle on Manage Property then click Save Changes

    That’s it! You’ve completed the one-time login needed to access Meta Audience Network reporting on LevelPlay. 

    As long as your Meta developer account remains active, with at least 1 application generating impressions, no additional action is required on the platform

    If you’re asked to log in again because of a session timeout or for any other reason, follow these steps:

      • From the SDK Networks page, select Meta Audience Network from the list of available ad networks
      • Click Reset login
      • Repeat the login process outlined above
      • Make sure to log in with your approved Meta developer account

      Step 8. Add the Meta Audience Network adapter to your build

      Unity Integration Manager (Recommended)

      Once you’ve completed SDK integration, you can download Meta Adapter, using the Unity Integration Manager.

      In your Unity Development platform, go to ironSource > Integration Manager

      If you already have the latest version of the adapters, the action button will be changed to “Updated”, and will be disabled.

      Android (Manual Resolve)

      To apply your changes, make sure you use the “Resolve” process. This will download all relevant artifacts, according to your choices. For detailed information see instructions here

      Android Plugin Manual Integration

      1. Download the Meta Audience Network adapter:

        Download adapter and SDK (AAR) from here.

      2. Add the Meta Audience Network files to your Unity project:
        Import adapter and SDK files into Assets/Plugins/Android.

      3. Update your manifest

        Manifest Permissions:
        <uses-permission android:name="android.permission.INTERNET"/>

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

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

      For Proguard Users Only (Android)

      If you are using ProGuard with the Meta adapter, you must add the following code to your ProGuard file:

      -dontwarn com.facebook.ads.internal.**
      -keeppackagenames com.facebook.*
      -keep public class com.facebook.ads.** {*;}
      -keep public class com.facebook.ads.**
      { public protected *; }
      Disclaimer: Plugin version 6.7.1

      To accommodate changes in Unity version 5.5, the ironSource Plugin version 6.7.1 requires Android Manifests to be added separately to the Plugin and mediation adapter. If you are updating your plugin or currently running on 6.7.1, make sure to add the manifest activities noted in the Android documentation.

      iOS Plugin Manual Integration

      1. Download the Meta Adapter and SDK:

        Download the adapter and SDK (XCFrameworks) from here.

      2. Add the Meta files to your Unity project:
        Import adapter and SDK files into Assets/Plugins/iOS.
      3. As of SDK 5.0.1 (ironSource FAN adapter V4.3.1) onwards, Meta Audience Network does not support devices running iOS version smaller than 9.

      Additional paths

      In case your project does not include Swift, make sure to add the following paths to the target’s Build Settings:

        1. Add the following paths under Library Search Paths:
          $(TOOLCHAIN_DIR)/usr/lib/swift/$(PLATFORM_NAME)
          $(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME)
          /usr/lib/swift
        2. Add the following path under Runpath Search Paths:
          /usr/lib/swift

      Step 9. Additional Meta settings

      CacheFlag Configuration – For Android Only

      ironSource enables you to report Meta CacheFlag values for interstitial ads, starting from Meta adapter version 4.3.20+.

      Define the CacheFlag  before the Init to set a single value, using “Meta_IS_CacheFlag” setting:

       IronSource.Agent.setMetaData("Facebook_IS_CacheFlag","IMAGE");

      The supported values are as follows: ICON, IMAGE, NONE, VIDEO or ALL to apply all values.

      More information about Meta CacheFlag values can be found here.

      COPPA and Mixed Audience Support 

      ironSource enables you to report Meta Mixed Audience flag, starting from Meta adapter version 4.3.46+.

      The flag was introduced by Meta as part of their COPPA best practices , and should be set to “true” when relevant.

       IronSource.Agent.setMetaData("Meta_Mixed_Audience","true");

      CCPA Support 

      If you are using Meta adapter 4.3.24+, make sure to follow Meta Audience Network instructions, as described here. Please note that setting FAN Limited Data Use flag, should be done before initializing ironSource Mediation. 

      iOS 14+ Support 

      If you are using Meta adapter 4.3.30+, and building for iOS14+, FAN requires you to set the setAdvertiserTrackingEnabled flag. This allows you to inform Meta whether to use the data to deliver personalized ads. If the flag is set to false FAN will not be able to deliver personalized ads. 

      Please note that setting the setAdvertiserTrackingEnabled flag should be done before initializing ironSource Mediation. Learn more about Advertising Tracking Enabled for Audience Network here

      In addition, make sure you follow Meta Audience Network instructions for iOS14, as described here.

      Important! When integrating FAN API’s SetDataProcessing or setAdvertiserTrackingEnabled make sure to add FAN Unity SDK to your Unity Project. You can download the SDK from here

      Verify your ad network integration

      • Verify your ad network integration with our Integration Helper. The ironSource SDK provides a tool to ensure you’ve successfully integrated our SDK as well as any additional network adapters.
      • Manage the debug logs for your integrated mediation ad networks with this boolean
        IronSource.Agent.setAdaptersDebug(true);

        When set to TRUE, this line of code will enable debug logs to help you troubleshoot issues with all of the mediation ad networks that permit to do so.  Remove this code before your app goes live with our ad units! Supported for SDK versions 6.5.2 and up.

      Note: if you are using Meta 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 Meta 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.