Android Studio プロジェクトをセットアップする

Places SDK for Android を使用するようにアプリを構成する手順は次のとおりです。Places SDK for Android を使用するすべてのアプリで必要です。

ステップ 1: Android Studio をセットアップする

  1. Arctic Fox 以降の Android Studio が必要です。お持ちでない場合は、ダウンロードしてインストールしてください。
  2. Android Studio で Android Gradle プラグイン バージョン 7.0 以降を使用していることを確認してください。

手順 2: SDK をセットアップする

Places SDK for Android ライブラリは、Google の Maven リポジトリを通して利用できます。アプリに SDK を追加するには、以下の手順を行います。

  1. トップレベルの settings.gradle ファイルで、pluginManagement ブロック以下に Gradle プラグイン ポータルGoogle Maven リポジトリMaven セントラル リポジトリをインクルードします。pluginManagement ブロックは、スクリプト内の他のステートメントよりも前に配置する必要があります。
    pluginManagement {
        repositories {
            gradlePluginPortal()
            google()
            mavenCentral()
        }
    } 
  2. トップレベルの settings.gradle ファイルで、dependencyResolutionManagement ブロック以下に Google の Maven リポジトリMaven セントラル リポジトリをインクルードします。
    dependencyResolutionManagement {
        repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
        repositories {
            google()
            mavenCentral()
        }
    } 
  3. モジュール レベルの build.gradle ファイルの dependencies セクションで、Places SDK for Android に依存関係を追加します。

    dependencies {
        implementation 'com.google.android.libraries.places:places:3.1.0'
    }
    
  4. モジュール レベルの build.gradle ファイルで、compileSdkminSdk を次の値に設定します。
    android {
        compileSdk 31
    
        defaultConfig {
            minSdk 21
            // ...
        }

ステップ 3: API キーをプロジェクトに追加する

このセクションでは、アプリで安全に参照されるように API キーを保存する方法を説明します。API キーは、バージョン管理システムにはチェックインせず、プロジェクトのルート ディレクトリにある local.properties ファイルに保存することをおすすめします。local.properties ファイルについて詳しくは、Gradle プロパティ ファイルをご覧ください。

このタスクを効率化するには、Android 用 Secrets Gradle プラグインを使用します。プラグインをインストールして API キーを保存するには:

  1. Android Studio でプロジェクト レベルの build.gradle ファイルを開き、buildscript の配下にある dependencies 要素に次のコードを追加します。
    plugins {
        // ...
        id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
    }
  2. 次に、モジュール レベルの build.gradle ファイルを開き、次のコードを plugins 要素に追加します。
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
        
  3. ファイルを保存して、プロジェクトを Gradle と同期します
  4. プロジェクト レベルのディレクトリで local.properties を開き、次のコードを追加します。YOUR_API_KEY は、API キーに置き換えます。
    MAPS_API_KEY=YOUR_API_KEY
        
  5. ファイルを保存します。
  6. AndroidManifest.xml ファイルで com.google.android.geo.API_KEY に移動し、android:value attribute を次のように更新します。
    <meta-data
        android:name="com.google.android.geo.API_KEY"
        android:value="${MAPS_API_KEY}" />
        

注: 上記のように、com.google.android.geo.API_KEY は、API キーとして推奨されるメタデータ名です。この名前のキーは、Places SDK for Android など、Android プラットフォーム上の複数の Google マップベースの API の認証に使用できます。下位互換性を確保するため、API では com.google.android.maps.v2.API_KEY という名前もサポートされています。この従来の名前は、Android Maps API v2 の認証にのみ使用できます。アプリでは、API キーのメタデータ名を 1 つのみ指定できます。両方を指定すると、API から例外がスローされます。

手順 4. Places API クライアントを初期化する

次の例に示すように、アクティビティまたはフラグメント内で Places SDK for Android を初期化します(Places.initialize() を呼び出すときに API キーを渡します)。

Java


    // Initialize the SDK
    Places.initialize(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);

      

Kotlin


    // Initialize the SDK
    Places.initialize(applicationContext, apiKey)

    // Create a new PlacesClient instance
    val placesClient = Places.createClient(this)

      

これで、Places SDK for Android を使用できるようになりました。

ステップ 5: Android デバイスをセットアップする

Places SDK for Android を使用するアプリを実行するには、Android 4.0 以降をベースとし Google API を含む Android デバイスまたは Android Emulator にアプリをデプロイする必要があります。

  • Android デバイスを使用する場合は、ハードウェア デバイス上でのアプリの実行の手順を踏んでください。
  • Android Emulator を使用する場合は、Android Studio に付属している Android Virtual Device(AVD)Manager を使用して仮想デバイスを作成し、エミュレータをインストールしてください。

次のステップ

プロジェクトの構成が完了したら、サンプルアプリを試すことができます。