How to pass publisher provided identifiers in ad request (PPID) (Only for GAM)

Below are the steps to pass PPID with ad request for GAM (Supported by all ad formats)

1

Create your AdRequestConfiguration

Java / Kotlin:

Java
AdRequestConfiguration.Builder configuration = AdRequestConfiguration.Companion.builder(context, "Your_placement_name");
2

Add PPID to the AdRequest

Set the publisher-provided identifier on the configuration:

Java / Kotlin
configuration.publisherProvidedId("YOUR_PPID");
circle-info

PPID can be passed for all ad type ad requests.

3

Example implementation (banner ad)

  1. Call loadAd() method as per below format

Java
AdSterAdLoader.Companion.builder().withAdsListener(new MediationAdListener() {
    @Override
    public void onBannerAdLoaded(@NonNull MediationBannerAd ad) {
        super.onBannerAdLoaded(ad);
        // Show banner ad here
    }

    @Override
    public void onFailure(@NonNull AdError adError) {
        // Handle failure here
    }
}).withAdsEventsListener(new AdEventsListener() {
    @Override
    public void onAdClicked() {
        //Handle ad click here
    }

    @Override
    public void onAdImpression() {
        //Handle ad impression here
    }
    
    @Override
    public void onAdRevenuePaid(double revenue, @NotNull String adUnitId, @NotNull String network) {
        // Callback which provides revenue and the network which provided it
    }
}).build().loadAd(configuration.build());
4

Add the banner view to your layout

Inside the onBannerAdLoaded callback method invoke getView() method of MediationnBannerAd object to add an xGrowth banner view to the given layout as shown below

Java / Kotlin
container.removeAllViews();
container.addView(ad.getView());
5

Clean up when destroyed

Call MediationBannerAd.destroy() When activity/fragment is destroyed or detached.

Last updated