AppsFlyer のアトリビューション、アナリティクス、ディファードディープリンク、OneLink サポートを Capacitor アプリに追加します
まずはこちらから initSDK() および以下に示すその他のコアメソッド。
プラットフォーム対応
「プラットフォーム対応」という見出しのセクション| プラットフォーム | サポート | 備考 |
|---|---|---|
| iOSと | はい | ネイティブ |
| Android | はい | ネイティブ |
| Web | いいえ | Capacitor.getPlatform() でガード |
コア機能
「コア機能」セクションinitSDK- AppsFlyer SDK を初期化して開始するには、このメソッドを使用します。この API は、アプリの起動後すぐに呼び出す必要があります。startSDK- 手動起動モードでのみ、AppsFlyer SDK を開始するにはこのメソッドを使用します。logEvent- アプリ内イベントをログに記録します。setCustomerUserId- 独自のカスタマーIDを設定することで、自社のユニークIDとAppsFlyerのユニークIDや他のデバイスのIDを照合できるようになります。このIDは、内部IDとのクロスリファレンス用に、ローデータレポートやPostback APIから取得可能です。
公開 API
「Public API」セクション| メソッド | 説明 |
|---|---|
addListener('conversion_callback', listener) | 以下を含むコンバージョンコールバックをリッスンします： onConversionDataSuccess と onConversionDataFail、さらに OnConversionDataResult ペイロード。 |
addListener('oaoa_callback', listener) | 以下を含むアプリ起動アトリビューションコールバックをリッスンします： onAppOpenAttribution と onAttributionFailure、さらに OnAppOpenAttribution ペイロード。 |
addListener('udl_callback', listener) | 統合されたディープリンクのコールバックを以下で受信します： OnDeepLink ペイロード。 |
initSDK | AppsFlyer SDK を初期化して開始するには、このメソッドを使用します。この API はアプリ起動直後に呼び出してください。 |
startSDK | 手動起動モードでのみ AppsFlyer SDK を開始するには、このメソッドを使用します。 |
logEvent | アプリ内イベントをログに記録します。 |
setCustomerUserId | 独自のカスタマーIDを設定することで、自社独自のIDとAppsFlyerのユニークIDや他のデバイスのIDを照合できるようになります。このIDは、内部IDとのクロスリファレンス用に、raw-dataレポートやPostback APIから利用可能です。 |
setCurrencyCode | アプリ内課金で使用する通貨を設定します。3文字のISO 4217 code を指定してください。 |
updateServerUninstallToken | 他のプラグインが収集済みのAndroid用GCM/FCMトークン、またはiOS用APNsトークンを渡します。これを使用して、アンインストール計測用のトークンをAppsFlyerに転送します。 |
setAppInviteOneLink | 招待アトリビューションのベースリンクとして使用するOneLink IDを設定します。 |
setOneLinkCustomDomain | ブランド化されたOneLinkドメインを登録し、AppsFlyerが短縮リンク内に隠されたアトリビューションパラメータを解決できるようにします。 |
appendParametersToDeepLinkingURL | OneLinkを使用しないApp Linksディープリンクのアトリビューションを有効にします。このメソッドを以下に呼び出してください： startSDK(). 少なくとも pid と is_retargeting=true をパラメータマップに含めてください。 |
setResolveDeepLinkURLs | AppsFlyer OneLinkが別のUniversal Linkにラップされている場合に使用します。これにより、SDK がラップされた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 | クロスプロモーションキャンペーンの一部としてインプレッションをログに記録します。プロモーション対象のアプリ ID は、AppsFlyer dashboard に表示されているものを使用してください。 |
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 イベントが自動的にログに記録されます。 |
Source of Truth
「Source Of Truth」セクションこのリファレンスは以下から同期されています： src/definitions.ts における capacitor-appsflyer.
@capgo/capacitor-appsflyerの続き
「@capgo/capacitor-appsflyerの続き」というタイトルのセクション使用している場合 @capgo/capacitor-appsflyer ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-appsflyer の使用 @capgo/capacitor-appsflyer でネイティブ機能を使用する場合、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。
