@capgo/capacitor-appsflyer

Capacitor plugin for AppsFlyer attribution, analytics, and deep links.

概要

CapacitorアプリをFlyerのAttribution、分析、デープリンク用プラグイン

主な機能

initSDK - このメソッドを使用して、FlyerのSDKを初期化して開始します。このAPIは、アプリが起動したときにすぐに呼び出してください。
startSDK - FlyerのSDKを開始するには、このメソッドを使用してください。ただし、手動起動モードでのみ使用してください。
logEvent - インアプリイベントをログします。
setCustomerUserId - 自社の顧客IDを設定することで、自社の独自IDをFlyerの独自IDと他のデバイスのIDと照合することができます。このIDは、raw-dataレポートとPostback APIで利用可能です。

パブリックAPI

メソッド	__CAPGO_KEEP_0__
`addListener('conversion_callback', listener)`	__CAPGO_KEEP_1__ `onConversionDataSuccess` and `onConversionDataFail`, with `OnConversionDataResult` payloads.
`addListener('oaoa_callback', listener)`	Listen for app-open attribution callbacks, including `onAppOpenAttribution` and `onAttributionFailure`, with `OnAppOpenAttribution` payloads.
`addListener('udl_callback', listener)`	Listen for unified deep link callbacks with `OnDeepLink` __CAPGO_KEEP_0__を初期化して起動するには、このメソッドを使用してください。
`initSDK`	Use this method to initialize and start AppsFlyer SDK. This API should be called as soon as the app launched.
`startSDK`	この方法を使用して、AppsFlyer SDK を手動起動モードでのみ開始します。
`logEvent`	インストールイベントをログします。
`setCustomerUserId`	AppsFlyer のユニーク ID と他のデバイスの ID とをクロス参照するために、自分のユニーク ID を設定します。この ID は、raw-data レポートと Postback API で利用できます。
`setCurrencyCode`	インストール購入の通貨を設定します。3 桁の ISO 4217 code を提供してください。
`updateServerUninstallToken`	Android では GCM/FCM トークン、iOS では APNs トークンをパスします。別のプラグインが収集した場合に、AppsFlyer にトークンを渡します。この方法を使用して、アンインストール測定トークンを AppsFlyer に送信します。
`setAppInviteOneLink`	AppsFlyer が短リンク内の隠れたパラメータを解決できるように、OneLink ID を設定します。
`setOneLinkCustomDomain`	OneLink ドメインを登録して、AppsFlyer が短リンク内のパラメータを解決できるようにします。
`appendParametersToDeepLinkingURL`	App Links のデープリンクの Attribution を有効にします。このメソッドを呼び出す前に、 `startSDK()`このパラメータマップに「」と「」を含めてください。 `pid` OneLink が Universal Link 内に wrap されている場合に使用します。この方法を使用して、__CAPGO_KEEP_0__ が wrap された URL を解決できるようにします。デープリンクが正しく機能するようにします。 `is_retargeting=true` __CAPGO_KEEP_0__
`setResolveDeepLinkURLs`	SDK
`addPushNotificationDeepLinkPath`	SDKがプッシュ通知のペイロードからデープリンク値を抽出する方法を設定します。
`setSharingFilter`	AppsFlyerパートナーにイベントを送信しないようにします。
`setSharingFilterForAllPartners`	すべてのAppsFlyerパートナーにイベントを送信しないようにします。設定済みのsetSharingFilterを上書きします。
`setSharingFilterForPartners`	AppsFlyerパートナーにイベントを送信しないようにします。
`setAdditionalData`	AppsFlyerに追加のキー値データを送信します。
`getAppsFlyerUID`	AppsFlyerのユニークデバイスIDを取得します (アプリの新しいインストールごとに作成されます)。
`anonymizeUser`	AppsFlyerの分析からエンドユーザーがオプトアウトする (ユーザーデータを匿名化する)。
`stop`	このAPIを呼び出した後、SDKはサーバーと通信できなくなり、機能を停止します。ユーザーオプトイン/オプトアウトの実装に役立ちます。
`disableSKAdNetwork`	SKAdNetworkからオプトアウトします。
`disableAdvertisingIdentifier`	SDKがAdvertising IDを収集しないようにします。このIDにはApple Identity for Advertisers (IDFA)、Google Advertising ID (GAID)、OAID、Amazon Advertising ID (AAID)が含まれます。
`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`	ユーザーconsentデータを手動で設定します。TCF v2.2に互換性のあるCMPを使用しない場合は、次の方法を使用して、consentデータを直接SDKに提供します。
`logAdRevenue`	広告収益をAttributingすることで、アプリの所有者はユーザーのLTVとキャンペーンROIを完全に把握できます。広告収益は、リワードビデオ、オファーワール、インスタンシャル、バナーなどの広告を表示することで生成されます。このメソッドを使用して、広告収益をログインできます。
`setConsentDataV2`	ユーザーconsentデータを手動で設定します。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のサーバー検証用のインアプリ購入V2。検証が成功した場合、関連する値を持つaf_purchaseイベントが自動的にログインされます。

真実の源

このリファレンスはsynced されています。 src/definitions.ts in capacitor-appsflyer.