Настройка проекта Google Cloud Console

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

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

Более подробную информацию о каждом шаге см. в следующих разделах.

Настройте свой проект разработки

Если у вас нет проекта разработки Google Cloud Console и ключа API для вашего проекта мобильности, вам необходимо его настроить. Подробности см. в разделе «Создание проекта» руководства Fleet Engine.

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

Добавьте Consumer SDK в свое приложение

Consumer SDK доступен в репозитории Google Maven. Репозиторий включает файлы объектной модели проекта SDK (.pom) и документацию Javadocs. Чтобы добавить Consumer SDK в свое приложение, добавьте зависимости Consumer SDK и Maps SDK в вашу конфигурацию Gradle или Maven.

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

Градл

Добавьте следующее в свой 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"
}

Мавен

Добавьте следующее в ваш 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 проекта, который вы получили при настройке проекта разработки. Дополнительные сведения см. в разделе «Настройка проекта разработки» на шаге 3 данного руководства.

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

Чтобы упростить эту задачу, вы можете использовать документацию GitHub Secrets Gradle Plugin for Android .

Чтобы установить плагин и сохранить ключ API:

  1. Откройте файл build.gradle корневого уровня и добавьте следующий код в элемент dependencies в buildscript .

    классный

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

    Котлин

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

    классный

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

    Котлин

    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 .

Что дальше

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

,

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

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

Более подробную информацию о каждом шаге см. в следующих разделах.

Настройте свой проект разработки

Если у вас нет проекта разработки Google Cloud Console и ключа API для вашего проекта мобильности, вам необходимо его настроить. Подробности см. в разделе «Создание проекта» руководства Fleet Engine.

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

Добавьте Consumer SDK в свое приложение

Consumer SDK доступен в репозитории Google Maven. Репозиторий включает файлы объектной модели проекта SDK (.pom) и документацию Javadocs. Чтобы добавить Consumer SDK в свое приложение, добавьте зависимости Consumer SDK и Maps SDK в вашу конфигурацию Gradle или Maven.

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

Градл

Добавьте следующее в свой 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"
}

Мавен

Добавьте следующее в ваш 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 проекта, который вы получили при настройке проекта разработки. Дополнительные сведения см. в разделе «Настройка проекта разработки» на шаге 3 данного руководства.

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

Чтобы упростить эту задачу, вы можете использовать документацию GitHub Secrets Gradle Plugin for Android .

Чтобы установить плагин и сохранить ключ API:

  1. Откройте файл build.gradle корневого уровня и добавьте следующий код в элемент dependencies в buildscript .

    классный

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

    Котлин

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

    классный

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

    Котлин

    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 .

Что дальше

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