##Who Can Use the Plugin

To use the plugin, you need to be a SpotX publisher and have an active account with MoPub.

Become a SpotX Publisher

If you are not already a SpotX publisher, click here to apply.

Create a MoPub Account

If you don't yet have a MoPub account, click here to sign up.

What the Plugin Does

The plugin allows the SpotX SDK and the MoPub SDK to communicate with each other seamlessly. To use this new plugin, SpotX publishers will need to integrate the SpotX SDK and the MoPub SDK into their App.

How to Install the Plugin

There are two ways to install this plugin:

CocoaPods (preferred)

Simply add the following to your Podfile.

pod 'SpotX-MoPub-Plugin'

Source Code

Download the source code and import it in your Xcode project. The project is available from our Github repository.

Configuration

Use the custom data field to pass configuration parameters to the SpotX plugin. Additional details are available in the documentation for MoPub Custom Events. The custom data is a JSON object with the following required keys:

• channel_id - Your SpotX publisher channel ID
• iab_category - IAB category used to classify your app
• iab_section - IAB category subsection used to classify your app
• appstore_url - URL to your app in the Apple App store.
• app_domain - Internet domain for your app's website

In addition to the required properties, you may also include any of the following optional keys (*default value in parenthesis):

• use_https - (false) All network requests will be done over HTTPS
• use_native_browser - (true) If false, ad interactions will be displayed in an internal browser rather than the system default
• allow_calendar - (false) Allow ads to create calendar events
• allow_phone - (false) Allow ads to initiate a phone call
• allow_sms - (false) Allow ads to author an SMS message
• allow_storage - (false) Allow ads to store images
• skippable - (false) Request ads that are skippable
• trackable - (true) Disable ad tracking
• params - (undefined) A hash of key-value strings that are passed-through in the ad request

Get step-by-step instructions on how to specify parameters through the MoPub UI in MoPub'a Ad Network Documentation.

Rewarded Video

Getting Started with Rewarded Video

Before integrating the SpotX custom event class library for MoPub rewarded video, please review the Rewarded Video for iOS Documentation.

Follow the instructions in the Basic Integration section of the documentation. If you have already installed the SpotX-MoPub-Plugin, you will have completed step one of the integration process.

Rewarded Video - Mediation Settings

Mediation settings may be used to pass additional configuration parameters to the SpotX network during the rewarded video initialization call.

The SpotX Rewarded Video interface currently only supports instance mediation settings. The current SpotX mediation settings class contains the following parameter:

• channel_id - Your SpotX publisher channel ID

The following code snippet demonstrates how to use the SpotX mediation settings object.

-(void) loadRewardedVideo {
    // Initialize rewarded video before loading any ads.
    [[MoPub sharedInstance] initializeRewardedVideoWithGlobalMediationSettings:nil delegate:self];
    
    // Create the SpotX Mediation Settings object
    SpotXInstanceMediationSettings * settings = [[SpotXInstanceMediationSettings alloc] init];
    
    // Set the SpotX channel ID
    settings.channel_id = @"[SpotX publisher channel ID]";

    // Fetch the rewarded video ad.
    [MPRewardedVideo loadRewardedVideoAdWithAdUnitID:@“[Placeholder Ad Unit ID]“ withMediationSettings:settings];
}
    

For a more detailed example of using the SpotX-MoPub-Plugin, checkout our SpotX-MoPub Integration Testing App for iOS on GitHub.