ガイド
Capacitor で AppsFlyer を使用する方法
@capgo/capacitor-appsflyer の使用方法
AppsFlyer のアトリビューション、分析、ディープリンクに対応した Capacitor プラグイン。
インストール
bun add @capgo/capacitor-appsflyer
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
API の概要
| メソッド | 説明 |
|---|---|
initSDK |
AppsFlyer SDK を初期化して開始するには、このメソッドを使用します。この API はアプリ起動直後に呼び出してください。 |
startSDK |
手動起動モードでのみ AppsFlyer SDK を開始するには、このメソッドを使用します。 |
logEvent |
アプリ内イベントをログに記録します。 |
setCustomerUserId |
独自のカスタマー ID を設定すると、自分のユニーク ID を AppsFlyer のユニーク ID や他のデバイスの ID と照合できます。この ID は raw-data レポートおよび Postback API で利用でき、社内 ID との突き合わせに使えます。 |
setCurrencyCode |
アプリ内課金の通貨を設定します。通貨 code は、3 文字の ISO 4217 code である必要があります。 |
updateServerUninstallToken |
(Android) サードパーティ製プラグインで収集した GCM/FCM トークンを AppsFlyer サーバーに渡すことができます。アンインストールログに使用できます。(iOS) サードパーティ製プラグインで収集した APN トークンを AppsFlyer サーバーに渡すことができます。アンインストールログに使用できます。 |
setAppInviteOneLink |
ユーザー招待の属性付けに使用するOneLink IDを設定します。ユーザー招待用に生成されるリンクは、このOneLinkをベースリンクとして使用します。 |
setOneLinkCustomDomain |
AppsFlyer SDK が、隠された（ショートリンクID内でデコードされた）アトリビューションパラメータを正しく解決できるようにするには、AppsFlyer Dashboard でブランドドメインとして設定されているすべてのドメインをこのメソッドに渡す必要があります。 |
appendParametersToDeepLinkingURL |
OneLink を使用せずに App Links を利用してディープリンクを行っているアプリオーナーが、アプリに関連付けられたドメイン経由で開始されたセッションをアトリビュートできるようにします。start を呼び出す前にこのメソッドを呼び出してください。parameters Map には、pid と is_retargeting を true に設定したパラメータを含める必要があります。 |
setResolveDeepLinkURLs |
広告主は AppsFlyer OneLink を別の Universal Link でラップすることができます。この Universal Link はアプリを起動しますが、ディープリンクのデータは AppsFlyer に伝播しません。setResolveDeepLinkURLs を使用すると、SDK がラップされた OneLink URL を解決するように設定でき、ディープリンクが正しく機能するようになります。 |
addPushNotificationDeepLinkPath |
プッシュ通知のペイロードから SDK がディープリンクの値を抽出する方法を設定します。 |
setSharingFilter |
指定した AppsFlyer パートナーへのイベントの伝播を停止します。 |
setSharingFilterForAllPartners |
すべての AppsFlyer パートナーへのイベントの伝播を停止します。setSharingFilter を上書きします。 |
setSharingFilterForPartners |
指定した AppsFlyer パートナーへのイベントの伝播を停止します。 |
setAdditionalData |
AppsFlyer に送信する追加データを設定します。詳細については参照してください。 |
getAppsFlyerUID |
AppsFlyer の一意のデバイス ID（アプリの新規インストールごとに作成されるもの）を取得します。 |
anonymizeUser |
AppsFlyer アナリティクスをエンドユーザーがオプトアウトします（ユーザーデータの匿名化）。 |
stop |
この API が呼び出されると、SDK はサーバーとの通信を停止し、機能しなくなります。ユーザーのオプトイン/オプトアウトを実装する際に便利です。 |
disableSKAdNetwork |
SKAdNetwork をオプトアウトします。 |
disableAdvertisingIdentifier |
SDK による各種広告 ID の収集を無効にします。これには Apple Identity for Advertisers (IDFA)、Google Advertising ID (GAID)、OAID、Amazon Advertising ID (AAID) が含まれます。 |
disableCollectASA |
Apple Search Ads のアトリビューションをオプトアウトします。 |
setHost |
カスタムホストを設定します。 |
generateInviteLink |
既存のユーザーが友人や連絡先をアプリの新規ユーザーとして招待できるようにします。 |
validateAndLogInAppPurchaseAndroid |
アプリ内課金のサーバー検証用 API です。検証が成功すると、関連する値を持つ af_purchase イベントが自動的にログに記録されます。 |
validateAndLogInAppPurchaseIos |
現在の動作については、ソースの定義を参照してください。 |
getSdkVersion |
アプリで使用されている AppsFlyer SDK のバージョンを取得します。 |
enableFacebookDeferredApplinks |
Facebook Deferred AppLinks の収集を有効にします。ターゲット/クライアントデバイスに Facebook SDK と Facebook アプリが必要です。正しく機能させるには、AppsFlyer SDK を初期化する前にこの API を呼び出す必要があります。 |
sendPushNotificationData |
プッシュ通知キャンペーンを計測し、データを取得します。 |
setCurrentDeviceLanguage |
デバイスの言語を設定します。データは Raw Data Reports に表示されます。 |
logCrossPromoteImpression |
クロスプロモーションキャンペーンの一環としてインプレッションをログに記録します。AppsFlyerダッシュボードに表示されている通りのプロモーション対象App IDを使用してください。 |
setUserEmails |
ユーザーのメールアドレスを設定し、暗号化します。 |
logLocation |
ユーザーの位置情報を手動でログに記録します。 |
setPhoneNumber |
SHA-256 で暗号化された文字列として送信されます。 |
setPartnerData |
パートナー連携用にカスタムデータを送信できます。 |
logInvite |
ユーザー招待のアプリ内イベント (af_invite) を記録するために使用します。 |
setDisableNetworkData |
デバイスからのネットワーク事業者名 (carrier) および SIM 事業者名の収集をオプトアウトする場合に使用します。 |
enableTCFDataCollection |
CMP を利用するユーザーの同意データの自動収集を有効/無効にします。このフラグの値はアプリのセッション間で保持されます。 |
setConsentData |
ユーザーの同意データを手動で設定する場合に使用します。アプリが TCF v2.2 に対応した CMP を使用していない場合は、以下のメソッドを使用して SDK に直接同意データを渡してください。 |
logAdRevenue |
広告収益をアトリビューションすることで、アプリオーナーはユーザーの LTV とキャンペーンの ROI を完全に把握できます。広告収益は、リワード動画、オファーウォール、インタースティシャル、バナーなどの広告表示によって発生します。このメソッドを使用して広告収益を記録できます。 |
setConsentDataV2 |
ユーザーの同意データを手動で設定する場合に使用します。アプリが TCF v2.2 に対応した CMP を使用していない場合は、以下のメソッドを使用して SDK に直接同意データを渡してください。 |
isSDKStarted |
このメソッドを使用して、現在のセッションで AppsFlyer SDK がすでに開始されているかどうかを確認します。 |
isSDKStopped |
このメソッドを使用して、AppsFlyer SDK が現在停止しているかどうかを確認します。 |
disableAppSetId |
AppSet ID の収集を無効にします。SDK の初期化前に呼び出した場合、App Set ID は収集されません。初期化後に呼び出した場合、App Set ID は収集されますが、リクエストのペイロードには送信されません。Android のみ。 |
validateAndLogInAppPurchaseV2 |
API はアプリ内課金のサーバー検証 (V2) 用です。検証に成功すると、該当する値を含む af_purchase イベントが自動的にログに記録されます。 |
例
initSDK()
AppsFlyer SDK を初期化して開始するには、このメソッドを使用します。この API はアプリ起動直後に呼び出してください。
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.initSDK({
devKey: 'dev-key-123',
appID: 'app-id-123',
});
console.log(result);
startSDK()
手動起動モードでのみ AppsFlyer SDK を開始するには、このメソッドを使用します。
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.startSDK();
console.log(result);
logEvent()
アプリ内イベントをログに記録します。
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);
setCustomerUserId()
独自のカスタマー ID を設定すると、自分のユニーク ID を AppsFlyer のユニーク ID や他のデバイスの ID と照合できます。この ID は raw-data レポートおよび Postback API で利用でき、社内 ID との突き合わせに使えます。
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCustomerUserId({ cuid: 'cuid' });
setCurrencyCode()
アプリ内課金の通貨を設定します。通貨 code は、3 文字の ISO 4217 code である必要があります。
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });
updateServerUninstallToken()
(Android) サードパーティ製プラグインで収集した GCM/FCM トークンを AppsFlyer サーバーに渡すことができます。アンインストールログに使用できます。(iOS) サードパーティ製プラグインで収集した APN トークンを AppsFlyer サーバーに渡すことができます。アンインストールログに使用できます。
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.updateServerUninstallToken({ token: 'token-123' });
上記の表は 44 個のコアメソッドの一覧です。リスナーとバージョンヘルパー、および各メソッドの完全なコントラクトは、以下に記載されています。 GitHub リポジトリ.
イベントをリッスンする
addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() を呼び出してください。
完全なリファレンス
@capgo/capacitor-appsflyer の使用方法から続ける
使用している場合 @capgo/capacitor-appsflyer の使用方法 ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-appsflyer @capgo/capacitor-appsflyer での実装の詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。