Code Integration for iOS

Get started with Prebid Mobile by creating a Prebid Server account. Once your account is set up include the Prebid Mobile SDK in your app by either using Cocoapods or by cloning the repo and using our included script to build the SDK.

Include with Cocoapods

If you are not familar with using Cocoapods for dependency management visit their getting started page. Once you have your podfile setup, include the following:

platform :ios, '11.0'

target 'MyAmazingApp' do
    pod 'PrebidMobile'
end

Build framework from source

Build Prebid Mobile from source code. After cloning the repo, use Terminal or another command line tool, change to the root directory and run:

./scripts/buildPrebidMobile.sh

This will output the PrebidMobile.framework.

Setup Prebid Server Account

In order to conduct header bidding within your app you will need a Prebid Server hosted account. There are two options available for publishers:

  1. The simplest option is to sign up for a hosted solution. Several Prebid.org members provide hosting packages.

  2. Implement your own Prebid Server solution. You will need to download the source code from Github. The repository has full instructions for configuring, deploying, and testing your implementation.

Once you have a Prebid Server account, you will need to add your account credentials to the app.

Prebid.shared.prebidServerAccountId = @"YOUR_ACCOUNT_ID";
Prebid.shared.prebidServerHost = PrebidHostAppnexus;

If you have opted to host your own Prebid Server solution you will need to store the url to the server in your app.

Prebid.shared.setCustomPrebidServer(url:URL_STRING_TO_SERVER)

Integrate Ad Servers With Your App

Integrating MoPub with your application

  1. Go to MoPub.com and register for a MoPub account . If you already have an account with them, you can log in.

  2. After the registration you will be automatically prompted to set up a new MoPub application required for integrating mobile ads to your application.

Integrating Google with your application

Go to Google’s developer site and follow the instructions for integrating their Mobile Ads SDK into your app.

Set Targeting Parameters (Optional)

Targeting parameters enable you to define the target audience for the bid request. Prebid Mobile supports the following global targeting parameters. These targeting parameters are set only once and apply to all Prebid Mobile ad units. They do not change for a given user session.

View the full list of targeting parameters.

Create Ad Units

Banner and interstitial ad units can be created:

let bannerUnit = BannerAdUnit(configId: "6ace8c7d-88c0-4623-8117-75bc3f0a2e45", size: CGSize(width: 300, height: 250))

For details on creating the specific ad units and additional parameters and methods associated with each view the documentation pertaining to them:

Banner Ad Unit
Interstitial Ad Unit

Add Custom Keywords

Once an ad unit has been instantiated, custom keywords can be added to it to improve its targeting.

bannerUnit.addKeyword(key:"Sample", value:"Value to add")

For more details on custom keywords, review the adUnit class documention.

Further Reading