Обёртка библиотеки AppMetrica для iOS и Android. За основу взята официальная библиотека от Яндекс. Переписана на Kotlin и Swift.

Версии нативных библиотек:

iOS 5.2.0

Android 6.3.0 maven

[!WARNING] Бибилиотека находится в разработке. До появления версии 1.0.0 работа может быть нестабильной. Могут отсутствовать некоторые методы, предоставляемые нативными библиотеками. До версии 1.0.0 любое минорное обновление может внести обратно-несовместимые изменения. В связи с этим, лучше зафиксировать точную версию в package.json. Для обновления следуйте руководству по миграции.

• Обновление iOS версии библиотеки до 5.2.0.
• Обновление Android версии библиотеки до 6.3.0.
• Для iOS зафиксирована конкретная версия библиотеки AppMetrica.

• Добавлена функция reportRevenue для отправки информации о покупке в приложении.
• Добавлена функция getSystemInfo для получения системной информации о библиотеке.
• Экспорт типов.

• Пропуск

• Обновление библиотеки для iOS до версии 5.0.0.
• AppMetricaConfig.statisticsSending помечен как deprecated. Будет удалён в версии 1.0.0.
• В AppMetricaConfig добавлено большинство полей, существующих в нативных библиотеках. Не добавлены для Android additionalConfig, appEnvironment, crashTransformer, errorEnvironment.

npm install react-native-ya-appmetrica

npx pod-install

Изменить импорт библиотеки

// Старый вариант
import AppMetrica from 'react-native-ya-appmetrica';
// Новый вариант
import * as AppMetrica from 'react-native-ya-appmetrica';

В функции активации AppMetrica заменить имя поля statisticsSending на dataSendingEnabled.

AppMetrica.activate({
  ...,
  dataSendingEnabled: true,
  ...,
});

...

Минимальный пример использования библиотеки смотрите в example.

Импортировать библиотеку.

import * as AppMetrica from 'react-native-ya-appmetrica';

При необходимости импортировать нужные типы.

import type {
  AppMetricaConfig,
  RevenueInfo,
  UserProfile,
  CrashesConfiguration,
  Location,
  PreloadInfo,
  SystemInfo,
} from 'react-native-ya-appmetrica';

Выполнить инициализацию библиотеки в App.tsx или index.js. Некоторые параметры уникальны для платформы. Если они не могут быть использованы, то будут проигнорированы.

AppMetrica.activate({apiKey: 'API_KEY'});

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

AppMetrica.configureCrashes({
  autoCrashTracking: true,
  applicationNotRespondingDetection: true,
  applicationNotRespondingPingInterval: 0.1,
  // ...,
});

Отправка своего события

AppMetrica.reportEvent('SomeEvent');
AppMetrica.reportEvent('SomeEventWithAttrs', {attrOne: 'one', arrtTwo: {aram: 'zamzam'}});

Отправка информации об ошибке

try {
  // что-то, что бросает исключение
}
catch (error) {
  if (error instanceof Error) {
    AppMetrica.reportError(error);
  }
}

Немедленно отправить все накопленные события в AppMetrica.

AppMetrica.sendEventsBuffer();

Приостановить и продолжить сессию.

AppMetrica.pauseSession();
AppMetrica.resumeSession();

Отправить информацию об открытии приложения через deeplink. Не обрабатывается автоматически. Необходимо вызывать самостоятельно в методе-обраотчике открытия приложения.

AppMetrica.reportAppOpen("myapp://some/deep/link");

Установить собственный id пользователя в AppMetrica. Максимум 200 символов. Id следует указывать во время инициализации библиотеки, если это возможно. Если для текушего устройства уже создан профиль пользователя, то при установке нового Id, будет создан новый профиль. appmetrica_device_id у таких профилей будет одинаковым.

AppMetrica.setUserProfileID("myOwnUserId");

Отправить расширенную информацию о профиле пользователя. Все поля опциональные.

Поле customAttributes заполняется объектом, где:

• ключ - наименование кастомного поля в профиле пользователя
• поле type в значениии - тип кастомного атрибута. Может быть boolean, number, counter, string. Соответствие значений указанному типу необходимо контролировать самостоятельно. Для сброса значения (!!!кроме counter!!!), следует передать undefined. Поле counter сбрасывается передачей 0 в поле value.

AppMetrica.reportUserProfile({
  userProfileID: 'qwerty',
  name: 'Иван Иванов',
  gender: 'male',
  birthDate: new Date(1992, 6, 13),
  notificationsEnabled: true,
  customAttributes: {
    is_premium: { type: 'boolean', value: true },
    login_count: { type: 'counter', value: 4 },
    last_payment: { type: 'number', value: 554.343 },
    car: { type: 'string', value: 'Lada Vesta' },
  },
});

Переключить отправку статистики в AppMetrica.

AppMetrica.setStatisticsSending(true);

Переключить отслеживание местоположения. При выключенном местоположении, оно будет определяться на основании ip-адреса.

AppMetrica.setLocationTracking(true);

Отправить информацию о покупке.

Чтобы группировать покупки по OrderID, укажите его в свойстве payload. Если идентификатор OrderID не указан, AppMetrica генерирует идентификатор автоматически.

AppMetrica.reportRevenue({
  price: 99.99,
  currency: 'RUB',
  payload: { OrderID: `${Platform.OS} test`},
})

Получить информацию о версиях нативных бибилиотек (для iOS и Android разные) и рисвоенном id устройства со стороны AppMetrica.

AppMetrica.getSystemInfo((info) => {
  console.log('appmetrica_device_id', info.appmetrica_device_id)
  console.log('library_version', info.library_version)
  console.log('uuid', info.uuid)
});

Вызвать ошибку для тестирования отчёта о крэшах. На iOS приложение вылетит. На Android будет выброшено обычное исключение JS.

AppMetrica.criticalError();

• [ ] описать все существующие параметры инициализации библиотеки
• [ ] настройка крэш-плагина для работы nativeCrashReporting в Android
• [ ] добавить PUSH SDK

MIT

Создано с помощью create-react-native-library