Referrer

API

static void getReferrerUrl(ReferrerCallback callback);                       // lib/affise.dart:194
static void getReferrerUrlValue(ReferrerKey key, ReferrerCallback callback); // lib/affise.dart:201

typedef ReferrerCallback = void Function(String value); (lib/referrer/referrer_callback.dart:2).

Get the full referrer URL

Affise.getReferrerUrl((value) {
  // handle referrer
});

Get a specific referrer value

Affise.getReferrerUrlValue(ReferrerKey.CLICK_ID, (value) {
  // handle referrer
});

Note

• To get the install referrer from Android RuStore, include the RuStore module.
• To get the install referrer from Android AppGallery, include the Huawei module.

Referrer keys

enum ReferrerKey is declared in lib/referrer/referrer_key.dart:1-37, native keys at :39-114.

| Enum | Native key | |---|---| | AD_ID | "ad_id" | | CAMPAIGN_ID | "campaign_id" | | CLICK_ID | "clickid" | | AFFISE_AD | "affise_ad" | | AFFISE_AD_ID | "affise_ad_id" | | AFFISE_AD_TYPE | "affise_ad_type" | | AFFISE_ADSET | "affise_adset" | | AFFISE_ADSET_ID | "affise_adset_id" | | AFFISE_AFFC_ID | "affise_affc_id" | | AFFISE_CHANNEL | "affise_channel" | | AFFISE_CLICK_LOOK_BACK | "affise_click_lookback" | | AFFISE_COST_CURRENCY | "affise_cost_currency" | | AFFISE_COST_MODEL | "affise_cost_model" | | AFFISE_COST_VALUE | "affise_cost_value" | | AFFISE_DEEPLINK | "affise_deeplink" | | AFFISE_KEYWORDS | "affise_keywords" | | AFFISE_MEDIA_TYPE | "affise_media_type" | | AFFISE_MODEL | "affise_model" | | AFFISE_OS | "affise_os" | | AFFISE_PARTNER | "affise_partner" | | AFFISE_REF | "affise_ref" | | AFFISE_SITE_ID | "affise_siteid" | | AFFISE_SUB_SITE_ID | "affise_sub_siteid" | | AFFC | "affc" | | PID | "pid" | | SUB_1 | "sub1" | | SUB_2 | "sub2" | | SUB_3 | "sub3" | | SUB_4 | "sub4" | | SUB_5 | "sub5" | | AFFISE_SUB_1 | "affise_sub1" | | AFFISE_SUB_2 | "affise_sub2" | | AFFISE_SUB_3 | "affise_sub3" | | AFFISE_SUB_4 | "affise_sub4" | | AFFISE_SUB_5 | "affise_sub5" |

Install referrer tracking

“Install referrer tracking is supported automatically, no actions needed”

README 1140-1142

Native behavior relies on Android’s com.android.installreferrer:installreferrer:2.2 dependency (android/build.gradle:54).