Android SDK

Android SDK позволяет добавить карту 2GIS в ваше Android-приложение. С помощью SDK можно отобразить карту на экране, получать информацию об объектах карты, использовать навигатор, строить маршруты и так далее.

Примеры использования SDK см. в разделе Примеры. Описание всех классов и методов см. в разделе Справочник API.

Картографические данные поддерживают стандарты OGC.

Получение ключей доступа

Для работы с SDK нужно получить файл ключа dgissdk.key с обязательным указанием appId приложения, для которого этот ключ создаётся. Ключ будет использоваться для подключения к серверам 2ГИС, получения географических данных, а также для использования офлайн-данных и навигатора. Этот ключ уникален для этого типа SDK и не может быть использован с другими SDK от 2ГИС.

Чтобы получить файл ключа:

Заполните форму на dev.2gis.ru.
Добавьте полученный файл ключа в assets приложения.

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

Требования к устройствам

Android 5.0 (Lollipop) и выше.
Поддерживаемые архитектуры: x86_64, x86, armeabi-v7a, arm64-v8a.
OpenGL ES 3.1.

Версии SDK

Пакеты Android SDK доступны в двух версиях:

Full — полная версия, которая позволяет:
- Добавлять карту в приложение и управлять ей: добавлять маркеры и геометрические фигуры, управлять движением камеры, отображать слои (например, пробки), работать со стилями карты и т. д.
- Искать объекты в справочнике: организации, здания, места и другие.
- Работать с навигатором в приложении в трёх режимах: свободная навигация, ведение по маршруту и симуляция ведения.
- Строить оптимальные маршруты на карте, в том числе внутри зданий.
- Использовать офлайн-данные.
Map — облегчённая версия, которая позволяет:
- Добавлять карту в приложение и управлять ей: добавлять маркеры и геометрические фигуры, управлять движением камеры, отображать слои (например, пробки), работать со стилями карты и т. д.
- Искать объекты в справочнике: организации, здания, места и другие.

Важно

Использовать совместно Full и Map нельзя: это приведёт к ошибке сборки.

Установка

Чтобы установить Android SDK:

Укажите пользовательский репозиторий в вашем файле build.gradle:
```
repositories {
    maven {
        url "https://artifactory.2gis.dev/sdk-maven-release"
    }
}
```

Добавьте одну из следующих зависимостей.

Для версии SDK Full:

dependencies {
    implementation 'ru.dgis.sdk:sdk-full:latest.release'
}

Для версии SDK Map:

dependencies {
    implementation 'ru.dgis.sdk:sdk-map:latest.release'
}

Демонстрационный проект

Демонстрационное приложение с исходным кодом см. в нашем GitHub-репозитории.

Размер приложения

Размер вашего приложения может заметно увеличиться после добавления SDK в проект. См. ниже описание причины и возможные стратегии для борьбы с этим увеличением.

Процессорные архитектуры

Современные устройства Android могут иметь различные типы процессоров: x86-64, x86, ARMv7 и ARMv8. Для кода, написанного на Java или Kotlin, это не является проблемой, так как он исполняется в виртуальной машине и абстрагируется от конкретного железа. Однако, для нативного кода тип процессора играет важную роль.

Наша библиотека содержит четыре версии для всех типов ABI (Application Binary Interface), чтобы обеспечить поддержку всех этих типов процессоров.

Оптимизация размера

Чтобы сократить размер приложения, вы можете использовать разделение APK по типам ABI. Это позволит собирать и загружать только необходимые библиотеки для конкретного устройства пользователя. См. инструкции по сборке и загрузке в документации Android. Если вы используете Android App Bundle, Google Play может автоматически пересобирать приложение под нужные типы процессоров для конкретных устройств пользователей.

Проверка размера

Чтобы увидеть фактический размер APK, который будет загружаться пользователем, рекомендуется использовать инструмент bundletool. Это поможет получить APK, содержащий только необходимые библиотеки для конкретного устройства:

Соберите app bundle, выбрав этот вариант сборки в Gradle.
Получите APK по необходимым критериям (например, только для arm64-v8a) из app bundle с помощью bundletool.

Полученный APK будет отражать реальный размер, который получит пользователь при загрузке приложения из Google Play.