iOS HyprMX SDK
SDK Documentation
  • Getting Started
    • iOS Setup Guide
    • Privacy
    • Apple App Privacy Details
    • Migrate to Version 6.4+
  • Ad Formats
    • Rewarded Ads
    • Interstitial Ads
    • Banner/MREC Ads
  • 3rd Party Mediation
    • 3rd Party Mediation
      • AdMob Mediation
      • AppLovin MAX
      • Chartboost Mediation
      • Digital Turbine FairBid
      • Unity LevelPlay
      • X3M XMediator
  • Downloads/Change Log
    • Downloads
    • Change Log
      • iOS SDK Change Log
      • iOS AdMob Adapter Change Log
      • iOS MAX Adapter Change Log
Powered by GitBook
On this page
  • Introduction
  • Compatibility
  • Setup Instructions
  • CocoaPods Integration
  • Manual Installation
  • Configuring Privacy Controls
  • SKAdNetwork Identifier
  • Integrating HyprMX On The AdMob Dashboard Using Custom Events
  • Optional: Tag for Child Directed Treatment
  • Optional: User Consent
  • License
  1. 3rd Party Mediation
  2. 3rd Party Mediation

AdMob Mediation

Previous3rd Party MediationNextAppLovin MAX

Last updated 2 months ago

Introduction

HyprMX iOS AdMob Adapter allows you to integrate HyprMX in your AdMob rewarded, interstitial, and banner/MREC waterfalls. The adapter can be set up with CocoaPods or by Manual Installation. See below for instructions on how to set up a new adapter or upgrade to newer versions.

is included in iOS SDK 6.3.0.1+

Compatibility

The HyprMX-AdMob adapter version 6.4.2.0 is compatible with AdMob 11.0+. If you need support for an older version of AdMob, please reach out to your HyprMX account manager.

Setup Instructions

This guide assumes you already have the AdMob iOS SDK integrated into your Xcode project. You can either set up the adapter by using or through .

CocoaPods Integration

1. Install or update to version 1.10.2 or newer.

2. Add the following to your Podfile:

pod 'HyprMX-AdMob', '6.4.2.0'

The HyprMX-AdMob Pod requires pod 'Google-Mobile-Ads-SDK' with version'11.0.0' or greater.

Manual Installation

To manually update the adapter, follow the steps below.

If you have set up the adapter before and are upgrading, perform steps 1 and 2. If not, skip to step 3.

  1. Remove HyprMX.framework and all HyprMX adapter files from your project.

  2. Find your target's Build Phases tab and open Link Binary with Libraries. If it exists, remove HyprMX.framework from this list.

  1. Add the HyprMX.xcframework to the project. Make sure to copy and verify target membership.

  1. Find your target's General tab, open Frameworks, Libraries, and Embedded Content and set the HyprMX.xcframework to Embed & Sign.

  1. Add the AdMob-Adapter folder to the project. Make sure to copy and verify the target membership.

Please note that the user ID has been removed in version 6.4.1.0 and can be safely removed from the integration.

That's it! You're up and running with the latest version of the HyprMX SDK.

Configuring Privacy Controls

The HyprMX 6.0.0+ SDK requires the `NSUserTrackingUsageDescription Plist Key to determine the authorization state.

iOS requires that the use of a user's camera, calendar, photo library, IDFA, etc. be declared by advertisers in the plist. Add all of the following entries to your app's plist.

<key>NSCameraUsageDescription</key>
    <string>${PRODUCT_NAME} requests write access to the Camera</string>
<key>NSPhotoLibraryAddUsageDescription</key>
    <string>${PRODUCT_NAME} requests write access to the Photo Library</string> 
<key>NSUserTrackingUsageDescription</key>
    <string>${PRODUCT_NAME} would like to show you personalized ads</string>

SKAdNetwork Identifier

The HyprMX 6.0.0+ SDK supports Apple's new SKAdNetwork for Attribution. To add the HyprMX SKAdNetwork ID to your info.plist:

<key>SKAdNetworkItems</key>
<array>
    <dict>
        <key>SKAdNetworkIdentifier</key>
        <string>nu4557a4je.skadnetwork</string>
    </dict>
    ...
</array>

Integrating HyprMX On The AdMob Dashboard Using Custom Events

  1. Create your Mediation Group on the AdMob Dashboard.

  2. In the Ad Sources, select Add Custom Event.

  3. In the popup, enter a unique label such as "HyprMX Placement1" in the label field and set the default eCPM (e.g. $15.00).

  4. Click Continue.

  5. Set the adapter Class Name:

    AdMob Ad Format

    Class Name

    HYPRAdMobRewardedAdapter

    HYPRAdMobVideoAdapter

    HyprMXCustomEventBanner

  6. In the parameter field, enter the distributor ID and placement name assigned to you by your HyprMX account manager.

    { "distributorID": "YOUR_DISTRIBUTOR_ID", "placementName": "HyprMX Placement1" }
  7. Click 'Done' and then 'Save'.

Optional: Tag for Child Directed Treatment

Optional: User Consent

Importing HyprMXAdapterConfiguration

To provide Consent Status to HyprMX, you will need to import the HyprMXAdapterConfiguration header into your project.

// Add the following to your project's Bridging-Header.h
#import "HyprMXAdapterConfiguration.h"
#import "HyprMXAdapterConfiguration.h"

Adding User Consent Status

HyprMX provides an API to indicate a user’s consent status. This API will be used to indicate a user’s opt-in or opt-out consent for the collection and use of personal data under applicable laws and jurisdictions (GDPR, CPRA, etc.). On App launch, the Consent value will be CONSENT_STATUS_UNKNOWN. You can set CONSENT_DECLINED by calling setHasUserConsent(false), or CONSENT_GIVEN with setHasUserConsent(true) depending on the user's consent collected by your application.

It is recommended to set the consent status once on App Launch and whenever your user changes their consent status.

HyprMXAdapterConfiguration.setHasUserConsent(false) // Consent is declined
HyprMXAdapterConfiguration.setHasUserConsent(true) // Consent has been granted
[HyprMXAdapterConfiguration setHasUserConsent:NO]; // Consent is declined
[HyprMXAdapterConfiguration setHasUserConsent:YES]; // Consent has been granted

License

By downloading this SDK, you are agreeing to the LICENSE included with the SDK zip.

Download the adapter file and unzip the file.

Ensure that your ATS (App Transport Security) settings are as described by .

Add or confirm that info.plist contains the required Privacy Keys. For more information, see the section below.

Optional: Set user consent, as shown .

iOS 14 introduced the framework to allow users control over the use of their Advertising Identifier.

Note: SKAdNetwork IDs are case sensitive. For more information about SKAdNetwork please refer to Apple's .

Regional laws and regulations such as COPPA, GDPR, and require child-directed treatment of applicable users. It is the responsibility of the app developer to ensure compliance with applicable laws and regulations.

For instructions on how to tag the ad request as child-directed, please follow .

AdMob
AppTrackingTransparency
documentation
Apple's Privacy Policy
AdMob's child-directed setting documentation
Apple Privacy Manifest
CocoaPods
CocoaPods
manual integration
Configuring Privacy Controls
below
Rewarded Ads
Interstitial
Banner/MREC
here