Guide
Capacitor/__CAPGO_KEEP_1__-appsflyerを使用する
@capgo/capacitor-アプリフライヤー
Capacitor AppsFlyer attribution、分析、デープリンク用プラグイン
Install
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を設定すると、AppsFlyerのユニークIDと他のデバイスのIDとをクロス参照できます。このIDは、raw-dataレポートとPostback APIで利用できます。 |
setCurrencyCode |
購入の通貨を設定します。通貨codeは、3文字のISO 4217codeでなければなりません。 |
updateServerUninstallToken |
(Android) AppsFlyerサーバーに、第三者プラグインによって収集されたGCM/FCMトークンを渡すことができます。アンインストールログに使用できます。(iOS) AppsFlyerサーバーに、第三者プラグインによって収集されたAPNトークンを渡すことができます。アンインストールログに使用できます。 |
setAppInviteOneLink |
ユーザー招待のAttributionに使用するOneLink IDを設定します。ユーザー招待用に生成されるリンクは、このOneLinkをベースとして生成されます。 |
setOneLinkCustomDomain |
AppsFlyer SDKが、短リンクIDで暗号化されたAttributionパラメータを解決するために、AppsFlyerダッシュボードで構成されている任意のドメインを提供する必要があります。 |
appendParametersToDeepLinkingURL |
App Linksを使用するアプリの所有者が、ドメインに関連付けられたアプリのセッションをトリガーするために使用するURLを属性することができます。startを呼び出す前に、このメソッドを呼び出してください。パラメータMapに次のパラメータを提供する必要があります: pidは_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を収集しないようにします。この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 アプリがターゲット/クライアント デバイスにインストールされている必要があります。この API を AppsFlyer SDK を初期化する前に呼び出す必要があります。 |
sendPushNotificationData |
プッシュ通知キャンペーンからデータを取得して測定します。 |
setCurrentDeviceLanguage |
デバイスの言語を設定します。データは Raw Data Reports で表示されます。 |
logCrossPromoteImpression |
クロスプロモーションキャンペーンの一部としてインプレッションをログします。AppsFlyer ダッシュボードで表示されるアプリ ID を使用してください。 |
setUserEmails |
ユーザーのメールアドレスを設定して暗号化します。 |
logLocation |
ユーザーの位置を手動でログします。 |
setPhoneNumber |
SHA-256で暗号化された文字列として送信されます。 |
setPartnerData |
パートナー統合の目的でカスタムデータを送信することを許可します。 |
logInvite |
af_inviteというユーザー招待インスタントイベントをログするために使用してください。 |
setDisableNetworkData |
デバイスからネットワークオペレータ名 (キャリア) とSIMオペレータ名を自動収集することをオプトアウトします。 |
enableTCFDataCollection |
CMPを使用するユーザーに自動収集するconsentデータをオプトイン/アウトします。フラグ値はアプリセッション間で保存されます。 |
setConsentData |
CMPがTCF v2.2に互換性がある場合、CMPを使用してください。そうでない場合は、次の方法でconsentデータを直接SDKに提供してください。 |
logAdRevenue |
広告収益をAttributionすることで、アプリの所有者はユーザーのLTVとキャンペーンROIを完全に把握できます。広告収益は、rewardedビデオ、オファーウォール、インスタンス広告、バナー広告などを表示することで生成されます。このメソッドを使用して広告収益をログできます。 |
setConsentDataV2 |
CMPがTCF v2.2に互換性がある場合、CMPを使用してください。そうでない場合は、次の方法でconsentデータを直接SDKに提供してください。 |
isSDKStarted |
このメソッドを使用して、現在のセッションでAppsFlyer SDKがすでに開始されているかどうかを確認します。 |
isSDKStopped |
このメソッドを使用して、AppsFlyer SDKが現在停止されているかどうかを確認します。 |
disableAppSetId |
AppSet IDの収集を無効にします。SDKの初期化前に呼び出された場合、App Set IDは収集されません。初期化後に呼び出された場合、App Set IDは収集されますが、リクエストパayloadに送信されません。Androidのみ。 |
validateAndLogInAppPurchaseV2 |
API for server verification of in-app purchases V2. An af_purchase event with the relevant values will be automatically logged if the validation is successful. |
例
initSDK()
このメソッドを使用して、AppsFlyer SDK を初期化して開始します。この API は、App が起動したときにすぐに呼び出してください。
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を設定すると、AppsFlyer のユニークIDと他のデバイスのIDとを照合できます。このIDは、raw-data レポートとPostback APIで利用できます。
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_KEEP_0__ を使用している場合 @Capacitor-capgo/capacitor-appsflyer __CAPGO_KEEP_0__ を使用して、ネイティブ プラグインの作業を計画するには、接続する capgo を使用して、@capacitor-appsflyer の実装の詳細を参照する @capgo/capacitor-アプリフライヤー実装詳細 ドキュメント Capacitor-AppsFlyer プラグインの使用方法 Capgo プラグイン ディレクトリ for the product workflow in Capgo Plugin Directory, Capacitor Capgoのプラグイン Capacitor プラグインの実装詳細については、Capgo によって提供されるプラグインです。 プラグインの追加または更新 Capacitor-AppsFlyer プラグインの使用方法