Amplitude

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

Adapty предоставляет полный набор данных, позволяющий отслеживать события подписки из сторов в одном месте и отправлять их в ваш аккаунт Amplitude. Это даёт возможность сопоставлять поведение пользователей с историей их платежей в Amplitude и принимать обоснованные продуктовые решения.

Как настроить интеграцию с Amplitude

В Adapty можно настроить отдельные потоки для продакшн и тестовых событий из песочницы Apple или Stripe, либо из тестового аккаунта Google.

• Для продакшн-событий введите Production API-ключи из дашборда Amplitude — отдельный ключ для каждой платформы: iOS, Android и Stripe.
• Для тестовых событий используйте поля Sandbox по необходимости.

Чтобы настроить интеграцию с Amplitude:

1. Откройте Integrations -> Amplitude в дашборде Adapty.

2. Включите Amplitude integration с помощью переключателя.

3. Заполните поля интеграции:

   Поле	Описание
   Amplitude iOS/ Android/ Stripe API key	Введите API Key Amplitude для iOS/ Android/ Stripe в Adapty. Найти его можно в разделе Project settings в Amplitude. Подробнее см. в документации Amplitude. Начните с ключей Sandbox для тестирования, затем переключитесь на ключи Production после успешных тестов.

   

4. Дополнительные настройки для расширенной конфигурации:

   Параметр	Описание
   How the revenue data should be sent	Выберите, отправлять ли валовую выручку или выручку после вычета налогов и комиссий. Подробнее см. в разделе Комиссия стора и налоги.
   Exclude historical events	Выберите этот параметр, чтобы исключить события, произошедшие до установки Adapty SDK, и избежать дублирования данных. Например, если пользователь оформил подписку 10 января, а Adapty SDK установил 6 марта, Adapty будет отправлять только события начиная с 6 марта.
   Send User Attributes	Выберите этот параметр, чтобы отправлять пользовательские атрибуты, например языковые настройки.
   Always populate user_id	Adapty автоматически отправляет device_id как amplitudeDeviceId. Для user_id этот параметр определяет поведение: ON: отправляет profile_id из Adapty, если amplitudeUserId или customer_user_id недоступны. OFF: оставляет user_id пустым, если ни один из идентификаторов недоступен.

5. Выберите события, которые хотите получать, и задайте им имена.

6. Нажмите Save, чтобы сохранить изменения.

После нажатия Save Adapty начнёт отправлять события в Amplitude.

Помимо событий, Adapty отправляет статус подписки и идентификатор продукта подписки в пользовательские свойства Amplitude.

События и теги

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

Рекомендуем использовать имена событий по умолчанию, предоставляемые Adapty. При необходимости вы можете изменить их под свои нужды. Adapty отправляет события подписки в Amplitude через серверную интеграцию (server-to-server), что позволяет просматривать все события подписки в вашем дашборде Amplitude.

Настройка SDK

Используйте метод setIntegrationIdentifier(), чтобы задать параметр amplitude_device_id. Это обязательный шаг для настройки интеграции.

Если у вас есть система регистрации пользователей, можно также передать amplitude_user_id.

do {
    try await Adapty.setIntegrationIdentifier(
        key: "amplitude_device_id", 
        value: Amplitude.instance().deviceId
    )
} catch {
    // handle the error
}

do {
    try await Adapty.setIntegrationIdentifier(
        key: "amplitude_user_id", 
        value: "YOUR_AMPLITUDE_USER_ID"
    )
} catch {
    // handle the error
}

//for Amplitude maintenance SDK (obsolete)
val amplitude = Amplitude.getInstance()
val amplitudeDeviceId = amplitude.getDeviceId()
val amplitudeUserId = amplitude.getUserId()

//for actual Amplitude Kotlin SDK
val amplitude = Amplitude(
    Configuration(
        apiKey = AMPLITUDE_API_KEY,
        context = applicationContext
    )
)
val amplitudeDeviceId = amplitude.store.deviceId

//

Adapty.setIntegrationIdentifier("amplitude_device_id", amplitudeDeviceId) { error ->
    if (error != null) {
        // handle the error
    }
}

//for Amplitude maintenance SDK (obsolete)
val amplitude = Amplitude.getInstance()
val amplitudeDeviceId = amplitude.getDeviceId()
val amplitudeUserId = amplitude.getUserId()

//for actual Amplitude Kotlin SDK
val amplitude = Amplitude(
    Configuration(
        apiKey = AMPLITUDE_API_KEY,
        context = applicationContext
    )
)
val amplitudeUserId = amplitude.store.userId

//

Adapty.setIntegrationIdentifier("amplitude_user_id", amplitudeUserId) { error ->
    if (error != null) {
        // handle the error
    }
}

final Amplitude amplitude = Amplitude.getInstance(instanceName: "YOUR_INSTANCE_NAME");

try {
    await Adapty().setIntegrationIdentifier(
        key: "amplitude_device_id", 
        value: amplitude.getDeviceId(),
    );
} on AdaptyError catch (adaptyError) {
    // handle the error
} catch (e) {
    // handle the error
}

final Amplitude amplitude = Amplitude.getInstance(instanceName: "YOUR_INSTANCE_NAME");

try {
    await Adapty().setIntegrationIdentifier(
        key: "amplitude_user_id", 
        value: "YOUR_AMPLITUDE_USER_ID",
    );
} on AdaptyError catch (adaptyError) {
    // handle the error
} catch (e) {
    // handle the error
}

using AdaptySDK;

Adapty.SetIntegrationIdentifier(
  "amplitude_device_id", 
  amplitude.getDeviceId(), 
  (error) => {
  // handle the error
});

using AdaptySDK;

Adapty.SetIntegrationIdentifier(
  "amplitude_user_id", 
  "YOUR_AMPLITUDE_USER_ID", 
  (error) => {
  // handle the error
});

try {
  await adapty.setIntegrationIdentifier("amplitude_device_id", deviceId);
} catch (error) {
  // handle `AdaptyError`
}

try {
  await adapty.setIntegrationIdentifier("amplitude_user_id", userId);
} catch (error) {
  // handle `AdaptyError`
}

Структура события Amplitude

Adapty отправляет события в Amplitude через HTTP API v2. Каждое событие имеет следующую структуру:

{
  "api_key": "your_amplitude_api_key",
  "events": [
    {
      "partner_id": "adapty",
      "event_type": "subscription_renewed",
      "time": 1709294400000,
      "insert_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_id": "user_12345",
      "device_id": "device_12345",
      "platform": "iOS",
      "os_name": "iOS",
      "productId": "yearly.premium.6999",
      "revenue": 9.99,
      "event_properties": {
        "vendor_product_id": "yearly.premium.6999",
        "original_transaction_id": "GPA.3383...",
        "currency": "USD",
        "environment": "Production",
        "store": "app_store"
      },
      "user_properties": {
        "subscription_state": "subscribed",
        "subscription_product": "yearly.premium.6999"
      }
    }
  ]
}

Где: