Google Cloud コンソール プロジェクトを構成する

Google Cloud コンソールをセットアップして構成し、Consumer SDK for Android を使用する手順は次のとおりです。

1. 開発プロジェクトを設定します。
2. Consumer SDK をアプリに追加します。
3. アプリに API キーを追加する。
4. アプリに必要な帰属表示を含める。

各ステップの詳細については、以降のセクションをご覧ください。

注: アプリは minSdkVersion 23 以降を対象とする必要があります。

開発プロジェクトを設定する

モビリティ プロジェクト用の Google Cloud コンソール開発プロジェクトと API キーがない場合は、設定する必要があります。詳細については、Fleet Engine ガイドのプロジェクトを作成するをご覧ください。

Consumer SDK の開発プロジェクトを選択する際は、Fleet Engine で使用しているものと同じ Google Cloud コンソール プロジェクトと API キーを選択します。

アプリに Consumer SDK を追加する

Consumer SDK は Google Maven リポジトリから入手できます。リポジトリには、SDK のプロジェクト オブジェクト モデル（.pom）ファイルと Javadoc が含まれています。アプリに Consumer SDK を追加するには、Consumer SDK と Maps SDK の依存関係を Gradle または Maven の構成に追加します。

注: Consumer SDK は Maps SDK に依存しています。次の例に示すように、依存関係を明示的に定義されたバージョンの Maps SDK に設定します。そうしないと、Consumer SDK は Maps SDK の最小要件バージョンを使用します。アプリがそれ以降の Maps SDK バージョンで利用可能な機能に依存している場合、問題が発生する可能性があります。

次の例では、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 キーを使用する必要があります。詳細については、このガイドのステップ 3 の開発プロジェクトを設定するをご覧ください。

このセクションでは、アプリでより安全に参照されるように API キーを保存する方法を説明します。API キーのセキュリティに関するベスト プラクティスについて詳しくは、Google Maps Platform の記事「API の保護に関するベスト プラクティス」をご覧ください。

重要: API キーをバージョン管理システムにチェックインしないでください。代わりに、プロジェクトのルート ディレクトリにある local.properties ファイルに保存します。local.properties ファイルについて詳しくは、Gradle プロパティ ファイルをご覧ください。

このタスクを効率化するには、GitHub ドキュメントの Android 用 Secrets Gradle プラグインを使用します。

プラグインをインストールして API キーを保存するには:

1. ルートレベルの build.gradle ファイルを開き、buildscript の下にある dependencies 要素に次のコードを追加します。

   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 と同期します。詳しくは、Android ドキュメントのプロジェクトを Gradle と同期するをご覧ください。

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 を使用する場合は、アプリの法的通知セクションの一部として、帰属表示テキストとオープンソース ライセンスを含める必要があります。帰属表示は、独立したメニュー項目として、またはメニュー項目「このアプリについて」の一部として掲載することをおすすめします。

ライセンス情報は、アーカイブされていない AAR ファイルの「third_party_licenses.txt」ファイルで確認できます。

オープンソースの通知を含める方法については、https://developers.google.com/android/guides/opensource をご覧ください。

次のステップ

認証トークンを取得する