メインコンテンツへスキップ
@capgo/capacitor-install-referrer アナリティクス オープンソース

Install Referrerのインストール Capacitor プラグイン

Capacitor から Google Play の Install Referrer データと Apple AdServices のアトリビューションを読み取ります

インストール

bun add @capgo/capacitor-install-referrer bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-install-referrer
  • pnpm add @capgo/capacitor-install-referrer
  • yarn add @capgo/capacitor-install-referrer

ガイド

Capacitor で Install Referrer を使用する方法

実機でテストする

Capgo アプリをダウンロードして、QR code をスキャンしてください。

Install Referrer プラグインのプレビューQR code

@capgo/capacitor-install-referrer の使い方

@capgo/capacitor-install-referrer Capacitor アプリ内のインストールアトリビューションシグナルを読み取ります。

Android の Google Play Install Referrer データと iOS の Apple AdServices アトリビューショントークンを、1つの API 経由で扱いたいときに使います。

インストール

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

このプラグインで利用可能な機能

  • getReferrer Android または iOS のインストールアトリビューション詳細を返します。
  • GetReferrer 〜からの移行用の非推奨の互換性エイリアスです。 cap-play-install-referrer.
  • Androidでは、Play referrer文字列、クリックタイムスタンプ、インストールタイムスタンプ、およびInstant Appフラグを取得できます。
  • iOSでは、AdServicesアトリビューショントークンを返し、オプションでAppleのアトリビューションペイロードを取得可能です。

使用例

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 アトリビューション ペイロード

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

console.log(result.appleAttribution);

プラットフォームに関する注意点

AndroidはGoogle Play Install Referrerサービスを使用するため、正確なリファラーデータの取得にはPlay Store経由のインストールが必要です。一方、iOSはApple AdServicesを使用します。これは、AppleがApp Storeにおいて汎用的なインストールリファラーを提供していないためです。

リファレンス全文

「@capgo/capacitor-install-referrer の使い方」から続ける

使用している場合 @capgo/capacitor-install-referrer の使い方 ネイティブプラグインの作業を計画するには、次と連携してください: @capgo/capacitor-install-referrer @capgo/capacitor-install-referrer の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。

よくある質問

Install Referrer プラグインの FAQ

Capacitor アプリに Install Referrer プラグインをインストールするにはどうすればいいですか?

"bun add @capgo/capacitor-install-referrer"(または "npm install @capgo/capacitor-install-referrer")を実行し、続けて "bunx cap sync" を実行すると、iOS と Android のプロジェクトにネイティブの code が反映されます。アプリの code で "@capgo/capacitor-install-referrer" からインポートしてください。

@capgo/capacitor-install-referrer は React、Vue、Angular で動作しますか?

はい。Install Referrer は Capacitor パッケージなので、Ionic、React、Vue、Angular、Svelte、素の JavaScript など、Capacitor 上で動くあらゆる Web フレームワークで使えます。

@capgo/capacitor-install-referrer はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-install-referrer は無料でオープンソースですか?

はい。code のソースコードは GitHub の https://github.com/Cap-go/capacitor-install-referrer/ で公開されており、パッケージは npm から無料でインストールできます。バグ報告やプルリクエストも歓迎します。

App Store の審査なしで、Install Referrer を使っている code をアップデートできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずに Install Referrer の変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める