Referrer

API

• public static void GetReferrerUrl(OnReferrerCallback callback) — Runtime/Affise.cs:214
• public static void GetReferrerUrlValue(ReferrerKey key, OnReferrerCallback callback) — Runtime/Affise.cs:226
• public enum ReferrerKey — Runtime/Referrer/ReferrerKey.cs:3
• public static class ReferrerKeyExtensions — Runtime/Referrer/ReferrerKey.cs:42 (extension ToValue(this ReferrerKey key))
• public delegate void OnReferrerCallback(string? value); — Runtime/Referrer/OnReferrerCallback.cs:4

Usage

Affise.GetReferrerUrl(referrer => {
    // handle referrer
});

Affise.GetReferrerUrlValue(ReferrerKey.CLICK_ID, referrer => {
    // handle referrer value
});

Caution

Don’t call these methods directly in Awake() — it may cause NullReferenceException. On the Unity Editor (desktop), the callback is invoked with "[Affise] platform not supported" (Runtime/Affise.cs:219,231, constant NotSupported at line 265).

Per-store referrer modules

• Android RuStore — to get Install referrer when installed from RuStore include the RuStore module. See RuStore module.
• Android AppGallery — to get Install referrer when installed from AppGallery include the Huawei module. See Huawei module.

ReferrerKey enumeration

Members from Runtime/Referrer/ReferrerKey.cs:4-40; wire values returned by ReferrerKeyExtensions.ToValue() at lines 47-84.

| Enum | Wire value | |---|---| | 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 |

ReferrerKey is also consumed by deferred deeplink value lookups.