Как настроить проект в консоли Google Cloud

Чтобы настроить консоль Google Cloud для использования Consumer SDK для Android, выполните следующие действия.

  1. Настройте проект.
  2. Добавьте Consumer SDK в приложение.
  3. Добавьте в приложение ключ API.
  4. Добавьте в приложение обязательную атрибуцию.

Подробные сведения о каждом шаге приведены в следующих разделах.

Как настроить проект

Если у вас нет проекта разработки в консоли Google Cloud и ключа API для проекта мобильности, вам нужно их настроить. Подробные инструкции вы найдете в разделе Создание проекта руководства по Fleet Engine.

При выборе проекта для разработки с помощью Consumer SDK укажите тот же проект консоли Google Cloud и ключ API, которые вы используете для Fleet Engine.

Как добавить Consumer SDK в приложение

Consumer SDK доступен в хранилище Google Maven. Репозиторий содержит файлы Project Object Model (.pom) и Javadoc для SDK. Чтобы добавить Consumer SDK в приложение, добавьте зависимости Consumer SDK и Maps SDK в конфигурацию Gradle или Maven.

В приведенных ниже примерах замените VERSION_NUMBER на нужную версию Consumer SDK:

Gradle

Добавьте в файл build.gradle следующий код:

dependencies {
  ...
  implementation 'com.google.android.libraries.mapsplatform.transportation:transportation-consumer:VERSION_NUMBER'
  implementation "com.google.android.gms:play-services-maps:18.1.0"
}

Maven

Добавьте в файл pom.xml следующий код:

<dependencies>
  ...
  <dependency>
    <groupId>com.google.android.libraries.mapsplatform.transportation</groupId>
    <artifactId>transportation-consumer</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
  <dependency>
    <groupId>com.google.android.gms</groupId>
    <artifactId>play-services-maps</artifactId>
    <version>18.1.0</version>
  </dependency>
</dependencies>

Как добавить в приложение ключ API

Добавив Consumer SDK в приложение, добавьте ключ API. Вы должны использовать ключ API проекта, полученный при настройке проекта разработки. Подробнее о том, как настроить проект для разработки…

В этом разделе рассказывается, как более безопасно ссылаться на ключ API в приложении. Дополнительную информацию о рекомендациях по обеспечению безопасности ключей API вы найдете в статье Рекомендации по обеспечению безопасности API на платформе Google Карт.

Чтобы упростить работу, используйте документацию GitHub Плагин Secrets Gradle для Android.

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

  1. Откройте файл build.gradle на корневом уровне и добавьте в элемент dependencies, принадлежащий элементу buildscript, указанный ниже код.

    Groovy

    buildscript {
          dependencies {
              // ...
              classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.0"
          }
    }
    

    Kotlin

    buildscript {
        dependencies {
            // ...
            classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.0")
        }
    }
    
  2. Откройте файл build.gradle на уровне приложения и добавьте в элемент plugins указанный ниже код.

    Groovy

    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
    

    Kotlin

    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
    
  3. Если вы используете Android Studio, синхронизируйте проект с Gradle. Подробные сведения приведены в разделе Синхронизация проекта с Gradle документации Android.

  4. Откройте файл local.properties в каталоге уровня проекта и добавьте в этот файл приведенный ниже код. Укажите вместо YOUR_API_KEY свой ключ API.

    MAPS_API_KEY=YOUR_API_KEY

  5. В файле AndroidManifest.xml найдите раздел com.google.android.geo.API_KEY и измените атрибут android:value следующим образом:

        <meta-data
            android:name="com.google.android.geo.API_KEY"
            android:value="${MAPS_API_KEY}" />

Ниже приведен пример полного манифеста для примера приложения:

    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
        package="com.example.consumerapidemo">
        <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
        <application
            android:allowBackup="true"
            android:icon="@mipmap/ic_launcher"
            android:label="@string/app_name"
            android:supportsRtl="true"
            android:theme="@style/_AppTheme">

            <meta-data
                android:name="com.google.android.geo.API_KEY"
                android:value="${MAPS_API_KEY}" />

            <activity android:name=".MainActivity">
                <intent-filter>
                    <action android:name="android.intent.action.MAIN" />
                    <category android:name="android.intent.category.LAUNCHER" />
                </intent-filter>
            </activity>
        </application>
    </manifest>

Добавьте в приложение необходимые сведения об авторстве.

Если вы используете Consumer SDK в своем приложении, вы должны включить текст атрибуции и лицензии на ПО с открытым исходным кодом в раздел юридической информации приложения. Рекомендуем добавить информацию об авторстве в отдельный пункт меню или в раздел О приложении.

Информацию о лицензии можно найти в файле third_party_licenses.txt в разархивированном файле AAR.

Инструкции по добавлению уведомлений о ПО с открытым исходным кодом можно найти на странице https://developers.google.com/android/guides/opensource.

Дальнейшие действия

Как получить токены аутентификации