Install Referrer Capacitor plugin

Using @capgo/capacitor-install-referrer

@capgo/capacitor-install-referrer reads install attribution signals in Capacitor apps.

Use it when you need Google Play Install Referrer data on Android and Apple AdServices attribution tokens on iOS through one API.

Install

bun add @capgo/capacitor-install-referrer
bunx cap sync

What This Plugin Exposes

• getReferrer returns install attribution details for Android or iOS.
• GetReferrer is a deprecated compatibility alias for migration from cap-play-install-referrer.
• Android returns the Play referrer string, click timestamp, install timestamp, and instant app flag.
• iOS returns an AdServices attribution token and can optionally fetch Apple's attribution payload.

Example Usage

import { InstallReferrer } from '@capgo/capacitor-install-referrer';

const result = await InstallReferrer.getReferrer();

if (result.platform === 'android') {
  console.log(result.referrer);
}

if (result.platform === 'ios') {
  console.log(result.attributionToken);
}

Apple Attribution Payload

const result = await InstallReferrer.getReferrer({
  fetchAppleAttribution: true,
  appleAttributionRetryCount: 3,
  appleAttributionRetryDelayMs: 5000,
});

console.log(result.appleAttribution);

Platform Notes

Android uses the Google Play Install Referrer service and requires a Play Store install for real referrer data. iOS uses Apple AdServices because Apple does not provide a generic App Store install referrer equivalent.

Full Reference

• GitHub: https://github.com/Cap-go/capacitor-install-referrer/
• Docs: /docs/plugins/install-referrer/

Keep going from Using @capgo/capacitor-install-referrer

If you are using Using @capgo/capacitor-install-referrer to plan native plugin work, connect it with @capgo/capacitor-install-referrer for the implementation detail in @capgo/capacitor-install-referrer, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.