Getting Started

GitHub

Kopieren Sie eine Einrichtungsanweisung mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen Plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-install-referrer`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/install-referrer/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mithilfe der folgenden Befehl hinzu:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Verwenden Sie dann die folgende Anfrage:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-install-referrer` plugin in my project.

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:

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

Importieren

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

Attributionsdetails lesen

const result = await InstallReferrer.getReferrer();

if (result.platform === 'android') {
  console.log('Install referrer:', result.referrer);
  console.log('Click timestamp:', result.clickTimestampSeconds);
  console.log('Install timestamp:', result.installBeginTimestampSeconds);
}

if (result.platform === 'ios') {
  console.log('AdServices token:', result.attributionToken);
}

Apple-Attributionsabrufen auf iOS

Wenn Sie native code-Funktionen möchten, die das Apple-Attributions-Endpunkt aufrufen, geben Sie fetchAppleAttribution.

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

// result.appleAttribution is the parsed Apple attribution response.
// See the iOS attribution page for the Apple-provided payload fields.
console.log(result.appleAttribution);

Apple kann 404 während die Attributionsdaten noch vorbereitet werden für einen gültigen Token. Die Wiederholungsoptionen steuern, wie oft die native Plugin wiederholt, bevor es abgelehnt wird. Siehe iOS-Attribution für Plattformdetails.

Kompatibilitätsalias

GetReferrer() für Apps verfügbar, die von cap-play-install-referrer.

const result = await InstallReferrer.GetReferrer();

Neue code sollten getReferrer().

Weitergehen von Getting Started

Wenn Sie native Plugin-Arbeiten planen, verbinden Sie es mit Getting Started mit @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-install-referrer für die native Fähigkeit in Using @capgo/capacitor-install-referrer for the native capability in Using @capgo/capacitor-install-referrer, für Capgo Plugin Directory für Capgo Capacitor Plugins von Capgo zur Implementierungsdetail in Capacitor Plugins von Capgo, Plugins hinzufügen oder aktualisieren zur Implementierungsdetail in Plugins hinzufügen oder aktualisieren, und Ionische Unternehmens-Plugin-Alternativen zur Produktworkflow in Ionische Unternehmens-Plugin-Alternativen.