SDK Beta Program

SDK 5.1.0-beta

The Beta is currently closed. See below for information on the Rewards Program.

What's New?

Highlights

  • New AdOptions view for Native Ads
  • Reporting Flow for Native Ads.
  • Added multi-process support for Interstitial and Rewarded Video formats.
  • Added new Interstitial design for Mobile App Install ads.
  • Refactored and updated Dynamic Framework.

The SDK Beta Program gives Developers a first look at the latest features and advancements from the Facebook Audience Network SDK.

The Beta period will last approximately one month before the general availability release of each major SDK. During this period, Developers using the Beta SDK will be eligible to receive various rewards.

Why use the Beta SDK?

  • First look at the latest features from the Audience Network
  • Rewards program with Facebook Advertising Credits
  • Access to closed Developer Community, with the Audience Network Team

The Beta SDK has been through the same testing and quality cycles as any other SDK from Facebook Audience Network.

How to use the Beta SDK?

In order to use the Beta SDK, please sign up for the SDK Beta Program in Monetization Manager.

  1. Go to Monetization Manager.
  2. Click Monetisation settings > SDK Beta.
  3. Agree to the Audience Network Beta SDK Terms
  4. Follow the installation guides below to download and install the Beta SDK.

All other instructions can be found in the general Android and iOS developer guides, unless stated below.

Beta Terms

By using the Audience Network Beta SDK, you acknowledge that you have read, understood, and agree to the Audience Network Beta SDK Terms.


Rewards

How to claim rewards in the Beta

Participants in our SDK Beta program can claim Facebook Ads Credits for delivering impressions and submitting bugs.

Impressions rewards

  1. Deliver 5 million impressions during the one-month Beta period.
  2. Deliver 7.5 million impressions on any of these formats over the 1-month beta period:
  • iOS Rewarded Video
  • Android Rewarded Video
  • iOS Interstitial
  • Android Interstitial

Bug bounty

Whilst the Beta SDK has been through the same testing and quality cycles as any other Facebook Audience Network SDK, we acknowledge that there may be undetected issues. If you find such an issue, then you may be eligible for the bug bounty reward.

  1. Submit a verified and validated bug during the 1-month beta period

Please visit the SDK Beta Page in Monetization Manager to submit a bug.

Submit a Bug

Android

Android installation Guide

See the Getting Started guide for more information on integrating the Audience Network Android SDK.

Maven (Preferred Download Method)

Add this to Module-level /app/build.gradle before dependencies:

repositories {
  // You can also use jcenter if you prefer
  mavenCentral() 
}

Add the compile dependency with the latest version of the Facebook SDK in the build.gradle file:

dependencies { 
compile 'com.facebook.android:audience-network-sdk:5.1.0-beta'
}

Manual Download

Package Date

Audience Network SDK 5.1.0-beta

October 8, 2018

What's New in 5.1.0-beta

  • Added AdOptionsView for Native ads which provides greater flexibility.
  • Added multi-process support for Interstitial and Rewarded Video formats.
  • Added initialization method to the SDK.
  • Added Integration Error Mode setting, which will throw an exception in debug mode when the SDK is used incorrectly.

AdOptions View

In SDK 5.1.0-beta, we have introduced the AdOptionsView as a preferred alternative to the AdChoicesView. This view can be placed in any location within your Native Ad Layout. Additionally, the icons' color is customizable.

To use this view, you will need to add a container for your Native Ad. The container should be a com.facebook.ads.NativeAdLayout which is a wrapper on top of a FrameLayout.

In your Layout, add the NativeAdLayout.

<com.facebook.ads.NativeAdLayout
    android:id="@+id/native_ad_container"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:orientation="vertical" />

Then, when constructing and displaying your Native Ad.

// Add the AdOptionsView
LinearLayout adChoicesContainer = findViewById(R.id.ad_choices_container);
AdOptionsView adOptionsView = new AdOptionsView(NativeAdActivity.this, nativeAd, nativeAdLayout);
adChoicesContainer.removeAllViews();
adChoicesContainer.addView(adOptionsView, 0);

Init method

We are introduce an initialization method in 5.1.0. This function is optional, but will become mandatory in SDK 5.2.0 onwards.

In order to ensure the Audience Network SDK functions correctly, we strongly recommend using the init function, which ensures that ad delivery and measurement will not be impacted. This method needs to be called once, ideally from your Application, or in the onCreate() method in the activity which contains your ads.

public class YourApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        AudienceNetworkAds.initialize(this);
    }
}

Multi-process Support

Interstitial and Rewarded Video Ad formats may now run on a separate process. This ensures that any problems which occur in the SDK, do not affect your application.

In order to disable this feature, please use the following method.

AdInternalSettings.setMultiprocessSupportMode(MultiprocessSupportMode.
                                              MULTIPROCESS_SUPPORT_MODE_OFF);

If your app uses a custom subclass of the Android Application class, you need to add the following snippet in your onCreate() method. Multi-process support will not work unless this is included.

public class YourApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        AudienceNetworkAds.initialize(this);

        if (AudienceNetworkAds.isInAdsProcess(this)) {
            return;
        }
        
        // Your default application initialization code
    }
}

Integration Error Mode setting

This method allows you to control your app's behavior under conditions where the SDK is used incorrectly.

  • INTEGRATION_ERROR_CRASH_DEBUG_MODE: App will crash if your build has Android FLAG_DEBUGGABLE, otherwise INTEGRATION_ERROR_CALLBACK_MODE will be used.
  • INTEGRATION_ERROR_CALLBACK_MODE: App will call AdListener.onError(Ad, AdError) callback if an integration error is discovered.
// Example for setting the SDK to crash when in debug mode
AdSettings.setIntegrationErrorMode(INTEGRATION_ERROR_CRASH_DEBUG_MODE);

Integration with third-party mediation platforms

Adapters published in Bintray are not built with the Beta SDK. It is discouraged to use them, follow the steps below to integrate the Beta SDK with a mediation platform.

Using the Beta with AdMob mediation

  • Follow the Android Installation guide to add the Beta SDK to your project.
  • Download adapter file, extract it and add the facebook-admob-adapter.aar to your project.

Using the Beta with MoPub mediation


iOS

iOS installation Guide

See the Getting Started guide for more information on integrating the Audience Network SDK for iOS.

Using Cocoapods

  1. Add the following line to your project's Podfile: pod 'FBAudienceNetwork', '~> 5.1.0-beta'
  2. Run pod install.

Manual Download

Package Date

Audience Network SDK 5.1.0-beta

October 8, 2018

What's New in 5.1.0-beta

  • Added FBAdOptionsView for Native ads which provides greater flexibility.
  • Added new Interstitial design for Mobile App Install ads.
  • Refactored and updated Dynamic Framework.

AdOptions View

In SDK 5.1.0-beta, we have introduced the FBAdOptionsView as a preferred alternative to the adChoicesView. This view can be placed in any location within your Native Ad UIView. Additionally, the foreground and background colors are customizable.

        // self.adChoicesView.nativeAd = self.nativeAd;
        // self.adChoicesView.corner = UIRectCornerTopRight;
        self.adOptionsView.nativeAd = self.nativeAd;
    }
}

Integration with third-party mediation platforms

Adapters published in Cocoapods are not built with the Beta SDK. It is discouraged to use them, follow the steps below to integrate the Beta SDK with a mediation platform.

Using the Beta with AdMob mediation

  • Follow the iOS Installation guide to add the Beta SDK to your project.
  • Download adapter zip, extract it and add FacebookAdapter.framework to your project.

Using the Beta with MoPub mediation