AppsFlyerLib
Обзор
AppsFlyerLib
— это основной класс SDK AppsFlyer для Android, который содержит большинство его методов.
Вернуться к Указателю справочника по SDK.
Импорт библиотеки
import com.appsflyer.AppsFlyerLib;
Доступ к экземпляру SDK
Доступ к одноэлементному экземпляру SDK:
AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();
Методы
addPushNotificationDeepLinkPath
Сигнатура метода
void addPushNotificationDeepLinkPath(java.lang.String... deepLinkPath)
Описание
Определяет, как SDK будет извлекать значения диплинков из полезных данных push-уведомлений.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String... | deepLinkPath | Массив строк String , который соответствует пути к JSON диплинка. |
Возвращаемые значения
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 | По умолчанию 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)
Описание
Позволяет владельцам приложений, использующим для диплинкинга App Links (без OneLink), атрибутировать сессии, инициированные через домен, связанный с их приложением.
Вызовите этот метод до вызова
start
Необходимо передать следующие параметры в 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
В примере выше URL-адрес для атрибуции, отправленный на серверы AppsFlyer, будет такой:
example.com?pid=exampleDomain&is_retargeting=true
enableFacebookDeferredApplinks
Сигнатура метода
void enableFacebookDeferredApplinks(boolean isEnabled)
Описание
Включает сбор данных App Links Facebook для отложенного диплинкинга. Требует, чтобы на целевом/клиентском устройстве были установлены SDK Facebook и приложение Facebook.
Для корректной работы этот API необходимо вызывать до инициализации SDK AppsFlyer.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
boolean | isEnabled | Должны ли App Links Facebook для отложенного диплинкинга обрабатываться SDK AppsFlyer. |
Возвращаемые значения
void
enableLocationCollection
Удалено в V6.8.0
Сигнатура метода
AppsFlyerLib enableLocationCollection(boolean flag)
Описание
Включает в SDK AppsFlyer сбор данных о последнем известном местоположении. Требуются разрешения манифеста ACCESS_COARSE_LOCATION
and ACCESS_FINE_LOCATION
.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
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).
Входные аргументы
Тип | Имя | Описание |
---|---|---|
булевое значение | 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 уникального идентификатора устройства. SDK генерирует уникальный идентификатор устройства AppsFlyer при установке приложения. При запуске SDK этот идентификатор записывается как идентификатор первой установки приложения.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения/активности. |
Возвращаемые значения
Уникальный идентификатор устройства AppsFlyer.
Пример использования
String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this);
String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this)
getAttributionId
Сигнатура метода
java.lang.String getAttributionId(Context context)
Описание
Получить идентификатор атрибуции Facebook, если он существует.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения/активности. |
Возвращаемые значения
void
Пример использования
String attributionId = AppsFlyerLib.getInstance().getAttributionId(this);
String attributionId = AppsFlyerLib.getInstance().getAttributionId(this)
getHostName
Сигнатура метода
java.lang.String getHostName()
Описание
Получает имя хоста.
Значение по умолчанию: appsflyer.com
Входные аргументы
Эта функция не принимает параметры.
Возвращаемые значения
Тип | Описание |
---|---|
String | Текущее имя хоста (hostname). |
Пример использования
getHostPrefix
Сигнатура метода
java.lang.String getHostPrefix()
Описание
Получает настраиваемый префикс хоста.
Входные аргументы
Эта функция не принимает параметры.
Возвращаемые значения
Префикс хоста.
getInstance
Сигнатура метода
AppsFlyerLib getInstance()
Описание
Возвращает экземпляр SDK, через который вы можете получить доступ к методам, описанным в этом документе.
Входные аргументы
Эта функция не принимает параметры.
Возвращаемые значения
Одноэлементный экземпляр AppsFlyerLib.
getOutOfStore
Сигнатура метода
java.lang.String getOutOfStore(Context context)
Описание
Получает значение реферера стороннего магазина приложений.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения/активности. |
Возвращаемые значения
AF_Store
значение.
getSdkVersion
Сигнатура метода
java.lang.String getSdkVersion()
Описание
Получает используемую в приложении версию SDK AppsFlyer.
Входные аргументы
Эта функция не принимает параметры.
Возвращаемые значения
Версия SDK AppsFlyer.
init
Сигнатура метода
AppsFlyerLib init(java.lang.String key,
AppsFlyerConversionListener conversionDataListener,
Context context)
Описание
Используйте этот метод для инициализации SDK AppsFlyer. Этот API должен вызываться внутри класса Application, метода onCreate
.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String | key | Ключ разработчика AppsFlyer |
AppsFlyerConversionDataListener | conversionDataListener | (Необязательно) Реализуйте AppsFlyerConversionDataListener для доступа к данным AppsFlyer о конверсиях. Не может иметь значение null. |
Context | context | Контекст приложения. |
Возвращаемые значения
void
Пример использования
См. статью Инициализация SDK.
isPreInstalledApp
Сигнатура метода
boolean isPreInstalledApp(Context context)
Описание
Логическое значение. Индикатор предустановки производителем устройства.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения/активности. |
Возвращаемые значения
boolean
.
Пример использования
isStopped
Сигнатура метода
boolean isStopped()
Описание
Проверяет, был ли SDK остановлен.
Входные аргументы
Эта функция не принимает параметры.
Возвращаемые значения
Тип | Описание |
---|---|
boolean | true если остановлен, false в противном случае. |
Пример использования
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 | Контекст приложения/активности |
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)
Описание
Аналогичен logEvent с AppsFlyerRequestListener. HttpURLConnection.HTTP_OK
от
сервера вызывает метод AppsFlyerRequestListener#onSuccess().
AppsFlyerRequestListener#onError(int, String) возвращает
ошибку, если она возникает
Входные аргументы
Эта функция не принимает параметры.
Возвращаемые значения
void
Пример использования
logLocation
Сигнатура метода
void logLocation(Context context,
double latitude,
double longitude)
Описание
Позволяет вручную регистрировать местоположение пользователя.
Этот метод создает внутреннее событие af_location_coordinates
, с параметрами события af_lat
and af_long
.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения/активности |
double | latitude | Широта |
double | longitude | Долгота |
Возвращаемые значения
void
Пример использования
logSession
Сигнатура метода
void logSession(Context ctx)
Описание
Если у вас служебное приложение, работающее в фоновом режиме, этот API можно использовать в методе onCreate() класса Activity, чтобы вручную регистрировать и отправлять сессию.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | ctx | Контекст приложения/активности |
Пример использования
public void logSession(Context context);
public void logSession(Context context)
Возвращаемые значения
void
onPause
Сигнатура метода
void onPause(Context context)
Описание
Только для платформы Cocos2dx
У Cocos2dx свое событие applicationDidEnterBackground.
Поэтому onPause будет вызываться из C++ средствами JNI
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения/активности |
Возвращаемые значения
void
Пример использования
performOnAppAttribution
Устарел с V6.3.2
Сигнатура метода
void performOnAppAttribution(Context context,
java.net.URI link)
Описание
Используется для расшифровки диплинков вручную.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения/активности |
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.
- Если зарегистрирован
DeepLinkListener
, поддерживается и отложенный, и прямой диплинкинг. - Если зарегистрирован
AppsFlyerConversionListener
, поддерживается только прямой диплинкинг.
Рекомендуется вызывать этот метод из класса Activity
метода onResume
для активностей, которые можно запускать с помощью диплинков.
Примечание. Прямые диплинки, обрабатываемые этим API, не передаются на сервер.
Пример использования
@Override
protected void onResume() {
super.onResume();
AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();
appsflyer.performOnDeepLinking(getIntent(),this);
}
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Intent | intent | |
Context | context | Контекст приложения/активности. |
Возвращаемые значения
void
registerConversionListener
Сигнатура метода
void registerConversionListener(Context context,
AppsFlyerConversionListener conversionDataListener)
Описание
Регистрирует слушатель данных о конверсиях. Вы также можете использовать init
для регистрации слушателя.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения/активности. |
AppsFlyerConversionListener | conversionDataListener | The AppsFlyerConversionListener объект, который требуется зарегистрировать. |
Возвращаемые значения
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)
Пример реализации AppsFlyerConversionListener
.
registerValidatorListener (LEGACY)
Сигнатура метода
void registerValidatorListener(Context context,
AppsFlyerInAppPurchaseValidatorListener validationListener)
Описание
Регистрирует прослушиватель данных о проверках для API validateAndLogInAppPurchase
.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения/активности. |
AppsFlyerInAppPurchaseValidatorListener | validationListener | The AppsFlyerInAppPurchaseValidatorListener объект, который требуется зарегистрировать. |
Возвращаемые значения
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 | Контекст приложения/активности. |
Map<String, Object> | validationListener |
Возвращаемые значения
void
sendPushNotificationData
Сигнатура метода
void sendPushNotificationData(Activity activity)
Описание
Измеряет и получает данные из кампаний с push-уведомлениями. Вызовите этот метод внутри метода onCreate
класса Activity
, которые запускаются из push-уведомлений.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Activity | activity | The Activity , который запускается уведомлением. |
Возвращаемые значения
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 Services, то по умолчанию SDK не проводит сбор данных IMEI и Android ID. Используйте этот API, чтобы явным образом отправлять Android ID в AppsFlyer.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String | aAndroidId | Идентификатор устройства Android. |
Возвращаемые значения
void
setAppId
Сигнатура метода
void setAppId(java.lang.String id)
Описание
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String | id | Идентификатор приложения Android. |
Возвращаемые значения
void
setAppInviteOneLink
Сигнатура метода
void setAppInviteOneLink(java.lang.String oneLinkId)
Описание
Задает идентификатор OneLink, который используется для атрибуции приглашений пользователей. Эта ссылка OneLink используется как базовая в ссылке, формируемой для приглашения пользователей. См. описание настройки ссылки OneLink для атрибуции приглашений пользователей.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String | oneLinkId | Идентификатор OneLink, полученный с дэшборда AppsFlyer. |
Возвращаемые значения
void
.
setCollectAndroidID
Сигнатура метода
void setCollectAndroidID(boolean isCollect)
Описание
Разрешает сбор Android ID. Заставляет SDK собирать Android ID.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
boolean | isCollect | Установите на true , чтобы согласиться. |
Возвращаемые значения
void
.
setCollectIMEI
Сигнатура метода
void setCollectIMEI(boolean isCollect)
Описание
Разрешает сбор IMEI. Заставляет SDK собирать IMEI.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
boolean | isCollect | Установите на true , чтобы согласиться. |
Возвращаемые значения
void
.
setCollectOaid
Сигнатура метода
void setCollectOaid(boolean isCollect)
Описание
Разрешение / отказ от сбора OAID. По умолчанию SDK пытается собирать данные OAID.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
boolean | isCollect | По умолчанию true . Установите на false , чтобы отказаться. |
Возвращаемые значения
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)
Описание
Задает валюту для покупок внутри приложения. Код валюты должен быть кодом из трех символов по стандарту 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)
Описание
Позволяет задать идентификатор клиента и запустить SDK.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String | id | Идентификатор клиента. |
String | context | Контекст приложения/активности. |
Возвращаемые значения
void
setCustomerUserId
Сигнатура метода
void setCustomerUserId(java.lang.String id)
Описание
Задав собственный ID клиента, вы сможете сопоставить свой уникальный идентификатор с уникальным идентификатором AppsFlyer, а также с идентификаторами других устройств.
Этот идентификатор можно посмотреть в отчетах с сырыми данными, а также получить с помощью API постбэков для связывания внутренних идентификаторов.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String | id | Идентификатор клиента. |
Возвращаемые значения
void
.
setDebugLog
Сигнатура метода
void setDebugLog(boolean shouldEnable)
Описание
Включает журналы отладки для SDK AppsFlyer. Значение true должно быть задано только в средах разработки.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
boolean | shouldEnable | По умолчанию false . |
Возвращаемые значения
void
.
Пример использования
setDisableAdvertisingIdentifiers
Добавлен в V6.3.2
Сигнатура метода
void setDisableAdvertisingIdentifiers(boolean disable);
Описание
Отключает сбор различных рекламных идентификаторов средствами SDK. Сюда входят ID рекламы Google (GAID), OAID и ID рекламы Amazon (AAID).
Входные аргументы
Тип | Имя | Описание |
---|---|---|
boolean | disable | По умолчанию false . |
Возвращаемые значения
void
.
setDisableNetworkData
Добавлено в V6.7.0
Сигнатура метода
void setDisableNetworkData(boolean disable);
Описание
Используется для отказа от сбора названия оператора сети (carrier) и названия оператора SIM-карты с устройства.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
boolean | disable | По умолчанию 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, если хост отправлен с пустым или нулевым значением, вызов API игнорируется.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String | hostPrefixName | Префикс хоста. |
String | hostName | Имя хоста. |
Возвращаемые значения
void
.
setImeiData
Сигнатура метода
void setImeiData(java.lang.String aImei)
Описание
Если приложение работает в ОС версии выше KitKat (4.4) и на устройстве установлены службы Google Play, то по умолчанию SDK не проводит сбор данных IMEI и Android ID.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
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 | Устанавливает минимальное время, которое должно пройти между двумя запусками приложения, чтобы они считались двумя отдельными сессиями. Если не задано, минимальное время между сессиями по умолчанию составляет 5 секунд. |
Возвращаемые значения
void
.
setOaidData
Сигнатура метода
void setOaidData(java.lang.String oaid)
Описание
По умолчанию SDK не собирает OAID. Используйте этот API, чтобы явным образом отправлять OAID в AppsFlyer.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String | oaid | OAID устройства. |
Возвращаемые значения
void
.
setOneLinkCustomDomain
Сигнатура метода
void setOneLinkCustomDomain(java.lang.String... domains)
Описание
Чтобы SDK AppsFlyer мог расшифровать скрытые параметры атрибуции (закодированные в идентификаторе короткой ссылки), этому методу следует предоставить все домены, настроенные на дэшборде AppsFlyer как домены бренда.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String... | domains | Массив доменов, которые должны восприниматься SDK как домены бренда (SDK будет пытаться расшифровать их как ссылки OneLink). |
Возвращаемые значения
void
.
setOutOfStore
Сигнатура метода
void setOutOfStore(java.lang.String sourceName)
Описание
Позволяет указать альтернативный магазин приложений, из которого было загружено приложение.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String | sourceName | Название стороннего магазина приложений. |
Возвращаемые значения
void
.
Пример использования
AppsFlyerLib.getInstance().setOutOfStore("baidu");
AppsFlyerLib.getInstance().setOutOfStore("baidu")
setPartnerData
Сигнатура метода
void setPartnerData(@NonNull String partnerId, Map<String, Object> data);
Описание
Разрешает отправку настраиваемых данных для интеграции с партнерами.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String | partnerId | Идентификатор партнера (обычно с суффиксом "_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 | Идентификатор сайта для атрибуции предустановки. |
Возвращаемые значения
void
.
setResolveDeepLinkURLs
Сигнатура метода
void setResolveDeepLinkURLs(java.lang.String... urls)
Описание
Рекламодатели могут обернуть ссылку OneLink AppsFlyer другой универсальной ссылкой. Такая универсальная ссылка будет вызывать приложение, но данные диплинкинга не будут передаваться в AppsFlyer.
setResolveDeepLinkURLs
позволяет настроить в SDK расшифровку обернутых ссылок OneLink для корректной работы диплинкинга.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String... | urls | Обязательно явным образом укажите URL-адреса. |
Возвращаемые значения
void
Пример использования
AppsFlyerLib.getInstance().setResolveDeepLinkURLs("clickdomain.com", "myclickdomain.com", "anotherclickdomain.com");
setSharingFilterForPartners
Добавлено в версии 6.4
Сигнатура метода
void setSharingFilterForPartners(java.lang.String... partners)
This function replaces the deprecated setSharingFilter
and setSharingFilterForAllPartners
Описание
Позволяет настроить, каких партнеров SDK должен исключать из обмена данными.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
String... | partners | Один или несколько идентификаторов партнеров, которые требуется исключить. Должны содержать только буквы/цифры и символы подчеркивания. Макс. длина идентификатора партнера: 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:
- Выполните команду Получить API активных интеграций, чтобы получить список всех активных интеграций
- Используйте
media_source_name
из ответа API как входные значения для массиваpartners
метода.
Исключения:
- For Twitter, use
twitter
(а неtwitter_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
Устарело в версии 6.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 | Один или несколько идентификаторов партнеров. Должен содержать только буквы/цифры и символы подчеркивания. До 45 символов. |
Возвращаемые значения
void
setSharingFilterForAllPartners
Устарело в версии 6.4
Сигнатура метода
void setSharingFilterForAllPartners()
This function is deprecated and has been replaced by setSharingFilterForPartners
Описание
Останавливает передачу событий всем партнерам AppsFlyer. Перезаписывает setSharingFilter
.
Входные аргументы
Эта функция не принимает параметры.
Возвращаемые значения
void
setUserEmails
Сигнатура метода
void setUserEmails(AppsFlyerProperties.EmailsCryptType cryptMethod,
java.lang.String... emails)
Описание
Задает адреса электронной почты пользователей и шифрует их.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
AppsFlyerProperties.EmailsCryptType | cryptMethod | Методы шифрования:
|
String... | emails | Один или несколько адресов электронной почты пользователей. |
Возвращаемые значения
void
.
start
Сигнатура метода
void start(Context context,
java.lang.String key,
AppsFlyerRequestListener listener)
Описание
Запускает SDK.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения, если вызов осуществляется в методе onCreate приложения, контекст активности, если вызов осуществляется после вызова в активности метода onResume . |
String | key | Ваш ключ разработчика AppsFlyer |
AppsFlyerRequestListener | listener | (Необязательно) Прослушиватель для получения статуса запроса. |
Возвращаемые значения
void
.
Пример использования
См. пример реализации в статье Интеграция SDK.
stop
Сигнатура метода
void stop(boolean shouldStop,
Context context)
Описание
После вызова этого API пакет SDK завершит обмен данными с нашими серверами и перестанет функционировать.
Полезен для реализации логики согласия/отказа пользователя.
Перезапуск SDK
После
stop(true)
необходимо вызватьstop(false)
и только затем вызватьstart()
Входные аргументы
Тип | Имя | Описание |
---|---|---|
boolean | shouldStop | Требуется ли остановить регистрацию. |
Context | context | Контекст приложения/активности. |
Возвращаемые значения
void
.
subscribeForDeepLink
Сигнатура метода
void subscribeForDeepLink(DeepLinkListener deepLinkListener,
long timeout)
Описание
Входные аргументы
Тип | Имя | Описание |
---|---|---|
DeepLinkListener | deepLinkListener | |
long | timeout | Необязательно. Единицы измерения в миллисекундах |
Возвращаемые значения
void
unregisterConversionListener
Сигнатура метода
void unregisterConversionListener()
Описание
Отмена регистрации ранее зарегистрированного AppsFlyerConversionListener
.
Входные аргументы
Эта функция не принимает параметры.
Возвращаемые значения
void
updateServerUninstallToken
Сигнатура метода
void updateServerUninstallToken(Context context,
java.lang.String token)
Описание
Для разработчиков, которые не используют Firebase для измерения количества удалений. Подробные сведения см. в статье Измерение количества удалений.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения/активности. |
String | token | Токен устройства Firebase. |
Возвращаемые значения
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 для серверной проверки покупок в приложении. Событие af_purchase
с соответствующими значениями будет автоматически регистрироваться, если проверка успешно пройдена.
Подробные инструкции см. в статье Проверка покупок.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
Context | context | Контекст приложения/активности. |
String | publicKey | Лицензионный ключ, полученный из консоли Google Play. |
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)
Описание
Этот метод откладывает инициализацию SDK до предоставления customerUserID
.
Все внутренние события приложения и любые другие вызовы API SDK отклоняются до предоставления и регистрации customerUserID
.
Входные аргументы
Тип | Имя | Описание |
---|---|---|
boolean | wait |
Возвращаемые значения
void
.
Пример использования
AppsFlyerLib.getInstance().waitForCustomerUserId(true);
AppsFlyerLib.getInstance().waitForCustomerUserId(true);
Изменения сохранены 2 месяца назад