gravity_sdk 0.8.8

Gravity SDK

📦 GravitySDK for Flutter

GravitySDK — это мощный инструмент для интеграции персонализированного контента, отслеживания взаимодействия пользователей и отображения кампаний в мобильных Flutter-приложениях. Он позволяет получать контент по шаблонам, отслеживать события и отображать контент в различных форматах (модальное окно, полноэкранный режим, bottom sheet).

📚 Оглавление

• ✨ Возможности
• 🚀 Установка
• ⚙️ Инициализация
• 🔧 Дополнительные параметры initialize
• 🎨 ProductWidgetBuilder — кастомизация продуктов
• 🧑 Пользователь и настройки
• 📄 Отслеживание и события
• 📈 Взаимодействие
• 🧩 Получение контента
• 🖼️ Отображение контента
• ❗ Обработка ошибок

Возможности

• Инициализация SDK с ключом API и параметрами секции
• Настройка контента и прокси
• Отслеживание посещений страниц и пользовательских событий
• Получение контента по шаблону
• Отображение контента в:
  • Модальном окне
  • Bottom sheet
  • Полноэкранном режиме
  • Bottom sheet с рядом товаров
• Отправка взаимодействий с контентом и продуктами

Установка

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

dependencies:
  gravity_sdk: ^0.8.0

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

flutter pub get

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

import 'package:gravity_sdk/gravity_sdk.dart';

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

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

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

Дополнительные параметры initialize

Future<void> initialize({
  required String apiKey,
  required String section,
  ProductWidgetBuilder? productWidgetBuilder,
  GravityEventCallback? gravityEventCallback,
  bool useAdvertisingId = false,
});

• productWidgetBuilder — кастомная отрисовка карточек продуктов
• gravityEventCallback — колбэк, вызываемый при трекинге событий
• useAdvertisingId — использовать рекламный идентификатор устройства

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

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

Зачем это нужно?

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

Если не указать productWidgetBuilder, будет использоваться реализация по умолчанию: DefaultProductWidgetBuilder.

📦 Пример использования

class MyCustomProductWidgetBuilder extends ProductWidgetBuilder {
  @override
  Widget build(Slot slot) {
    final item = slot.item;

    return Card(
      shape: RoundedRectangleBorder(borderRadius: BorderRadius.circular(12)),
      margin: EdgeInsets.symmetric(horizontal: 8, vertical: 4),
      child: Column(
        crossAxisAlignment: CrossAxisAlignment.start,
        children: [
          if (item.imageUrl != null)
            ClipRRect(
              borderRadius: BorderRadius.vertical(top: Radius.circular(12)),
              child: Image.network(
                item.imageUrl!,
                height: 160,
                width: double.infinity,
                fit: BoxFit.cover,
              ),
            ),
          Padding(
            padding: const EdgeInsets.all(12.0),
            child: Column(
              crossAxisAlignment: CrossAxisAlignment.start,
              children: [
                if (item.isNew == 'true')
                  Padding(
                    padding: const EdgeInsets.only(bottom: 4.0),
                    child: Text(
                      '🔥 Новинка',
                      style: TextStyle(color: Colors.red, fontWeight: FontWeight.bold),
                    ),
                  ),
                Text(
                  item.name,
                  style: TextStyle(fontSize: 16, fontWeight: FontWeight.bold),
                ),
                SizedBox(height: 4),
                Text(
                  '${item.price}',
                  style: TextStyle(fontSize: 14, color: Colors.black87),
                ),
                if (item.oldPrice != null)
                  Text(
                    '${item.oldPrice}',
                    style: TextStyle(
                      fontSize: 12,
                      color: Colors.grey,
                      decoration: TextDecoration.lineThrough,
                    ),
                  ),
                SizedBox(height: 8),
                if (item.inStock != null)
                  Text(
                    item.inStock! ? 'В наличии' : 'Нет в наличии',
                    style: TextStyle(
                      fontSize: 12,
                      color: item.inStock! ? Colors.green : Colors.red,
                    ),
                  ),
              ],
            ),
          ),
        ],
      ),
    );
  }
}

Передача кастомного builder’а при инициализации SDK:

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

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

GravitySDK.instance.setUser('user-id', 'session-id');

GravitySDK.instance.setOptions(
  options: Options(...),
  contentSettings: ContentSettings(...),
  proxyUrl: 'https://your-proxy.com',
);

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

await GravitySDK.instance.trackView(
  pageContext: PageContext(...),
);

await GravitySDK.instance.triggerEvent(
  events: [TriggerEvent(...)],
  pageContext: PageContext(...),
);

Взаимодействие

GravitySDK.instance.sendContentEngagement(ContentImpressionEngagement(...));
GravitySDK.instance.sendProductEngagement(ProductClickEngagement(...));

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

final content = await GravitySDK.instance.getContent('template-id');

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

Модальное окно

GravitySDK.instance.showModalContent(context, content);

Bottom Sheet

GravitySDK.instance.showBottomSheetContent(context, content);

Bottom Sheet: Ряд товаров

GravitySDK.instance.showBottomSheetProductsRow(context, content);

Полноэкранное окно

GravitySDK.instance.showFullScreenContent(context, content);

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

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

GravitySDK is not initialized. Call initialize() first.