Getting Started

このプラグインのインストール手順と完全なマークダウンガイドを含むセットアップコマンドをコピーしてください。

        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.

インストール

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

インポート

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

Attribution Detailsを読み取る

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);
}

iOSでApple Attributionの取得

native codeでAppleのAttributionエンドポイントを呼び出すには 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 は有効なトークンに対してアトリビューションデータが準備中の場合に戻すことができます。 404 再試行オプションは、ネイティブプラグインが拒否する前に何回再試行するかを制御します。詳細は iOS アトリビューション

を参照してください。

GetReferrer() セクションのタイトルは “互換性のあるエイリアス” です。 cap-play-install-referrer.

const result = await InstallReferrer.GetReferrer();

New code should use getReferrer().

コピー

Getting Started から続けてください。セクションのタイトルは “Getting Started から続けてください” です。 Getting Started native プラグインの作業を計画するには、を接続する必要があります。 @capgo/capacitor-install-referrerを使用します。 @capgo/capacitor-install-referrerのnative機能のために Capgo プラグインディレクトリ Capgo プラグインディレクトリの製品ワークフローについて Capacitor プラグイン ( Capgo によって提供 ) Capacitor プラグイン ( Capgo によって提供 ) の実装詳細についてプラグインの追加または更新プラグインの追加または更新の実装詳細について Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフローについて