Интеграция Varioqub Flutter

Varioqub Flutter — комплексный инструмент аналитики и маркетинга приложений, который работает на всех основных мобильных платформах. Он включает поддержку Varioqub SDK для Android и iOS.

Системные требования:

• Flutter 2.0 и выше.
• pigeon 10.0 и выше.

Для работы плагина Varioqub Flutter подключите и инициализируйте плагин AppMetrica Flutter. Подробнее о том, как это можно сделать, читайте в документации AppMetrica Flutter.

Ниже описаны этапы подключения и инициализации Varioqub Flutter.

Общие рекомендации при интеграции

1. При старте новой сессии вызывайте метод activateConfig(), чтобы получить значения сохраненных флагов.

2. Запускайте fetchConfig() в фоне, чтобы выгрузить новые значения флагов с сервера и активировать их при старте следующей сессии.

3. Не рекомендуется вызывать метод activateConfig() в середине сессии — это может привести к неконсистентному поведению приложения.

Шаг 1. Подключите плагин Varioqub Flutter

Из корня проекта вызовите команду:

flutter pub add varioqub_plugin

После добавления плагина в файле pubspec.yaml появится строка с зависимостью:

dependencies:
  varioqub_plugin: ^0.1.0

Шаг 2. Инициализируйте библиотеку

1. Добавьте импорт varioqub_plugin:

   import 'package:varioqub_plugin/varioqub_plugin.dart';
   

2. Инициализируйте библиотеку Varioqub с помощью метода initVarioqubWithAppMetricaAdapter():

   Varioqub.initVarioqubWithAppMetricaAdapter({
       clientId: 'appmetrica.1234567',
   });
   

Для инициализации библиотеки используется метод initVarioqubWithAppMetricaAdapter(settings: VarioqubSettings). В качестве параметров он принимает объект VarioqubSettings.

Содержит обязательные и опциональные настройки:

Обязательные

• clientId — идентификатор проекта в формате appmetrica.XXXXXX, где XXXXXX — идентификатор приложения из интерфейса AppMetrica (например, VarioqubSettings("appmetrica.1234567")).

  Совет

  ID приложения можно получить на странице Настройки AppMetrica: скопируйте его из Общие настройки → ID приложения.

Опциональные

• clientFeatures — список пользовательских параметров. Например, признак того, что пользователь подписан на рассылки.

• fetchThrottleIntervalSeconds — ограничение частоты обновления конфига в секундах. Рекомендуется использовать только для тестирования.

• url — изменение URL для ответов сервера. Используется только для тестов.

• logs — включение внутреннего логирования. При обращении в поддержку лучше сначала включить логирование и отправить лог с описанием проблемы.

• activateEvent — отправка события при активации конфигурации флагов. По умолчанию отправка события включена.

Шаг 3. Задайте конфигурацию по умолчанию

Вы можете установить конфигурацию по умолчанию, чтобы ваше приложение использовало необходимые значения параметров до того, как оно подключится к серверу с удаленной конфигурацией. Для этого передайте список параметров с помощью метода setDefaults(Map<String,String> defaults).

Вы можете скачать XML-файл конфигурации по умолчанию со страницы Конфиг флагов.

Шаг 4. Запустите обновление конфигурации флагов в фоне и активируйте конфигурацию

Чтобы использовать самую свежую конфигурацию флагов из интерфейса, запустите фоновое обновление конфигурации с помощью метода fetchConfig().

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

Varioqub.fetchConfig().then((value) {
    if (value.status == 0) {
        Varioqub.activateConfig();
    } else {
        log("Error while fetching config - ${value.error}");
    }
});

Получение флагов из интерфейса

Значения флагов вычисляются и предоставляются в следующем порядке:

1. Флаг есть в эксперименте.
2. Флаг есть в загруженной конфигурации.
3. Флаг есть в конфигурации по умолчанию.

Методы для получения флагов:

• Varioqub.getString(key, default).

Пример кода:

Varioqub.getString("key", "default_value");

Получение ID устройства для проверки эксперимента

Для получения ID устройства используйте метод Varioqub.getId():

Varioqub.getId();

Подробнее о создании и проверке эксперимента читайте в разделе Создание эксперимента.