This guide shows you how to use Google Mobile Ads SDK for React Native to load and display ads from PubMatic using [AdMob Mediation](https://developers.google.com/admob/react-native/mediation.md.txt), covering bidding integrations. It covers how to add PubMatic to an ad unit's mediation configuration and how to integrate the PubMatic SDK and adapter into a React Native app. ## Supported integrations and ad formats The AdMob mediation adapter for PubMatic has the following capabilities: | Integration || |---|---| | Bidding | Yes | | Waterfall | | | App Open | | | Banner | Yes | | Interstitial | Yes [^1^](https://developers.google.com/admob/react-native/mediation/pubmatic.md.txt#format-beta-footnote) | | Rewarded | Yes [^1^](https://developers.google.com/admob/react-native/mediation/pubmatic.md.txt#format-beta-footnote) | | Rewarded Interstitial | | | Native | Yes [^1^](https://developers.google.com/admob/react-native/mediation/pubmatic.md.txt#format-beta-footnote) | ^1^ This format is in beta. Reach out to your account manager to request access. ## Prerequisites Before you continue, verify the following: - Latest Google Mobile Ads SDK for React Native version. - React Native framework version 0.85.0 or later. - To deploy on Android - Android API level 24 or later. - To deploy on iOS - iOS deployment target of 13.0 or later. - A working React Native project configured with Google Mobile Ads SDK for React Native. See [Set up Google Mobile Ads SDK for React Native](https://developers.google.com/admob/react-native/quick-start.md.txt) for details. - Make sure you have downloaded and extracted the `adapters` folder from the [`gma-sdk-react-native`](https://drive.google.com/corp/drive/folders/1s5j2kx0yyYxLsdLNyBrhNJvkzmaUgOwD) folder. If you don't have the `adapters` folder, follow steps one, two, and three in [Install Google Mobile Ads SDK for React Native](https://developers.google.com/admob/react-native/quick-start.md.txt#install). - [Set up AdMob Mediation](https://developers.google.com/admob/react-native/mediation.md.txt). ## Step 1: Set up configurations in PubMatic OpenWrap SDK UI [Sign up](https://go.pubmatic.com/openwrap-sdk-capture-more-direct-brand-spend) or [Log in](https://apps.pubmatic.com/login/publisher) to your PubMatic account and select the **OpenWrap SDK** card. ### Add a new application Navigate to the **Apps** tab and click the **Add App** button. ![Apps Dashboard](https://developers.google.com/static/admob/images/mediation/pubmatic/dashboard_apps.png) Select the **Platform** , as well as the **App Store URL** and **App Name** for your app. ### Android Under **Integration Path** , select **React Native** and select **AdMob - SDK Bidding** as the **Sub-integration Path** . Then, click the **Add App** button. ![New App Form](https://developers.google.com/static/admob/images/mediation/pubmatic/new_app_Android.png) ### iOS Under **Integration Path** , select **React Native** and select **AdMob - SDK Bidding** as the **Sub-integration Path** . Then, click the **Add App** button. ![New App Form](https://developers.google.com/static/admob/images/mediation/pubmatic/new_app_iOS.png) ### Update your app-ads.txt [Authorized Sellers for Apps app-ads.txt](https://iabtechlab.com/wp-content/uploads/2019/03/app-ads.txt-v1.0-final-.pdf) is an IAB Tech Lab initiative that helps ensure your app ad inventory is only sold through channels you've identified as authorized. To prevent a significant loss in ad revenue, you'll need to implement an `app-ads.txt` file. If you haven't done so already, [set up an app-ads.txt file for your app](https://support.google.com/admob/answer/9363762). Before your app is finalized, you will be presented the appropriate entries to add to your `app-ads.txt`. ![app-aps.txt](https://developers.google.com/static/admob/images/mediation/pubmatic/update_app_ads_txt.png) For additional information on how to implement `app-ads.txt` for PubMatic, see [How to Implement app-ads.txt](https://help.pubmatic.com/publisher/docs/app-adstxt-adstxt-for-apps-overview#how-to-implement-app-adstxt). #### Profile ID Once your app is created, navigate to the **Apps** tab and take note of your newly created application's **Profile ID**. ![App Profile ID](https://developers.google.com/static/admob/images/mediation/pubmatic/app_details_profile_id.png) ### Create an ad unit Under the **Ad Units** tab, select the app you created on the previous section and click the **Create Ad Unit** button. ![Create Ad Unit](https://developers.google.com/static/admob/images/mediation/pubmatic/create_ad_unit.png) Fill out the form with the details of your ad unit and click **Save**. ![Create Ad Unit Form](https://developers.google.com/static/admob/images/mediation/pubmatic/create_ad_unit_form.png) Take note of your newly created **OpenWrap Ad Unit ID**. ![App Ad Unit ID](https://developers.google.com/static/admob/images/mediation/pubmatic/app_details_ad_unit.png) ### Obtain your Publisher ID Navigate to the [Analytics Dashboard](https://apps.pubmatic.com/v3/analytics/dashboard). Hover over the profile icon and take note of your **ID**. ![Publisher ID](https://developers.google.com/static/admob/images/mediation/pubmatic/publisher_id.png) ## Step 2: Set up PubMatic OpenWrap SDK demand in AdMob UI ### Configure mediation settings for your ad unit ### Android For instructions, see step 2 in the guide for [Android](https://developers.google.com/admob/android/mediation/pubmatic.md.txt#step-2). ### iOS For instructions, see step 2 in the guide for [iOS](https://developers.google.com/admob/ios/mediation/pubmatic.md.txt#step-2). ### Add PubMatic to GDPR and US state regulations ad partners list > [!IMPORTANT] > **Important:** Verify that you have **Account Management** permission to complete the configuration for EU Consent and GDPR, US State regulations, and User Messaging Platform. See [Manage user access to your > account](https://support.google.com/admob/answer/2784628) for details. Follow the steps in [European regulations settings](https://support.google.com/admob/answer/10113004#adding_ad_partners_to_published_gdpr_messages) and [US state regulations settings](https://support.google.com/admob/answer/14125907) to add **PubMatic** to the European and US state regulations ad partners list in the AdMob UI. ## Step 3: Import the PubMatic OpenWrap SDK SDK and adapter > [!NOTE] > **Note:** Failure to integrate the compatible PubMatic and Google Mobile Ads SDK for React Native versions might lead to build issues. In your project's root directory, install the Google Mobile Ads SDK for React Native mediation adapter for PubMatic OpenWrap SDK. Complete the following: 1. Copy the Google Mobile Ads SDK for React Native adapter tar file from the `gma-sdk-react-native/adapters/pubmatic/` directory into your project's `local_packages/` directory. If you don't have the `adapters` folder, see [Prerequisites](https://developers.google.com/admob/react-native/mediation/pubmatic.md.txt#prerequisites). ```bash mkdir -p local_packages cp EXTRACT_DIR/gma-sdk-react-native/adapters/pubmatic/gma-mediation-pubmatic-0.1.0.tgz local_packages/ ``` Replace EXTRACT_DIR with the path to the directory where you extracted the archive. 2. Install the adapter package using your preferred package manager: ### npm ```bash npm install ./local_packages/gma-mediation-pubmatic-0.1.0.tgz ``` ### yarn ```bash yarn add ./local_packages/gma-mediation-pubmatic-0.1.0.tgz ``` 3. If you're building for Android, add the following repository to the `build.gradle` file in your project's `android` directory: ```groovy repositories { google() mavenCentral() maven { url = uri("https://repo.pubmatic.com/artifactory/public-repos") } } ``` ## Step 4: Implement privacy settings on PubMatic OpenWrap SDK SDK ### EU Consent and GDPR To [comply with the Google EU User Consent Policy](https://www.google.com/about/company/consentstaging.html), you must make certain disclosures to your users in the European Economic Area (EEA), the UK, and Switzerland, and obtain their consent for the use of cookies or other local storage where legally required, and for the collection, sharing, and use of personal data for ads personalization. This policy reflects the requirements of the EU ePrivacy Directive and the General Data Protection Regulation (GDPR). You are responsible for verifying that consent is propagated to each ad source in your mediation chain. PubMatic OpenWrap SDK React Native adapter version 0.1.0 and later supports passing GDPR consent signals from consent management platforms that integrate with IAB's Transparency and Consent Framework (TCF) to PubMatic OpenWrap SDK SDK. For more information, see [Pass GDPR and GDPR consent](https://help.pubmatic.com/openwrap/reference/advanced-topics-3#pass-gdpr-and-gdpr-consent). ### US states privacy laws [US states privacy laws](https://support.google.com/admob/answer/9561022) require giving users the right to opt out of the "sale" of their "personal information" (as the law defines those terms), with the opt-out offered through a prominent "Do Not Sell My Personal Information" link on the "selling" party's homepage. The [US states privacy laws compliance guide](https://developers.google.com/admob/react-native/privacy/us-states) offers the ability to enable [restricted data processing](https://privacy.google.com/businesses/rdp/) for Google ad serving, but Google is unable to apply this setting to each ad network in your mediation chain. Therefore, you must identify each ad network in your mediation chain that may participate in the sale of personal information and follow guidance from each of those networks to ensure compliance. PubMatic automatically reads CCPA consent set by consent management platforms that support [Google's Additional Consent specification](https://support.google.com/admob/answer/9681920), including the [UMP SDK](https://developers.google.com/admob/react-native/privacy.md.txt). For more information, see [Set CCPA String](https://help.pubmatic.com/openwrap/reference/advanced-topics-3#set-ccpa-string). ## Step 5: Add required code ### Android No additional code required for PubMatic integration. ### iOS ### SKAdNetwork integration Follow [PubMatic OpenWrap SDK's documentation](https://help.pubmatic.com/openwrap/reference/home-get-started-with-ios-openwrap-sdk-as-primary-ad-sdk#configure-skadnetwork-settings-to-track-conversions) to add the SKAdNetwork identifiers to your project's `Info.plist` file. ## Step 6: Test your implementation ### Enable test ads Make sure you [register your test device](https://developers.google.com/admob/react-native/test-ads.md.txt#enable_test_devices) for AdMob. > [!IMPORTANT] > **Important:** Disable test mode for AdMob and PubMatic OpenWrap SDK before releasing your app. ### Verify test ads To verify that you are receiving test ads from PubMatic OpenWrap SDK, enable [single ad source testing](https://developers.google.com/admob/react-native/ad-inspector#single_ad_source_testing) in ad inspector using the **PubMatic OpenWrap** ad source(s). ## Error codes If the adapter fails to receive an ad from PubMatic, publishers can check the underlying error from the ad response using [`ResponseInfo`](https://developers.google.com/admob/react-native/response-info.md.txt) under the following classes: ### Android ```java com.pubmatic.sdk com.google.ads.mediation.pubmatic ``` ### iOS ```objective-c GADMediationAdapterPubMatic ``` Here are the codes and accompanying messages thrown by the PubMatic adapter when an ad fails to load: ### Android | Error code | Domain | Reason | |---|---|---| | 101 | com.google.ads.mediation.pubmatic | Server configuration missing a required publisher ID. | | 102 | com.google.ads.mediation.pubmatic | Ad format unsupported by PubMatic or missing in RTB signal data. | | 103 | com.google.ads.mediation.pubmatic | Failed to present an ad because the ad was not ready. | | 104 | com.google.ads.mediation.pubmatic | Missing or invalid Profile ID. | | 105 | com.google.ads.mediation.pubmatic | Missing or empty Ad Unit ID. | | 106 | com.google.ads.mediation.pubmatic | Returned Rewarded ad is null. | | 107 | com.google.ads.mediation.pubmatic | Invalid banner ad size. | | 1001-5002 | Sent by PubMatic SDK | PubMatic SDK returned an error. See PubMatic's [documentation](https://pubmatic-sdk.s3.amazonaws.com/androidapidoc/html/com/pubmatic/sdk/common/POBError.html) for more details. | ### iOS | Error code | Domain | Reason | |---|---|---| | 101 | com.google.ads.mediation.pubmatic | Server configuration missing a required publisher ID. | | 102 | com.google.ads.mediation.pubmatic | The bidding signal collection request failed because multiple formats, no format, or an unsupported format was specified in the request parameters. | | 103 | com.google.ads.mediation.pubmatic | Invalid ad configuration for loading an ad. | | 104 | com.google.ads.mediation.pubmatic | Failed to present an interstitial ad because the ad was not ready. | | 105 | com.google.ads.mediation.pubmatic | Failed to present an rewarded ad because the ad was not ready. | | 106 | com.google.ads.mediation.pubmatic | Failed to load one of the native ad image sources. | | 107 | com.google.ads.mediation.pubmatic | The ad configuration is missing a publisher ID. | | 108 | com.google.ads.mediation.pubmatic | The ad configuration is missing a profile ID. | | 109 | com.google.ads.mediation.pubmatic | The ad configuration contains a non-number profile ID. | | 110 | com.google.ads.mediation.pubmatic | The ad configuration is missing an ad unit ID. | | 111 | com.google.ads.mediation.pubmatic | PubMatic OpenWrap SDK failed to instantiate an ad size instance. | | 1001-5002 | Sent by PubMatic SDK | PubMatic SDK returned an error. See PubMatic's [documentation](https://pubmatic-sdk.s3.amazonaws.com/iosapidoc/html/Constants/POBErrorCode.html) for more details. | #### Version 0.1.0 - Initial release. - Supports [PubMatic Android adapter version 5.3.0.1](https://github.com/googleads/googleads-mobile-android-mediation/blob/main/ThirdPartyAdapters/pubmatic/CHANGELOG.md#version-5301). - Supports [PubMatic iOS adapter version 5.3.0.0](https://github.com/googleads/googleads-mobile-ios-mediation/blob/main/adapters/PubMatic/CHANGELOG.md#version-5300). - Built and tested with the Google Mobile Ads React Native Plugin version 0.1.0.