AppsFlyerLib
概要
AppsFlyerLib
は、AppsFlyer iOS SDKのメインクラスで、ほどんとのメソッドをカプセル化しています。
SDK参照インデックスに戻る。
ライブラリのインポート
import com.appsflyer.AppsFlyerLib;
SDKインスタンスへのアクセス
SDKシングルトンのインスタンスへアクセス:
AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();
メソッド
addPushNotificationDeepLinkPath
メソッドのシグネチャ
void addPushNotificationDeepLinkPath(java.lang.String... deepLinkPath)
詳細
SDKがプッシュ通知のペイロードからディープリンクの値を抽出する方法を設定してください。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String... | deepLinkPath | An array of String s that corresponds to the JSON path of the deep link. |
返されるコード
void
.
使用例:
一般的な設定:
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("af_push_link");
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("af_push_link")
高度な設定:
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link")
この呼び出しは、以下のペイロードの構造と一致します:
{
"deeply": {
"nested": {
"deep_link": "https://yourdeeplink2.onelink.me"
}
}
}
anonymizeUser
メソッドのシグネチャ
void anonymizeUser(boolean shouldAnonymize)
詳細
ユーザーのインストール、イベント、およびセッションを匿名化します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | shouldAnonymize | Defaults to false . |
返されるコード
void
使用例:
AppsFlyerLib.getInstance().anonymizeUser(true);
AppsFlyerLib.getInstance().anonymizeUser(true)
appendParametersToDeepLinkingURL
メソッドのシグネチャ
void appendParametersToDeepLinkingURL(java.lang.String contains,
java.util.Map<java.lang.String,java.lang.String> parameters)
詳細
OneLinkを使用せず、ディープリンクにApp Linksを使用しているアプリの所有者は、アプリに関連するドメイン経由で開始されたセッションをアトリビューションできるようになります。
Call this method before calling
start
You must provide the following parameters in the parameters
Map
:
pid
is_retargeting
は次のように設定してください:true
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | contains | ディープリンクURL内に含まれる文字列 |
Map<String, String> | parameters | 一致したURLに追加される計測パラメーター |
返されるコード
void
使用例:
HashMap<String, String> urlParameters = new HashMap<>();
urlParameters.put("pid", "exampleDomain"); // Required
urlParameters.put("is_retargeting", "true"); // Required
AppsFlyerLib.getInstance().appendParametersToDeepLinkingURL("example.com", urlParameters);
AppsFlyerLib.getInstance().appendParametersToDeepLinkingURL("example.com",
mapOf("pid" to "exampleDomain", "is_retargeting" to "true")) // Required
上記の例では、AppsFlyerサーバーに送信される計測URLは次のようになります。
example.com?pid=exampleDomain&is_retargeting=true
enableFacebookDeferredApplinks
メソッドのシグネチャ
void enableFacebookDeferredApplinks(boolean isEnabled)
詳細
FacebookのDeferred AppLinksの収集を可能にします。Facebook SDKとターゲット/クライアントデバイスにFacebookアプリが必要です。
このAPIが正しく機能するためには、AppsFlyer SDKの初期化の前に起動する必要があります。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | isEnabled | FacebookのディファードアプリリンクはAppsFlyer SDKにより処理されるべきです。 |
返されるコード
void
enableLocationCollection
V6.8.0 で削除
メソッドのシグネチャ
AppsFlyerLib enableLocationCollection(boolean flag)
詳細
Enable the AppsFlyer SDK to collect the last known location. Requires ACCESS_COARSE_LOCATION
and ACCESS_FINE_LOCATION
Manifest permissions.
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | flag |
返されるコード
void
enableTCFDataCollection
メソッドのシグネチャ
AppsFlyerLib enableTCFDataCollection (boolean flag)
詳細
Enables the collection of Transparency and Consent Framework (TCF) data from SharedPreferences
. The data was placed in SharedPreferences
by the device TCF v2.2 compatible Consent Management Platform (CMP).
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | flag | A boolean value to enable (true ) or disable (false ) the collection of TCF data. The SDK collects TCF data when the flag is set to true . |
返されるコード
void
getAppsFlyerUID
メソッドのシグネチャ
java.lang.String getAppsFlyerUID(Context context)
詳細
AppsFlyerのユニークデバイスIDを取得します。SDKはアプリのインストール時にAppsFlyerのユニークなデバイスIDを生成します。SDKを起動すると、このIDが最初のアプリインストール時のIDとして記録されます。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
返されるコード
AppsFlyerのユニークデバイスID。
使用例:
String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this);
String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this)
getAttributionId
メソッドのシグネチャ
java.lang.String getAttributionId(Context context)
詳細
存在する場合、Facebookのattribution IDを取得します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
返されるコード
void
使用例:
String attributionId = AppsFlyerLib.getInstance().getAttributionId(this);
String attributionId = AppsFlyerLib.getInstance().getAttributionId(this)
getHostName
メソッドのシグネチャ
java.lang.String getHostName()
詳細
ホスト名を取得します。
デフォルト値は、"appsflyer.com" です。
引数の入力
この関数はパラメーターを含みません。
返されるコード
タイプ | 詳細 |
---|---|
String | 現在設定されているホスト名。 |
使用例:
getHostPrefix
メソッドのシグネチャ
java.lang.String getHostPrefix()
詳細
カスタムセットのホストプレフィックスを取得します。
引数の入力
この関数はパラメーターを含みません。
返されるコード
ホストプレフィックス
getInstance
メソッドのシグネチャ
AppsFlyerLib getInstance()
詳細
このドキュメントで説明されているメソッドにアクセスできるSDKインスタンスを返します。
引数の入力
この関数はパラメーターを含みません。
返されるコード
AppsFlyerLibのシングルトン・インスタンス。
getOutOfStore
メソッドのシグネチャ
java.lang.String getOutOfStore(Context context)
詳細
サードパーティアプリストアのリファラー値を取得します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
返されるコード
AF_Store
値。
getSdkVersion
メソッドのシグネチャ
java.lang.String getSdkVersion()
詳細
アプリで使用されているAppsFlyer SDKのバージョンを取得します。
引数の入力
この関数はパラメーターを含みません。
返されるコード
AppsFlyer SDKのバージョン。
init
メソッドのシグネチャ
AppsFlyerLib init(java.lang.String key,
AppsFlyerConversionListener conversionDataListener,
Context context)
詳細
Use this method to initialize AppsFlyer SDK. This API should be called inside the Application's onCreate
。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | key | AppsFlyerのDevキー |
AppsFlyerConversionDataListener | conversionDataListener | (オプション)AppsFlyerConversionDataListenerを実装して、AppsFlyerのコンバージョンデータにアクセスします。null にも設定できます。 |
Context | context | Application コンテキスト。 |
返されるコード
void
使用例:
SDKの初期化を参照してください。
isPreInstalledApp
メソッドのシグネチャ
boolean isPreInstalledApp(Context context)
詳細
端末メーカーによるプリインストール向けの Boolean インジケータです。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
返されるコード
boolean
.
使用例:
isStopped
メソッドのシグネチャ
boolean isStopped()
詳細
SDKが停止したかを確認します。
引数の入力
この関数はパラメーターを含みません。
返されるコード
タイプ | 詳細 |
---|---|
boolean | true if stopped, false otherwise. |
使用例:
logAdRevenue
Added in v6.15.0
メソッドのシグネチャ
public abstract void logAdRevenue(
@NonNull AFAdRevenueData adRevenueData,
@Nullable Map<String, Object> additionalParameters
);
詳細
The method sends an ad revenue event to AppsFlyer. See more information in Ad revenue.
インプットパラメーター
名前 | タイプ | 詳細 |
---|---|---|
adRevenueData | AFAdRevenueData | An object that encapsulates all the mandatory parameters of the adRevenue event. The object is passed to the logAdRevenue method. |
additionalParameters | Map<String, Object> | An optional dictionary containing additional parameters to log with the adRevenue event. |
返されるコード
void
.
AFAdRevenueData
An object that encapsulates all mandatory adRevenue
data received from the mediation network.
Definition
data class AFAdRevenueData(
val monetizationNetwork: String,
val mediationNetwork: MediationNetwork,
val currencyIso4217Code: String,
val revenue: Double
)
AFAdRevenueData parameters
名前 | タイプ | 詳細 |
---|---|---|
monetizationNetwork | 文字列 | The monetization network name. |
mediationNetwork | MediationNetwork | The mediation network enum. |
currencyIso4217Code | 文字列 | The ad revenue event currency is a String validated against currencyIso4217Code |
revenue | Double | The ad revenue event amount. |
MediationNetwork
名前 | タイプ | Comments |
---|---|---|
ironsource | 文字列 | |
applovinmax | 文字列 | |
googleadmob | 文字列 | |
fyber | 文字列 | |
appodeal | 文字列 | |
admost | 文字列 | |
topon | 文字列 | |
tradplus | 文字列 | |
yandex | 文字列 | |
chartboost | 文字列 | |
unity | 文字列 | |
customMediation | 文字列 | メディエーションソリューションが、サポートされているメディエーションパートナーのリストに含まれていません。 |
directMonetizationNetwork | 文字列 | このアプリは、仲介なしで収益化ネットワークと直接連携しています。 |
logEvent
メソッドのシグネチャ
void logEvent(Context context,
java.lang.String eventName,
java.util.Map<java.lang.String,java.lang.Object> eventValues)
詳細
アプリ内イベントを記録します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
String | eventName | イベント名 |
Map | eventValues | イベント値 |
返されるコード
void
使用例:
logEvent
メソッドのシグネチャ
void logEvent(Context context,
java.lang.String eventName,
java.util.Map<java.lang.String,java.lang.Object> eventValues,
AppsFlyerRequestListener listener)
詳細
Same as logEvent, with AppsFlyerRequestListener. HttpURLConnection.HTTP_OK
from
server will invoke the AppsFlyerRequestListener#onSuccess()
method. AppsFlyerRequestListener#onError(int, String) will return
the error in case one occurs
引数の入力
This function takes no parameters.
Returns
void
使用例:
logLocation
メソッドのシグネチャ
void logLocation(Context context,
double latitude,
double longitude)
詳細
ユーザーのロケーションを手動で記録します。
This method creates an af_location_coordinates
in-app event, with the af_lat
and af_long
event parameters.
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
double | latitude | 緯度 |
double | longitude | 経度 |
返されるコード
void
使用例:
logSession
メソッドのシグネチャ
void logSession(Context ctx)
詳細
アプリがバックグラウンドのユーティリティーアプリの場合、Activity の onCreate() でこのAPIを使用して、手動でログを取り、セッションを送信することができます。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | ctx | Application / Activity コンテクスト |
使用例:
public void logSession(Context context);
public void logSession(Context context)
返されるコード
void
onPause
メソッドのシグネチャ
void onPause(Context context)
詳細
Cocos2dx プラットフォームのみ
Cocos2dx は独自の applicationDidEnterBackground イベントを保持します。
そのため、'onPause' はJNIによって C++ から呼び出されます。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
返されるコード
void
使用例:
performOnAppAttribution
V6.3.2から非推奨となりました。
メソッドのシグネチャ
void performOnAppAttribution(Context context,
java.net.URI link)
詳細
ディープリンクを手動で解決するために使用します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
java.net.URI | link | 解決するリンク |
返されるコード
void
使用例:
AppsFlyerLib.getInstance().performOnAppAttribution(context, uri);
AppsFlyerLib.getInstance().performOnAppAttribution(context, uri)
performOnDeepLinking
V6.3.1以降で追加されました
メソッドのシグネチャ
public void performOnDeepLinking(@NonNull Intent intent, @NonNull Context context);
詳細
ディープリンクの実行を手動でトリガーできるようにします。このメソッドを使用すると、startの呼び出しを遅延させているアプリがSDKの開始前にディープリンクを実行できるようになります。
- If a
DeepLinkListener
is registered, supports both deferred and direct deep linking - If a
AppsFlyerConversionListener
is registered, only supports direct deep linking
It's recommended to call this from an Activity
's onResume
, for activities that can be launched via deep linking.
Note: Direct deep links processed by this API will not be reported to the server.
使用例:
@Override
protected void onResume() {
super.onResume();
AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();
appsflyer.performOnDeepLinking(getIntent(),this);
}
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Intent | intent | |
Context | context | Application / Activity コンテクスト |
返されるコード
void
registerConversionListener
メソッドのシグネチャ
void registerConversionListener(Context context,
AppsFlyerConversionListener conversionDataListener)
詳細
Register a conversion data listener. You can also use init
to register the listener.
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
AppsFlyerConversionListener | conversionDataListener | The AppsFlyerConversionListener object to register. |
返されるコード
void
使用例:
// conversionDataListener is an object of type AppsFlyerConversionListener.
AppsFlyerLib.getInstance().registerConversionListener(getApplicationContext(), conversionDataListener);
// conversionDataListener is an object of type AppsFlyerConversionListener.
AppsFlyerLib.getInstance().registerConversionListener(getApplicationContext(), conversionDataListener)
Here's an example implementation of AppsFlyerConversionListener
.
registerValidatorListener (LEGACY)
メソッドのシグネチャ
void registerValidatorListener(Context context,
AppsFlyerInAppPurchaseValidatorListener validationListener)
詳細
Register a validation listener for the validateAndLogInAppPurchase
API.
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
AppsFlyerInAppPurchaseValidatorListener | validationListener | The AppsFlyerInAppPurchaseValidatorListener object to register. |
返されるコード
void
使用例:
sendAdRevenue (LEGACY)
Deprecated in v6.15.0
(Supported until SDK v6.14.2 For versions including and above v6.15.0 use logAdRevenue
)
メソッドのシグネチャ
void sendAdRevenue(Context context,
java.util.Map<java.lang.String,java.lang.Object> eventValues)
詳細
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
Map<String, Object> | validationListener |
返されるコード
void
sendPushNotificationData
メソッドのシグネチャ
void sendPushNotificationData(Activity activity)
詳細
Measure and get data from push-notification campaigns. Call this method inside the onCreate
method of Activity
s that are launched from push notifications.
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Activity | activity | The Activity which is launched via the notification. |
返されるコード
void
.
使用例:
setAdditionalData
Calling
setAddiotionalData
before first launch will have the additional data included in installs, sessions, as well as in-app events.
メソッドのシグネチャ
void setAdditionalData(java.util.Map<java.lang.String,java.lang.Object> customData)
詳細
イベントのペイロードにカスタマーデータを追加するために使用します。これはローデータレポートに表示されます。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
HashMap | customData |
返されるコード
void
.
setAndroidIdData
メソッドのシグネチャ
void setAndroidIdData(java.lang.String aAndroidId)
詳細
AndroidのバージョンがKitKat(4.4)以上で、かつ、Google Playサービスを利用している場合、デフォルトでIMEIとAndroid IDはSDKでは収集されません。このAPIを使用して、明示的にAndroid IDをAppsFlyerに送信してください。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | aAndroidId | AndroidデバイスID。 |
返されるコード
void
setAppId
メソッドのシグネチャ
void setAppId(java.lang.String id)
詳細
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | id | AndroidアプリID。 |
返されるコード
void
setAppInviteOneLink
メソッドのシグネチャ
void setAppInviteOneLink(java.lang.String oneLinkId)
詳細
計測するユーザー招待に使用するOneLink IDを設定します。ユーザー招待向けに生成されたリンクは、このOneLinkをベースリンクとして使用します。ユーザー招待の計測におけるOneLink設定を参照してください。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | oneLinkId | AppsFlyer管理画面から取得したOneLink ID。 |
返されるコード
void
.
setCollectAndroidID
メソッドのシグネチャ
void setCollectAndroidID(boolean isCollect)
詳細
Android IDの収集にオプトインします。SDKにAndroid IDの収集を強制します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | isCollect | Set to true to opt-in. |
返されるコード
void
.
setCollectIMEI
メソッドのシグネチャ
void setCollectIMEI(boolean isCollect)
詳細
IMEIの収集にオプトインします。SDKにIMEIの収集を強制します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | isCollect | Set to true to opt-in. |
返されるコード
void
.
setCollectOaid
メソッドのシグネチャ
void setCollectOaid(boolean isCollect)
詳細
OAID収集のオプトアウト。デフォルトでSDKはOAIDの収集を試みます。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | isCollect | Defaults to true . Set to false to opt-out. |
返されるコード
void
.
setConsentData
メソッドのシグネチャ
AppsFlyerLib.getInstance().setConsentData(AppsFlyerConsent afConsent)
詳細
Transfers consent data to the SDK.
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
AppsFlyerConsent | afConsent | An object containing user consent data |
setCurrencyCode
メソッドのシグネチャ
void setCurrencyCode(java.lang.String currencyCode)
詳細
アプリ内購入の通貨を設定します。通貨コードは3桁のISO 4217コードを使用してください。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | currencyCode | 3 character ISO 4217 code. Defaults to "USD" . |
返されるコード
void
.
setCustomerIdAndLogSession
Before calling this method, the method
waitForCustomerUserId
must be called
メソッドのシグネチャ
void setCustomerIdAndLogSession(java.lang.String id,
Context context)
詳細
カスタマーユーザーID(CUID)を設定しSDKを開始します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | id | クライアントのカスタマーID。 |
String | context | Application / Activity コンテクスト |
返されるコード
void
setCustomerUserId
メソッドのシグネチャ
void setCustomerUserId(java.lang.String id)
詳細
独自のカスタマーIDを設定することで、独自のユニークIDとAppsFlyerのユニークIDおよびその他のデバイスIDを相互照会できるようになります。
このIDは、内部IDと相互照会ができるようローデータレポートとポストバックAPIで利用できます。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | id | クライアントのカスタマーID。 |
返されるコード
void
.
setDebugLog
メソッドのシグネチャ
void setDebugLog(boolean shouldEnable)
詳細
AppsFlyer SDKのデバッグログを有効にします。開発環境でのみ true に設定してください。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | shouldEnable | Defaults to false . |
返されるコード
void
.
使用例:
setDisableAdvertisingIdentifiers
V6.3.2で追加されました。
メソッドのシグネチャ
void setDisableAdvertisingIdentifiers(boolean disable);
詳細
SDKによる様々な広告IDの収集を無効にします。これには、Google Advertising ID(GAID)、OAID、Amazon Advertising ID(AAID)が含まれます。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | disable | Defaults to false . |
返されるコード
void
.
setDisableNetworkData
V6.7.0で追加
メソッドのシグネチャ
void setDisableNetworkData(boolean disable);
詳細
デバイスからネットワーク事業者名 (キャリア) とSIM 事業者名の収集をオプトアウトするために使用します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | disable | Defaults to false . |
返されるコード
void
.
setExtension
メソッドのシグネチャ
void setExtension(java.lang.String extension)
詳細
SDKプラグインとエクステンションがこの項目で設定されます。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | extension | エクステンション名。 |
返されるコード
void
.
setHost
メソッドのシグネチャ
void setHost(java.lang.String hostPrefixName,
java.lang.String hostName)
詳細
カスタムホストを設定します。注:SDK V6.10 以降、ホストが空またはNull値で送信された場合、APIの呼び出しは無視されます。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | hostPrefixName | ホストプレフィックス |
String | hostName | ホスト名 |
返されるコード
void
.
setImeiData
メソッドのシグネチャ
void setImeiData(java.lang.String aImei)
詳細
OSバージョンがKitKat(4.4)以上で、かつ、Google Playサービスを利用している場合、デフォルトでIMEIとAndroid IDはSDKでは収集されません。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | aImei | デバイスIMEI。 |
返されるコード
void
.
setIsUpdate
メソッドのシグネチャ
void setIsUpdate(boolean isUpdate)
詳細
アプリがアップデートされたことを手動で設定します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | isUpdate |
返されるコード
void
.
setLogLevel
メソッドのシグネチャ
void setLogLevel(AFLogger.LogLevel logLevel)
詳細
SDKログレベルを設定します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | logLevel | ログレベル。 |
返されるコード
void
.
setMinTimeBetweenSessions
メソッドのシグネチャ
void setMinTimeBetweenSessions(int seconds)
詳細
このセッション計測の最小間隔を任意で設定したい場合には、値を設定してください。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
int | seconds | 2つの別々のセッションとしてカウントするために、2つのアプリ起動の間隔を経過する必要がある最小時間を設定します。これが設定されていない場合は、デフォルトのセッション間の最小時間は5秒です。 |
返されるコード
void
.
setOaidData
メソッドのシグネチャ
void setOaidData(java.lang.String oaid)
詳細
デフォルトでは、OAIDはSDKによって収集されません。このAPIを使用してAppsFlyerにOAIDを明示的に送信します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | oaid | デバイスOAID。 |
返されるコード
void
.
setOneLinkCustomDomain
メソッドのシグネチャ
void setOneLinkCustomDomain(java.lang.String... domains)
詳細
AppsFlyer SDKが隠れた(ショートリンクIDでデコードされた)計測パラメーターを正常に解決するためには、AppsFlyer管理画面でブランドドメインとして設定されているすべてのドメインをこのメソッドに提供する必要があります。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String... | domains | SDKがブランドドメインとして扱うべきドメインの配列(SDKはそれらをOneLinksとして解決しようとします)。 |
返されるコード
void
.
setOutOfStore
メソッドのシグネチャ
void setOutOfStore(java.lang.String sourceName)
詳細
アプリのダウンロード元となったアプリストア(Google Play以外)を指定します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | sourceName | サードパーティアプリストア名。 |
返されるコード
void
.
使用例:
AppsFlyerLib.getInstance().setOutOfStore("baidu");
AppsFlyerLib.getInstance().setOutOfStore("baidu")
setPartnerData
メソッドのシグネチャ
void setPartnerData(@NonNull String partnerId, Map<String, Object> data);
詳細
パートナーとの連携を目的としたカスタムデータの送信を可能にします。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | partnerId | パートナーID(通常「_int」というサフィックスが付きます) |
Map | data | カスタマーデータ。特定のパートナーとの連携設定により異なります |
返されるコード
void
.
使用例:
Map<String, Object> partnerData = new HashMap();
partnerData.put("puid", "123456789");
AppsFlyerLib.getInstance().setPartnerData("test_int", partnerData);
val partnerData = mapOf("puid" to "123456789")
AppsFlyerLib.getInstance().setPartnerData("test_int", partnerData)
setPhoneNumber
メソッドのシグネチャ
void setPhoneNumber(java.lang.String phoneNumber)
詳細
SHA-256 で暗号化された文字列として送信されます。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | phoneNumber |
返されるコード
void
.
setPreinstallAttribution
メソッドのシグネチャ
void setPreinstallAttribution(java.lang.String mediaSource,
java.lang.String campaign,
java.lang.String siteId)
詳細
プリインストールを発生させた端末メーカーやメディアソース名を指定します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String | mediaSource | プリインストール計測のメーカー名またはメディアソース名。 |
String | campaign | プリインストール計測のキャンペーン名。 |
String | siteId | プリインストール計測のサイトID。 |
返されるコード
void
.
setResolveDeepLinkURLs
メソッドのシグネチャ
void setResolveDeepLinkURLs(java.lang.String... urls)
詳細
広告主はAppsFlyer OneLinkをもう一つのユニバーサルリンク内にラップすることができます。このユニバーサルリンクは、アプリを起動しますが、ディープリンクデータはAppsFlyerに渡されません。
setResolveDeepLinkURLs
は、ラップされたOneLink URLを解決するようにSDKを設定することで、ディープリンクが正常に発生するようにします。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String... | urls | URLは必ず明示してください。 |
返されるコード
void
使用例:
AppsFlyerLib.getInstance().setResolveDeepLinkURLs("clickdomain.com", "myclickdomain.com", "anotherclickdomain.com");
setSharingFilterForPartners
V6.4で追加
メソッドのシグネチャ
void setSharingFilterForPartners(java.lang.String... partners)
This function replaces the deprecated setSharingFilter
and setSharingFilterForAllPartners
詳細
SDKがどのパートナーをデータ共有から除外するかを設定することができます。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
String... | partners | 除外したい1つまたは複数のパートナーの識別子。アルファベット/数字、およびアンダースコアのみを使用してください。 パートナーIDの最大文字数:45 |
注意:
Make sure to use the exact partner ID (PID). Failing to do so may result in privacy-preservation breaches.
To find out the required partner IDs:
- Run the Get active integrations API for a list of all active integrations
- 次を使用してください:
media_source_name
values from the API response as input values to the methodpartners
array.
Exceptions:
- For Twitter, use
twitter
(and nottwitter_int
)
使用例:
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int"); // Single partner
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int", "partner2_int"); // Multiple partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("all"); // All partners
AppsFlyerLib.getInstance().setSharingFilterForPartners(); // Reset list (default)
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int") // Single partner
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int", "partner2_int") // Multiple partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("all") // All partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("") // Reset list (default)
setSharingFilter
V6.4で非推奨
メソッドのシグネチャ
void setSharingFilter(java.lang.String... partners)
This function is deprecated and has been replaced by setSharingFilterForPartners
詳細
Stops events from propagating to the specified AppsFlyer partners.
(Deprecated and replaced by setSharingFilterForPartners)
Input arguments
タイプ | 名前 | 詳細 |
---|---|---|
String... | partners | 1つ以上のパートナー識別子。アルファベット/数字、およびアンダースコアのみを使用してください。最大文字数:45 |
返されるコード
void
setSharingFilterForAllPartners
V6.4で非推奨
メソッドのシグネチャ
void setSharingFilterForAllPartners()
This function is deprecated and has been replaced by setSharingFilterForPartners
詳細
Stops events from propagating to all AppsFlyer partners. Overwrites setSharingFilter
.
引数の入力
この関数はパラメーターを含みません。
返されるコード
void
setUserEmails
メソッドのシグネチャ
void setUserEmails(AppsFlyerProperties.EmailsCryptType cryptMethod,
java.lang.String... emails)
詳細
ユーザーのメールアドレスを設定し暗号化します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
AppsFlyerProperties.EmailsCryptType | cryptMethod | 暗号化の方法:
|
String... | emails | 1つ以上のユーザーメールアドレス。 |
返されるコード
void
.
start
メソッドのシグネチャ
void start(Context context,
java.lang.String key,
AppsFlyerRequestListener listener)
詳細
SDKを開始します。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application Context if calling in the Application onCreate method, Activity Context if calling after Activity's onResume 。 |
String | key | AppsFlyer Devキー。 |
AppsFlyerRequestListener | listener | (オプション)リクエストのステータスを取得するリスナー。 |
返されるコード
void
.
使用例:
実装の例は、SDKの実装を参照してください。
stop
メソッドのシグネチャ
void stop(boolean shouldStop,
Context context)
詳細
このAPIが呼び出されると、SDKはサーバーとの通信を停止し、機能しなくなります。
ユーザーのオプトイン/オプトアウトを実装する際に役立ちます。
SDK restart
>
stop(true)
was called, you need to callstop(false)
and only then callstart()
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | shouldStop | ログを停止します。 |
Context | context | Application / Activity コンテクスト |
返されるコード
void
.
subscribeForDeepLink
メソッドのシグネチャ
void subscribeForDeepLink(DeepLinkListener deepLinkListener,
long timeout)
詳細
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
DeepLinkListener | deepLinkListener | |
long | timeout | オプション。 ミリ秒単位 |
返されるコード
void
unregisterConversionListener
メソッドのシグネチャ
void unregisterConversionListener()
詳細
Unregister a previously registered AppsFlyerConversionListener
.
引数の入力
この関数はパラメーターを含みません。
返されるコード
void
updateServerUninstallToken
メソッドのシグネチャ
void updateServerUninstallToken(Context context,
java.lang.String token)
詳細
アンインストール計測以外の目的でFirebaseを使用している開発者向けです。詳細については、アンインストール計測を参照してください。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
String | token | Firebase Device Token。 |
返されるコード
void
使用例:
AppsFlyerlib.getInstance().updateServerUninstallToken(getApplicationContext(), <TOKEN>);
AppsFlyerlib.getInstance().updateServerUninstallToken(getApplicationContext(), <TOKEN>);
validateAndLogInAppPurchase
Added in v6.14.0
メソッドのシグネチャ
public abstract void validateAndLogInAppPurchase(@NonNull AFPurchaseDetails purchaseDetails,
@Nullable Map<String, String> additionalParameters,
@Nullable AppsFlyerInAppPurchaseValidationCallback validationCallback);
詳細
The method validates a purchase event with the store and if the validation is successful, the SDK sends an af_purchase
event to AppsFlyer.
See detailed instructions in Validate and log in-app purchase.
引数の入力
名前 | タイプ | 詳細 |
---|---|---|
purchaseDetails * | AFPurchaseDetails | An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase method. |
additionalParameters | Map<String, String> | Additional parameters to log with the purchase. |
validationCallback * | AppsFlyerInAppPurchaseValidationCallback ` | A callback for delivering validation results. |
返されるコード
void
AFPurchaseDetails
An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase method.
data class AFPurchaseDetails(
val purchaseType: AFPurchaseType,
val purchaseToken: String,
val productId: String,
val price: String,
val currency: String
)
AFPurchaseDetails parameters
名前 | タイプ | 詳細 |
---|---|---|
purchaseType | AFPurchaseType | Field to distinguish between one-time purchases and subscriptions. The field can accept either subscription or one-time-purchase. |
purchaseToken | 文字列 | Token that uniquely identifies a purchase for a given item and user pair. Part of the Billing Library's Purchase class . To retrieve the token call the getPurchaseToken API |
productId | 文字列 | ID of the product item that has been purchased. Also part of the Billing Library's Purchase class . |
price | 文字列 | The full price of the one-time purchase or the subscription. Also part of the Billing Library's Purchase class . |
currency | 文字列 | Currency used to make the purchase. |
validateAndLogInAppPurchase (LEGACY)
Deprecated in v6.4
メソッドのシグネチャ
void validateAndLogInAppPurchase(Context context,
java.lang.String publicKey,
java.lang.String signature,
java.lang.String purchaseData,
java.lang.String price,
java.lang.String currency,
java.util.Map<java.lang.String,java.lang.String> additionalParameters)
詳細
API for server verification of in-app purchases. An af_purchase
event with the relevant values will be automatically logged if the validation is successful.
購入の検証の詳細な説明を参照してください。
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
Context | context | Application / Activity コンテクスト |
String | publicKey | Google Play Consoleから取得したLicense Key。 |
String | signature | data.INAPP_DATA_SIGNATURE from onActivityResult(int requestCode, int resultCode, Intent data) |
String | purchaseData | data.INAPP_PURCHASE_DATA from onActivityResult(int requestCode, int resultCode, Intent data) |
String | price | 購入価格。skuDetails.getStringArrayList("DETAILS_LIST") から取得してください。 |
String | currency | 購入通貨。skuDetails.getStringArrayList("DETAILS_LIST") から取得してください。 |
Map<String, String> | additionalParameters | 購入時に記録されるフリーハンドパラメーター(検証された場合)。 |
返されるコード
void
.
waitForCustomerUserId
メソッドのシグネチャ
void waitForCustomerUserId(boolean wait)
詳細
This method defers the SDK initialization, until a customerUserID
is provided.
All in-app events and any other SDK API calls are discarded until the customerUserID
is provided and logged.
引数の入力
タイプ | 名前 | 詳細 |
---|---|---|
boolean | wait |
返されるコード
void
.
使用例:
AppsFlyerLib.getInstance().waitForCustomerUserId(true);
AppsFlyerLib.getInstance().waitForCustomerUserId(true);
更新済 9日前