Настройка

На этой странице описано, что необходимо сделать для начала работы с SDK Maps 3D для Android. Процесс настройки включает в себя конфигурацию проекта Google Cloud и API для использования с SDK, а затем настройку проекта Android Studio. Выполните эти шаги, прежде чем добавлять свою первую 3D-карту в приложение .

Настройте проект Google Cloud и ключ API.

Прежде чем начать разработку с использованием Maps 3D SDK для Android, необходимо настроить проект Google Cloud и ключ API для работы с Maps 3D SDK для Android, выполнив следующие шаги:

Шаг 1

Консоль

  1. В консоли Google Cloud на странице выбора проекта нажмите «Создать проект» , чтобы начать создание нового проекта Cloud.

    Перейдите на страницу выбора проекта.

  2. Убедитесь, что для вашего облачного проекта включена функция выставления счетов. Подтвердите, что выставление счетов включено для вашего проекта .

    Google Cloud предлагает пробный период с нулевой комиссией. Пробный период истекает по истечении 90 дней или после того, как на счету накопится сумма расходов в размере 300 долларов США, в зависимости от того, что наступит раньше. Отменить можно в любое время. Для получения дополнительной информации см. разделы «Бонусы на счете» и «Выставление счетов».

Облачный SDK

gcloud projects create "PROJECT"

Подробнее о Google Cloud SDK , установке Cloud SDK и следующих командах можно узнать здесь:

Шаг 2

Для использования платформы Google Maps необходимо включить API или SDK, которые вы планируете использовать в своем проекте.

Обратите внимание, что для некоторых интеграций требуется включить несколько API/SDK. Если вы не уверены, какие API или SDK следует включить, попробуйте использовать Capabilities Explorer или обратитесь к документации по нужному вам API/SDK.

Для включения одного или нескольких API или SDK:

Консоль

  1. Список API и SDK платформы Google Maps, которые можно включить, можно найти на странице «Библиотека API карт» в консоли Cloud:

    Перейдите на страницу библиотеки API карт.

  2. Щелкните по API или SDK, который хотите включить.
    • Если на кнопке написано ENABLE , нажмите эту кнопку, чтобы включить 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:

Консоль

  1. Перейдите на страницу «Платформа Google Maps» > «Учетные данные» .

    Перейдите на страницу «Учетные данные».

  2. На странице «Учетные данные» нажмите «Создать учетные данные» > «Ключ API» .
    В диалоговом окне « Создан ключ API» отображается ваш недавно созданный ключ API.
  3. Нажмите «Закрыть».
    Новый ключ 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 Maps» .

Создайте проект в Android Studio.

В этом разделе объясняется, как создать и настроить проект Android Studio для использования с Maps 3D SDK для Android.

Часть 1: Настройка проекта и конфигурации Gradle

  1. Создайте новый проект Android Studio, используя шаблон Empty Views Activity .

  2. Если вы используете Git для контроля версий, измените файл .gitignore проекта, чтобы предотвратить добавление файла с секретами в систему контроля версий:

    • В корневом каталоге вашего проекта откройте файл .gitignore .
    • Добавьте следующую строку:
    secrets.properties
    
  3. Обновите файл 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
    }
    
  4. Обновите файл gradle/libs.versions.toml :

    • Откройте файл gradle/libs.versions.toml , который обычно находится в каталоге gradle внутри корневого каталога проекта.
    • В разделе versions укажите версии SDK и плагина Secrets Gradle:
    maps3dSdk = "0.0.1" # Update this value to match the SDK version to include
    secretsGradlePlugin = "2.0.1"
    
    • В разделе «Библиотека» добавьте библиотеку SDK:
    play-services-maps3d = { module = "com.google.android.gms:play-services-maps3d", version.ref = "maps3dSdk" }
    
    • В разделе плагинов добавьте плагин Secrets Gradle:
    secrets-gradle-plugin = { id = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin", version.ref = "secretsGradlePlugin" }
    
  5. Обновите файл 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
    }
    
    • В блоке dependencies добавьте SDK:
    dependencies {
        // ... other dependencies
        implementation(libs.play.services.maps3d) // Add this line
    }
    
    • В конце файла, вне блоков android и dependencies , добавьте конфигурацию secrets:
    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-ключ в свой проект.

  1. Создайте файл secrets.properties :

    • В корневом каталоге модуля приложения (обычно это каталог app ) создайте новый файл с именем secrets.properties .
    • Добавьте свой API-ключ в файл:
    MAPS3D_API_KEY=YOUR_API_KEY_HERE
    
  2. Создайте файл local.defaults.properties : - В корневом каталоге модуля приложения создайте новый файл с именем secrets.properties . - Добавьте в файл ключ API по умолчанию или в качестве заполнителя. Этот файл можно добавить в систему контроля версий:

    MAPS3D_API_KEY=DEFAULT_API_KEY_OR_PLACEHOLDER
    

Часть 3: Обновите файл AndroidManifest.xml

  1. Откройте файл app/src/main/AndroidManifest.xml .

  2. Внутри тега <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-карту в свое приложение .