API Reference

HyBid iOS SDK - HyBid Configuration

Migration from the PubNativeLite SDK to the HyBid SDK

As you might have noticed, we changed our product name from PubNativeLite to HyBid. What that means is that if your project uses the old PubNativeLite SDK, we encourage you to check out the Migration to HyBid.framework document here for a smooth migration.

Install HyBid SDK

There are 2 ways that you can install HyBid into your application:

1. Cocoapods

  • If you're using CocoaPods, you can add the following line to your Podfile. This will get you the full featured HyBid iOS SDK.
pod 'HyBid', '3.1.4'
  • However, if you want a specific feature / some features from the HyBid iOS SDK, now you can get them by installing the desired module(s). Down below you'll find a list to the available modules. You can install as little as one module, or multiple modules based on your application's need by adding them to your Podfile.

For Banner Ads 

pod `HyBid/Banner`, '3.1.4'

For Fullscreen / Interstitial Ads

pod `HyBid/FullScreen`, '3.1.4'

For Rewarded Video Ads 

pod `HyBid/RewardedVideo`, '3.1.4'

For Native Ads 

pod `HyBid/Native`, '3.1.4'

NOTE: If you already have the previous versions of HyBid iOS SDK in your project and you are updating to the HyBid.xcframework, you need to remove the Run Script under Build Phases. You don't need that anymore.

2. Drag & Drop HyBid.xcframework

  • Download HyBid.xcframework and simply drag and drop the HyBid.xcframework file into your project's target.
  • IMPORTANT NOTE: Make sure it is set for Embed & Sign in General, under "Frameworks, Libraries and Embedded Content"

Integrate The Adapters

There are 2 ways that you can install Adapters into your application:

1. Cocoapods

If you're using CocoaPods, you can add the adapters to your project using Podfile. Check the listed repositories for a detailed integration guide for MoPub HyBid and Google Mobile Ads HyBid adapters.

2. Drag & Drop Adapter Files

To use the Adapters in your project, head over to either MoPub HyBid Adapters and/or Google Mobile Ads HyBid Adapters repository and import all the adapter files to your project.

Swift Integration

To use the Adapters in your Swift project, ensure that you have a Bridging Header file in your project and the Objective-C Bridging Header build setting under Swift Compiler - Code Generation has a path to the header

SKAdNetwork Support

SKAdNetwork is an attribution solution introduced by Apple. It validates advertiser-driven app installations without disclosing user-level data. Starting with the iOS 14, the utilization of SKAdNetwork framework will become more important since IDFA (Apple’s Identifier for Advertiser) is going to be opted-out by default.

To comply with SKAdNetwork standards,

  1. Control-click or Right-click a property list (Info.plist) in the Project navigator, then choose Open As > Source Code from the pop-up menu
  2. Add a SKAdNetworkItems key with SKAdNetworkIdentifier values to your Info.plist, by using this code.

Initialise SDK

Add the HyBid.framework to your code.

import HyBid

#import <HyBid/HyBid.h>

Before making any requests, you must initialise HyBid iOS SDK by calling init() method and wait for its completion. Ideally, you should call this init() method in your app's AppDelegate.

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
//...
//....
    HyBid.initWithAppToken("<YOUR_APP_TOKEN_HERE>", completion: nil)
//...
//....      
    return true
}

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
//...
//....
    [HyBid initWithAppToken:@"<YOUR_APP_TOKEN_HERE>" completion:nil];
//...
//....
    return YES;
}

Advanced Configurations

There are certain parameters that should be configured in the SDK before doing any type of interaction with it. Ensure to configure these parameters only 1 per session.

COPPA compliance

If your app is intended for children you should set COPPA as true in order to protect the privacy of the information in their devices. It is disabled by default.

HyBid.setCoppa(Bool)

[HyBid setCoppa:BOOL];

Test Mode

In development, you should set Test Mode as true for our SDK and disable it in the release. It allows not to track impressions and tracks on the server side of development application:

HyBid.setTestMode(Bool)

[HyBid setTestMode:BOOL];

Location tracking

If the user has given location permissions, HyBid SDK will use the available user location to provide better targeted ads.
This feature is enabled by default, but can be disabled by setting the setLocationTracking on the HyBid class:

HyBid.setLocationTracking(Bool)

[HyBid setLocationTracking:BOOL];

Location updates

The SDK refreshes the user location after every ad request if the user has given permission for location tracking. This is done to keep the best accuracy possible. However if the app will do many requests in a short time it might display location updates very often which can be intrusive for some users.

You can disable this behaviour by setting the setLocationUpdatesEnabled on the HyBid class:

HyBid.setLocationUpdates(Bool)

[HyBid setLocationUpdates:BOOL];

Keep in mind that if location tracking is disabled, anything you set in here will have no effect since location tracking will be disabled globally for HyBid SDK

Skip Offset
You can define manually a global minimum amount of seconds until the ad can be skipped for HTML and Video Interstitials.

For HTML Interstitials;

HyBid.setHTMLInterstitialSkipOffset(2) //2 seconds

[HyBid setHTMLInterstitialSkipOffset:2]; //2 seconds

For Video Interstitials;

HyBid.setVideoInterstitialSkipOffset(5) //5 seconds

[HyBid setVideoInterstitialSkipOffset:5]; //5 seconds

Custom Click Behavior

As a publisher, you have the option to set the click behavior in fullscreen ads. There are 2 options:

  • HB_CREATIVE: The entire creative is clickable
  • HB_ACTION_BUTTON: The creative is not clickable. Only the action button in bottom right is right is clickable
HyBid.setInterstitialActionBehaviour(HB_CREATIVE)

[HyBid setInterstitialActionBehaviour:HB_CREATIVE];

Automatically close Video Interstitial

You can choose whether to close Video Interstitials automatically after video ends. The default value is NO.

HyBid.setInterstitialCloseOnFinish(Bool)

[HyBid setInterstitialCloseOnFinish:BOOL];

Targeting

If you want to improve targeting, first configure the HyBidTargetingModel object that you want to pass on and then invoke the following method:

var targeting = HyBidTargetingModel()
targeting.age = <AGE>
targeting.interests = <ARRAY_OF_THE_INTERESTS>
targeting.gender = "<GENDER>"     // "f" for female, "m" for male
HyBid.setTargeting(targeting)

HyBidTargetingModel *targeting = [[HyBidTargetingModel alloc] init];
targeting.age = <AGE>;
targeting.interests = <ARRAY_OF_THE_INTERESTS>;
targeting.gender = "<GENDER>";     // "f" for female, "m" for male
[HyBid setTargeting:targeting];

Logging

You can control the level of log that you want to see in your console. As default HyBidLogger is set to HyBidLogLevelInfo. There are 5 HyBidLogLevels;

  • HyBidLogLevelNone
  • HyBidLogLevelError
  • HyBidLogLevelWarning
  • HyBidLogLevelInfo
  • HyBidLogLevelDebug

If you want to set a different HyBidLogLevel in your app, the best place to do it, is before the HyBid initialization part.

HyBidLogger.setLogLevel(HyBidLogLevelInfo)

[HyBidLogger setLogLevel:HyBidLogLevelInfo];

Set AppStore ID

This is required if your app supports iOS 14+.

HyBid.setAppStoreAppID("NUMERIC_APPSTORE_ID_HERE")

[HyBid setAppStoreAppID:@"NUMERIC_APPSTORE_ID_HERE"];

Return to the HyBid
Return to the MoPub Adapter
Return to the MoPub Pre-Bid
Return to the DFP Pre-Bid