Request a Demo

Getting Started with iOS SDK

Getting set up

To get started you need to set up your Application and Placements on display.io Platform:

1. Log in to your account.

2. Go to Inventory section:

mceclip36.png

3. Create a new inventory: select iOS platform and SDK integration:

mceclip25.png

 

3. Placements and Ads

Placements allow you to configure different ad-triggers within your app, based on predefined placements of ads. For example, you could add one placement upon app launch, another placement when a user reaches level X, and another placement in your app’s newsfeed.

Placements are bound to a specific Ad Unit type. Currently supported Ad Units/Ad Formats/Ad Sizes are:

  • ic_interstitial_09.svg  Interscroller (in-feed, 320×480) – Video and Display ad formats
  • Infeed-svg__4___1___1___2_.svg Headline (in-feed, 300×250) – Video and Display ad formats
  • device-1__2_.svg  Interstitial (320×480 / 480×320) – Video and Display ad formats
  • ic_infeed_01.svg  Infeed (300×250 / 320×250) – Video and Display ad formats
  • Banner_in_the_middle__3___1_.svg  Medium Rectangle (300×250) – Display ad format
  • Banner_on_the_bottom__1___1_.svg  Banner (320×50) – Display ad format

To get test ad for each ad request within testing mode choose status “Testing” for your placements.

mceclip13.png

Interscroller placement setup 

Installing the SDK

Before You Start Make Sure:

  • At least one App and Placement are added on Publisher Portal

Add the SDK to your XCode project

1a. Via Cocoapods

Specify in your Podfile:

target 'YourProjectName' do
 pod 'DIOSDK', '3.7.2'
end

1b. Manually

1.b.1. Drag and drop the downloaded DIOSDK.framework into your XCode project.

screen-shot-1.pngscreen-shot-2.png

1.b.2. Be sure to have “Copy items if needed” checked.

screen-shot-3.png

1.b.3. Click on the “+” in “Embedded Binaries” and add DIOSDK.framework.

screen-shot-4.png

2. Add the following item to your Info.plist file

screen-shot-5.png

Initializing the SDK

Before You Start Make Sure:

  • At least one App and Placement are added on Publisher Portal
  • SDK is installed

Initialise the SDK upon application start. Example for one of the view controllers:

#import <DIOSDK/DIOController.h>
 
@implementation ViewController
 
- (void)viewDidLoad {
 [super viewDidLoad];
 
 [[DIOController sharedInstance] initializeWithProperties:nil appId:@"1234" completionHandler:^{
 // Ready to go
 } errorHandler:^(NSError *error) {
 // Something wrong happened
 }];
}

Note: initialisation is an asynchronous operation.

A more advanced way to initialise the SDK is by passing a DIOInitProperties object:

DIOInitProperties *properties = [[DIOInitProperties alloc] init];
[[DIOController sharedInstance] initializeWithProperties:properties appId:@"1234" completionHandler:^{
 // Success
} errorHandler:^(NSError *error) {
 // Failure
}];

In order to define user’s gender:

[properties setGender:GENDER_MALE];
[properties setGender:GENDER_FEMALE];

In order to define if the user is a child, according to the local law:

[properties setChildCompliance:DIOComplianceUnknown];
[properties setChildCompliance:DIOComplianceYes];
[properties setChildCompliance:DIOComplianceNo];

In order to define user’s year of birth:

[properties setYearOfBirth:1980];

In order to define user’s keywords:

[properties setUserKeywords:@[@"iPhone", @"Apple"]];

Location based targeting is enabled by default, but there is a way to disable it:

[[DIOController sharedInstance] setLocationBasedTargeting:NO];

In order to disable the internal crash reporting system (this might be helpful if you use your own crash reporting system, like Crashlytics):

[properties setCrashReportsDisabled:NO]

Requesting & Loading Ads

Before You Start Make Sure:

  • at least one App and Placement are added on Publisher Portal
  • SDK is installed
  • SDK is initialised
  • Placements have “Testing” status in order to get a test ad,  for testing the integration

1. Requesting ads

To request an ad you should retrieve the Placement object from the Controller.

DIOPlacement *placement = [[DIOController sharedInstance] placementWithId:@"5678"];

Then issue a new DIOAdRequest object from the Placement object:

DIOAdRequest *request = [placement newAdRequest];

To execute an Ad Request (asynchronous operation):

[request requestAdWithAdReceivedHandler:^(DIOAdProvider *adProvider) {
 // Success
} noAdHandler:^(NSError *error){
 // Failure
}];

You may add data about the user or the context of the ad to the Ad Request. As a best practice, we advise our publishers to add as much user data to their Ad Requests as possible. The reason  is, this gives advertisers visibility into the parameters of each user within your app, and in doing so, allows advertisers to bid more intelligently. Meaning a higher CPM payout for you.

[request setContentKeywords:@[@"house of cards", @"ronaldo"]];
[adRequest setUserId:@"some user ID"];

[adRequest setBuyerId:@"some buyer ID"];

[adRequest setIABPageCats:@[@"IAB12", @"IAB6-1", @"IAB48-84"]];

[adRequest setIABSectionCats:@[@"IAB2", @"IAB61-12", @"IAB1-1"]];

In case you are requesting Banner or Medium Rectangle ads, specify the expected position of the ad on a screen as follows:

[request setPosition:DIOBannerPositionAboveTheFold];
[request setPosition:DIOBannerPositionBelowTheFold];

Note: Ad Request properties should be added prior to executing the ad request.


2. Loading ads

Use the DIOAdProvider to load the ad:

[adProvider loadAdWithLoadedHandler:^(DIOAd *ad) {
 // Success
} failedHandler:^(NSError *error){
 // Failure
}];

If you previously requested ad attributes like ‘Advertiser Name’ and ‘Advertiser Click URL’, you can access them as follows:

NSString *name = ad.avertiserName;
NSString *clickURL = ad.advertiserClickURL;

You also can retrieve additional data of current ad:

NSLog(@"=================== advertiserName = %@", ad.advertiserName);
NSLog(@"=================== advertiserClickURL = %@", ad.advertiserClickURL);
NSLog(@"=================== ecpm = %@", ad.ecpm);
NSLog(@"=================== crid = %@", ad.crid);
NSLog(@"=================== cid = %@", ad.cid);
NSLog(@"=================== adomain = %@", ad.adomain); // NSArray
NSLog(@"=================== auctionId = %@", ad.auctionId);
NSLog(@"=================== msessId = %@", ad.msessId);

A/B testing labels can be defined via:

[request setLabels:@[@"blue", @"red"]]

Note:
We provide GDPR compliance through the IAB’s GDPR Transparency and Consent framework. If you use a CMP that implements this IAB standard, we will be able to pick the consent state from your integrated CMP and apply it in our ad serving.

Still have Questions?

Contact Us