AppMetrica

AppMetrica — это бесплатный инструмент аналитики, который помогает отслеживать поведение пользователей и анализировать эффективность мобильного приложения в реальном времени. Интегрировав AppMetrica с Adapty, вы сможете получить более глубокое представление о метриках подписок и вовлечённости пользователей.

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

Настройка интеграции AppMetrica состоит из двух основных шагов:

1. Настройте интеграцию в дашборде Adapty
2. Добавьте интеграцию в код вашего приложения

Настройка в дашборде

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

1. Откройте список приложений AppMetrica
2. Выберите нужное приложение
3. Перейдите в Settings > Main и скопируйте Application ID и Post API key

4. Откройте Integrations > AppMetrica в дашборде Adapty
5. Вставьте учётные данные AppMetrica.

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

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

Настройки выручки

По умолчанию Adapty отправляет данные о выручке в виде свойств событий, которые отображаются в отчёте Events в AppMetrica. Вы можете настроить способ расчёта и отображения этих данных:

• Revenue calculation: Выберите, как рассчитываются значения выручки в соответствии с вашими потребностями финансовой отчётности:

  • Gross revenue: Показывает общую выручку до вычетов — полезно для отслеживания суммы, которую платят пользователи
  • Proceeds after store commission: Отображает выручку после вычета комиссии App Store/Play Store — помогает отслеживать фактический доход
  • Proceeds after store commission and taxes: Показывает чистую выручку после вычета комиссии стора и налогов — наиболее точное отображение реального дохода

• Report user’s currency: Если включено, продажи отображаются в локальной валюте пользователя, что упрощает анализ выручки по регионам. Если отключено, все продажи конвертируются в USD для единообразной отчётности по разным рынкам.

• Send revenue events: Включите эту опцию, чтобы данные о выручке отображались не только в отчёте Events, но и в отчёте AppMetrica In-app and ad revenue. Убедитесь, что вы не отправляете выручку из других источников, иначе данные могут задвоиться.

• Exclude historical events: Если включено, Adapty не будет отправлять события, произошедшие до установки пользователем приложения с Adapty SDK. Это помогает избежать дублирования данных, если вы уже отправляли события в аналитику до интеграции Adapty.

Настройка SDK

Для подключения интеграции AppMetrica в приложении необходимо задать два идентификатора:

1. appmetrica_device_id: обязателен для базовой интеграции
2. appmetrica_profile_id: необязателен, но рекомендуется, если в приложении есть регистрация пользователей

Используйте метод setIntegrationIdentifier() для установки этих значений. Ниже показано, как реализовать это для каждой платформы:

AppMetrica.requestStartupIdentifiers(on: nil) { ids, error in
  if let error {
    // handle AppMetrica error    
    return
  }

  guard let deviceIDHash = ids?[.deviceIDHashKey] as? String else {
    // handle AppMetrica error
    return
  }

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

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

val startupParamsCallback = object: StartupParamsCallback {
    override fun onReceive(result: StartupParamsCallback.Result?) {
        val deviceIdHash = result?.deviceIdHash ?: return

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

    override fun onRequestError(
        reason: StartupParamsCallback.Reason,
        result: StartupParamsCallback.Result?
    ) {
        //handle the error
    }
}

AppMetrica.requestStartupParams(context, startupParamsCallback, listOf(StartupParamsCallback.APPMETRICA_DEVICE_ID_HASH))

val startupParamsCallback = object: StartupParamsCallback {
    override fun onReceive(result: StartupParamsCallback.Result?) {
        val deviceIdHash = result?.deviceIdHash ?: return

        Adapty.setIntegrationIdentifier("appmetrica_device_id", deviceIdHash) { error ->
            if (error != null) {
                // handle the error
            }
        }
        
        Adapty.setIntegrationIdentifier("appmetrica_profile_id", "YOUR_ADAPTY_CUSTOMER_USER_ID") { error ->
            if (error != null) {
                // handle the error
            }
        }
    }

    override fun onRequestError(
        reason: StartupParamsCallback.Reason,
        result: StartupParamsCallback.Result?
    ) {
        //handle the error
    }
}

AppMetrica.requestStartupParams(context, startupParamsCallback, listOf(StartupParamsCallback.APPMETRICA_DEVICE_ID_HASH))

final startupParams = await AppMetrica.requestStartupParams([AppMetricaStartupParams.deviceIdHashKey]);
final deviceIdHash = startupParams.result?.deviceIdHash;

if (deviceIdHash != null) {
  try {
    await Adapty().setIntegrationIdentifier(
        key: "appmetrica_device_id", 
        value: deviceIdHash,
    );
  } on AdaptyError catch (adaptyError) {
    // handle the error
  } catch (e) {
    // handle the error
  }
}

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

using AdaptySDK;
using Io.AppMetrica;

AppMetrica.RequestStartupParams(
    (result, errorReason) => {
        string deviceIdHash = result.DeviceIdHash;

        if (deviceIdHash != null) {
            Adapty.SetIntegrationIdentifier(
                "appmetrica_device_id",
                deviceIdHash,
                (error) => {
                    // handle the error
                });
          }
      },
      new List<string>() { StartupParamsKey.AppMetricaDeviceIDHash }
);

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

// ...
const startupParamsCallback = async (
  params?: StartupParams,
  reason?: StartupParamsReason
) => {
  const deviceIdHash = params?.deviceIdHash
  if (deviceIdHash) {
    try {
      await adapty.setIntegrationIdentifier("appmetrica_device_id", deviceIdHash);
    } catch (error) {
      // handle `AdaptyError`
    }
  }
}

AppMetrica.requestStartupParams(startupParamsCallback, [DEVICE_ID_HASH_KEY])

try {
  await adapty.setIntegrationIdentifier("appmetrica_profile_id", 'YOUR_ADAPTY_CUSTOMER_USER_ID');
} catch (error) {
  // handle `AdaptyError`
}

Структура событий AppMetrica

Adapty отправляет события в AppMetrica через POST-запросы с параметрами в строке запроса. Для каждого события Adapty AppMetrica получает до двух отдельных запросов:

1. Profile event (отправляется всегда): содержит метаданные события
2. Revenue event (опционально): содержит данные о выручке, если опция «Send revenue events» включена в дашборде Adapty

Запрос Profile Event

Отправляется на: https://api.appmetrica.yandex.ru/logs/v1/import/events

Пример URL с параметрами запроса:

POST https://api.appmetrica.yandex.ru/logs/v1/import/events?post_api_key=your_key&application_id=your_app_id&event_name=subscription_renewed&event_timestamp=1709294400&event_json=%7B%22vendor_product_id%22%3A%22yearly.premium%22...%7D&os_name=ios&ios_ifa=00000000-0000-0000-0000-000000000000&ios_ifv=12345678-1234-1234-1234-123456789012&profile_id=user_12345&session_type=foreground

Параметры запроса:

Запрос Revenue Event (опционально)

Отправляется на: https://api.appmetrica.yandex.ru/logs/v1/import/revenue

Этот запрос отправляется только при включённой опции «Send revenue events» в настройках интеграции дашборда Adapty.

Пример URL с параметрами запроса:

POST https://api.appmetrica.yandex.ru/logs/v1/import/revenue?post_api_key=your_key&application_id=your_app_id&revenue_event_type=subscription_renewed&price=9.99&currency=USD&product_id=yearly.premium&quantity=1&transaction_id=GPA.3383...&payload=%7B%22vendor_product_id%22%3A%22yearly.premium%22...%7D&os_name=ios&ios_ifa=00000000-0000-0000-0000-000000000000&profile_id=user_12345&session_type=foreground

Параметры запроса:

Устранение неполадок

access_level_updated отображается как неуспешное в Event Feed

access_level_updated — это событие только для вебхуков. Adapty не отправляет его в эту интеграцию. Однако Adapty фиксирует результат для каждой активной интеграции, и неподдерживаемое событие отображается как ошибка.