📦 GravitySDK for Flutter #

GravitySDK — инструмент для интеграции персонализированного контента, отслеживания взаимодействий пользователей и показа кампаний в мобильных Flutter-приложениях. SDK сам загружает и показывает in-app контент (модальное окно, bottom sheet, полноэкранный режим, tooltip), а также поддерживает inline-виджеты и headless-режим для полностью кастомной отрисовки.

📚 Оглавление #

✨ Возможности
🚀 Установка
⚙️ Инициализация
🪵 Логирование
🧑 Пользователь и настройки
📄 Отслеживание и события
📡 Офлайн-доставка событий
🔔 Обработка колбэков
🔒 Блокировка показа (presentation lock)
🧩 Получение контента
🖼️ Отображение контента
🎨 ProductWidgetBuilder — кастомизация продуктов
📈 Взаимодействия (engagement)
❗ Обработка ошибок

Возможности #

Инициализация SDK с ключом API и параметрами секции
Отслеживание просмотров экранов и пользовательских событий с автопоказом in-app кампаний
Получение контента по селектору, ID кампании или группе
Автоматический батчинг и дедупликация конкурентных choose-запросов
Inline-виджеты и tooltip-кампании (GravityAnchor)
Headless-режим: сырые данные кампаний без встроенного UI
Многошаговые (multi-step) кампании
Отправка взаимодействий с контентом и продуктами
Временная блокировка автопоказа in-app контента (presentation lock)

Установка #

Добавь пакет в файл pubspec.yaml:

dependencies:
  gravity_sdk: ^0.20.0

Затем выполни команду:

flutter pub get

И импортируй пакет в своём коде:

import 'package:gravity_sdk/gravity_sdk.dart';

Требуется Dart SDK ^3.10.0.

Для iOS добавь в ios/Runner/Info.plist описание App Tracking Transparency (SDK читает статус трекинга):

<key>NSUserTrackingUsageDescription</key>
<string>This identifier will be used to deliver personalized ads to you.</string>

Инициализация #

Для работы SDK необходимо провести базовую инициализацию, передав параметры apiKey и section. Их можно найти в личном кабинете.

await GravitySDK.instance.initialize(
  apiKey: 'api-key',
  section: 'section',
);

Полная сигнатура:

Future<void> initialize({
  required String apiKey,
  required String section,
  ProductWidgetBuilder? productWidgetBuilder,
  GravityEventCallback? gravityEventCallback,
  GravityContentCallback? gravityContentCallback,
  LogLevel logLevel = LogLevel.info,
});

productWidgetBuilder — кастомная отрисовка карточек продуктов (подробнее)
gravityEventCallback — колбэк событий SDK и действий пользователя (подробнее)
gravityContentCallback — колбэк с сырым контентом кампании для headless-сценариев
logLevel — уровень логирования

Логирование #

await GravitySDK.instance.initialize(
  apiKey: 'api-key',
  section: 'section',
  logLevel: LogLevel.debug,
);

Уровни: none (отключено), error, warn, info (по умолчанию), debug.

Пользователь и настройки #

// Ручная идентификация пользователя
GravitySDK.instance.setUser('user-id', 'session-id');
// После setUser() все последующие запросы SDK, включая запросы контента
// (getContent*, GravityInlineWidget, GravityAnchor, автопоказ in-app), уходят от имени этого пользователя.

// Сброс пользователя и сессии (например, при logout)
await GravitySDK.instance.resetUser();

// Серверный uid анонимной сессии (null до первого успешного запроса)
final uid = await GravitySDK.instance.getUserId();

// Колбэк при появлении или смене серверного uid (null после resetUser)
GravitySDK.instance.setUserIdListener((uid) => saveToKeychain(uid));

// Восстановить прежнего пользователя по сохранённому uid (например, после переустановки)
await GravitySDK.instance.restoreUserId(savedUid);

// Глобальные настройки
GravitySDK.instance.setOptions(
  options: Options(
    isReturnUserInfo: true,
    isImplicitImpression: true,
  ),
  contentSettings: ContentSettings(
    skusOnly: false,
    fields: ['name', 'price', 'imageUrl'],
  ),
  proxyUrl: 'https://your-proxy.com',
  isFetchContentOnTrack: true,
);

// Статус разрешения на push-уведомления
GravitySDK.instance.setNotificationPermissionStatus(NotificationPermissionStatus.granted);

getUserId() — всегда серверный uid анонимной сессии; идентификатор, переданный в setUser(), здесь не возвращается. Ждёт завершения уже идущей инициализации сессии. Доступен до initialize().
setUserIdListener() — вызывается, когда серверный uid становится известен процессу или меняется: после первого успешного запроса на холодном старте, после resetUser() (с null) и после restoreUserId(). Ответ сервера с тем же uid колбэк не вызывает. Передай null, чтобы снять слушателя.
restoreUserId(uid) — восстанавливает пользователя, которому сервер ранее выдал этот uid (например, после переустановки приложения): сбрасывает текущую сессию и пользователя из setUser(), следующий запрос уходит с этим uid, и сервер узнаёт прежнего пользователя с его историей и сегментами. Неизвестный серверу uid игнорируется — будет выдан новый. Пустая строка — ArgumentError. Под setUser() сервер uid/ses не возвращает, поэтому getUserId() отдаёт последний известный анонимный uid.
proxyUrl — маршрутизация запросов через прокси
isFetchContentOnTrack — автоматическая загрузка контента после trackViewNoShow() / triggerEventNoShow() (по умолчанию true)
NotificationPermissionStatus: granted / denied / unknown

Отслеживание и события #

Оба метода принимают BuildContext — если событие триггерит кампанию, SDK сам покажет её контент.

await GravitySDK.instance.trackView(
  context: context,
  pageContext: PageContext(
    type: ContextType.homepage,
    data: [],
    location: 'app://homepage',
  ),
);

await GravitySDK.instance.triggerEvent(
  context: context,
  events: [
    AddToCartEvent(value: 99.99, productId: 'sku-123', quantity: 1, currency: 'RUB'),
  ],
  pageContext: PageContext(
    type: ContextType.product,
    data: ['sku-123'],
    location: 'app://product/sku-123',
  ),
);

Доступные события (TriggerEvent): AddToCartEvent, RemoveFromCartEvent, SyncCartEvent, PurchaseEvent, AddToWishlistEvent, SignUpEvent, LoginEvent, CustomEvent.

final purchase = PurchaseEvent(
  uniqueTransactionId: 'ORDER-12345',
  value: 2550.75,
  currency: 'RUB',
  cart: [
    CartItem(productId: 'sku-123', quantity: 1, itemPrice: 100.50),
  ],
);

final custom = CustomEvent(
  type: 'survey-completed-v1',
  name: 'Survey completed',
  customProps: {'surveyId': 'summer-2025', 'rating': '5'},
);

У всех событий есть два необязательных поля:

customProps — дополнительные свойства Map<String, String> (только строковые значения: числа передавайте строкой, вложенные объекты и списки сервер не принимает);
eventTime — когда событие произошло (DateTime). SDK отправляет его в UTC; если не задано, SDK сам проставляет момент вызова (см. «Офлайн-доставка событий»), поэтому отложенное событие сохраняет верное время.

AddToCartEvent(
  value: 99.99,
  productId: 'sku-123',
  quantity: 1,
  customProps: {'list': 'search'},
  eventTime: DateTime.now(),
);

У CustomEvent дополнительно есть cuid / cuidType (идентификатор пользователя, как у LoginEvent) и cart (список CartItem).

Офлайн-доставка событий #

События (triggerEvent, triggerEventNoShow, ответы форм) не теряются без сети:

Короткий повтор. Любой запрос SDK при сетевой ошибке или ответе 408/429/5xx повторяется до трёх раз с паузами 1 → 2 → 4 с, пока не истёк staleContentTimeout (по умолчанию 10 с). Ошибки вида 4xx не повторяются.
Очередь на диске. Тело POST /event записывается в SharedPreferences до отправки и удаляется после ответа сервера, поэтому событие переживает даже завершение приложения во время зависшего запроса. Если запрос так и не ушёл, событие отправляется позже — при запуске приложения, возврате на передний план, после любого удачного запроса SDK, по таймеру с нарастающей паузой (5 с … 15 мин), при включении очереди через setOptions или по вызову flushQueue(). Пауза после ответа сервера 408/429/5xx не прерывается удачными запросами к другим адресам — только таймером, flushQueue() и возвратом на передний план. Кампании из ответа на отложенное событие не запрашиваются и не показываются.
eventTime. SDK проставляет время события (UTC, RFC 3339) в момент вызова — ещё до ожидания сессии, поэтому отложенное событие ложится в аналитику с верным временем. Если событие уже содержит eventTime, оно не перезаписывается.
Идентичность. Запись в очереди хранит пользователя на момент вызова, поэтому событие, отправленное после resetUser() или смены пользователя, уходит от того, кто его совершил. Событие, поставленное в очередь до первой сессии (свежая установка без сети), при отправке проходит тот же путь, что и обычный запрос: ждёт уже идущую инициализацию сессии или создаёт её сам и сохраняет uid, который вернул сервер. Последующие запросы приложения используют этот же uid.

Что не попадает в очередь: /visit (просмотр экрана), /choose (запрос контента), engagement-урлы (показы/клики) — они повторяются только коротким повтором.

GravitySDK.instance.setOptions(
  offlineQueue: const OfflineQueueSettings(
    enabled: true,                 // по умолчанию включено
    maxEntries: 500,               // старые записи вытесняются
    maxAge: Duration(days: 7),     // старше — не отправляются
  ),
  staleContentTimeout: const Duration(seconds: 10),
);

// Свой детектор сети? Дёрните очередь, когда соединение появилось:
await GravitySDK.instance.flushQueue();

// Выход из аккаунта по требованию политики данных, общее устройство,
// смена окружения: удалить всё, что ещё не отправлено. resetUser() очередь
// не трогает — события, совершённые до выхода, доставляются от того
// пользователя, который их совершил.
await GravitySDK.instance.clearQueue();

// Диагностика:
final pending = await GravitySDK.instance.pendingDeliveries;

staleContentTimeout также ограничивает показ: если ответ /visit или /event пришёл позже этого таймаута (пользователь, скорее всего, уже на другом экране), кампания не запрашивается — в headless-режиме метод вернёт null. Вторая проверка — уже перед самим показом, после паузы delayTime кампании — считает всё время вызова от его начала, а не только паузу: если /visit ответил быстро, а запрос контента затянулся, показ тоже отменяется.

Ограничения: событие, запрос которого дошёл до сервера, но ответ потерялся, может быть доставлено дважды (покупки дедуплицируются по uniqueTransactionId); отправка происходит только пока приложение запущено; flushQueue() при выключенной очереди ничего не делает; выключение очереди не отменяет уже начатую отправку; pendingDeliveries учитывает и событие, запрос которого идёт прямо сейчас; в headless-методах (*NoShow) таймаут свежести ограничивает только ответ /visit//event — контент, полученный после него, возвращается вызывающему, и решение о показе остаётся за приложением.

Обработка колбэков #

gravityEventCallback получает события жизненного цикла контента и действий пользователя (TrackingEvent). Большинство — информационные; обязательной обработки на стороне приложения требуют FollowUrlEvent, FollowDeeplinkEvent и RequestPushEvent. FollowUrlEvent.type (FollowUrlType.browser / FollowUrlType.webview) подсказывает, где кампания просит открыть ссылку; если в кампании тип не задан, используется browser:

await GravitySDK.instance.initialize(
  apiKey: 'api-key',
  section: 'section',
  gravityEventCallback: (event) {
    if (event is FollowUrlEvent) {
      if (event.type == FollowUrlType.webview) {
        // открыть event.url во внутреннем webview приложения
      } else {
        launchUrl(Uri.parse(event.url), mode: LaunchMode.externalApplication);
      }
    }
    if (event is FollowDeeplinkEvent) {
      // навигация по диплинку приложения
    }
    if (event is RequestPushEvent) {
      // запрос разрешения на push-уведомления
    }
  },
);

Информационные события: ContentLoadEvent, ContentImpressionEvent, ContentVisibleImpressionEvent, ContentCloseEvent, CopyEvent, CancelEvent, ProductImpressionEvent.

Блокировка показа (presentation lock) #

Приложение может временно запретить автопоказ in-app кампаний Gravity — например, пока показывает собственный диалог, онбординг или paywall:

GravitySDK.instance.lockPresentation();

// ... приоритетный UI приложения ...

GravitySDK.instance.unlockPresentation();

Подписка на изменение состояния блокировки:

GravitySDK.instance.setPresentationLockListener((locked) {
  debugPrint('Gravity presentation locked: $locked');
});

// отписка
GravitySDK.instance.setPresentationLockListener(null);

Семантика (совпадает с iOS/Android SDK):

пока блокировка активна, trackView и triggerEvent загружают и резолвят контент, но не показывают in-app UI — в лог пишется Presentation is locked, skipped content for campaign <campaignId>;
так как контент под блокировкой всё равно загружается (уходят запрос choose и события contentLoaded), серверные лимиты показов кампании (frequency cap, one-shot) расходуются даже без показа;
блокируется только автопоказ: fetchAnchorContent (в том числе автозагрузка через GravityAnchor), step-навигация уже открытого контента, trackViewNoShow/triggerEventNoShow и getContentBy* под блокировку не попадают;
уже открытый in-app контент при lockPresentation() не закрывается;
после unlockPresentation() показы снова разрешены для следующих trackView/triggerEvent; кампания, пропущенная во время блокировки, ретроактивно не показывается;
повторные вызовы lock/unlock безопасны; listener вызывается при каждом вызове;
состояние блокировки живёт в памяти и сбрасывается при перезапуске приложения — если оно должно переживать рестарт, сохраняйте и восстанавливайте его на стороне приложения (пример — PresentationLockPrefs в example/);
текущее состояние доступно через GravitySDK.instance.isPresentationLocked.

Получение контента #

Контент можно запросить напрямую, без автопоказа:

final bySelector = await GravitySDK.instance.getContentBySelector(
  selector: 'homepage-recommendations',
  pageContext: pageContext,
  rules: rules, // опционально, List<RtRule>
);

final byCampaign = await GravitySDK.instance.getContentByCampaignId(
  campaignId: 'campaign-id',
  pageContext: pageContext,
);

final byGroup = await GravitySDK.instance.getContentByGroup(
  group: 'homepage-group',
  pageContext: pageContext,
);

Ответ — ContentResponse с кампаниями (data), их вариациями (payload) и контентом (contents):

final campaign = bySelector.data.firstOrNull;
final variation = campaign?.payload.firstOrNull;
final content = variation?.contents.firstOrNull;

Батчинг и дедупликация #

Конкурентные вызовы getContentBySelector / getContentByCampaignId автоматически оптимизируются в пределах короткого окна (10 мс):

полностью идентичные запросы дедуплицируются — уходит один сетевой вызов, вызывающие делят один ответ;
разные запросы с одинаковым окружением (пользователь, PageContext, Options) объединяются в один POST /choose с несколькими элементами data[].

Это прозрачно для вызывающего кода и не требует настройки. getContentByGroup в батчинге не участвует.

Пример: фильтрация рекомендаций правилами #

final rules = [
  RtRule(
    type: 'filter',
    conditions: [
      RtRuleCondition(
        field: 'category',
        arguments: [RtRuleArgument(action: 'in', value: ['shoes'])],
      ),
    ],
  ),
];

Headless-режим #

Для полностью кастомной отрисовки есть методы с сырым JSON и «беззвучные» аналоги трекинга (контент возвращается, но не показывается):

// модель + сырой JSON
final GravityDataResponse<ContentResponse> details =
    await GravitySDK.instance.getContentBySelectorWithDetails(
  selector: 'homepage-banner',
  pageContext: pageContext,
);

// трекинг без показа: null, если кампания не сработала, ответ пришёл позже staleContentTimeout или событие ушло в очередь
final GravityDataResponse<ContentResponse>? triggered =
    await GravitySDK.instance.trackViewNoShow(pageContext: pageContext);

final GravityDataResponse<ContentResponse>? byEvent =
    await GravitySDK.instance.triggerEventNoShow(
  events: [event],
  pageContext: pageContext,
);

trackViewNoShow / triggerEventNoShow дополнительно вызывают gravityContentCallback и подчиняются флагу isFetchContentOnTrack.

Произвольные ключи `variables` #

Кроме типизированных полей (title, elements, frameUI, …) объект variables кампании может содержать любые ключи, заданные в дашборде Gravity. Они доступны без разбора сырого JSON:

content.rawVariables — весь объект variables как Map<String, dynamic>;
content.variables['<ключ>'] — значение по ключу (Object?; null и если ключа нет, и если в нём записан null — различить можно через content.rawVariables.containsKey('<ключ>'));
content.variables.valueOf<T>('<ключ>') — то же, но вернёт значение, только если оно имеет тип T, иначе null. Значения приходят из jsonDecode, поэтому T должен быть JSON-типом: объекты — Map<String, dynamic>, массивы — List<dynamic> (не List<String>), числа — num (целое 15 не является double, а 1.5 — int), строки — String, флаги — bool.

rawVariables есть у любого CampaignContent, откуда бы он ни пришёл: getContentBySelector, …WithDetails, gravityContentCallback, ContentLoadEvent.content, inline-виджеты.

final content = details.data.data.first.payload.first.contents.first;

// A/B-вариация, описанная в кампании произвольным объектом
final variant = content.variables.valueOf<Map<String, dynamic>>('inline_banner');
final label = variant?['variant'] as String?;

// весь объект целиком
final all = content.rawVariables;

Важно:

rawVariables — полный объект variables, включая типизированные ключи; типизированные поля (content.variables.title, content.variables.elements, …) продолжают работать как раньше;
карта неизменяемая на верхнем уровне (попытка записи бросит UnsupportedError), но вложенные объекты и списки — те же экземпляры, что и в GravityDataResponse.json: не мутируйте их;
набор и структура ключей полностью определяются настройками кампании на стороне Gravity — SDK их не валидирует и ничего о них не предполагает.

Отображение контента #

In-app контент (модальное окно, bottom sheet, полноэкранный режим, tooltip) SDK показывает автоматически из trackView / triggerEvent — формат задаётся настройками кампании на стороне Gravity. Многошаговые кампании (переходы между шагами по кнопкам) обрабатываются встроенным рендерером.

In-app формы (например, опрос с оценкой приложения) тоже рендерятся автоматически: выбор оценки, текстовый ввод с ограничениями длины, условная видимость элементов в зависимости от ответов. Кнопка отправки неактивна, пока обязательные поля не заполнены; результат отправляется в Gravity без участия приложения. Отдельной обработки не требуется — кроме FollowUrlEvent, если кампания после отправки ведёт на внешнюю ссылку (например, в магазин приложений).

Inline-виджеты #

Встраивание кампании в вёрстку экрана:

GravityInlineWidget(
  selector: 'homepage-recommendations',
  height: 250,
  pageContext: pageContext,
);

GravityInlineListWidget(
  group: 'homepage-group',
  height: 250,
  pageContext: pageContext,
);

GravityInlineWidget дополнительно принимает placeholderId, width, showLoading, loadingWidget, backgroundColor, onLoaded, rules; GravityInlineListWidget — showLoading, loadingWidget, showIndicator, indicatorActiveColor, indicatorInactiveColor.

GravityAnchor помечает виджет как якорь для tooltip-кампании и сам загружает её контент:

GravityAnchor(
  selector: 'profile_tooltip',
  pageContext: pageContext,
  builder: (context, onReady) {
    return GravityInlineWidget(
      selector: 'profile_inline',
      height: 120,
      pageContext: pageContext,
      onLoaded: onReady,
    );
  },
);

Загрузить якорный контент можно и вручную:

await GravitySDK.instance.fetchAnchorContent(
  context: context,
  selector: 'profile_tooltip',
  pageContext: pageContext, // опционально
);

ProductWidgetBuilder — кастомизация отображения продуктов #

Некоторые кампании содержат продукты (рекомендации, акции). Чтобы карточки товаров вписывались в стиль приложения, передайте свою реализацию ProductWidgetBuilder при инициализации; иначе используется DefaultProductWidgetBuilder.

class MyProductWidgetBuilder extends ProductWidgetBuilder {
  @override
  Widget build({
    required BuildContext context,
    required Slot product,
    required CampaignContent content,
    required Campaign campaign,
  }) {
    final item = product.item; // Map<String, dynamic> — атрибуты товара из фида
    final imageUrl = item['imageUrl'] as String?;

    return GestureDetector(
      onTap: () {
        GravitySDK.instance.sendProductEngagement(
          ProductClickEngagement(product, content, campaign),
        );
      },
      child: Card(
        child: Column(
          crossAxisAlignment: CrossAxisAlignment.start,
          children: [
            if (imageUrl != null) Image.network(imageUrl, height: 160, fit: BoxFit.cover),
            Text(item['name'] as String? ?? '', style: const TextStyle(fontWeight: FontWeight.bold)),
            Text('${item['price'] ?? ''}'),
          ],
        ),
      ),
    );
  }
}

await GravitySDK.instance.initialize(
  apiKey: 'api-key',
  section: 'section',
  productWidgetBuilder: MyProductWidgetBuilder(),
);

Взаимодействия (engagement) #

При кастомной отрисовке контента отправляйте взаимодействия вручную:

// контент
GravitySDK.instance.sendContentEngagement(ContentImpressionEngagement(content, campaign));
GravitySDK.instance.sendContentEngagement(ContentVisibleImpressionEngagement(content, campaign));
GravitySDK.instance.sendContentEngagement(ContentCloseEngagement(content, campaign));
GravitySDK.instance.sendContentEngagement(ContentClickEngagement(content, campaign));

// продукты
GravitySDK.instance.sendProductEngagement(ProductClickEngagement(slot, content, campaign));
GravitySDK.instance.sendProductEngagement(ProductVisibleImpressionEngagement(slot, content, campaign));

ContentClickEngagement — клик по контенту, который приложение отрисовало само (например, A/B-вариация в headless-режиме). SDK берёт URL из content.events с типом click; если сервер такого события не прислал, вызов ничего не отправляет. Для контента, который рисует сам SDK, отправлять его не нужно: кнопки follow_url, follow_deeplink и request_push уже фиксируют клик своими действиями, и повторный вызов удвоит его в статистике.

ContentEngagement — sealed-класс: если в приложении есть исчерпывающий switch по его подтипам, после обновления добавьте ветку для ContentClickEngagement.

Обработка ошибок #

Перед вызовами SDK необходимо убедиться, что он инициализирован. В противном случае будет выброшено исключение:

GravitySDK is not initialized. Call initialize() first.

Сетевые ошибки getContentBy* пробрасываются вызывающему коду (DioException); trackView / triggerEvent и inline-виджеты обрабатывают свои ошибки самостоятельно и не роняют приложение. Сетевые сбои при отправке событий покрыты повтором и очередью на диске — см. Офлайн-доставка событий.

gravity_sdk 0.24.0
gravity_sdk: ^0.24.0 copied to clipboard

Metadata

📦 GravitySDK for Flutter #

📚 Оглавление #

Возможности #

Установка #

Инициализация #

Логирование #

Пользователь и настройки #

Отслеживание и события #

Офлайн-доставка событий #

Обработка колбэков #

Блокировка показа (presentation lock) #

Получение контента #

Батчинг и дедупликация #

Пример: фильтрация рекомендаций правилами #

Headless-режим #

Произвольные ключи `variables` #

Отображение контента #

Inline-виджеты #

Tooltip-кампании: GravityAnchor #

ProductWidgetBuilder — кастомизация отображения продуктов #

Взаимодействия (engagement) #

Обработка ошибок #

← Metadata

Documentation

Publisher

Weekly Downloads

Metadata

License

Dependencies

More

gravity_sdk 0.24.0 gravity_sdk: ^0.24.0 copied to clipboard

Metadata

📦 GravitySDK for Flutter #

📚 Оглавление #

Возможности #

Установка #

Инициализация #

Логирование #

Пользователь и настройки #

Отслеживание и события #

Офлайн-доставка событий #

Обработка колбэков #

Блокировка показа (presentation lock) #

Получение контента #

Батчинг и дедупликация #

Пример: фильтрация рекомендаций правилами #

Headless-режим #

Произвольные ключи variables #

Отображение контента #

Inline-виджеты #

Tooltip-кампании: GravityAnchor #

ProductWidgetBuilder — кастомизация отображения продуктов #

Взаимодействия (engagement) #

Обработка ошибок #

← Metadata

Documentation

Publisher

Weekly Downloads

Metadata

License

Dependencies

More

gravity_sdk 0.24.0
gravity_sdk: ^0.24.0 copied to clipboard

Произвольные ключи `variables` #