iOS

Pre-Requisites

To successfully use the SDK, make sure that the following steps are completed:

  • All of your Bundle IDs you plan to use during testing and production are registered by SOM (contact your publisher manager)
  • Obtain your page domain mapping (please refer to your publisher manager to get your mapping)

Install SevenOneAds Pod

  • Make sure you have Cocoapod installed
  • Open your Podfile
  • Add the SevenOneAds pod
pod 'SevenOneAds'
  • Install the pod
pod install --repo-update

Update your Info.plist

For the SDK to work, you also need to update your Info.plist file. Full documentation from Google can be found here. Add the following key/value to your Info.plist:

<key>GADIsAdManagerApp</key>
<true/>

Initialise SDK

We recommend to initialise the SDK in the AppDelegate -> didFinishLaunchingWithOptions() to ensure the ads are available as soon as possible.

  • Import the SDK to your project: import SevenOneAds
  • To initialise and configure the SDK, create a SevenOneAdsSettings object and initialise the SDK:
let settings = SevenOneAdsSettings(pageTopDomain: <pageTopDomain>,
                                   pageSubDomain: <pageSubDomain>,
                                   contentURL: <contentUrl>, metadata: <metadata>)

SevenOneAds.shared.initialise(sevenOneAdsSettings: settings) { isSuccessful in
            // Handle isSuccessful
}
  • pageTopDomain: sets the top page domain. This would be the top topic of the current page, for example "football". The supported domains for your integration will be provided by SOM.
  • pageSubDomain: (Optional, default: nil) sets the sub page domain. This would be the subtopic of the current page, for example "champions-league". The supported domains for your integration will be provided by SOM.
  • contentURL: (Optional, default: nil) sets the content url.
  • metadata: (Optional, default: nil) A dictionary of string key/value pairs for passing in custom values. Only agreed upon key/value pairs will be used. For more information please contact SOM.

The initialisation will return a success/failure message that can be used for debugging. If the initilisation fails, please monitor your logs to find the cause.

Note:The SDK uses the bundle ID of the application to automatically identify which application is using the SDK. Each application is associated with a unique config file that is created and handled by SOM. Before a new application can use the SDK the bundle ID must be registered by SOM. Using an unknown bundle ID will fail to initialise the SDK. If the initialisation fails, or you are uncertain if your bundle ID is registered, please contact SOM.

Custom Meta Data

In some special cases it might be necessary to pass in custom meta data during initialisation. This should only be done if you have special requirements that have been discussed and approved by SOM in advance. All unknown data will be ignored by the SDK.

← IntroductionAndroid →