OpenWrap Mobile In-App Support

OpenWrap now supports delivering mobile in-app ads on Android and iOS devices integrated with PubMatic's OpenWrap SDK

About OpenWrap SDK Integration

The OpenWrap SDK lets you leverage PubMatic's robust platform of OpenWrap capabilities within your mobile app. Publishers who want to increase monetization and access the broadest set of exchanges and unique demand, use OpenWrap's transparent enterprise wrapper solution for Prebid. OpenWrap simplifies partner management with an intuitive UI. Enterprise grade analytics and a dedicated support team help you optimize your inventory's monetization. OpenWrap SDK takes the power of OpenWrap mobile. OpenWrap SDK provides integration strategies focused on the ad service SDK you choose to deliver ads in your app:

The sections below describe the processes for creating and managing an OpenWrap profile, which is required to integrate OpenWrap SDK in your mobile app.

Create an OpenWrap Profile for Mobile In-App

  1. Login to the PubMatic UI portal with your account credentials. If you're unsure of your account credentials, contact to your account manager for assistance.
  2. From the main navigation, select  Inventory  >  OpenWrap  >  Profile Management . Click  Create Profile



  3. Enter a Profile Name, set Platform to Mobile In-app, then set AdServer to a supported ad server SDK. For example:

    • DFP (now called, Google Ads Manager, or GAM) for Google Mobile Ads SDK.
    • MoPub for MoPub SDK.
    • CUSTOM for some other ad server or no ad server.

  4. Select your partners. PubMatic always appears by default for Partners. If you want to add more partners, select from the list and click Done.



    Set the following:

    The Auction Timeout (ms) is the time in milliseconds that the ad server will wait for a response before the auction times out. Choose a high number (for example, 10,000 ms or more), if you want to wait to load ads until the user has had a chance to interact with the consent management platform during the first visit to your site.

    1. Change the Traffic Allocation (%) for your selected partners if you want something lower than the default of 100%.
    2. Set the Bid Adjustment (%) for partners that require a revenue share. For example, if a partner charges 15% revenue share, the Bid Adjustment (%) field should be 15. Use a negative number to boost the bid.
    3. The Path for for OTT/CTV is defaulted to Server-side, which means all bids will be sent via server-to-server.

  5. Advanced setting:
    • Enable Send All Bids if you want to send additional key values to the ad server with bid information for every bidder.
      • If you want to enable bid landscape or per partner reporting, you must enable Send All Bids.If you wants to provide priority to PMP bids, you must enable Send All Bids.
      • When Send All Bids is selected, OpenWrap still sets the OpenWrap key values for the winning bid in addition to the per-bidder key value
    • Enabling Supply Chain Object (schain) will include Prebid's Supply Chain Object Module in your OpenWrap bundle. Most publishers to do not need to enable this option. Service Providers who manage Prebid wrappers on behalf of multiple publishers and handle payments to publishers need to declare their intermediary status in the Supply Chain object.

      The input box accepts a JSON object with Prebid's schain module configuration. See Prebid schain modules for a full list of options.
      An example schain module configuration:
      {
        "config": {
          "ver": "1.0",
          "nodes": [
            {
              "asi": "indirectseller.com",
              "hp": 1,
              "sid": "00001"
            }
          ],
          "complete": 1
        },
        "validation": "strict"
      }

      If Supply Chain Object is enabled but the input box is left blank, the module is compiled in PWT but no configuration call is made. The schain configuration will need to be set by code on the page or via the custom script option. If different bidders need different schain object, leave the box blank and use custom code to set bidder-specific configuration.

  6. Choose Save. You will be redirected to Profile Details page. When you're ready to map the ad units, continue to Map ad units below.



Manage a profile


Tip

If you'd like to modify the profile name, click the name.

  1. Select the Profile Management tab.
  2. Select a profile from the Select Profile menu.
  3. From the Actions menu, choose:
    • Edit to modify the profile.
    • Map Ad Units if you're ready to map the ad units for this profile version.

 

View account-level parameters

Follow these steps to view account-level parameters on the Version Details page:

  1. Select the Profile Management tab.
  2. Select a profile from the Select Profile menu.
  3. Select the the version number you want to view.
  4. The Version Details modal displays the partners mapped to the version and their account-level parameters at the time of version creation.



Map ad units

After adding a new profile or creating a new profile version with additional partners, you need to create and upload a mapping file for each partner. The mapping process allows the wrapper tag to include a partner-specific identifier (for example, PubMatic requires a site id and ad tag id in the ad call), that allows each partner to understand which ad unit is generating the impression. Partners use this information to apply various settings in their own platform, such as floor price, demand sources, and so on.

You must upload a mapping file for each partner. The template type below refers to the on-page information that the wrapper looks for during runtime, then maps to the partner-specific ids listed in the mapping file. The table below describes the template you'll use for mobile in-app.

Template Type

Details

Ad Unit Name + Size

(Currently the only type available for Mobile In-App.)

The AD Unit Code of the slot defined for DFP/MoPub; for example, /12345/Adunit1/Adunit2/

Size will be: Width x Height

When mapping ad units for interstitial ads:

You must map the predefined ad sizes for each device type on which the interstitial ad will display:

  • 320 x 480 and 480 x 320 for mobile phones.
  • 1024 x 768 and 768 x 1024 for tablets.

When mapping ad units for video ads:

For interstitial video, rewarded video and in-banner (size 300 x 250) video ads, you must map 0 x 0 for each partner. 

In-app integration

After you have created your Mobile In-App profile, you can link directly to the OpenWrap SDK documentation for your target mobile platform.

  1. Select the Tag Management tab.
  2. Choose your Mobile In-App profile from the Select a profile drop-down.
  3. Use the integration steps links to view the OpenWrap SDK documentation and choose the Get started instructions for your platform and ad server.

The OpenWrap SDK documentation demonstrates how to integrate ad support in your app by adding code that includes your Publisher ID, Profile ID, and Ad Unit ID. First complete the requirements documented in the Getting Started guide, then use the instructions and code samples in the following documentation sections to learn how to integrate one or more ad types in your app:

Android

iOS

⇧ Top

Do you have feedback on this document? Let us know: email us.

Table of Contents