プラグインチームと話す
How to use AppsFlyer in Capacitor
@capgo/capacitor-appsflyerを使用
CapacitorはAppsFlyerのAttribution、Analytics、Deep Linkのプラグインです。
インストール
bun add @capgo/capacitor-appsflyer
bunx cap sync
bunx cap sync プラグインのネイティブ codeをプロジェクトにコピーします。プラグインのアップグレード後は再度実行してください。
インポート
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
APIの概要
| 方法 | 概要 |
|---|---|
initSDK |
AppsFlyerを初期化して開始するには、このメソッドを使用してください。SDKを実行する必要があります。アプリが起動した直後にこのAPIを呼び出してください。 |
startSDK |
Use this method to start AppsFlyer SDK, only on manual start mode. |
logEvent |
インストールイベントをログします。 |
setCustomerUserId |
顧客IDを設定すると、AppsFlyerのユニークIDと他のデバイスのIDとをクロス参照できます。このIDは、raw-dataレポートとPostback APIで利用できます。 |
setCurrencyCode |
購入の通貨を設定します。通貨codeは3桁のISO 4217codeでなければなりません。 |
updateServerUninstallToken |
(Android) GCM/FCMトークンをAppsFlyerサーバーに渡すことができます。これは、アンインストールログに使用できます。(iOS) APNトークンをAppsFlyerサーバーに渡すことができます。これは、アンインストールログに使用できます。 |
setAppInviteOneLink |
ユーザー招待のAttributionに使用するOneLink IDを設定します。ユーザー招待用に生成されるリンクは、このOneLinkをベースとして生成されます。 |
setOneLinkCustomDomain |
In order for AppsFlyer SDK to successfully resolve hidden (decoded in shortlink ID) attribution parameters, any domain that is configured as a branded domain in the AppsFlyer Dashboard should be provided to this method. |
appendParametersToDeepLinkingURL |
App Linksを使用してデープリンクを実装するアプリの所有者は、セッションを開始するドメインを提供する必要があります。このメソッドを呼び出す前に、pid、is_retargetingをtrueに設定したパラメータマップを提供する必要があります。 |
setResolveDeepLinkURLs |
アドバタイザーは、AppsFlyer OneLinkを他のUniversal Link内に wrap することができます。このUniversal Linkはアプリを呼び出すが、AppsFlyerにdeep linkingデータを伝えることはできません。setResolveDeepLinkURLsは、SDKをwrapしたOneLink URLを解決するように設定することができます。これにより、deep linkingが正しく発生するようになります。 |
addPushNotificationDeepLinkPath |
Configures how the SDK extracts deep link values from push notification payloads. |
setSharingFilter |
AppsFlyerの指定されたパートナーにイベントを送信しないようにします。 |
setSharingFilterForAllPartners |
すべてのAppsFlyerパートナーにイベントを送信しないようにします。setSharingFilterを上書きします。 |
setSharingFilterForPartners |
AppsFlyerの指定されたパートナーにイベントを送信しないようにします。 |
setAdditionalData |
AppsFlyerに追加データを送信します。詳しくは。 |
getAppsFlyerUID |
AppsFlyerのユニークなデバイスIDを取得します (アプリの新しいインストールごとに作成されます)。 |
anonymizeUser |
AppsFlyerの分析からユーザーをオプトアウトします (ユーザーデータを匿名化します)。 |
stop |
このAPIが呼び出された後、SDKはサーバーと通信できなくなり、機能を停止します。ユーザーオプトイン/オプトアウトの実装に役立ちます。 |
disableSKAdNetwork |
SKAdNetworkからオプトアウトします。 |
disableAdvertisingIdentifier |
SDKが、Apple Identity for Advertisers (IDFA)、Google Advertising ID (GAID)、OAID、Amazon Advertising ID (AAID)などの広告IDの収集を停止します。 |
disableCollectASA |
Apple Search AdsのAttributionからオプトアウトします。 |
setHost |
ホストをカスタマイズしてください。 |
generateInviteLink |
既存のユーザーが友達や連絡先を新しいユーザーとしてアプリに招待できるようにします。 |
validateAndLogInAppPurchaseAndroid |
API を使用してアプリ内購入のサーバー検証を行います。検証が成功すると、関連する値を含む af_purchase イベントが自動的にログされます。 |
validateAndLogInAppPurchaseIos |
現在の動作のソース定義を参照してください。 |
getSdkVersion |
アプリで使用されている AppsFlyer の SDK バージョンを取得してください。 |
enableFacebookDeferredApplinks |
Facebook Deferred AppLinks の収集を有効にします。Facebook SDK と Facebook アプリがターゲット/クライアント デバイスにインストールされている必要があります。この API は、AppsFlyer SDK を初期化する前に呼び出す必要があります。 |
sendPushNotificationData |
プッシュ通知キャンペーンからデータを取得して測定します。 |
setCurrentDeviceLanguage |
デバイスの言語を設定します。データは Raw Data Reports で表示されます。 |
logCrossPromoteImpression |
クロスプロモーションキャンペーンの一部としてインプレッションをログします。AppsFlyer ダッシュボードで表示されるアプリ ID を使用してください。 |
setUserEmails |
ユーザーのメールアドレスを設定して暗号化します。 |
logLocation |
ユーザーの位置を手動でログします。 |
setPhoneNumber |
SHA-256 で暗号化された文字列として送信されます。 |
setPartnerData |
パートナー統合の目的でカスタムデータを送信することを許可します。 |
logInvite |
ユーザー招待のインアプリイベント (af_invite) をログするために使用してください。 |
setDisableNetworkData |
ネットワークオペレータ名 (carrier) と SIM オペレータ名をデバイスから収集しないようにオプトアウトするために使用してください。 |
enableTCFDataCollection |
CMP を使用するユーザーに自動的にconsentデータを収集することをオプトイン/アウトするために使用してください。フラグ値はアプリセッション間で保存されます。 |
setConsentData |
CMPがTCF v2.2に互換性がある場合に限り、ユーザーconsentデータを手動で設定するために使用してください。アプリがCMPに互換性のない場合、以下の方法でconsentデータを直接SDKに提供する必要があります。 |
logAdRevenue |
広告収益をAttributingすることで、アプリの所有者はユーザーのLTVとキャンペーンROIを完全に把握できます。広告収益は、rewardedビデオ、オファーワール、インテリセスト、バナーなどの広告を表示することで生成されます。このメソッドを使用して、広告収益をログできます。 |
setConsentDataV2 |
CMPがTCF v2.2に互換性がある場合に限り、ユーザーconsentデータを手動で設定するために使用してください。アプリがCMPに互換性のない場合、以下の方法でconsentデータを直接SDKに提供する必要があります。 |
isSDKStarted |
このメソッドを使用して、AppsFlyerSDKが現在のセッションで既に開始されているかどうかを確認できます。 |
isSDKStopped |
このメソッドを使用して、AppsFlyerSDKが現在停止されているかどうかを確認できます。 |
disableAppSetId |
AppSet IDの収集を無効にします。SDKの初期化前に呼び出された場合、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で利用できます。
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCustomerUserId({ cuid: 'cuid' });
setCurrencyCode()
インストール購入の通貨を設定します。通貨codeは3桁のISO 4217codeでなければなりません。
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });
updateServerUninstallToken()
(Android) AppsFlyerサーバーにGCM/FCMトークンを渡すことができます。これはアンインストールログに使用できます。(iOS) AppsFlyerサーバーにAPNトークンを渡すことができます。これはアンインストールログに使用できます。
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.updateServerUninstallToken({ token: 'token-123' });
上の表は44のコアメソッドをリストしています。リスナーとバージョンヘルパー、各メソッドのフルコントラクトは__CAPGO_KEEP_0__リポジトリでドキュメント化されています。 GitHub リポジトリ.
ハンドルを返します。画面がアンマウントされたときに呼び出してください。
addListener フルリファレンス handle.remove() __CAPGO_KEEP_0__リポジトリ
イベントをリスンします。
@capgo/capacitor-appsflyer
__CAPGO_KEEP_0__ を使用 @capgo/capacitor-appsflyer __CAPGO_KEEP_0__ の実装詳細 @capgo/capacitor-appsflyer @capgo/capacitor-アプリフライヤー実装詳細 プラグインディレクトリ __CAPGO_KEEP_0__ リポジトリ Capgo Plugin Directory Capacitor AppsFlyer プラグインの製品ワークフローについては、Capgo プラグイン ディレクトリで Capacitor プラグインは Capgo によって提供されます Capacitor AppsFlyer プラグインの実装詳細については、Capacitor プラグインは Capgo によって提供されます プラグインの追加または更新 Capacitor AppsFlyer プラグインの実装詳細については、プラグインの追加または更新