Skip to main content

​
Ad Event Parameters

ParametersDescriptionExample
AdsCompanyAd network
AdsCompany.Admob
AdsCompany.Adx
AdsCompany.Facebook
AdsTypeAd format
AdsType.Interstitial
AdsType.AppOpen
AdsType.Native
AdsType.Banner
AdsType.Mrc
etc.
AdsActionWhat happened with the ad
AdsAction.Request
AdsAction.Loaded
AdsAction.Show
AdsAction.Failed
AdsAction.FailedOther
AdsAction.Click
contextYour activity class"com.analytics.test.MainActivity"
adIdYour ad unit ID"ca-app-pub-3940256099942544/9214589741"
uniqIdUnique identifier per ad eventSystem.currentTimeMillis()

​
How to Send an Ad Event

​
Ad Request

When an ad fetch is initiated. 
Analytics.getInstance()
    .setAdsRequestEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        AdsAction.Request,
        context,
         adId, // [adId](#param-adid)
        uniqId
    )

​
Ad Load

When the ad successfully loads. 
Analytics.getInstance()
    .setAdsLoadEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        AdsAction.Loaded,
        context,
        adId,
        uniqId
    )

​
Ad Failed

Captures load/show errors with error codes and messages. 
Analytics.getInstance()
    .setAdsFailedEvent(
            AdsCompany.Admob,
            AdsType.Interstitial, 
            AdsAction.Failed,
            context,
            adId,
            uniqId,
            null,
            loadAdError == null ? Constant.not_found : String.valueOf(loadAdError.getCode()),
            loadAdError.getMessage() == null ? Constant.not_found : loadAdError.getMessage()
        )

​
Ad Failed Other

Captures load/show errors with error codes and messages. As an example: onAdFailedToShowFullScreenContent. 
Analytics.getInstance()
    .setAdsFailedEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        AdsAction.FailedOther,
        context,adManagerInterstitialAd.getAdUnitId() == null ?
        Constant.not_found : adManagerInterstitialAd.getAdUnitId(),
        uniqId, null,
        String.valueOf(adError.getCode()),
        adError.getMessage()
    )

​
Ad Show

When the ad is displayed. 
Analytics.getInstance()
    .setAdsImpressionEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        AdsAction.Show,
        context,
        adManagerInterstitialAd.getAdUnitId(),
        uniqId,
        null
    )

​
Ad Click

Tracks user clicks on the ad. 
Analytics.getInstance()
    .setAdsClickEvevnt(
        AdsCompany.Admob,
        AdsType.Interstitial,
        AdsAction.Click,
        context,
        adManagerInterstitialAd.getAdUnitId(),
        uniqId,
        null
    )

​
Ad Paid Event

Records revenue data only uses AdMob (micros, currency, precision). 
Analytics.getInstance()
    .setAdsPaidEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        context,
        adManagerInterstitialAd.getAdUnitId(),
        uniqId,
        null,
        adValue.getCurrencyCode(),
        String.valueOf(adValue.getPrecisionType()),
        String.valueOf(adValue.getValueMicros())
    )