Carrot quest SDK

Тема

Установка ​

Результат шага

В проекте появится зависимость io.carrotquest:android-sdk и заработает импорт io.carrotquest_sdk.android.Carrot.

Carrot quest SDK для Android распространяется только через Gradle (Maven-репозиторий). Требования: minSdkVersion ≥ 21, Java 17 в compileOptions. Актуальную версию смотрите на странице Актуальные версии — в примерах ниже стоит 2.0.5-commonRelease, замените на нужную. API Key для дальнейшей инициализации берётся из Подготовительных работ.

Примеры даны для Kotlin DSL и Groovy — выберите ту вкладку, в формате которой написаны ваши Gradle-файлы.

Шаг 1. Добавьте репозитории ​

В блок repositories файла, в котором они объявлены в вашем проекте (settings.gradle[.kts] → dependencyResolutionManagement.repositories или корневой build.gradle → allprojects.repositories для старых проектов), допишите два Maven-репозитория:

kotlin
maven { url = uri("https://raw.githubusercontent.com/carrotquest/android-sdk/carrotquest") }
maven { url = uri("https://jitpack.io") }
groovy
maven { url "https://raw.githubusercontent.com/carrotquest/android-sdk/carrotquest" }
maven { url "https://jitpack.io" }

Первый — Maven-репозиторий Carrot quest, второй — Jitpack (часть транзитивных зависимостей SDK берётся оттуда).

Шаг 2. Подключите зависимость ​

В build.gradle[.kts] модуля приложения:

kotlin
dependencies {
    implementation("io.carrotquest:android-sdk:2.1.0-commonRelease")
}
groovy
dependencies {
    implementation 'io.carrotquest:android-sdk:2.1.0-commonRelease'
}

Шаг 3. Убедитесь, что включена Java 17 ​

SDK собран под Java 17. Если в вашем модуле приложения compileOptions ниже — поднимите:

kotlin
android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_17
        targetCompatibility = JavaVersion.VERSION_17
    }
}
groovy
android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_17
        targetCompatibility JavaVersion.VERSION_17
    }
}

Проверка ​

После Gradle Sync в любом файле должен резолвиться импорт:

kotlin
import io.carrotquest_sdk.android.Carrot

Если проект собирается и импорт не красный — установка завершена. Дальше — инициализация SDK.

Настройка сервиса (триггерных сообщений, чата и т. д.) выполняется в личном кабинете Carrot quest так же, как для веб-сайтов. Инструкция по настройке триггерных сообщений: help.carrotquest.io/article/11138.