Интеграция SDK Android для маркетологов

Данные о доходе можно отправлять с любым внутренним событием приложения. Убедитесь, что для включения данных о доходе используется параметр af_revenue. Это единственный параметр события, который AppsFlyer учитывает как реальный доход и отображает на дэшборде и в отчетах с сырыми данными. Подробные сведения см. здесь.

Инструкции для разработчиков см. в разделе Регистрация доходов.

При покупках в приложении SDK AppsFlyer выполняет проверку на сервере. Валидация покупки в приложении автоматически отправляет в AppsFlyer данные о событии покупки. При самостоятельной отправке этого события происходит дублирование данных о событии.

Если приложение относится к определенной категории, такой как путешествия, игры, электронная коммерция, см. список рекомендованных событий для каждой категории.

Если у пользователей не установлено ваше приложение, OneLink определяет тип устройства и перенаправляет их в нужное место назначения: в Google Play, Apple App Store, сторонний магазин приложений или на веб-страницу. Это зависит от ваших настроек шаблона OneLink. Узнать больше

Если у пользователей установлено ваше приложение, OneLink открывает приложение. Помимо открытия приложения, вы также можете перенаправлять пользователей по диплинкам на определенное действие или страницу в приложении. Для этого вашему разработчику нужно реализовать унифицированный диплинкинг (UDL).

Внимание:

• Для UDL нужен SDK версии 6.1+.
• Вместо UDL клиенты, уже применяющие OneLink для диплинкинга, могут использовать устаревшие методы.

См. наше руководство по настройке диплинкинга при помощи OneLink.

Если у пользователей не установлено ваше приложение, OneLink определяет тип устройства и перенаправляет их в нужную точку: в Google Play, Apple App Store, сторонний магазин приложений или на веб-страницу. Когда пользователь загрузит приложение, вы можете направить его на определенную активность или страницу приложения с помощью отложенного диплинкинга.

Для этого вашему разработчику нужно реализовать унифицированный диплинкинг (UDL).

Внимание:

• Для UDL нужен SDK версии 6.1+.
• Вместо UDL клиенты, уже применяющие OneLink для отложенного диплинкинга, могут использовать устаревшие методы.

Дополнительные сведения см. в руководстве по отложенному диплинкингу.

AppsFlyer поддерживает измерение кампаний с push-уведомлениями всех поставщиков, а также поддерживает разработчиков, напрямую использующих Google Cloud Messaging или службу push-уведомлений Apple. Конверсии, определенные как открытие приложения из push-уведомления, отображаются на дэшборде ретаргетинга.

С помощью OneLink вы можете измерять повторное вовлечение пользователей через push-уведомления. См. руководство по измерению эффективности кампаний по повторному вовлечению пользователей при помощи push-уведомлений.

AppsFlyer позволяет атрибутировать установки приложений для Android, приобретенных на независимых торговых площадках. Это дает возможность продвигать ваши приложения на рынках, где Google Play недоступен, и расширять аудиторию. 

Подробные сведения об атрибуции установок приложений, приобретенных на независимых торговых площадках, см. здесь.

В ходе предустановочных кампаний изготовители устройств по просьбе владельцев приложений устанавливают эти приложения на устройства еще до их отправки в торговую сеть.

AppsFlyer позволяет легко атрибутировать установки предустановленных приложений. Когда пользователь в первый раз запускает приложение, AppsFlyer атрибутирует эту установку изготовителю как медиаисточнику.

Дополнительные сведения см. здесь.

Инструкции по настройке измерения количества удалений см. здесь.

Для получения подтверждения от серверов AppsFlyer о поступлении запроса можно использовать прослушиватель AppsFlyerTrackingRequestListener.

Метод обратного вызова onRequestSuccess() выполняется каждый раз, когда в ответ на запрос атрибуции, посланный пакетом SDK, возвращается код 200.

Для любого другого ответа выполняется метод обратного вызова onRequestFailure(String error) и возвращается ответ в виде строки ошибки.

Пример использования

AppsFlyerLib.getInstance().start(getApplicationContext(), "devKey", new AppsFlyerRequestListener() {
            @Override
            public void onSuccess() {
                Log.d(LOG_TAG, "Launch sent successfully, got 200 response code from server");
            }
            @Override
            public void onError(int i, @NonNull String s) {
                Log.d(LOG_TAG, "Launch failed to be sent:\n" +
                                "Error code: " + i + "\n"
                                + "Error description: " + s);
            }
        });

AppsFlyerLib.getInstance().start(this, "devKey", object : AppsFlyerRequestListener {
            override fun onSuccess() {
                Log.d(LOG_TAG, "Launch sent successfully")
            }
            override fun onError(errorCode: Int, errorDesc: String) {
                Log.d(LOG_TAG, "Launch failed to be sent:\n" +
                        "Error code: " + errorCode + "\n"
                        + "Error description: " + errorDesc)
            }
        })

В случае возникновения ошибки во время работы прослушивателя запросов отображается код ошибки и описание строки, как указано в таблице ниже.

API setAdditionalData необходим для интеграции на уровне SDK с несколькими внешними партнерским платформами, включая Segment, Adobe и Urban Airship.
Используйте данный API только в тех случаях, когда в руководстве по интеграции платформы специально указана необходимость использования API setAdditionalData.

Пример кода setAdditionalData:

HashMap<String,Object> CustomDataMap = new HashMap<>();
CustomDataMap.put("custom_param_1","value_of_param_1");
AppsFlyerLib.getInstance().setAdditionalData(CustomDataMap);

val customDataMap = HashMap<String, Any>()
customDataMap.put("custom_param_1","value_of_param_1")
AppsFlyerLib.getInstance().setAdditionalData(customDataMap)

Владельцы приложений, использующие App Links для диплинкинга (без OneLink) и имеющие домен, связанный с их приложением, могут атрибутировать сессии, инициированные через этот домен, с помощью метода appendParametersToDeepLinkingURL.

Например, пользователь ищет что-то в Google и кликает по ссылке на ваш домен www.example.com:

• Если у пользователя не установлено приложение, он перенаправляется на веб-сайт (www.example.com).
• Если приложение уже установлено на устройстве этого пользователя, диплинк приведет его в приложение, связанное с доменом www.example.com. Данная сессия атрибутируется медиа-источнику (параметр pid), указанному в appendParametersToDeepLinkingURL.

Дополнительную информацию см. в материалах по Android SDK.

Заметьте: Смарт-баннеры помогают конвертировать посетителей сайта в пользователей мобильного приложения.

По умолчанию два сеанса учитываются как отдельные, если интервал между двумя запусками приложения составляет не меньше 5 секунд (см. дополнительные сведения об учете сеансов).

Чтобы установить минимальный интервал между сеансами, используйте этот API:

AppsFlyerLib.setMinTimeBetweenSessions(int seconds);

Установка большого интервала между запусками может отрицательно сказаться на работе API, которые используют данные сеансов, например, для диплинкинга.

Чтобы сообщить о новых сеансах пользователя, можно использовать этот метод SDK. Это может оказаться удобным, например, для служебных приложений, которые работают в фоновом режиме.

Используйте этот API в активности onCreate():

public void logSession(Context context);

Пример использования:

AppsFlyerLib.getInstance().logSession(context);

Некоторые сторонние службы, такие как службы электронной почты упаковывают ссылки в электронных письмах в свои собственные домены регистрации кликов. Некоторые даже разрешают вам устанавливать свои собственные домены регистрации кликов. Упаковка ссылки OneLink в такие домены может привести к ограничению ее функциональных возможностей.

Чтобы преодолеть эту проблему, можно использовать API setResolveDeepLinkURLs. Этот API позволяет получать ссылки OneLink от доменов кликов, которые запускают приложение.  Этот API нужно обязательно вызвать перед инициализацией SDK.

Например, у вас есть три домена регистрации кликов, которые выполняют перенаправление на вашу ссылку OneLink по адресу https://mysubdomain.onelink.me/abCD. Используйте этот API для получения ссылки OneLink, на которую перенаправляют домены регистрации кликов. Этот метод API получает список доменов, разрешение которых выполняет SDK. Добавьте следующий код перед инициализацией SDK.

AppsFlyerLib.getInstance().setResolveDeepLinkURLs("clickdomain.com", "myclickdomain.com", "anotherclickdomain.com");

Приведенный выше код позволяет использовать домен регистрации кликов, сохраняя при этом функциональные возможности OneLink. Домены регистрации кликов выполняют запуск приложения. API, в свою очередь, получает от этих доменов ссылку OneLink, после чего данные этой ссылки OneLink можно использовать для диплинкинга и персонализации пользовательского контента.

С помощью AppsFlyer можно выполнять измерения push-уведомлений при проведении кампаний по ретаргетингу.

Чтобы включить эту функцию, вызовите метод sendPushNotificationData в каждой активности внутри метода onCreate, которая запускается после нажатия на уведомление:

AppsFlyerLib.getInstance().sendPushNotificationData(this);

Подробные сведения об измерении push-уведомлений см. здесь.

С их помощью уже имеющиеся пользователи могут приглашать своих друзей и знакомых в качестве новых пользователей вашего приложения, что может существенно способствовать его продвижению. С помощью AppsFlyer можно атрибутировать и регистрировать установки, источником которых являются приглашения, отправленные пользователями из вашего приложения.

Подробные сведения см. в статье Атрибуция приглашений пользователей.

Идентификатор AppsFlyer ID создается для каждой новой установки приложения. Вы можете использовать AppsFlyer ID для различных целей:

• Отправляйте внутренние события приложения от сервера к серверу.
• Сопоставляйте AppsFlyer ID с данными пользователей, зарегистрированных в ваших серверных системах.
• Сопоставляйте записи при объединении данных из Pull API и Push API.

Для получения уникального ID из AppsFlyer используйте следующие API:

public String getAppsFlyerUID(Context context);

Пример использования:

String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this);

Для установки своего Customer User ID используйте такой код:

public void setCustomerUserId(String id);

Пример использования:

AppsFlyerLib.getInstance().setCustomerUserId("myId");

Рекомендуется установить свой ID клиента на раннем этапе продвижения приложения, так как после установки этого идентификатора только он привязывается к событиям, включаемым в отчеты:

• Если вызов setCustomerUserId выполняется перед вызовом start, идентификатор клиента будет отображаться в отчетах по сырым данным и для установок, и для событий.
• Если задать ID клиента позже, он будет привязан только к событиям, зарегистрированным после настройки этого идентификатора.

Чтобы избежать необходимости повторно устанавливать значение ID клиента после первого запуска и многократно обращаться к серверу для его получения, проверьте, задано ли его значение, с помощью этого кода:

AppsFlyerProperties.getInstance().getString(AppsFlyerProperties.APP_USER_ID)

Для получения дополнительных сведений о Customer User ID щелкните здесь.

Можно отложить инициализацию SDK до настройки идентификатора customerUserID.

Чтобы указать, что инициализацию SDK необходимо отложить до установки идентификатора клиента, выполните такой вызов:

AppsFlyerLib.getInstance().waitForCustomerUserId(true);

непосредственно перед методом init(). Остальную часть инициализации SDK следует оставить без изменений.

После передачи customerUserID выполните вызов

AppsFlyerLib.getInstance().setCustomerIdAndLogSession("customer_id", this);

чтобы передать SDK соответствующий идентификатор клиента User ID и запустить SDK.

Должен отобразиться следующий код:

public class AFApplication extends Application {
  private static final String AF_DEV_KEY = "qrdZGj123456789";
  @Override
  public void onCreate() {
    super.onCreate();
    AppsFlyerConversionListener conversionDataListener = 
    new AppsFlyerConversionListener() {
      ...
    };
    AppsFlyerLib.getInstance().waitForCustomerUserId(true);
    //WARNING! Removing above line doesn't cancel its effect.
    // Replace with this to stop waiting for CUID:
    // AppsFlyerLib.getInstance().waitForCustomerUserId(false);
    AppsFlyerLib.getInstance().init(AF_DEV_KEY, getConversionListener(), getApplicationContext());
    AppsFlyerLib.getInstance().start(this);
    // Do your magic to get the customerUserID
    // ...
    // any AppsFlyer SDK code invoked here will be discarded
   //Call the following API once the customerUserID is available:
 AppsFlyerLib.getInstance().setCustomerIdAndLogSession("customer_id", this);
  }
}

class AFApplication: Application() {
 private val afDevKey = ""

 override fun onCreate() {
  super.onCreate()
  val conversionDataListener = object: AppsFlyerConversionListener {
   ...
  }
  AppsFlyerLib.getInstance().waitForCustomerUserId(true);
  //WARNING! Removing above line doesn't cancel its effect.
  // Replace with this to stop waiting for CUID:
  // AppsFlyerLib.getInstance().waitForCustomerUserId(false);
  AppsFlyerLib.getInstance().init(afDevKey, conversionDataListener, this)
  AppsFlyerLib.getInstance().start(this)
  // Do your magic to get the customerUserID
  // ...
  // any AppsFlyer SDK code invoked here will be discarded
  // Call the following API once the customerUserID is available:
  AppsFlyerLib.getInstance().setCustomerIdAndLogSession("customer_id", this)
 }
}

Дополнительные сведения об отсрочке инициализации SDK до получения идентификатора клиента см. здесь.

AppsFlyer SDK, начиная с версии 4.8.0, автоматически выполняет сбор идентификаторов рекламы Google google_advertising_id.

Требование включать сбор идентификаторов рекламы Google относится только к SDK версии 4.7.X или более старых версий.

Хотя бы один идентификатор устройства должен быть получен для целей атрибуции. Доступны следующие идентификаторы: GAID, Android ID, IMEI и OAID.

GAID - Google Advertising ID

Получается автоматически из приложений, содержащих Сервисы Google Play. Если GAID доступен, IMEI и Android ID НЕ ДОЛЖНЫ собираться приложением, чтобы избежать нарушения политики Google Play.

IMEI и Android ID

По умолчанию отключено. Можно собирать ТОЛЬКО для приложений, не включающих в себя Сервисы Google Play.
Заметьте: Начиная с Android 10 (уровень API 29), выпущенной в конце 2019 года, доступ к параметру IMEI ограничен.

Чтобы передавать эти идентификаторы в AppsFlyer:

1. После запуска приложения соберите IMEI устройства и/или Android ID.
2. Вызовите следующие API, ПРЕЖДЕ ЧЕМ вызывать метод start:
   

   AppsFlyerLib.getInstance().setImeiData("IMEI_HERE");
   AppsFlyerLib.getInstance().setAndroidIdData("ANDROID_ID_HERE");

OAID - Open Advertiser Identifier(Открытый идентификатор рекламодателя)

Руководство по внедрению OAID

Отказ от сбора идентификатора устройства

Разработчики могут отказаться от сбора IMEI, Android ID и OAID, используя следующие API: 

AppsFlyerLib.getInstance().setCollectIMEI(false);
AppsFlyerLib.getInstance().setCollectAndroidID(false);
AppsFlyerLib.getInstance().setCollectOaid(false);

В исключительных случаях может потребоваться полное отключение SDK для соблюдения норм законодательства и правил конфиденциальности. Для этого можно использовать API stop. После вызова этого API пакет SDK прекратит работу и обмен данными с серверами AppsFlyer.

AppsFlyerLib.getInstance().stop(true, getApplicationContext());

AppsFlyerLib.getInstance().stop(true, applicationContext);

Есть несколько различных сценариев, которые владелец приложения может применить для прекращения отслеживания пользователя. Мы рекомендуем следовать инструкциям сценария, применимого для вашего приложения.

SDK можно активировать повторно, вызвав:

AppsFlyerLib.getInstance().stop(false, getApplicationContext());
AppsFlyerLib.getInstance().start(getApplicationContext(), <AF_DEV_KEY>);

AppsFlyerLib.getInstance().stop(false, applicationContext);
AppsFlyerLib.getInstance().start(applicationContext, <AF_DEV_KEY>);

Не вызывайте start, если для параметра stop установлено значение true. Вы можете проверить текущее состояние SDK, вызвав:

AppsFlyerLib.getInstance().isStopped() // returns true if SDK is stopped, false otherwise

AppsFlyerLib.getInstance().isStopped // returns true if SDK is stopped, false otherwise

Для реализации явной анонимизации установок, событий и сеансов пользователя используйте этот API во время инициализации SDK:

public void anonymizeUser(boolean isDisabled);

Пример использования:

AppsFlyerLib.getInstance().anonymizeUser(true);

Регистрацию данных можно запустить снова, вызвав anonymizeUser и установив значение false.

В некоторых случаях рекламодатели должны прекратить передачу рекламным сетям / партнерам данных по определенным пользователям. Причины могут быть следующие:

• Политики конфиденциальности, такие как CCPA или GDPR.
• Отказ пользователей от предоставления данных
• Конкуренция с некоторыми партнерами (рекламными сетями, третьими сторонами)

AppsFlyer предоставляет два метода API для прекращения обмена данными с некоторыми или всеми партнерами:

• setSharingFilter: Используется рекламодателями, чтобы задать несколько  сетей/интегрированных партнеров, которым нужно прекратить предоставлять данные.
• setSharingFilterForAllPartners: используется рекламодателями, чтобы прекратить предоставлять данные всем сетям / интегрированным партнерам.

Эти методы фильтрации поддерживаются в SDK начиная с версии V5.4.1.

Метод фильтрации должен вызываться каждый раз при инициализации SDK, он влияет на всю сессию. Если требуется время, чтобы определить, нужно ли устанавливать фильтры общего доступа, то отложите инициализацию SDK.

Если метод активирован до первого вызова start:

• Пользователи из SRN атрибутируются как органические, и их данные не передаются интегрированным партнерам.
• Пользователи по кликам из рекламных сетей (не SRN) правильно атрибутируются в AppsFlyer, но их данные не передаются в рекламные сети через постбэки, API, отчеты по сырым данным или каким-либо другим способом.

В настоящее время данные об удалении приложения нельзя фильтровать с помощью этих методов. Однако вы можете прекратить отправку событий удаления партнерам, настроив это на их страницах настройки в AppsFlyer.