Overview

Auto Store allows DSPs to decide whether InMobi Exchange should display a store modal on top of a VAST video. This feature enhances the effectiveness of app-install campaigns, leading to increased conversion rates and reduced CPIs.

It is a store modal supported by iOS with the SKStoreProductViewController object.

Experience

DSPs determine if the InMobi Exchange iOS Store Kit is displayed automatically after a user:

• Views the complete video
• Skips the video

When dismissed, users see the creative end card loaded below.

OpenRTB Specifications

BidRequest.imp.ext

Example

{
  "imp": [
     {
       "ext": {
         "autostore":1
        }
     }
  ]

BidResponse.seatbid.bid.ext

Example

{
  "seatbid":[ 
   { 
     "bid":[ 
        { 
          "ext": { 
             "autostore":1 
            } 
         } 
       ] 
     } 
   } 
 }

Example

{
  "seatbid":[
    {
      "bid":[
        {
         "ext":{
            "autostore":1,
             "autostoreclick":1
            }
        }
     ]
   }
]

Overview

Android StoreView is part of InMobi’s suite of ad behavior enhancements. It is an InMobi SDK-powered ad experience that allows users to quickly preview key elements of an app’s Google Play Store page directly within the ad flow.

This experience presents a lightweight, store-like interface that mirrors the Google Play product page, featuring elements such as app description, scrollable screenshots, and relevant metadata. It provides users with immediate context about the advertised app without requiring them to leave the host app.

How it Works

StoreView automatically appears at the end of a video ad, overlaying the end card in a format similar to iOS Auto StoreKit. Users can dismiss it or interact with it. On interaction, a clickthrough redirects them to the Google Play Store to continue the install flow.

By increasing user intent and engagement before redirection, StoreView improves key performance metrics such as conversion rate, IPM, and overall efficiency (CPA, CPI). It is enabled by default and can be controlled by DSPs via the bid response.

Supported Formats

This feature is available for:

• Android only
• Interstitial Video
• Rewarded Video

Ways to Enable Android StoreView

Android StoreView is enabled automatically for performance DSPs running app install campaigns. Reach out to your Demand Partner Manager to confirm activation.

DSP Controlled Enablement

DSPs can choose to enable StoreView on a per-impression basis, allowing full control over when the feature is applied. This enables optimization based on campaign goals, landing page behavior, and CTR performance, and supports straightforward A/B testing.

Request parameter - BidRequest.imp.ext

Request parameter - BidResponse.seatbid.bid.ext

Overview

Android Inline Installs is a Google Play-powered capability enabled by the InMobi SDK that allows users to install an advertised app directly within the ad experience, without redirecting to the Google Play Store.

This experience leverages the Google Play Install API to present app product details in a native, in-context interface, allowing users to complete the install flow without leaving the host app.

For DSPs and advertisers, this results in a more seamless user journey, reducing friction in the clickthrough flow and improving key metrics such as conversion rate, and overall campaign efficiency (IPM, CPA, CPI).

The integration follows a two-sided OpenRTB handshake:

• Bid Request: InMobi signals availability using imp.ext.inlineinstallallowed
• Bid Response: DSP enables the feature and passes an install referrer using seatbid.bid.ext.inlineinstall

Requirements

InMobi sets inlineinstallallowed = 1 only when all of the following conditions are met:

• Device OS is Android
• Google Play Store is installed and reachable
• InMobi SDK version is 11.1.0 or higher

Bid Request

Object: BidRequest.imp.ext

Example

"ext": {
  "inlineinstallallowed": 1
}

Bid Response

Object: BidResponse.seatbid[].bid[].ext.inlineinstall

Example

"ext": {
  "inlineinstall": {
    "enabled": true,
    "referrer": "dsp1_760a59d6-1507-11f1-96c3-9565488fcc70"
  }
}

Referrer and Attribution

The InMobi SDK calls the Google Play Install API directly on the device. The flow bypasses the Play Store redirect entirely, which means:

• There is no redirect URL for referrer parameters to be appended to.
• There is no redirect chain for MMPs to read.

You must pass the referrer explicitly in the bid response for attribution.

Without a referrer:

• The install reaches the app with no referrer string.
• Attribution will be missed for the ad.
• MMPs may record the install as organic or unattributed.
• Campaign reporting (ROAS and conversions) becomes incomplete.

We recommend passing the install referrer explicitly in the bid response for attribution. If the DSP does not use Install Referrer for third-party attributions, then this recommendation may not be relevant for you. 

FAQs 

Overview

Skip to Store is an ad experience feature available on the InMobi Exchange for DSPs bidding on in-app inventory via the InMobi SDK. It enables a streamlined click-through flow that directs users to the advertiser’s destination as part of the ad experience.

This feature is designed for performance-focused campaigns such as app installs, retargeting, and commerce. It helps improve:

• Landing page rate
• Attribution rate
• Installs per mille (IPM)
• Cost per acquisition (CPA)
• Cost per install (CPI)

How it works

When enabled for an eligible impression, the InMobi SDK renders a full-screen ad experience with a single call-to-action (CTA) button.

• The user must interact with the CTA button to proceed through the ad flow.
• Clicking the button redirects the user to the configured click-through destination.
• The CTA messaging is dynamically optimized based on campaign objective and destination type.

Click-through destinations

The CTA button can direct users to:

• App Store or Google Play Store listing
• Deep link into an installed app
• Web landing page (href)

User interaction behavior

• If the user clicks the CTA button, the standard click tracking and redirect flow is executed.
• If the user clicks the primary ad asset (e.g., a video), the Skip to Store flow is disabled, and the default click behavior applies.

Supported formats

Skip to Store is supported for the following ad formats:

• Standalone interstitial playables
• Standalone rewarded playables
• Interstitial video
• Rewarded video

Enable Skip to Store

You can enable Skip to Store using one of the following methods:

Option 1: Managed rollout by InMobi

InMobi can enable Skip to Store across a defined percentage of traffic for selected formats and placements.

• Example: Enable for 50% of rewarded video inventory
• Rollout is configured and managed by InMobi upon request

Option 2: DSP-controlled enablement

DSPs can control Skip to Store on a per-impression basis using OpenRTB extensions.

This approach allows you to:

• Apply the feature selectively based on campaign logic
• Maintain internal optimization strategies (for example, CTR or CPA optimization)
• Control click classification and reporting

API Integration

Sample Request

Sample Response

Click tracking behavior

CTA button click

When the user clicks the Skip to Store CTA button:

• Standard click trackers are triggered
• The configured click-through URL is opened

Format-specific behavior

Video ads

• Video click trackers are triggered
• Video click-through URL is opened

Playable ads

• Configured click URL is triggered
• Associated landing page is opened

FAQs

What click trackers are triggered when the user clicks the CTA button?

Standard click trackers are triggered, consistent with a normal ad click. The configured click-through URL is then opened.

Which click-through URL is used?

• Video ads: Video click-through URL defined in the VAST response
• Playable ads: Configured click URL associated with the creative

What happens if the user clicks on the main ad asset instead of the CTA button?

If the user clicks the main ad asset (for example, the video player), the Skip to Store flow is disabled for that interaction. The default click behavior is applied.

The InMobi WebX enables publishers to monetize their websites by rendering ads through a lightweight JavaScript integration.

Prerequisites

Ensure you have the following before integrating:

• Publisher ID (provided by InMobi).
• A valid HTML container where the ad will be rendered.
• Ensure the following consent and privacy requirements are met:  
  • Add InMobi (Vendor ID: 333) to your Consent Management Platform (CMP) vendor list.
  • Ensure the following purposes are enabled for InMobi:
    • Purpose 1 – Storage and access of information
    • Purpose 2 – Basic ads
    • Purpose 7 – Measurement
    • For personalized advertising, also enable:
      • Purpose 3 – Personalized ads
      • Purpose 4 – Personalized content

Create Default Placements

Before you begin with InMobi WebX integration, you need to create default website placements first. 

Follow the steps in Default Website Placements to start creating website placements.

Integration Methods

The SDK supports multiple integration approaches based on your use case:

<!DOCTYPE html>
<html>
<head>
  <title>InMobi Ad Example</title>
</head>
<body>

<h1>My Website</h1>

<div id="inmobi-ad-container"></div>

<script
  defer
  src="https://app.inmobi.com/web-sdk?publisherId=<inmobi_accountID>"
  data-mode="auto"
  data-container="inmobi-ad-container">
</script>

</body>
</html>

<!DOCTYPE html>
<html>
<head>
<title>InMobi Web SDK Example</title>

<script defer src="https://app.inmobi.com/web-sdk?publisherId=<inmobi_accountID>"></script>

</head>
<body>

<h1>My Website</h1>

<div id="ad-slot"></div>

<script>
window.addEventListener("DOMContentLoaded", function () {

  InMobiWebSDK.init({
    containerId: "ad-slot",
    slotSize: ["300x250"]
  });

});
</script>

</body>
</html>

<!DOCTYPE html>
<html>
<head>
<title>InMobi Web SDK Example</title>

<script defer src="https://app.inmobi.com/web-sdk?publisherId=<inmobi_accountID>"></script>

</head>
<body>

<h1>My Website</h1>

<div id="ad-slot"></div>

<script>
window.addEventListener("DOMContentLoaded", function () {

  InMobiWebSDK.init({
    minSeconds: 3,
    minViewabilityPercentage: 50,
  });

});
</script>

</body>
</html>

No-Fill Event Listener

When no ad is available for a given slot, the SDK dispatches a NO_FILL custom event on the window object. You can listen for this event to take fallback actions. 

window.addEventListener('NO_FILL', function(event) { 

 const slotId = event.detail.slotId; 

 console.log('No fill for slot:', slotId); 

});

Best Practices

• Always load the SDK using the defer attribute.
• Ensure the container exists before loading ads.
• Use unique container IDs if placing multiple ads on a page.
• Avoid removing ad containers dynamically after initialization.

Troubleshooting

Check the following if ads are not rendering:

• The Publisher ID is correct.
• The container ID exists in the DOM.
• The SDK script loads successfully.
• There are no JavaScript errors in the browser console.

For further assistance, Contact Us.

This topic provides a comprehensive overview of InMobi CMP Premium vs Essentials for publishers and partners to understand benefits, eligibility, billing, and advanced features.

Premium vs Essentials Comparison

InMobi CMP offers two tiers — Essentials (free) and Premium (paid or free with SSP integration). Essentials ensures compliance with privacy regulations like GDPR and CCPA, while Premium provides deeper customization, analytics, and revenue optimization.

Premium access enhances brand trust, compliance management efficiency, and revenue optimization while giving publishers full creative and analytical control over their consent workflows.

Why Upgrade to Premium?

• Enhanced customization: Full branding, themes, and design freedom.
• Advanced analytics: Understand consent trends by region and platform.
• Regional flexibility: Manage compliance in multi-jurisdiction environments.
• Better monetization: Implement Consent-or-Pay to recover lost revenue.
• Improved UX: Build a transparent, familiar user consent experience.

Features

Custom Branding

Premium users can upload logos, apply custom fonts, and align consent banners with their brand theme. Essentials users are limited to basic text and color customization.

Consent modal without your brand logo.

Consent modal with your brand logo.

Light and Dark Themes (Apps)

Available exclusively to Premium users, enabling adaptive themes for mobile apps to ensure better user experience across platforms.

The option to configure theme colors for apps through the portal will be supported only for premium properties. Properties under the Essentials plan will have default theme colour.

Geo-Location Targeting

Premium enables region-specific consent flows (e.g., EEA, USA, or APAC). Essentials only supports a global configuration.

Non-premium properties can only select Worldwide; consent can’t be collected from limited regions.

Premium properties can pick and choose regions, i.e., apply to one or more regions/countries (EEA, USA, etc.) supported on the portal.

Consent Across Sub-domains

Premium supports consent sharing across sub-domains, ensuring a seamless user experience for publishers managing multiple properties.

Non-premium properties can’t enable consent collection across sub-domains. Consent collection will be limited to the parent URL

Custom Vendor Management

Premium users can manage both IAB and custom (non-IAB) vendors. Essentials only supports IAB vendors.

Non-IAB vendors added to the account will be supported only for premium properties. Consent collected will not be shared with non-IAB/custom-added vendors if the property is not a premium property.

Granular Analytics & Reporting

Premium provides detailed analytics by country, regulation type, and device to help optimize consent rates. Essentials includes only basic metrics.

Dashboard and detailed analytics under the Reports tab will be supported only for premium properties.

Removing InMobi Branding

Premium properties can remove InMobi’s logo or text from consent banners to maintain a fully white-labeled experience.

Non-Premium property with InMobi branding.

Premium property without InMobi branding.

Custom GDPR Consent Text (Coming Soon)

Premium users will be able to modify the consent modal text in compliance with IAB standards to match brand tone and language.

This feature allows you to have a custom consent modal text as per your requirement(subject to IAB guidelines). This feature will be available only for premium properties.

Consent-or-Pay (Coming Soon)

Premium will support a hybrid model where users can choose to consent or access content through an alternative payment option, allowing publishers to minimize revenue loss.

Consent or pay model allows you to configure the modal pop-up to enable your property with an option to either collect consent or pay in case of withdrawal. To learn more, see Overview. This feature will be available only for premium properties.

For more information on billing, setup, and SSP integration, see CMP Premium FAQs.

For further assistance, Contact Us.

InMobi CMP offers a subscription for its premium features, or you can get those premium features for free by integrating with InMobi SSP. For more information, see InMobi CMP Premium. 

1. Once you log in, under My Properties, you can see all your premium properties with their subscription statuses, integration, and plans.

   

2. To subscribe to InMobi CMP, create your property or select a property and click Start Subscription.

   

3. There are two ways to go Premium. You can get premium access for free by integrating with InMobi SSP or pay $20 /property/month.

   

4. Once you have made your selection, fill up some basic information and a consent form to confirm your subscription. Click Confirm & Continue. You will be redirected to the payment gateway page to complete the transaction.

   

5. Check your cart, future charges, GST (if applicable) and next billing date. Click Proceed to Checkout.

   

6. Fill in the checkout form and enter your billing address and card details.

   Note

   • Billing address is used in generating an invoice for your transaction
   • You may enter the same or a different shipping address.
   • You may also enter a PO number, if applicable.

   

7. Add payment details.

   

   Note

   • We only support credit card as a payment method.
   • Your next payment will be auto-deducted from the same credit card.
8. Click Pay $20 and subscribe. You will be redirected to the Manage Subscriptions page. Under Subscriptions, you can view the property, subscriptions, and cancellations with reason.

   

9. Under Billing & Invoices, see the payment status, invoice date and number, and the amount paid. Click Download Invoice to save the e-invoice.

   

10. Under Billing Details, find all the billing details after your account.

    

11. To edit Billing details, click Edit Details. Click Update to save.

    

12. To remove a card, select Remove card. Make changes and click Yes, Remove to confirm.

    

    Note

    • In case you update your billing address, it will reflect in the next payment for all your active subscriptions. 
    • Ensure you update your billing address before proceeding to the checkout page.
    • You can remove any payment method from the list of payment methods. Please ensure at least one payment method is added to avoid transaction failure.

This guide covers the steps and best practices for configuring and managing vendors for your properties within the InMobi CMP portal. When you use InMobi CMP on your property, you must specify the vendors (third parties) that may process user data, set their purposes, and manage consent preferences. 

Access the Vendors Page

1. Log in to the InMobi CMP portal.
2. Navigate to the Vendors page from the left-side panel. Here you’ll find tabs for:
   • IAB Vendors
   • Non-IAB Vendors
   • Google Vendors
3. You manage each category separately under the same interface.

IAB Vendors

IAB vendors are those registered in the IAB Global Vendor List (GVL) and recognized by the IAB Transparency & Consent Framework (TCF). Using them allows you to use standardized consent strings (TCF/GPP) and simplifies compliance.

1. Search vendors by name in the search field.
2. Click the + icon next to the vendor name to find the Purposes, Special Purposes, Features, and Special Features for that vendor.

   

3. Filter the vendors list by legal basis - Consent, Legitimate Interest, Flexible, and Multi. 
   • Consent: vendor with only consent purposes.
   • Legitimate Interest: vendors with only legitimate interest purposes.
   • Flexible: vendors with at least one flexible purpose.
   • Multi: vendors with consent and legitimate interest purposes.

   Note

   We consider consent, legitimate interest, and flexible purposes to classify vendors' legal basis types. Special purposes, features, and special features are not considered to classify vendors based on legal basis.

4. Select the checkbox next to the vendor name and click Block or Whitelist as required.

Non-IAB Vendors

Non-IAB vendors are vendors who have not registered with IAB Europe and are not part of the IAB Vendor List TCF 2.2. Since they are not listed in the IAB Global Vendor List, it is not possible to create a signal to transmit to non-IAB vendors. They only enable publishers to show the vendor to the consumer and obtain a consumer's privacy preferences for that vendor, not the ability to transmit them in a standard way. 

1. To add non-IAB vendors, go to the Non-IAB Vendors tab and click Add Vendor.

   

2. Add details such as Vendor name, Vendor Privacy Policy Link, Vendor Description, TCF Version, Vendor Legitimate Interest Claim, and Purposes. 

   

3. Click Add Vendors to save changes.

Your newly created vendor will be added to your non-IAB vendors list in the portal and will appear in the CMP in the partner screen.

On the InMobi CMP portal, the vendor will be given a non-IAB vendor ID, which will correlate to their position in the non-IAB vendor cookie and the non-IAB vendor API. You will now need to manage these vendor technologies using the non-IAB APIs and/or cookie instructions. 

You have completed all the configuration options for the InMobi CMP and can apply the Universal tag to the site.

nonIABVendorConsent API

You need to use the nonIABVendorConsent API to gather user consent. Each vendor you specified is assigned an id and stored in the consent.nonIabVendorConsents object. Check each entry as needed for consent (true/false). Here is an example using a fictitious vendor "Non-IAB Company" with id 1, which requires consent for purposes 1 and 3 to operate.

__tcfapi('getNonIABVendorConsents', 2, function(consent, success) { 
    // check consent for non-IAB vendor with id 1. Always check 
    // whether the callback returned success and GDPR applies
    if (   success 
        && consent.gdprApplies
        && consent.nonIabVendorConsents[1]
       ) {
        // Use getTCData to validate consent is given for the 
        // purposes declared in the configuration step
        __tcfapi('getTCData', 2, function(tcdata, success) {
          if (   success 
              && consent.gdprApplies) {
              if (   tcdata.purpose.consents[1]
                  && tcdata.purpose.consents[3]) {
                  nonIabCompanyTag(); // replace this with your own code
                  console.log("Debug: ", tcdata.purpose.consents[1],
                    tcdata.purpose.consents[3]);
              }
          }
        });
    }
});

You can make that call anywhere in your code where you need to check for consent for the non-IAB vendor you use on your page. You also need to manually configure your Google tag(s) on your site to behave based on the consent preference made and on the product the user is using.

For Non-IAB vendor API and all other APIs, see CMP2 & CCPA API Index.

Google Vendors

These are vendors that work with Google and are not listed under the TCF vendor list. If you work with Google Ad Manager, you may want to review this list and enable the vendors that you are working with through Google Ad Manager, AdMob, and AdSense. By default, all vendors are selected. For more information, see Ad Technology Providers.

1. Select the additional vendors you want to include in your ad request within Google Ad Manager. Check or uncheck the vendors in the list.

   

2. Click Save.

Best Practices for UK ICO Consent Compliance

The UK Information Commissioner’s Office (ICO) outlines how organizations must approach cookie consent within the scope of the Privacy and Electronic Communications Regulations (PECR). These requirements go beyond legal compliance, they are designed to ensure that users are given clear, fair, and transparent choices about how their data is used. 

In this topic, we highlight the essential principles of an ICO-aligned consent framework and show how Inmobi CMP can be applied to put these principles into practice. 

Requirements for Valid Consent 

In alignment with GDPR principles, the ICO requires that consent is more than a simple acknowledgment. It must reflect a user’s clear and deliberate choice. For a consent banner to be considered compliant, it needs to embody four core qualities: freely given, specific, informed, and unambiguous.

 The Inmobi CMP platform provides the functionality to implement these standards effectively and helps ensure your consent messaging is consistent with ICO requirements. 

Right to Decline and Withdraw Consent

InMobi CMP supports these requirements through an option in the Themes settings, which provides the necessary setup required to be compliant with the UK ICO.  

Record-Keeping and Accountability

Accountability is a central principle of the ICO’s guidance. Organizations must be able to show that consent was collected properly and that reliable records are maintained over time. A Consent Management Platform (CMP) plays a key role in enabling this transparency. 

Further Guidance 

For official examples and deeper advice, see the ICO’s resource: How do we manage consent in practice. 

By following these practices, you ensure your consent experience is both compliant and user-centric—protecting your business while respecting user rights. 

Create Theme

After creating your property, it's time to create a theme for it. InMobi CMP allows you the freedom to tailor your message, branding, and display to your audience.

A theme is a customizable bundle of design and configuration settings, like layout, text, colors, and legal link behavior, that defines the look and feel of your CMP. Once created, you can save and assign themes to multiple sites.

1. Navigate to the Themes tab and click Create Theme. Select Site Theme from the dropdown.

   

2. Theme Name (required): Enter a name for your theme.
3. For Regulation for which the theme is required, select European regulation (GDPR) or US regulation (CCPA & MSPA), or both. For more information, see GDPR and CCPA.

The theme creation process is divided into five sections for each regulation.

1. Language & Text
2. Colors
3. Customize Privacy
4. Privacy Widget
5. Override CSS

GDPR Consent Settings

US Consent Settings

UI CSS Overrides

If you would like to make any additional CSS changes to your CMP outside the customization options presented on the Theme’s page, you can include the CSS code in the CSS Overrides section of the Theme’s page.

If you are using InMobi CMP Version2, we use a CSS reset within the CMP to have a consistent experience on all websites. Therefore, please prepend all your rules with the id #qc-cmp2-ui. This will also eliminate the need to specify !important to all the rules.

Background Color

#qc-cmp2-ui { 
   background: yellow;  
}

Buttons

#qc-cmp2-ui button[mode="primary"] { 
   background: red; 
   color: white;  
}

Headings

#qc-cmp2-ui h2 { 
   color: red; 
   font-size: 21px;  
}

Texts

To change the font-family and sizing of all our texts, see below:

#qc-cmp2-ui p { 
   font-family: Arial, sans-serif; 
   font-size: 15px;  
}

To change the text styling of the main message of the summary page, see below:

#qc-cmp2-ui .qc-cmp2-summary-info p { 
   color: red;  
}

To change the text styling of the main message of the purposes, vendors, and legitimate pages, see below:

#qc-cmp2-ui .qc-cmp2-consent-info p { 
   color: pink;  
}

To change the text styling of the list elements, see below:

#qc-cmp2-ui .qc-cmp2-list-item-title { 
   color: red;  
}

#qc-cmp2-ui .qc-cmp2-list-item-status { 
   color: blue;  
}

To change the text styling of the text INSIDE a list element you can do it like this:

Text Inside List

#qc-cmp2-ui .qc-cmp2-expandable-list p { 
   color: green;  
}

Headers

#qc-cmp2-ui .qc-cmp2-expandable-list li { 
   color: darkblue; 
}

Persistence Link

.qc-cmp2-container .qc-cmp2-persistent-link { 
   background-color: red; 
   color: white; 
   padding: 10px;  
}

Create Theme

After creating your property, it's time to create a theme for it. InMobi CMP allows you the freedom to tailor your message, branding, and display to your audience.

A Theme is a customizable bundle of design and configuration settings, like layout, text, colors, and legal link behavior, that defines the look and feel of your CMP. Once created, you can save and assign themes to multiple sites.

1. Navigate to the Themes tab and click Create Theme. Select App Theme from the dropdown.

   

2. Theme Name (required): Enter a name for your theme.
3. For Regulation for which the theme is required, select European regulation (GDPR) or US regulation (CCPA & MSPA) or both. For more information, see GDPR and CCPA.

The theme creation process is divided into three sections for each regulation.

1. Language & Text
2. Colors
3. Typography
4. Customize Privacy

GDPR Consent Settings

Advanced Customization (for Premium properties only)

1. Choose from supported languages for the CMP UI.
2. Enter the desired text for your primary button.

   

3. Enter the desired text for your secondary button.
4. Enter the desired text for your Disagree button or X Button Tooltip text.
5. Enter the Privacy Header text.
6. Add the Privacy Body copy.
7. Add custom footer links as needed. The first entry is reserved as the privacy policy link.

Choose Font Name & Font Size

Once you've set the language and text of your consent screen, you can further customize it by choosing the font and font size you prefer.

1. Select the Title Font for the heading of your consent pop-up.
2. Select the size of the font for your consent pop-up's title. Ensure Font size is constrained between 10px and 24px.
3. Select the Body Font Name and Body Font Size for the body text of your consent pop-up.
4. Choose the Font Size for the Call to Action Button on the consent pop-up.
5. Choose the Font Size for the Privacy Policy link.

Consent or Pay (for Premium properties only)

1. Choose from supported languages for the CMP UI.
2. Choose Layout of your consent pop-up.

   

3. Enter the Button Text for Accept Policy.
4. Enter Button Text to View Preferences.
5. Enter Button Text to Enable Subscribe.
6. Enter Button Text to Enable Login.
7. Enter the Privacy Header text.
8. Add the Privacy Body Copy.
9. Add custom footer links as needed. The first entry is reserved as the privacy policy link.

Choose Font Name & Font Size

Once you've set the language and text of your consent screen, you can further customize it by choosing the font and font size you prefer.

1. Select the Title Font for the heading of your consent pop-up.
2. Select the size of the font for your consent pop-up's title. Ensure Font size is constrained between 10px and 24px.
3. Select the Body Font Name and Body Font Size for the body text of your consent pop-up.
4. Choose the Font Size for the Call to Action Button on the consent pop-up.
5. Choose the Font Size for the Privacy Policy link.

US Consent Settings

These support the dropdown/search functionality in the UI:

Use this API to retrieve the list of all DSP accounts integrated with the InMobi Exchange. This metadata API is useful when setting up or editing deals, as it provides valid DSP ID and name pairs required for deal creation.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/meta/dsps

Parameters

Sample Request

 curl -X GET "https://apis.demand.ssp.inmobi.com/v1/meta/accounts" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"

Sample Response

{
  "data": [
    {
      "name": "Aarki RTB",
      "id": "cbab4104e7f14e2fbd2e21e96a8bf787"
    },
    {
      "name": "Adcolony_FirstRTBD",
      "id": "50f3f94bf37047ff982aca2536d781d1"
    },
    {
      "name": "Adcolony RTBD",
      "id": "b77bf7ba928f412eb02714cb5983f8d2"
    },
    {
      "name": "AdElement RTBD",
      "id": "bb9c931396d44a45b7e11b9b259e2d42"
    }
    // ...more DSPs
  ]
}

This metadata API returns the list of all supported countries that can be used for country-level geo-targeting in deals. The API supports pagination to retrieve results in batches.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/meta/countries

Parameters

Headers

Query Parameters

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/meta/countries?num_items=30&page_num=2" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json" \

Sample Response

{
  "data": {
    "countries": [
      { "id": 150, "name": "India" },
      { "id": 108, "name": "Brazil" },
      { "id": 151, "name": "Canada" },
      { "id": 152, "name": "Netherlands" },
      { "id": 153, "name": "Bulgaria" },
      { "id": 154, "name": "Japan" },
      { "id": 155, "name": "China" }
      // ...more countries
    ],
    "pageNum": 2,
    "numItems": 30,
    "nextPage": true,
    "totalItems": 254,
    "totalPages": 9
  }
}

This metadata API returns the list of states or regions available under a specific country. It is typically used when setting up state-level geo-targeting during deal creation or update.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/meta/states

Parameters

Headers

Query Parameters

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/meta/states?country_id=108" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json" \

Sample Response

{
  "data": {
    "states": [
      {
        "id": 31328,
        "name": "ACRE",
        "countryName": "Brazil",
        "countryId": 108
      },
      {
        "id": 31300,
        "name": "ALAGOAS",
        "countryName": "Brazil",
        "countryId": 108
      },
      {
        "id": 31301,
        "name": "AMAPA",
        "countryName": "Brazil",
        "countryId": 108
      }
      // ...more states
    ],
    "pageNum": 1,
    "numItems": 20,
    "nextPage": true,
    "totalItems": 39,
    "totalPages": 2
  }
}

This metadata API returns a list of cities within a specified country and (optionally) a specific state. It is used to configure precise city-level targeting while creating or updating deals.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/meta/cities

Parameters

Headers

Query Parameters

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/meta/cities?country_id=108&state_id=31301" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json" \

Sample Response

{
  "data": {
    "cities": [
      {
        "id": 1174474,
        "name": "CARIPI",
        "stateName": "AMAPA",
        "stateId": 31301,
        "countryName": "Brazil",
        "countryId": 108
      },
      {
        "id": 73777,
        "name": "MACAPA",
        "stateName": "AMAPA",
        "stateId": 31301,
        "countryName": "Brazil",
        "countryId": 108
      }
      // ... more cities
    ],
    "pageNum": 1,
    "numItems": 5,
    "nextPage": false,
    "totalItems": 5,
    "totalPages": 1
  }
}

This metadata API is used to retrieve ZIP or postal code information for supported countries. It helps in configuring zipcode-level geo-targeting in deal setup.

Note: This API is designed to filter zip codes by a numeric string using the search parameter.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/meta/zip-code

Parameters

Headers

Query Parameters

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/meta/zip-code?search=302012" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"

Sample Response

{
  "data": {
    "countries": [
      {
        "id": 11,
        "name": "India",
        "zipcodes": [
          {
            "id": 5558498,
            "code": "302012"
          }
        ]
      }
    ],
    "pageNum": 1,
    "numItems": 1,
    "nextPage": false,
    "totalItems": 1,
    "totalPages": 1
  }
}

This metadata API returns the list of ad types supported by InMobi, along with their internal id, name, and broad externalName classification. These IDs are required for configuring ad type targeting in deals.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/meta/ad-type

Parameters

Headers

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/meta/ad-type" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"

Sample Response

{
  "data": [
    {
      "id": 0,
      "name": "Banner/Interstitial",
      "externalName": "Display"
    },
    {
      "id": 1,
      "name": "Interstitial Video",
      "externalName": "Video"
    },
    {
      "id": 6,
      "name": "Native",
      "externalName": "Native"
    },
    {
      "id": 10,
      "name": "Audio Banner",
      "externalName": "Audio"
    }
    // ...more ad types
  ]
}

This metadata API returns the list of supported ad slot sizes (width x height) available for inventory targeting. Each ad slot is identified by a unique id and its standard dimension name.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/meta/ad-slot

Parameters

Headers

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/meta/ad-slot" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"

Sample Response

{
  "data": [
    { "id": 14, "name": "320x480" },
    { "id": 11, "name": "728x90" },
    { "id": 15, "name": "320x50" },
    { "id": 18, "name": "160x600" },
    { "id": 0,  "name": "0x0" },
    { "id": 37, "name": "320x100" },
    { "id": 16, "name": "768x1024" },
    { "id": 32, "name": "480x320" },
    { "id": 33, "name": "1024x768" },
    { "id": 10, "name": "300x250" }
  ]
}

This metadata API returns a list of supported Operating Systems (OS) that can be used for device-level targeting during deal configuration. Each OS is identified by a unique ID and a human-readable name.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/meta/operating-system

Parameters

Headers

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/meta/operating-system" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"

Sample Response

{
  "data": [
    { "id": 3, "name": "Android" },
    { "id": 42, "name": "Android Automotive" },
    { "id": 11, "name": "Bada OS" },
    { "id": 35, "name": "BlackBerry OS" },
    { "id": 18, "name": "Desktop" },
    { "id": 21, "name": "FireFox OS" },
    { "id": 32, "name": "Fire OS" },
    { "id": 43, "name": "Fuchsia" },
    { "id": 44, "name": "HarmonyOS" },
    { "id": 15, "name": "Hiptop OS" },
    { "id": 5, "name": "iOS" },
    { "id": 38, "name": "iPadOS" }
  ]
}

This metadata API returns a list of audience segments available for targeting. These segments can be used to define behavioral, contextual, or 3rd-party targeting in a deal. The API supports search, pagination, and country filtering.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/meta/audiences

Parameters

Headers

Query Parameters

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/meta/audiences?limit=2&offset=0&searchValue=Weather&country=USA" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"

Sample Response

{
  "data": {
    "records": [
      {
        "type": "segment_detailed",
        "id": "374c4f34-5ad5-437c-aa20-8f153d04970d",
        "segmentCore": {
          "type": "segment_third_party",
          "startDateTime": "2024-12-31T00:00:00.000Z",
          "endDateTime": "2099-12-31T00:00:00.000Z",
          "brands": [],
          "categories": [],
          "tags": [],
          "widgets": [],
          "taxonomyType": "custom",
          "datasets": [],
          "name": "TWC > Weather Targeting > Relative > Current > Unseasonably Warm and Sunny",
          "description": "TWC > Weather Targeting > Relative > Current > Unseasonably Warm and Sunny",
          "providerId": "0f6e5ac5-cf01-494e-895e-840c416c4f4b",
          "pricing": {
            "value": 0,
            "pricingModel": "CPM"
          },
          "membershipTTLInHours": 8760,
          "segmentType": "PUBLIC",
          "primaryCountry": 94,
          "clientType": "IDI",
          "externalId": "de97d203-aa46-488d-b5de-3c9399e05d03",
          "externalSegmentId": "AU_RTD_9crq",
          "snapshotEpoch": 0
        },
        "createdOn": 1737023889992,
        "updatedOn": 1737023889992,
        "createdBy": "NA",
        "updatedBy": "NA",
        "isDeprecated": false,
        "segmentLifeCycleStage": "CREATED",
        "stats": {
          "reach": 0
        },
        "consumerAccountIdList": []
      },
      {
        "type": "segment_detailed",
        "id": "e246b77b-b71a-4537-8789-1ea07c5e2219",
        "segmentCore": {
          "type": "segment_third_party",
          "startDateTime": "2024-12-31T00:00:00.000Z",
          "endDateTime": "2099-12-31T00:00:00.000Z",
          "brands": [],
          "categories": [],
          "tags": [],
          "widgets": [],
          "taxonomyType": "custom",
          "datasets": [],
          "name": "TWC > Weather Targeting > Relative > Current > Unseasonably Cool",
          "description": "TWC > Weather Targeting > Relative > Current > Unseasonably Cool",
          "providerId": "0f6e5ac5-cf01-494e-895e-840c416c4f4b",
          "pricing": {
            "value": 0,
            "pricingModel": "CPM"
          },
          "membershipTTLInHours": 8760,
          "segmentType": "PUBLIC",
          "primaryCountry": 94,
          "clientType": "IDI",
          "externalId": "de97d203-aa46-488d-b5de-3c9399e05d03",
          "externalSegmentId": "AU_RTD_9crp",
          "snapshotEpoch": 0
        },
        "createdOn": 1737023889626,
        "updatedOn": 1737023889626,
        "createdBy": "NA",
        "updatedBy": "NA",
        "isDeprecated": false,
        "segmentLifeCycleStage": "CREATED",
        "stats": {
          "reach": 0
        },
        "consumerAccountIdList": []
      }
    ],
    "pagination": {
      "pageNum": 0,
      "pageSize": 2,
      "totalPages": 264,
      "totalRecords": 528
    }
  }
}

This API allows you to retrieve the synchronization status of a deal between the InMobi platform and a connected DSP. It provides details like the proposal ID, name, revision number, and last sync timestamp.

API Endpoint

POST https://apis.demand.ssp.inmobi.com/v1/deals/sync

Parameters

Headers

Request Body

Sample Request

curl -X POST "https://apis.demand.ssp.inmobi.com/v1/deals/sync" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json" \
-d '{ "rpDealId": "4263509454" }'

Sample Response

{
  "data": {
    "data": {
      "Sync Timestamp": "2025-06-26 08:58",
      "Proposal Id": 3491448,
      "Proposal Name": "TTD_SYNC_TEST_DEAL - Package",
      "Revision Number": 1
    }
  }
}

The Deal Management APIs allow InMobi partners—such as DSPs, agencies, curators, and advertisers—to programmatically create, retrieve, update, and manage their deals at scale. These APIs are designed to eliminate manual workflows, support faster deal creation, and provide fine-grained control over deal configuration and targeting.

Use these endpoints to integrate directly with InMobi’s exchange and manage deals aligned with your business goals.API Topics

• Get Auth Token – Authenticate with the API using a secure bearer token.
• Create Deal – Set up a new public deal with targeting, pricing, and seat-level details.
• Get Deals List – Retrieve all deals created by your organization with filtering options.
• Get Deal by ID – Fetch detailed information for a specific deal.
• Update Deal – Modify an existing deal’s attributes or targeting rules.
• Delete Deal – Expire or remove a deal from the platform.
• Metadata APIs – Access supporting datasets.
• Error Codes - Understand standardized error responses.

These APIs require authentication via a bearer token, along with a mandatory client ID and Client Secret, for tracking and access control.

Authentication

To access the Deals API, every request must include the following three mandatory headers:

Sample Request

curl --location 'https://iam.inmobi.com/iam/v3/app/token' \
--header 'Content-Type: application/json' \
--data '{
  "clientId": "<client id value>",
  "clientSecret": "<client secret value>"

}'

Sample Response

{
  "httpCode": 200,
  "data": {
    "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InZSY0Flb29fcFFMTnFiREo4ekZ2ciJ9.eyJpc3MiOiJodHRwczovL3N0YWdpbmcuaWFtLmF1dGguaW5tb2JpLmNvbS8iLCJzdWIiOiJoelVlaEh5alNDcGdwN0IxSU9mT0s0Z1ozZUtRekxsdUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9pbm1vYmlpYW0udXMuYXV0aDAuY29tL2FwaS92Mi8iLCJpYXQiOjE3NTA3ODAzNjEsImV4cCI6MTc1MDg2Njc2MSwic2NvcGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJhenAiOiJoelVlaEh5alNDcGdwN0IxSU9mT0s0Z1ozZUtRekxsdSJ9.c3xwBQfXq5oVY04ReS8uFrgEsbnW_aGUkS6D3UEYMAosbcc66_tMFoQUIDuhk0tj-4ol9YNpMviy5ot4JyadErhRGa3gzyUQnwz6lFSNWK95g_k1weVKq3gyhp5-ImBNyW0xNvUG4u7QIG0KmC1jTAfjM5kJsL4SL1XWzmEVNc_o50tvBjGoBCc88ChDkel3NuZYBxCN-idQ3Y0N_okA68RYIgzlhIfpiv4LccOEib3I_jK17myZVlkno7JlG2p8HTvkYVPS3p15OhDAKt9sLMAN5xeCP9Fme9AtnnJNAa-E7mjxWner52I4Q75DxsBk47oEzE443FdImgz-8AJi_w",
    "validTill": "2025-06-25T15:52:41.21"
  }
}

Use the following API to create a new deal on the partner platform.

API Endpoint

POST https://apis.demand.ssp.inmobi.com/v1/deals

Parameters

Headers

Object: Deal

Object: seats[]

Object: targeting[]

Object: geography

countryTargeting

stateTargeting

Inside states[]

cityTargeting

Inside cities[]

Object: inventory

inventoryTypeTargeting

placementContextTargeting

Object: audiences

Object: devices

Object: targetKpis[]

Object: tracking

viewabilityPartners.ias

Sample Request

curl -X POST "https://apis.demand.ssp.inmobi.com/v1/deals" \
-H "accept: application/json" \
-H "Authorization: Bearer <your bearer id>" \
-H "X-USER-ID: testapp" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json" \
-d '{
  "deal": {
    "name": "testdeal1",
    "dspId": "cbab4104e7f14e2fbd2e21e96a8bf787",
    "seats": [
      {
        "id": "seat1"
      }
    ],
    "startDate": "17/07/2025 00:00:00",
    "endDate": "18/07/2025 23:59:59",
    "dealType": "PREFERRED_DEAL",
    "dealFloor": 10,
    "dealFloorType": "STATIC",
    "margin": 20,
    "targeting": [
      {
        "geography": {
          "stateTargeting": {
            "states": [
              {
                "stateIds": [
                  31207
                ]
              }
            ],
            "isIncl": true
          },
          "cityTargeting": {
            "cities": [
              {
                "countryId": 53,
                "cityIds": [
                  900611
                ]
              },
              {
                "countryId": 111,
                "cityIds": [
                  49229,
                  49222
                ]
              }
            ],
            "isIncl": true
          },
          "countryTargeting": {
            "countries": [
              125
            ],
            "isIncl": true
          }
        },
        "inventory": {
          "bundleTargeting": {
            "bundleIds": [
              "app/domain"
            ],
            "isIncl": true
          },
          "publisherTargeting": {
            "publishers": [
              "publisherwhitelist"
            ],
            "isIncl": true
          },
          "inventoryTypeTargeting": {
            "types": [
              "BROWSER"
            ],
            "isIncl": true
          },
          "adTypeTargeting": {
            "types": [
              1
            ],
            "isIncl": true
          },
          "adSlotTargeting": {
            "slots": [
              14
            ],
            "isIncl": true
          }
        },
        "audiences": {
          "csidFilterExpression": "[[5ace5190-db24-4392-8c88-4042491bca2e,7740e4bb-1963-4ed5-b4e2-c4a69a716e2f]]"
        },
        "devices": {
          "osVersions": [
            3
          ],
          "deviceIdPresent": 1
        }
      }
    ],
    "dealFloorTolerance": "",
    "isActive": false,
    "targetKpis": [
      {
        "kpi": "vcr",
        "optimisationRule": "auto",
        "target": 70,
        "isPrimary": false
      }
    ],
    "tracking": {
      "viewabilityPartners": {
        "ias": {
          "enableIas": true,
          "useInmobiIasTag": true,
          "usePartnerAdvertiserIdIas": false,
          "iasExternalTags": []
        }
      }
    }
  }
}'

Sample Response

{
  "data": {
    "id": "4263509453",
    "message": "Created successfully"
  }
}

This response confirms that the deal was created successfully and provides the unique deal ID generated by the system.

Error Codes

For more information, see Error Codes.

Use the API to retrieve a paginated list of all deals associated with your organization. Supports optional filters by status, partner, or keyword search.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/deals

Parameters

Headers

Query Parameters

You must include the standard headers: Authorization, X-USER-ID, and X-INMOBI-ORG-ID.

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/deals" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"

Sample Response

{
  "data": {
    "deals": [
      {
        "name": "testdeal1",
        "id": "4263509453",
        "seats": [
          {
            "id": "seat1"
          }
        ],
        "endDate": "2025-07-18T23:59:59",
        "status": "UPCOMING"
      },
      {
        "name": "testdeal2",
        "id": "4263509452",
        "seats": [
          {
            "id": "seat1"
          }
        ],
        "endDate": "2025-07-18T23:59:59",
        "status": "UPCOMING"
      }
    ]
  }
}

Error Codes

For more information, see Error Codes.

Use the API to fetch the complete configuration of a specific deal using its unique ID.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/deals?deal_id=<deal_id>

Parameters

Headers

Query Parameters

All requests must include the headers: Authorization, X-USER-ID, and X-INMOBI-ORG-ID.

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/deals?deal_id=4263509468" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"

Sample Response

{
  "data": {
    "id": "4263509468",
    "name": "testdeal1",
    "seats": [
      {
        "id": "seat1"
      }
    ],
    "dspId": "cbab4104e7f14e2fbd2e21e96a8bf787",
    "dspName": "Aarki RTB",
    "startDate": "17/07/2025",
    "endDate": "18/07/2025",
    "dealType": "PREFERRED_DEAL",
    "dealFloor": 10,
    "dealFloorType": "STATIC",
    "dealFloorTolerance": "",
    "status": "UPCOMING",
    "isActive": false,
    "isDealSynced": false,
    "targeting": [
      {
        "targetingSegmentId": 30890,
        "geography": {
          "stateTargeting": {
            "states": [
              {
                "countryId": 128,
                "countryName": "Algeria",
                "stateIds": [
                  {
                    "id": 31207,
                    "name": "ADRAR"
                  }
                ]
              }
            ],
            "isIncl": true
          },
          "cityTargeting": {
            "cities": [
              {
                "countryId": 53,
                "countryName": "Germany",
                "cityIds": [
                  {
                    "id": 900611,
                    "name": "RHEINLAND-PFALZ - AACH"
                  }
                ]
              },
              {
                "countryId": 111,
                "countryName": "Belgium",
                "cityIds": [
                  {
                    "id": 49229,
                    "name": "OOST-VLAANDEREN - AALST"
                  },
                  {
                    "id": 49222,
                    "name": "VLAAMS-BRABANT - AARSCHOT"
                  }
                ]
              }
            ],
            "isIncl": true
          },
          "countryTargeting": {
            "countries": [
              {
                "id": 125,
                "name": "Afghanistan"
              }
            ],
            "isIncl": true
          }
        },
        "inventory": {
          "inventoryTypeTargeting": {
            "types": [
              {
                "id": "BROWSER",
                "name": "Browser"
              }
            ],
            "isIncl": true
          },
          "adTypeTargeting": {
            "types": [
              {
                "id": 1,
                "name": "Interstitial Video",
                "externalName": "Video"
              }
            ],
            "isIncl": true
          },
          "adSlotTargeting": {
            "slots": [
              {
                "id": 14,
                "name": "320x480"
              }
            ],
            "isIncl": true
          },
          "bundleTargeting": {
            "bundleIds": [
              "app/domain"
            ],
            "isIncl": true
          },
          "publisherTargeting": {
            "publishers": [
              "publisherwhitelist"
            ],
            "isIncl": true
          }
        },
        "audiences": {
          "csidFilterExpression": "[[5ace5190-db24-4392-8c88-4042491bca2e,7740e4bb-1963-4ed5-b4e2-c4a69a716e2f]]"
        },
        "devices": {
          "osVersions": [
            {
              "id": 3,
              "name": "Android"
            }
          ],
          "deviceIdPresent": 1
        }
      }
    ],
    "tracking": {
      "viewabilityPartners": {
        "ias": {
          "enableIas": true,
          "useInmobiIasTag": true,
          "usePartnerAdvertiserIdIas": false,
          "iasExternalTags": []
        }
      }
    },
    "margin": 20
  }
}

Error Codes

For more information, see Error Codes.

Use the API to update the details of an existing deal using its unique deal ID. You can modify attributes like end date, targeting, margins, floor price, and more.

API Endpoint

PUT https://apis.demand.ssp.inmobi.com/v1/deals

Parameters

Headers

General

Targeting

KPIs & Tracking

Sample Request

curl -X PUT "https://apis.demand.ssp.inmobi.com/v1/deals" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json" \
-d '{
  "deal": {
    "id": "4263509468",
    "name": "testdeal1",
    "dspId": "cbab4104e7f14e2fbd2e21e96a8bf787",
    "seats": [
      {
        "id": "seat1"
      }
    ],
    "startDate": "17/07/2025 00:00:00",
    "endDate": "18/07/2025 23:59:59",
    "dealType": "PREFERRED_DEAL",
    "dealFloor": 10,
    "dealFloorType": "STATIC",
    "margin": 20,
    "targeting": [
      {
        "targetingSegmentId": 30890,
        "geography": {
          "stateTargeting": {
            "states": [
              {
                "stateIds": [
                  31207
                ]
              }
            ],
            "isIncl": true
          },
          "cityTargeting": {
            "cities": [
              {
                "countryId": 53,
                "cityIds": [
                  900611
                ]
              },
              {
                "countryId": 111,
                "cityIds": [
                  49229,
                  49222
                ]
              }
            ],
            "isIncl": true
          },
          "countryTargeting": {
            "countries": [
              125
            ],
            "isIncl": true
          }
        },
        "inventory": {
          "bundleTargeting": {
            "bundleIds": [
              "app/domain"
            ],
            "isIncl": true
          },
          "publisherTargeting": {
            "publishers": [
              "publisherwhitelist"
            ],
            "isIncl": true
          },
          "inventoryTypeTargeting": {
            "types": [
              "BROWSER"
            ],
            "isIncl": true
          },
          "adTypeTargeting": {
            "types": [
              1
            ],
            "isIncl": true
          },
          "adSlotTargeting": {
            "slots": [
              14
            ],
            "isIncl": true
          }
        },
        "audiences": {
          "csidFilterExpression": "[[5ace5190-db24-4392-8c88-4042491bca2e,7740e4bb-1963-4ed5-b4e2-c4a69a716e2f]]"
        },
        "devices": {
          "osVersions": [
            3
          ],
          "deviceIdPresent": 1
        }
      }
    ],
    "dealFloorTolerance": "",
    "isActive": false,
    "targetKpis": [
      {
        "kpi": "vcr",
        "optimisationRule": "auto",
        "target": 70,
        "isPrimary": false
      }
    ],
    "tracking": {
      "viewabilityPartners": {
        "ias": {
          "enableIas": true,
          "useInmobiIasTag": true,
          "usePartnerAdvertiserIdIas": false,
          "iasExternalTags": []
        }
      }
    }
  }
}'

Sample Response

{
  "data": {
    "id": "4263509468",
    "message": "Updated successfully"
  }
}

Error Codes

For more information, see Error Codes.

Welcome to the Monetization and Integration Guides, your central resource for setting up and scaling monetization with InMobi across environments. Whether you’re using InMobi as a demand source on a mediation platform or integrating it directly as a mediation layer, these guides are designed to help you go live with confidence.

These guides cover integrations across:

• In-app (Audience Bidding)
• Mobile Web
• Connected TV (CTV)

They also walk you through key steps for real-time bidding setup, SDK integration, and yield partner configuration — ensuring a seamless monetization experience on the platform of your choice.

Integration Types

Depending on the platform and inventory type, InMobi supports two modes of integration:

• SDK-Based Integration: Integrate InMobi’s SDK directly into your app to enable real-time ad rendering and monetization.
• oRTB (Open Real-Time Bidding): Integrate via the oRTB protocol for real-time bidding and dynamic yield management, typically used for web and CTV environments.

Supported Ad Formats

Depending on the platform and environment, InMobi supports:

• Banner
• Interstitial
• Rewarded Video
• Native 
• In-stream and Oustream Video

Partners

InMobi is now integrated with all the leading header bidding and mediation platforms, including:

Introduction

InMobi is available as a bidder on Amazon Publisher Services (APS) through Transparent Ad Marketplace (TAM) and Unified Ad Marketplace (UAM). This server-side integration uses the OpenRTB protocol and does not require SDK implementation. This setup enables seamless access to InMobi’s demand, offering an efficient, API-based monetization path for both mobile web and in-app inventory.

Requirements

To successfully integrate InMobi with APS, ensure you meet the following prerequisites:

• InMobi Account: You must have an active account on the InMobi Publisher Dashboard to access inventory settings, reporting, and account configuration. For more information, see Create InMobi Account.
• APS Account: You must have an active account on APS, either for in-app or web monetization.
• Inventory Setup: Create ad placements in your InMobi Publisher Dashboard. The following environments are supported:
  • Mobile
  • Web
• Supported Ad Formats
  • Mobile (In-App): Banner, Interstitial, Video (all formats), Native.
  • Web: Banner, In-stream Video, Native.

Configure InMobi Dashboard

Use the toggle below to view the differences in dashboard configuration across platforms.

Integrate with Amazon Publisher Services

Use the toggles below to view platform-specific integration instructions.

For further assistance, Contact Us.

Use the API to delete (expire) a deal from the InMobi platform using its unique ID. This action marks the deal as inactive and prevents it from being served.

API Endpoint

DELETE https://apis.demand.ssp.inmobi.com/v1/deals?deal_id=<deal_id>

Parameters

Headers

Query Parameters

Sample Request

curl -X DELETE "https://apis.demand.ssp.inmobi.com/v1/deals?deal_id=4263509453" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"

Response

{
  "data": {
    "id": "4263509453",
    "message": "Deleted successfully"
  }
}

This confirms the deal was successfully marked as inactive and removed from active use.

Error Codes

For more information, see Error Codes.

Introduction

This guide covers integrating InMobi as a real-time bidder on MAX, AppLovin’s in-app header bidding platform. InMobi uses the oRTB protocol and renders ads via its SDK for Banner, Interstitial, Video, and Native formats. Ideal for gaming publishers, this SDK-based integration supports in-app environments only.

Prerequisites

Ensure the following before you get started with this integration:

• An active InMobi account on the InMobi Publisher Platform to access inventory settings, reporting, and account configuration. For more information, see Create InMobi Account.
• An active MAX account.
• An integration with the MAX SDK and InMobi MAX adapter. Download for Android and iOS.
• Supports in-app inventory.
• Supports waterfall and bidding.
• Ad Formats Supported: Banner, Interstitial, Rewarded Video, and Native.

Configure InMobi Placements

To get your account and inventory up and running on the InMobi Publisher Platform, follow the instructions below:

1. Create an InMobi Account or log in to the InMobi Publisher Platform. 
2. If you are adding apps and placements for the first time, see Add Your App or Website.

   To create placements for MAX:

   1. Search for the app or website you would like to create a placement for and click + Add a placement.
   2. Select an ad unit. For more information on our ad units, see Ad Units.
   3. Name your placement. Enable Audience Bidding and select AppLovin MAX from the Partner dropdown.
   4. Click Create Placements.

Add InMobi as a Bidder on MAX 

1. On the MAX dashboard, go to MAX > Manage > Ad Units and select the ad unit where you want to enable InMobi.
2. Enter the InMobi Account ID and Placement ID.
   • Find your InMobi account ID on the InMobi Publisher Platform under Finance > Payment Settings > Payment Information.

     

   • Find the InMobi Placement ID under the placement name.

     

For more details, see InMobi Integration Guide on MAX's documentation.

Integration Checklist for Native

• Integrate the MAX SDK and the MAX-InMobi adapter. Native support for InMobi requires SDK version 10.1.0.1 (iOS) and 10.0.9.3 (Android).
• Use the main image in your native ad to enable impression tracking. Impressions won't register without it.
• We support a default image aspect ratio of 256:165 (~3:2). Let us know if you support other ratios.
• Native ad templates supported on MAX include small, medium, and manual:
  • Small/medium are predefined templates.
  • Manual allows full customization to match your feed.

For more information, see the following links:

iOS: Integration Guide | Enabling Manual Native Ads | Enabling Small/Medium Template

Android: Integration Guide | Enabling Manual Native Ads | Enabling Small/Medium Template

For further assistance, Contact Us.

Introduction

CloudX is an in-app mediation platform that enables publishers to monetize their inventory through real-time bidding and SDK-based integrations. This guide explains how to integrate InMobi with CloudX for Android and iOS applications using the InMobi SDK.

This integration supports global in-app inventory and key ad formats, including Banner, Interstitial, Native(upcoming), and Rewarded ads.

Requirements

Before starting the integration, ensure you have the following:

• An active account on the InMobi Publisher Platform. For more information, see Create InMobi Account.
• Access to the CloudX dashboard.
• Your app already added to the InMobi Publisher Platform dashboard. If you are adding app inventory for the first time, see Add Your App or Website.
• Placements created for the required ad formats. If you are adding placements for the first time, see Create Placements and Ad Units.
• Supported Ad Formats
  • Banner
  • Interstitial
  • Rewarded
  • Native (in progress)

Configure InMobi Dashboard

1. Log in to the InMobi Publisher Dashboard.
2. Search the app you would like to create a placement for and click + Add a placement.

   

3. Select the ad unit type for which you want to create a placement.

   

4. Add Placement Details. Switch on Audience Bidding and select CloudX from the Partner dropdown.  

   

5. Click Create Placement.

Integrate with CloudX

Before you add InMobi to the CloudX dashboard, ensure you have the following:

• InMobi Account ID: You can find it in the top left corner under your Account's name. 

  

• Placement ID: The InMobi Placement ID is present under the placement name. 

  

• Integrate the CloudX SDK using the platform guides for Android and iOS, and meet the InMobi Adapter requirements for iOS.
• Follow the steps in the InMobi Network guide to configure InMobi bidding in CloudX. 

For further assistance, Contact Us.

Introduction

This guide outlines how to integrate InMobi as a real-time bidder on DT FairBid, Digital Turbine’s mediation platform. InMobi connects via the oRTB protocol and renders Banner, Interstitial, and Video ads using its SDK. Ideal for global in-app publishers across gaming and non-gaming verticals.

Prerequisites

Ensure the following before you get started with this integration:

• An active InMobi account on the InMobi Publisher Platform to access inventory settings, reporting, and account configuration. For more information, see Create InMobi Account.
• An active DT Fairbid account.
• An integration with the DT Fairbid SDK and InMobi SDK and adapter. Download the latest SDK versions here. To integrate the InMobi SDK, follow the instructions on the Supported Networks page.
• Supports in-app inventory.
• Supports waterfall and bidding.
• Ad Formats Supported: Banner, Interstitial, Rewarded Video.

Configure

To get your account and inventory up and running on the InMobi Publisher Dashboard, follow the instructions below:

1. Create an InMobi Account or log in to the InMobi Publisher Dashboard. 
2. If you are adding apps and placements for the first time, see Add Your App or Website.

   To create placements for DT FairBid:

   1. Search for the app you would like to create a placement for and click + Add a placement.
   2. Select an ad unit. For more information on our ad units, see Ad Units.
   3. Name your placement. Enable Audience Bidding and select DT Fairbid from the Partner dropdown.
   4. Click Create Placements.

The InMobi Placement ID is present under the placement name. You will need it while configuring InMobi placements on the DT Console.

Add InMobi As a Mediated Network on DT Console

Before adding InMobi as a mediated network to DT Fairbid, ensure you:

• Retrieve your InMobi Account ID and API key.
  • Find your InMobi Account ID on the InMobi Publisher Platform under Finance > Payment Settings > Payment Information.

    

  • To locate your InMobi Reporting API key:
    • Go to My Account > Account Settings. Navigate to the API Key tab and click Generate API Key.

      

    • Select the email of the user that requires the key, and click Generate API Key. A file containing the API key and username/login name will be generated.
• Add your App using the DT Console.
• Set up a DT Placement for each InMobi ad type you want to mediate with DT.

Once done, follow the steps below:

1. Log in to the DT Console, and click App Management.
2. Set up InMobi or InMobi bidder as a mediated network using your InMobi Account ID and API Key.

   

   

3. Set up an ad network instance for each ad type you want to mediate with DT. Use the InMobi Placement ID for the Instance ID.

For further assistance, Contact Us.

Introduction

Integrate InMobi with Google SDK Bidding on Google Ad Manager using a direct supply path for better signal collection and ad rendering. This setup supports Banner, Interstitial, Native, and Rewarded Video formats across gaming and non-gaming apps. It enables hybrid monetization without custom adapters or changes to your existing waterfall.

Prerequisites

Ensure you have the following before you begin the integration:

• An InMobi account
• An active Google Ad Manager account
• Signed contract with InMobi
• Integration with InMobi adapters and SDK. We recommend using the latest versions. Download for Android and iOS
• Formats supported: Banner, Interstitial, Native, and Rewarded Video
• Supports in-app inventory
• Supports both waterfall and bidding 
• For non-SDK integration, see Google Open Bidding

Configure InMobi

Add InMobi as a Bidder on Google Ad Manager

To verify your SDK bidding setup, see Verify your SDK Bidding setup.

For Google Ad Manager docs, see Integrate InMobi with mediation for iOS and Android. 

Import InMobi SDK and Adapter

After setting up InMobi on the SSP and adding it as a bidder in GAM, import the InMobi SDK and adapter.

• Android: Follow the instructions in Step 3: Import the InMobi SDK and adapter.
• iOS: Follow the instructions in Step 3: Import the InMobi SDK and adapter.

Additional Instructions for GDPR

Follow the additional instructions below about GDPR settings on your Google dashboard for higher monetization results. The following configuration applies to traffic from European Economic Area and publishers using AdMob/GAM CMP for GDPR consent purposes. Google CMP provides two ways of adding ad partners on their AdMob/GAM platform:

• Commonly used ad partners
• Custom ad partners

InMobi is not part of ‘Commonly used ad partners’ by default, and you must add it manually by selecting Custom ad partners.

Follow the instructions below to enable InMobi under Custom ad partners on your Google dashboard.

1. On the Google Dashboard, select Privacy & messaging GDPR Settings Review your ad partners.
2. Select Custom ad partners and then InMobi from the list and save the settings.

For further assistance, Contact Us.

Introduction

This guide explains how to integrate InMobi with Google SDK Bidding on AdMob. It uses a direct supply path for better signal collection and ad rendering, supporting Banner, Interstitial, Native, and Rewarded Video formats. 

Prerequisites

Ensure you have the following before you begin the integration:

• An InMobi account
• An active Google AdMob account
• Signed contract with InMobi
• Integration with InMobi adapters and SDK. We recommend using the latest versions. Download for Android and iOS
• Formats supported: Banner, Interstitial, Rewarded Video, and Native
• Supports in-app inventory only
• Supports both waterfall and bidding 
• For non-SDK integration, see Google Open Bidding

Configure InMobi

Follow these steps to set up your account and inventory on the InMobi Publisher Dashboard.

Add InMobi as an Ad Source on Google AdMob

Import InMobi SDK and Adapter

After setting up InMobi on the SSP and adding it as an ad source in AdMob, import the InMobi SDK and adapter.

• Android: Follow the instructions in Step 3: Import the InMobi SDK and adapter.
• iOS: Follow the instructions in Step 3: Import the InMobi SDK and adapter.

Additional Instructions for GDPR

Follow the additional instructions below about GDPR settings on your Google dashboard for higher monetization results. The following configuration applies to traffic from European Economic Area and publishers using AdMob/GAM CMP for GDPR consent purposes. Google CMP provides two ways of adding ad partners on their AdMob/GAM platform:

• Commonly used ad partners
• Custom ad partners

InMobi is not part of ‘Commonly used ad partners’ by default, and you must add it manually by selecting Custom ad partners.

Follow the instructions below to enable InMobi under Custom ad partners on your Google dashboard.

1. On the Google Dashboard, select Privacy & messaging GDPR Settings Review your ad partners.
2. Select Custom ad partners and then InMobi from the list and save the settings.

For further assistance, Contact Us.

Introduction

InMobi is a certified bidder on Google Open Bidding (GOB), supporting integration via both Google Ad Manager (GAM) and AdMob across in-app, web, and CTV inventory. This server-side integration uses the OpenRTB protocol and does not require an SDK.

Requirements

To successfully integrate InMobi with Google Open Bidding, ensure you meet the following prerequisites:

• Active account on GAM or AdMob for Mobile App and GAM 360, Google AdX, and GAM SMB (with CTA/Click to Accept feature only) for Web.
• App-ads.txt / ads.txt setup (recommended).
• Supported Ad Formats:
  • Mobile App: Banner, Video (any format), and Native
  • Web: Banner, Instream and Outstream Video, and Native
• For SDK-based integrations, see Google AdMob and Google Ad Manager.

Configure Google Console

After setting up your InMobi account, you must enable InMobi on your Google dashboard and start sending us traffic. Use the toggles below to view platform-specific integration instructions.

Integration Request Approval

Since Open Bidding does not require an SDK integration, InMobi must approve your request before going live. Once your setup is complete, share your Google Publisher ID with your InMobi Customer Success Manager or email googlebidding@inmobi.com.

Configure InMobi Dashboard

Use the toggle below to view the differences in dashboard configuration across platforms.

Additional Instructions for GDPR

Follow the additional instructions below about GDPR settings on your Google dashboard for higher monetization results. This configuration applies to traffic from European Economic Area (EEA) and publishers using AdMob/GAM CMP for GDPR consent purposes. Google CMP provides two ways of adding ad partners on their AdMob/GAM platform:

• Commonly used ad partners
• Custom ad partners

Follow the instructions below to enable InMobi under Custom ad partners on your Google dashboard.

1. On the Google Dashboard, select Privacy & messaging GDPR Settings Review your ad partners.
2. Select Custom ad partners and then InMobi from the list and save the setting.

For further assistance, Contact Us.

Introduction

This topic explains how to integrate InMobi as a real-time bidder on Nimbus. InMobi connects via the OpenRTB (oRTB) protocol and uses the InMobi SDK to render ads when it wins an auction.

Prerequisites

Before you begin, ensure that you have the following:

• An active Nimbus account.
• A signed contract with InMobi.
• Minimum Nimbus SDK versions:
  • iOS: 2.31.0
  • Android: 2.34.0
• Supported ad formats: Banner, Interstitial, and Video (any format).

Configure

To set up your account and inventory on the InMobi Publisher Dashboard, follow these steps:

1. Create an InMobi Account or log in to the InMobi Publisher Dashboard.
2. Create Placements for Nimbus following the instructions below:

   Note

   If you are adding apps and placements for the first time, see Add Your App or Website.

   1. Search for the app you want to create a placement for and click + Add a placement.
   2. Select an ad unit. For more information on our Ad units, see Ad Units.
   3. Name your placement.

   4. Enable Audience Bidding and select Nimbus from the Partner dropdown.

      

   5. Click Create Placements. The InMobi Placement ID appears under the placement name. You will need this ID when configuring InMobi placements on the Nimbus Console.

Add InMobi to the Nimbus Console

Use the following Nimbus documentation links to complete the integration:

• Android integration guide
• iOS integration guide

Introduction

This topic describes how to integrate the InMobi SDK rendering plugin with Prebid SDK and Prebid Server. For more information about Prebid Plugin Renderers and how this setup works, see Prebid Plugin Renderer (Header Bidding).

Set up placements

1. If you do not already have an InMobi publisher account, create one.
2. After you create your account, set up your apps in the InMobi dashboard.
3. Under each app, create placements with Audience bidding enabled.
4. Select Prebid as the audience bidding partner.
5. From your Prebid Server, pass the placement ID to InMobi using the plc key. For more information, see InMobi for Header Bidding.

Android integration

Prerequisites

• Minimum InMobi SDK version: 10.8.2.
• Currently supported only on Android (Beta)

Step 1: Add dependencies

In your app’s build.gradle file, add the following:

implementation "com.inmobi.monetization:inmobi-prebid-adapter:10.8.2.0"
implementation "com.inmobi.monetization:inmobi-ads-kotlin:10.8.2"

Step 2: Register the InMobi plugin renderer

Before initializing Prebid SDK, register the InMobi renderer:

PrebidMobile.registerPluginRenderer(
    InMobiRenderer.getInstance(
        this,
        new InMobiMediationConfiguration("<<account_id>>", 
            new InMobiRendererInitListener() {
                @Override
                public void onInitCompleted(@Nullable Error error) {
                    System.out.println("InMobi SDK initialized");
                }
            }
        )
    )
);

Rendering behavior

• Once the InMobi plugin renderer is registered, Prebid SDK delegates rendering of InMobi demand to the InMobi SDK.
• Other demand continues to be rendered by the Prebid SDK.

Introduction

This topic provides a unified approach to integrating InMobi with Prebid Server across both mobile (in-app) and web platforms. It outlines the requirements, integration steps, and partner dashboard configurations necessary to enable header bidding through Prebid Server with InMobi demand. Whether you're working with a mobile app, mobile web, or desktop web environment, this guide will walk you through the complete integration process.

Requirements

To successfully integrate InMobi with Prebid Server, ensure you meet the following prerequisites:

• InMobi Account: You must have an active account on the InMobi Publisher Dashboard to access inventory settings, reporting, and account configuration. For more information, see Create InMobi Account.
• Prebid Account: You must have an active account on Prebid.
• Inventory Setup: Create ad placements in your InMobi Publisher Dashboard. The following environments are supported:
  • Mobile
  • Web
• Auction Type Support:
  • Mobile (In-App): Supports in-app header bidding (audience bidding via Prebid Server).
  • Web: Supports client-side and server-side header bidding.

Integrate

Use the toggles below to view platform-specific integration instructions.

Configure Dashboard

Use the toggle below to view the differences in dashboard configuration across platforms.

For further assistance, Contact Us.

Introduction

InMobi provides a transparent bidding adapter for Prebid.js (client-side integration) and Prebid Server (server-to-server integration). As a Prebid-approved bidder, InMobi continuously updates its adapter with new features and enhancements.

Prerequisites

• InMobi's Prebid.js adapter is available on Prebid.js v9.20 and above.
• Your website must be integrated with Prebid.js. For setup details, see the Prebid.js documentation and for the sample code, see Basic Prebid.js Example.
• Download the InMobi Prebid.js Adapter:
  1. Go to Customize and Download Prebid.js page.
  2. Select InMobi as the Bidder Adapter.
  3. Click Get Prebid.js to download the file.

Configure InMobi for Prebid.js

1. Create an InMobi Account: Sign up for an InMobi Supply Side Platform (SSP) account. For more information, see Create InMobi Account. If you already have an InMobi account, use the same credentials to monetize your web properties.
2. Add Your Website: Add your website(s) to the InMobi platform. For more information, see Add Inventory.
3. Create Placements:
   1. Search for the website where you want to create a placement.
   2. Click +Add a Placement.
   3. Select the ad unit (e.g., Banner, Video, or Native).
   4. Name your placement.
   5. Enable Audience Bidding by turning the toggle ON.
   6. From the Partner dropdown, select Prebid.
   7. Click Create Placements.

Add InMobi to Your Prebid Setup

To configure InMobi in your Prebid.js setup:

1. Add the InMobi Placement ID to your Prebid adapter configuration. For implementation details and sample code, see the InMobi Bidder Page on Prebid.org.

   

2. Map the InMobi Placement ID to the corresponding ad format and website in your Prebid.js configuration. Start sending requests from your Prebid.js setup to InMobi.

Introduction

Publica integration is the process of connecting your CTV inventory with the Publica platform, which is a CTV ad server designed to help publishers manage and monetize their video ad inventory. This guide provides step-by-step instructions for connecting your CTV inventory with InMobi via Publica. It lets publishers streamline their CTV ad operations and maximize yield by connecting with demand partners and managing ad decision-making in a flexible and transparent way.

Prerequisites

Before starting the integration, ensure you have:

• Create an InMobi account if you don't have one.
• A Publica account
• Access to the Publica dashboard

Configure InMobi

To set up your account and inventory on the InMobi Publisher Dashboard, follow these steps:

1. Sign up or log in to your InMobi Supply Side Platform account. 
2. Add your CTV Apps by following the steps outlined in Add inventory. 
3. Create new placements as follows:
   1. Search for the CTV app you want to create a placement for and click + Add a placement.
   2. Select an ad unit.

      

   3. Name your placement and choose to enable Audience Bidding by turning the toggle on. Select Custom Mediation from the Partner dropdown. Click Create Placements.

      

Add InMobi to the Publica Dashboard

To map the InMobi placements,

1. Find the InMobi Placement ID under the placement name.
2. Enter the InMobi placement ID with the corresponding ad formats and websites in your Publica dashboard.

For further assistance, Contact Us.

Introduction

SpringServe integration is the process of connecting your CTV inventory with the SpringServe platform, which is a CTV ad server designed to help publishers manage and monetize their video ad inventory. 

Prerequisites

Before starting the integration, ensure you have:

• An active InMobi account
• A SpringServe account
• Access to the SpringServe dashboard

Configure InMobi

To set up your account and inventory on the InMobi Publisher Dashboard, follow these steps:

1. Sign up or log in to your InMobi Supply Side Platform account. 
2. Add your CTV Apps by following the steps outlined in Add inventory. 
3. Create new placements as follows:
   1. Search for the CTV app you want to create a placement for and click + Add a placement.
   2. Select an ad unit.

      

   3. Name your placement and select On from the Audience Bidding dropdown. Select SpringServe from the Partner dropdown.

      

   4. Click Create Placements.

Add InMobi to the SpringServe Dashboard

To map the InMobi placements,

1. Log in to your SpringServe dashboard.
2. Create a Demand Tag.
3. Set the Demand Source as InMobi.
4. Find the InMobi Placement ID under the placement name.
5. Enter the InMobi placement ID with the corresponding ad formats and channel in your SpringServe dashboard.

For further assistance, Contact Us.

Adding the Plugin to your App

1. Open your project in the Unity editor.

2. Select Assets Import Package Custom Package, and search for the InMobiAdsUnityPlugin.unitypackage file you downloaded.

   

3. Make sure all the files are selected, and then click Import.

   

Running your Project

• iOS:
  • Navigate to File Build Settings, select the iOS platform, and select Build to export an Xcode project and a corresponding CocoaPods xcworkspace.
  • Open up the exported xcworkspace, and then navigate to Product Run in Xcode to run your project.
• Android:
  • Navigate to File Build Settings, select the Android platform, and then select Build and Run.

Unity Plugin API

You can use the common C# API in the InMobi Ads plugin to request banner, interstitial, and rewarded video ads. The code can be written once and deployed to both Android and iOS.

Providing Demographics Data

There are multiple APIs provided in InMobiPlugin Class to pass on Demographic information to InMobi SDK which helps us in better ad targeting.

Some of them are as follows:

//Set Age
public void SetAge(int age){
inmobiPluginClient.SetAge (age);
}
//Set PostalCode
public void SetPostalCode(string postalCode){
inmobiPluginClient.SetPostalCode (postalCode);
}
//Set Year of Birth
public void SetYearOfBirth(int yearOfBirth){
inmobiPluginClient.SetYearOfBirth (yearOfBirth);
}
//Set Gender GENDER_MALE or GENDER_FEMALE
public void SetGender(string gender){
inmobiPluginClient.SetGender (gender);
}

Initializing the InMobi SDK

You can use the InMobiPlugin Class to initialize the InMobi SDK. Account Id is required to initialize the InMobi SDK.

Here is the sample code to initialize the InMobi SDK:

private void initializeInMobiAds () {

//Account id used here is test account id   

InMobiPlugin inmobiPlugin = new InMobiPlugin(); 
    
    inmobiPlugin.OnInitializationCompleted += this.HandleInitializationStatus; 
    
    Dictionary<string, object=""> consentObject = new Dictionary<string, object="">(); 

#if UNITY_ANDROID 

consentObject.Add(InMobiPlugin.IM_GDPR_CONSENT_AVAILABLE, true); 

#elif (UNITY_5 && UNITY_IOS) || UNITY_IPHONE 

    consentObject.Add(InMobiPlugin.IM_GDPR_CONSENT_AVAILABLE, “true”); 
#endif 

    consentObject.Add(InMobiPlugin.IM_GDPR_CONSENT_IAB, "IAB_STRING"); 
    inmobiPlugin.Init("4028cb8b2c3a0b45012c406824e800ba", consentObject); 
}  
 
public void HandleInitializationStatus (object sender, SdkInitializationStatusArgs args) { 

Debug.Log("SDK Initialization status code : " + args.status.Code + " and reason : " + 
        args.status.Reason); 
}

Let’s understand a few things here before you proceed:

What is a consentObject? - A consentObject is a dictionary representation of all kinds of consent provided by the publisher to the SDK. The key is mandatory if you wish to monetize traffic from EEA region. You can read further on GDPR regulations here.

It is mandatory to initialize the InMobi SDK before making any ad request to InMobi. It is advised to do it at the start of the app itself.

Age Restriction API

For COPPA compliance, you can indicate whether the user is a child. Set to true if the user is under 13 in the US, or the applicable age in other regions.

// Set age restriction for COPPA compliance
// Set to true if the user is a child (under 13 in US)
inMobiPlugin.SetAgeRestriction(true);

Publisher Signals

Publisher Signals

Publisher Signals allow you to pass contextual data to improve ad targeting and yield. You can signal information about user behavior, acquisition source, and other attributes to help generate better ad performance.

Setting Publisher Signals

Create a dictionary with signal keys and values, then pass it to the SDK. This method must be called after InMobi SDK is successfully initialized. Ensure you call this function and update the values before every ad request.

// Create a dictionary with all required signals and corresponding values
Dictionary<string, object=""> publisherSignals = new Dictionary<string, object="">();

// User monetization signals
publisherSignals.Add("iap", true);              // User has made IAP
publisherSignals.Add("ua_type", "paid");        // User is acquired via paid medium
publisherSignals.Add("iap_type", "minnow");     // User has made low purchases
publisherSignals.Add("iaa_type", "whale");      // User has seen high number of ads

// Session and impression depth signals
publisherSignals.Add("s_dep_rew", 4);           // User has seen 4 rewarded ads in current session
publisherSignals.Add("i_dep_rew", 10);          // User has seen 10 rewarded ads in lifetime

// Performance signals
publisherSignals.Add("ctr_rew", 9.25);          // Historical CTR for user is 9.25%
publisherSignals.Add("abp_5_rew", 0.01720);     // Average winning bid price for last 5 rewarded auctions was $0.01720, eCPM is $17.2

// Pass the signals to InMobi SDK
inMobiPlugin.PutPublisherSignals(publisherSignals);
</string,></string,>

Getting Publisher Signals

You can retrieve the currently set signals to verify what data is being passed.

// Check what signals are set already
Dictionary<string, object=""> currentSignals = inMobiPlugin.GetPublisherSignals();</string,>

Resetting Publisher Signals

Clear all the signals data for the user when needed.

// Clear all the signals data for the user
inMobiPlugin.ResetPublisherSignals();

Passing GDPR values

You must provide a consentObject in every session. SDK does not persist consent, it only keeps the consentObject in memory. If the app is relaunched, SDK will lose the consentObject. Within a session, a consentObject can be updated as below:

Dictionary<string, object=""> consentObject = new Dictionary<string, object="">(); 

    #if UNITY_ANDROID

        consentObject.Add(InMobiPlugin.IM_GDPR_CONSENT_AVAILABLE, true);

    #elif (UNITY_5 && UNITY_IOS) || UNITY_IPHONE

        consentObject.Add(InMobiPlugin.IM_GDPR_CONSENT_AVAILABLE, “true”); 

    #endif 

    consentObject.Add(InMobiPlugin.IM_GDPR_CONSENT_IAB, "IAB_STRING"); 

    inmobiPlugin.UpdateGdprConsentObject(consentObject);

Integrating Banner Ads

Following is the minimal code to create and load a banner ad:

private void RequestBanner ()
{
  // These placement Ids are configured to always serve test ads.
  #if UNITY_ANDROID
  string placementId = "1467162141987";
  #elif UNITY_IPHONE
  string placementId = "1464947431995";
  #endif
  // Create a 320x50 banner at the bottom of the screen.
  this.bannerAd = new BannerAd (placementId, 320, 50, (int)InMobiAdPosition.BottomCenter);
  // Register for ad events.
this.bannerAd.OnAdLoadSucceeded += this.HandleOnAdLoadSucceeded;    // Called when ad is loaded successfully
this.bannerAd.OnAdLoadFailed += this.HandleAdLoadFailed;            // Called when ad fails to load
this.bannerAd.OnAdFetchSuccessful += this.HandleAdFetchSuccessful;  // Called when ad content is fetched successfully
this.bannerAd.OnAdFetchFailed += this.HandleAdFetchFailed;          // Called when ad fetch fails
this.bannerAd.OnAdImpression += this.HandleAdImpression;            // Called when ad impression is recorded
this.bannerAd.OnAdDisplayed += this.HandleAdDisplayed;              // Called when ad is displayed on screen
this.bannerAd.OnAdDismissed += this.HandleAdDismissed;              // Called when ad is dismissed
this.bannerAd.OnAdInteraction += this.HandleAdInteraction;          // Called when user interacts with ad
this.bannerAd.OnUserLeftApplication += this.HandleUserLeftApplication; // Called when user leaves app via ad
// Load a banner ad.
  this.bannerAd.LoadAd ();
}

InMobiAdPosition enum specifies where to place the banner.

Add SetExtras Method

// Set extras for ad targeting. All values must be passed as string.
Dictionary<string, string=""> extras = new Dictionary<string, string="">();
extras.Add("tp", "admob");           // Mediation partner name
extras.Add("tp_ver", "19.0.0");      // Mediation partner SDK version
this.bannerAd.SetExtras(extras);

</string,></string,>

Integrating Interstitial Ads

Please note that the integration for interstitial and full-screen video ads is same. Following is the minimal code to load an interstitial ad:

  private void RequestInterstitial ()
{
  // These placement Ids are configured to always serve test ads.
  #if UNITY_ANDROID
  string placementId = "1469137441636";
  #elif UNITY_IPHONE
  string placementId = "1467548435003";
  #endif
  // Create an interstitial.
  this.interstitialAd = new InterstitialAd (placementId);
  // Register for ad events.
  this.interstitialAd.OnAdLoadSucceeded += this.HandleOnAdLoadSucceeded;    // Called when ad is loaded successfully
this.interstitialAd.OnAdLoadFailed += this.HandleAdLoadFailed;            // Called when ad fails to load
this.interstitialAd.OnAdFetchSuccessful += this.HandleAdFetchSuccessful;  // Called when ad content is fetched successfully
this.interstitialAd.OnAdFetchFailed += this.HandleAdFetchFailed;          // Called when ad fetch fails
this.interstitialAd.OnAdImpression += this.HandleAdImpression;            // Called when ad impression is recorded
this.interstitialAd.OnAdDisplayed += this.HandleAdDisplayed;              // Called when ad is displayed on screen
this.interstitialAd.OnAdDismissed += this.HandleAdDismissed;              // Called when ad is dismissed
this.interstitialAd.OnAdInteraction += this.HandleAdInteraction;          // Called when user interacts with ad
this.interstitialAd.OnUserLeftApplication += this.HandleUserLeftApplication; // Called when user leaves app via ad
  this.interstitialAd.OnAdDisplayFailed += this.HandleAdDisplayFailed;
  this.interstitialAd.OnAdWillDisplay += this.HandleAdWillDisplay;
  // Load an interstitial ad.
  this.interstitialAd.LoadAd ();
}

Interstitial ads need to be shown explicitly, but before that check if interstitial ad is ready or not by calling isReady () as depicted below:

  if (this.interstitialAd.isReady ()) {
   this.interstitialAd.Show ();
  } else {
   MonoBehaviour.print ("Interstitial is not ready yet");
  }

A good place to show an interstitial ad is end of a level or end of session.

Add SetExtras Method

// Set extras for ad targeting. All values must be passed as string.
Dictionary<string, string=""> extras = new Dictionary<string, string="">();
extras.Add("tp", "admob");           // Mediation partner name
extras.Add("tp_ver", "19.0.0");      // Mediation partner SDK version
this.interstitialAd.SetExtras(extras);

</string,></string,>

Integrating Rewarded Video Ads

Following is a minimal code to load a rewarded video ad:

  private void RequestRewardBasedVideo ()
{
  // These placement Ids are configured to always serve test ads.
  #if UNITY_ANDROID
  string placementId = "1453753057988";
  #elif UNITY_IPHONE
  string placementId = "1465883204802";
  #endif
  this.rewardedVideoAd = new RewardedVideoAd (placementId);
  // Register for ad events.
  this.rewardedVideoAd.OnAdLoadSucceeded += this.HandleOnAdLoadSucceeded;
  this.rewardedVideoAd.OnAdLoadFailed += this.HandleAdLoadFailed;
  this.rewardedVideoAd.OnAdFetchSuccessful += this.HandleAdFetchSuccessful;
  this.rewardedVideoAd.OnAdFetchFailed += this.HandleAdFetchFailed;
  this.rewardedVideoAd.OnAdDisplayed += this.HandleAdDisplayed;
  this.rewardedVideoAd.OnAdDismissed += this.HandleAdDismissed;
  this.rewardedVideoAd.OnAdImpression += this.HandleAdImpression;
  this.rewardedVideoAd.OnAdInteraction += this.HandleAdInteraction;
  this.rewardedVideoAd.OnUserLeftApplication += this.HandleUserLeftApplication;
  this.rewardedVideoAd.OnAdDisplayFailed += this.HandleAdDisplayFailed;
  this.rewardedVideoAd.OnAdWillDisplay += this.HandleAdWillDisplay;
  this.rewardedVideoAd.OnAdRewardActionCompleted += this.HandleRewardActionCompleted;
  this.rewardedVideoAd.LoadAd ();
}

Rewarded video ads work in a similar way to interstitial ads and need to be checked whether they are ready before calling show ().

  private void ShowRewardBasedVideo ()
{
  if (this.rewardedVideoAd.isReady ()) {
   this.rewardedVideoAd.Show ();
  } else {
   MonoBehaviour.print ("Rewarded video ad is not ready yet");
  }
}

Handling Events

You can set the following ad events on a banner, interstitial, and rewarded video ad.

 #region callback handlers
   public void HandleOnAdLoadSucceeded(object sender, AdLoadSuccessEventArgs args)
{
    MonoBehaviour.print("HandleOnAdLoadSucceeded event received");
    // Access ad metadata from the event args
    MonoBehaviour.print("Creative ID: " + args.AdMetaInfo.CreativeID);
    MonoBehaviour.print("Bid: " + args.AdMetaInfo.Bid);
    MonoBehaviour.print("Bid Keyword: " + args.AdMetaInfo.BidKeyword);
}
   public void HandleAdLoadFailed (object sender, AdLoadFailedEventArgs args)
{
  MonoBehaviour.print ("HandleAdLoadFailed event received with message: " + args.Error);
}
   public void HandleAdDisplayed (object sender, EventArgs args)
{
  MonoBehaviour.print ("HandleAdDisplayed event received");
}
  public void HandleAdDismissed (object sender, EventArgs args)
{
  MonoBehaviour.print ("HandleAdDismissed event received");
}
  public void HandleAdInteraction (object sender, AdInteractionEventArgs args)
{
  MonoBehaviour.print ("HandleAdDismissed event received " + args.Message);
}
  public void HandleUserLeftApplication (object sender, EventArgs args)
{
  MonoBehaviour.print ("HandleUserLeftApplication event received");
}
#endregion
#region Interstitial specific callback handlers
public void HandleAdReceived (object sender, EventArgs args)
{
  MonoBehaviour.print ("HandleAdReceived event received");
}
  public void HandleAdWillDisplay (object sender, EventArgs args)
{
  MonoBehaviour.print (
   "HandleAdWillDisplay event received with message: ");
}
  public void HandleAdDisplayFailed (object sender, EventArgs args)
{
  MonoBehaviour.print ("HandleAdDisplayFailed event received");
}
   #endregion
  #region RewardBasedVideo specific callback handlers
   public void HandleRewardActionCompleted (object sender, AdRewardActionCompletedEventArgs args)
{
  MonoBehaviour.print (
   "HandleRewardActionCompleted event received for " + args.Rewards);
}
 
public void HandleAdFetchSuccessful(object sender, AdFetchSuccessEventArgs args)
{
    // Called when ad content is successfully fetched
    // Access ad metadata from the event args
    MonoBehaviour.print("HandleAdFetchSuccessful event received");
    MonoBehaviour.print("Creative ID: " + args.AdMetaInfo.CreativeID);
    MonoBehaviour.print("Bid: " + args.AdMetaInfo.Bid);
}

public void HandleAdFetchFailed(object sender, AdFetchFailedEventArgs args)
{
    // Called when ad fetch fails
    MonoBehaviour.print("HandleAdFetchFailed event received");
    MonoBehaviour.print("Error: " + args.Error);
}

public void HandleAdImpression(object sender, EventArgs args)
{
    // Called when an ad impression is recorded
    MonoBehaviour.print("HandleAdImpression event received");
}

#endregion

New EventArgs Classes

AdMetaInfo Properties

Introduction

Unity LevelPlay Mediation is one of InMobi’s top-performing bidding platforms, especially among gaming publishers. This guide explains how to integrate InMobi as a real-time bidder via SDK-based oRTB on Unity LevelPlay Mediation. 

Prerequisites

Ensure the following before you get started with this integration:

• An active InMobi account on the InMobi Publisher Platform to access inventory settings, reporting, and account configuration. For more information, see Create InMobi Account.
• An active Unity LevelPlay Mediation account.
• Integration with InMobi adapters and SDK. We recommend using the latest versions. Download for Android and iOS, and Unity.
• Formats supported: Banner, Interstitial, and Rewarded Video.
• Supports in-app inventory.
• Supports both waterfall and bidding.

Configure

To get your account and inventory up and running on the InMobi Publisher Dashboard, follow the instructions given below:

1. Create an InMobi Account or log in to the InMobi Publisher Dashboard. 
2. If you are adding apps and placements for the first time, see Add Your App or Website.

   To create placements for Unity LevelPlay:

   1. Search for the app or website you would like to create a placement for and click + Add a placement.
   2. Select an ad unit. For more information on our ad units, see Ad Units.
   3. Name your placement. Enable Audience Bidding and select Unity LevelPlay from the Partner dropdown.
   4. Click Create Placements.

Add InMobi to Unity LevelPlay Dashboard

After you are done setting up your account and inventory on InMobi, the next steps would be to add InMobi as a network on the Unity LevelPlay Mediation dashboard, followed by mapping the created placements in the network on the Unity LevelPlay Mediation dashboard. Follow the instructions below:

1. Use in-app bidding on the Unity LevelPlay Mediation. For more information, see ironSource Documentation.
2. To map the InMobi placements on ironSource, enter the Placement ID.

   

    The InMobi Placement ID is present under the placement name on your InMobi dashboard.

For any further assistance, Contact Us.

This topic provides the technical implementation of opt-outs covered under the U.S. state data privacy regulations, currently under MSPA from Alabama to Delaware. 

This topic provides the technical implementation of opt-outs covered under the U.S. state data privacy regulations, currently under MSPA from Florida to Louisiana. 

This topic provides the technical implementation of opt-outs covered under the U.S. state data privacy regulations, currently under MSPA from Maine to North Dakota.