Установка и настройка плагина

Руководство по Интеграции.

Версия релиза 1.4.2 | Дата релиза 07.07.2025

Минимальные требования:

Используйте Unity 2018.3+ версии.
Используйте Android API level 22 (Android OS 5.1) и выше.
Используйте iOS 13.0 и выше.
Используйте Xсode 13 и выше.

Демо-приложение

Используйте наше демо-приложение в качестве примера.

GitHub - YabbiSDKTeam/yabbi-unity-demoGitHub

Установка

Общее описание процесса установки

Для установки Unity Plugin вам потребуется:

Ознакомиться с демо-приложением
Скачать и импортировать в проект последнюю версию плагина
Настроить External Dependency Manager
Проверить корректность установки с помощью инициализации плагин с включенным режимом отладки

Скачайте плагин

Скачайте последнюю версию плагина по ссылке.
Импортируйте плагин в проект через опцию Custom Package. Плагин включает в себя External Dependency Manager. Вы можете его не импортировать, если он был установлен в проекте раньше.

Настройте External Dependency Manager

External Dependency Manager - плагин для разрешения конфликтов зависимостей.

Для разрешения конфликтов зависимостей в вашем приложении выполните следующие шаги:

Перейдите в Build Settings → Android→Player Settings → Publishing settings
Для Unity 2018.4 - Unity 2019.2: добавьте флаг Custom Gradle Template Для Unity 2019.3 или выше: добавьте флаг Custom Main Gradle Template

Перейдите в External Dependency Manager → Android Resolver → Settings
Включите настройку - Patch mainTemplate.gradle
Включите настройку - Use Jetifier

Выберите опцию Force Resolve в External Dependency Manager → Android Resolver → Force Resolve
При успешном импорте зависимостей вы увидите оповещение Resolution Succeeded

Обфускация кода

Если в вашем Android-приложении включена обфускация кода, то добавьте следующий текст в конец файла proguard-rules.pro:

-keep class sspnet.tech.**.* { *; }

Добавьте ключ Applovin SDK

Если вы используете адаптер для Applovin, то выполните следующие действия для платформы с которой вы работаете

Если вы используете адаптер для Applovin, то добавьте следующий <meta-data> элемент в свой AndroidManifest.xml внутри <application> элемента:

<meta-data android:name="applovin.sdk.key"
           android:value="APPLOVIN_SDK_KEY"/>

Ваш APPLOVIN_SDK_KEY вы сможете скопировать в разделе "Keys" в личном кабинете Applovin.

Добавьте следующий в Info.plist следующий ключ:

<key>AppLovinSdkKey</key>
<string>APPLOVIN_SDK_KEY</string>

Ваш APPLOVIN_SDK_KEY вы сможете скопировать в разделе "Keys" в личном кабинете Applovin.

Проверка установки

Чтобы убедиться, что плагин установлен корректно, потребуется включить режим отладки и инициализировать плагин.

Режим отладки

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

Для включения режима отладки используйте метод EnableDebug.

Yabbi.EnableDebug(true);

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

Наследуйте класс который будет работать с SDK от интерфейса для отслеживания инициализации SDK.

class YourClassName : IInitializationListener {    
    public void OnInitializeSuccess()
    {
        // Вызывется когда SDK установлена корректно
    }
    
    public void OnInitializeFailed(AdException error)
    {
        // Вызывется когда при установке SDK произошла ошибка
        // С помощью AdException error можно получить подробную информацию об ошибке
    }
}

Используйте код ниже, чтобы инициализировать плагин в вашем проекте. Ваш publisher_id вы сможете скопировать в разделе "Настройки" в личном кабинете Yabbi.

Yabbi.Initialize("publisher_id");

Если плагин установлен корректно, то вы увидите в консоли следующее сообщение.

Call to Initialize on not supported platform. To test advertising, install your application on the Android/iOS device.

Сообщениие сигнализирует что плагин установлен правильно, но показ рекламы возможен только после сборки приложения под Android/iOS.

Готово! Плагин установлен, можем переходить к настройке рекламы.

Рекомендуем вам не отключать режим отладки до завершения работы с рекламой.

Если плагин устанавливается некорректно

В случае возникновения ошибок рекомендуем очистить кеш External Dependency Manager и выбрать Force Resolve в External Dependency Manager → Android Resolver.

Если это не помогло, попробуйте установить плагин в чистый проект. Если плагин установился корректно, попробуйте отладить ошибки в вашем проекте.

Также рекомендуем взглянуть на установку и инициализацию в демо-приложении.

Если у вас не получается корректно установить плагин, и действия выше не привели к успешной инициализации — обратитесь в поддержку.

Обновление плагина и управление адаптерами для других рекламных сетей

Обязательно проверьте наличие обновления перед сборкой приложения.

Yabbi Unity Plugin предоставляет удобный интерфейс для обновления плагина и управления рекламными сетями. В окне Dependency Manager вы можете обновить плагин до последней версии, а так же выбрать рекламные сети, которые вы хотите использовать.

Дополнительные действия для повышения дохода

Установка Apple ID

Для более эффективного работы таргетированной рекламы и повышения дохода Yabbi SDK собирает и передаёт с данными о пользователе App ID - уникальный числовой идентификатор приложения из Apple AppStore.

Он определяется автоматически, но в некоторых случаях Yabbi SDK не может его определить.

Если Yabbi SDK не определил ваш App ID, то вы увидите в консоли следующее сообщение.

AppStore ID is nil. You must set AppStore ID manually.

В таком случае вам необходимо установить ID вручную.

Для установки Apple ID используйте метод setCustomParams

Yabbi.SetCustomParams("appStoreAppID", "apple_id");

Замените apple_id на ваш App ID из кабинета разработчика AppStore. Вы можете найти его на странице приложения в кабинете разработчика.

Рекламный идентификато Apple (IDFA)

Для более эффективного работы таргетированной рекламы и повышения дохода вы можете собирать рекламный идентификатор пользователя устройств Apple и передавать их в Yabbi SDK.

Чтобы включить сбор IDFA, включите следующие чекбоксы в настройках плагина:

NSUserTrackingUsageDescription - Разрешение для сбора рекламного идентификатора (Advertising Identifier IDFA)

Сбор данных о геолокации

Для более эффективного работы таргетированной рекламы и повышения дохода вы можете собирать в приложении данные о точной и/или примерной геолокации пользователя, и передавать их в Yabbi SDK.

Чтобы включить сбор данных о геолокации на Android, включите следующие чекбоксы в настройках плагина:

ACCESS_COARSE_LOCATION - Разрешение для сбора приблизительной геолокации пользователя

ACCESS_FINE_LOCATION - Разрешение для сбора точной геолокации пользователя

Чтобы включить сбор данных о геолокации на iOS, включите следующие чекбоксы в настройках плагина:

NSLocationWhenInUseUsageDescription - Разрешение для сбора геолокации пользователя

Прочие настройки плагина

Экран пользовательского согласия

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

Обычно получение согласия пользователя происходит на специальном экране при первом запуске приложения — consent-screen.

В Yabbi Unity Plugin реализован такой экран, вы можете добавить и настроить его с помощью библиотеки Consent Manager.

Подробнее о его установке и настройке вы можете узнать в соответствующем разделе.

Экран пользовательского согласия

Возможные ошибки

Library not loaded: @rpath/YabbiSDK.framework/YabbiSDK

Ошибка возникает из-за особенностей линковки xcframework в Unity. Для того чтобы исправить ошибку вам необходимо скачать YabbiPostProcessBuildiOS.cs по этой ссылке и поместить его в папку scripts либо в другую папку для ваших скриптов.

PreviousUnity Plugin NextРабота с рекламой

Last updated 2 days ago

Was this helpful?