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.
activityFullNameYour activity class"com.analytics.test.MainActivity"
adUnitIdYour 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.
Twinalyze.setAdsRequestEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        activityFullName: string,
        adUnitId: String,
        uniqId: String
    )

Ad Load

When the ad successfully loads.
Twinalyze.setAdsLoadedEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        activityFullName: string,
        adUnitId: String,
        uniqId: String
    )

Ad Show

When the ad is displayed.
Twinalyze.setAdsImpressionEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        activityFullName: string,
        adUnitId: String,
        uniqId: String,
        bannerImpressionCount: String ?= null
    )

Ad Click

Tracks user clicks on the ad.
Twinalyze.setAdsClickEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        activityFullName: string,
        adUnitId: String,
        uniqId: String,
        bannerImpressionCount: String ?= null
    )

Ad Failed

Captures load/show errors with error codes and messages.
Twinalyze.setAdFailedToLoadEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        activityFullName: string,
        adUnitId: String,
        uniqId: String,
        bannerImpressionCount: String ?= null,
        errorCode: String,
        errorMessage: String
    )

Ad Failed Other

Captures load/show errors with error codes and messages. As an example: onAdFailedToShowFullScreenContent.
Twinalyze.setAdFailedToShowEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        activityFullName: string,
        adUnitId: String,
        uniqId: String,
        bannerImpressionCount: String ?= null,
        errorCode: String,
        errorMessage: String
    )

Ad Paid Event

Records revenue data only uses AdMob (micros, currency, precision).
Twinalyze.setAdsPaidEvent(
        AdsCompany.Admob,
        AdsType.Interstitial,
        activityFullName: string,
        adUnitId: String,
        uniqId: String,
        bannerImpressionCount: String ?= null,
        currencyCode: String,
        precisionType: String,
        valueMicros: String
    )