@capgo/capacitor-install-referrer
Read Android Play install referrer data and iOS Apple AdServices attribution tokens from Capacitor.
Overview
Section titled “Overview”@capgo/capacitor-install-referrer exposes install attribution signals through one Capacitor API.
On Android, it reads Google Play Install Referrer details: the raw referrer string, click timestamp, install timestamp, and instant app flag. On iOS, it returns an Apple AdServices attribution token and can optionally call Apple’s AdServices attribution endpoint for Apple Search Ads attribution data.
Core Capabilities
Section titled “Core Capabilities”getReferrer- Return native install attribution details for the current platform.GetReferrer- Deprecated compatibility alias for apps migrating fromcap-play-install-referrer.getPluginVersion- Return the native plugin implementation version marker.- Optional iOS Apple attribution lookup with retry support for delayed AdServices responses.
Platform Support
Section titled “Platform Support”| Platform | Support |
|---|---|
| Android | Google Play Install Referrer API |
| iOS | Apple AdServices attribution token and optional Apple attribution payload |
| Web | Unsupported stub |
Public API
Section titled “Public API”| Method | Description |
|---|---|
getReferrer(options?) | Return install attribution details for Android or iOS. |
GetReferrer(options?) | Deprecated compatibility alias for getReferrer. |
getPluginVersion() | Return the native plugin version marker. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-install-referrer.