Get started with Android Header Bidder SDK for GAM

1. Integrate GAM in your app by updating the allprojects section of your project-level  build.gradle file.

   Add repository dependency

   1 2 3 4 5

   allprojects {    repositories {       google()     } }

2. Now update the dependencies section of your app-level build.gradle  as shown in the code block below.

   

3. Add your Ad Manager app ID to your app’s AndroidManifest.xml file as a <meta-data> tag with the property, android:name="com.google.android.gms.ads.APPLICATION_ID". You’ll find the app ID in the Ad Manager UI. For android:value insert your Ad Manager app ID in quotes, similar to the example below. Learn more

   

Integrate Wrapper SDK

Integrate the Adapex header bidder SDK in your app by updating the Gradle and AndroidManifest.xml files to satisfy this wrapper SDK dependency: 

1. Add Adapex’s maven repository to the allprojects section of your project-level build.gradle file. 

   Add repository dependency

   1 2 3 4 5 6 7

   allprojects {    repositories {       maven {         url 'https://repo.adapex.com/artifactory/public-repos'       }    } }

   At this point, your allprojects section of your project-level  build.gradle should look similar to this:

   Project-level build.gradle

   1 2 3 4 5 6 7 8

   allprojects {    repositories {       google()       maven {           url 'https://repo.adapex.com/artifactory/public-repos'       }    } }

2. Now update the dependencies section of your app-level build.gradle with the wrapper SDK and GAM handlers. Adapex’s event handler for GAM is essential as it  makes the ad server call using GAM SDK APIs.

   Add lib dependency

   1 2 3 4 5 6

   dependencies{     // To integrate Header Bidder SDK     implementation 'com.adapex.sdk:wrapper:2.6.1'     // To integrate GAM event handler     implementation 'com.adapex.sdk:wrapper-eventhandler-dfp:2.8.0' }

   At this point, the dependencies section of your app-level build.gradle should look similar to this:

   App-level build.gradle

   1 2 3 4 5 6

   dependencies{     // Your app dependencies     implementation 'com.google.android.gms:play-services-ads:21.0.0'     implementation 'com.adapex.sdk:wrapper:2.6.1'     implementation 'com.adapex.sdk:wrapper-eventhandler-dfp:2.8.0' }

3. Save your Gradle file and perform Gradle sync.

Add permissions to AndroidManifest.xml file

Now that you’ve satisfied the required dependencies, it’s time to update permissions in your AndroidManifest.xml file. Android OpenWrap SDK requires only two mandatory permissions:

The following code snippet adds necessary permissions to your app’s AndroidManifest.xml file:

Network security configuration

The Adapex header bidder SDK defaults to secure ad calls and delivers only secure ads. If you configure the header bidder SDK to serve non-secure ads, as described in Advanced topics > Configure SSL , you should opt-out of cleartext traffic as  Android 9.0 (API 28) blocks cleartext (non-HTTPS) traffic by default , which prevents ads from rendering. To resolve this in apps running on Android 9.0 or above, include a network security config file that allowlists cleartext traffic and allows HTTP ads to render.

1. Create the res/xml/ network_security_config.xml resource file in your app, then add the following XML:

   <?xml version="1.0" encoding="utf-8"?>  <network-security-config>     <base-config cleartextTrafficPermitted="true">         <trust-anchors>             <certificates src="system"/>         </trust-anchors>     </base-config>     </network-security-config>

Update the <application> tag of your app’s AndroidManifest.xml file to match the following example:

Supported ad formats

Now that you’ve integrated the Adapex header bidder Android SDK, you’re ready to begin implementing ads in your app. The header bidder Android SDK currently supports the following ad formats:

Banner:

Mobile banner ads usually appear as a short strip spanning the width of the app page or screen, positioned above or below the app content. Banner ads can be static or animated images, any mobile-compatible rich media ad format, or in-banner video.

Native and Banner:

Native ads are native assets rendered via an app’s native UI components to provide a consistent visual design. Though the header bidder SDK doesn’t support native ads separately, you can combine native and banner requests to support native inventory through the SDK’s header bidding feature.

Interstitial:

Mobile interstitial ads fill the screen or page and require the user to dismiss the ad before they can view/access the app’s main content. Interstitial ads also support static or animated full-screen images, any mobile-compatible rich media ad format, or full-screen video.

Rewarded:

Mobile rewarded ads fill the screen or page and require the user to dismiss the ad before they can view/access the app’s main content. Rewarded ads support only full-screen video ad formats. Once video playback completes the user receives in-app rewards.