На этой странице описывается, что необходимо сделать для начала работы с Maps 3D SDK для Android. Процесс настройки включает в себя настройку проекта Google Cloud и API для использования с SDK, а также настройку проекта Android Studio. Выполните эти шаги, прежде чем добавлять свою первую 3D-карту в приложение .
Настройте проект Google Cloud и ключ API
Прежде чем приступить к разработке с помощью Maps 3D SDK для Android, вам необходимо настроить проект Google Cloud и ключ API для использования с Maps 3D SDK для Android, выполнив следующие шаги:
Шаг 1
Консоль
В консоли Google Cloud на странице выбора проекта нажмите «Создать проект» , чтобы начать создание нового облачного проекта.
Убедитесь, что для вашего облачного проекта включена функция выставления счетов. Убедитесь, что для вашего проекта включена функция выставления счетов .
Google Cloud предлагает пробный период стоимостью 0,00 долларов США. Срок действия пробного периода истекает по истечении 90 дней или после накопления на счете средств на сумму 300 долларов США, в зависимости от того, что наступит раньше. Отменить подписку можно в любое время. Подробнее см. в разделах «Биллинговые кредиты» и «Выставление счетов».
Облачный SDK
gcloud projects create "PROJECT"
Узнайте больше о Google Cloud SDK , установке Cloud SDK и следующих командах:
Шаг 2
Чтобы использовать платформу Google Карт, необходимо включить API или SDK, которые вы планируете использовать в своем проекте.
Обратите внимание, что для некоторых интеграций требуется включить несколько API/SDK. Если вы не уверены, какие API или SDK нужно включить, попробуйте воспользоваться API Picker или обратитесь к документации по нужному API/SDK.
Чтобы включить один или несколько API или SDK:
Консоль
Ознакомьтесь с API и SDK платформы Google Карт, которые можно включить, перейдя на страницу библиотеки API Карт в консоли Cloud:
Перейти на страницу библиотеки API Карт
- Щелкните API или SDK, который вы хотите включить.
- Если на кнопке написано ВКЛЮЧИТЬ , нажмите ее, чтобы включить API или SDK.
- Если на кнопке написано УПРАВЛЕНИЕ , API или SDK уже включены и вам не нужно ничего делать дополнительно.
- При нажатии любой из кнопок откроется панель управления API или SDK. (Нажмите кнопку ОТКЛЮЧИТЬ , чтобы удалить API или SDK из этого проекта.)
Облачный SDK
Следующая команда включает все API карт, маршрутов и мест:
gcloud services enable \ --project "PROJECT" \ "addressvalidation.googleapis.com" \ "areainsights.googleapis.com" \ "tile.googleapis.com" \ "aerialview.googleapis.com" \ "elevation-backend.googleapis.com" \ "routes.googleapis.com" \ "geocoding-backend.googleapis.com" \ "geolocation.googleapis.com" \ "maps-android-backend.googleapis.com" \ "maps-backend.googleapis.com" \ "maps-embed-backend.googleapis.com" \ "maps-ios-backend.googleapis.com" \ "mapsplatformdatasets.googleapis.com" \ "places-backend.googleapis.com" \ "roads.googleapis.com" \ "routeoptimization.googleapis.com" \ "static-maps-backend.googleapis.com" \ "street-view-image-backend.googleapis.com" \ "timezone-backend.googleapis.com"
Узнайте больше о Google Cloud SDK , установке Cloud SDK и следующих командах:
Используйте эту команду для включения API среды:
gcloud services enable \ --project "PROJECT" \ "airquality.googleapis.com" \ "solar.googleapis.com" \ "pollen.googleapis.com" \ "weather.googleapis.com"
Шаг 3
Этот шаг касается только процесса создания API-ключа. Если вы используете API-ключ в рабочей среде, мы настоятельно рекомендуем ограничить его использование. Подробнее см. на странице «Использование API-ключей» для конкретного продукта.
Ключ API — это уникальный идентификатор, который аутентифицирует запросы, связанные с вашим проектом, для целей использования и выставления счетов. С вашим проектом должен быть связан хотя бы один ключ API.
Чтобы создать ключ API:
Консоль
Перейдите на страницу «Платформа Google Карт» > «Учетные данные» .
- На странице «Учетные данные» нажмите Создать учетные данные > Ключ API .
В диалоговом окне создания ключа API отобразится ваш недавно созданный ключ API. - Нажмите «Закрыть».
Новый ключ API указан на странице «Учетные данные» в разделе «Ключи API» .
(Не забудьте ограничить ключ API перед его использованием в производстве.)
Облачный SDK
gcloud services api-keys create \ --project "PROJECT" \ --display-name "DISPLAY_NAME"
Узнайте больше о Google Cloud SDK , установке Cloud SDK и следующих командах:
Чтобы включить SDK, перейдите на страницу Maps 3D SDK для Android в консоли Google Cloud. Подробнее об этом см. в статье «Начало работы с платформой Google Карт» .
Настройте проект Android Studio
В этом разделе объясняется, как создать и настроить проект Android Studio для использования с Maps 3D SDK для Android.
Часть 1: Настройка проекта и конфигурации Gradle
Создайте новый проект Android Studio, используя шаблон Empty Views Activity .
Если вы используете Git для управления исходным кодом, измените файл
.gitignore
проекта, чтобы предотвратить передачу вашего файла секретов в систему управления версиями:- В корневом каталоге вашего проекта откройте файл
.gitignore
. - Добавьте следующую строку:
secrets.properties
- В корневом каталоге вашего проекта откройте файл
Обновите файл
build.gradle.kts
на уровне проекта:- В корневом каталоге вашего проекта откройте файл
build.gradle.kts
. - В блоке
plugins
добавьте плагин Secrets Gradle:
plugins { alias(libs.plugins.android.application) apply false alias(libs.plugins.kotlin.android) apply false alias(libs.plugins.secrets.gradle.plugin) apply false // Add this line }
- В корневом каталоге вашего проекта откройте файл
Обновите файл
gradle/libs.versions.toml
: - Откройте файлgradle/libs.versions.toml
, который обычно находится в каталогеgradle
в корневом каталоге проекта. - В разделе версий добавьте версии для SDK и плагина Gradle Secrets:maps3dSdk = "0.0.1" # Update this value to match the SDK version to include secretsGradlePlugin = "2.0.1"
- In the library section, add the SDK library:
play-services-maps3d = { module = "com.google.android.gms:play-services-maps3d", version.ref = "maps3dSdk" }
- In the plugin section, add the Secrets Gradle plugin:
secrets-gradle-plugin = { id = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin", version.ref = "secretsGradlePlugin" }
Обновите файл
app/build.gradle.kts
на уровне модуля: - Откройте файлbuild.gradle.kts
на уровне модуля, который обычно находится в каталогеapp
. - В верхней части файла добавьте плагин Secrets Gradle в блокplugins
:plugins { alias(libs.plugins.android.application) alias(libs.plugins.kotlin.android) alias(libs.plugins.secrets.gradle.plugin) // Add this line }
- In the `dependencies` block, add the SDK:
dependencies { // ... other dependencies implementation(libs.play.services.maps3d) // Add this line }
- At the end of the file, outside of the `android` and `dependencies` blocks, add the secrets configuration:
secrets { // Optionally specify a different filename containing your secrets. // The plugin defaults to "local.properties" propertiesFileName = "secrets.properties" // A properties file containing default secret values. This file can be // checked in version control. defaultPropertiesFileName = "local.defaults.properties" }
Часть 2: Добавьте свой ключ API в свой проект
Создайте файл
secrets.properties
:- В корневом каталоге модуля приложения (обычно это каталог
app
) создайте новый файл с именемsecrets.properties
. - Добавьте свой ключ API в файл:
MAPS3D_API_KEY=YOUR_API_KEY_HERE ``` Note: Make sure you replace `YOUR_API_KEY_HERE` with the API key that you configured for use with the Maps 3D SDK for Android.
- В корневом каталоге модуля приложения (обычно это каталог
Создайте файл
local.defaults.properties
: - В корневом каталоге модуля приложения создайте новый файл с именемsecrets.properties
. - Добавьте в файл ключ API по умолчанию или заглушку. Этот файл можно добавить в систему контроля версий:MAPS3D_API_KEY=DEFAULT_API_KEY_OR_PLACEHOLDER
Часть 3: Обновите файл AndroidManifest.xml
Откройте файл
app/src/main/AndroidManifest.xml
.Внутри тега
<application>
, перед тегом<activity>
, добавьте следующий элемент<meta-data>
, чтобы объявить ваш ключ API:<application ...> <meta-data android:name="com.google.android.geo.maps3d.API_KEY" android:value="${MAPS3D_API_KEY}" /> <activity ...> </activity> </application>
В процессе сборки плагин Secrets Gradle заменит заполнитель
${MAPS3D_API_KEY}
ключом из вашего файлаsecrets.properties
.
Следующие шаги
Теперь, когда у вас есть проект Google Cloud, ключ API и проект Android Studio, настроенный для использования с Maps 3D SDK для Android, вы можете добавить 3D-карту в свое приложение .