Place Autocomplete

プラットフォームを選択: Android iOS JavaScript ウェブサービス

Android 向け Places SDK の予測入力サービスは、ユーザーの検索クエリに対応して場所の予測を返します。オートコンプリート サービスは、ユーザーが入力している最中に、お店やサービス、住所、プラスコード、有名なスポットなど、プレイスの候補を返します。

次の方法でアプリにオートコンプリート機能を追加することができます。

予測入力ウィジェットを追加する

オートコンプリート ウィジェットは、組み込みのオートコンプリート機能を備えた検索ダイアログです。ユーザーが検索キーワードを入力すると、予測されるプレイスのリストが表示され、そこからプレイスを選択できます。ユーザーがプレイスを選択すると、Place インスタンスが返されます。その後、アプリはこのインスタンスを使用して、選択されたプレイスの詳細を取得できます。

オートコンプリート ウィジェットをアプリに追加する方法として、次の 2 つのオプションがあります。

オプション 1: AutocompleteSupportFragment を埋め込む

アプリに AutocompleteSupportFragment を追加する手順は次のとおりです。

  1. フラグメントをアクティビティの XML レイアウトに追加します。
  2. リスナーをアクティビティまたはフラグメントに追加します。

AutocompleteSupportFragment をアクティビティに追加する

アクティビティに AutocompleteSupportFragment を追加するには、XML レイアウトに新しいフラグメントを追加します。次に例を示します。

<fragment android:id="@+id/autocomplete_fragment"
  android:layout_width="match_parent"
  android:layout_height="wrap_content"
  android:name="com.google.android.libraries.places.widget.AutocompleteSupportFragment"
  />
  • デフォルトでは、フラグメントには境界線や背景はありません。統一感のある見た目にするには、CardView などの別のレイアウト要素内にフラグメントをネストします。
  • 自動入力フラグメントを使用していて、onActivityResult をオーバーライドする必要がある場合は、super.onActivityResult を呼び出す必要があります。呼び出さないと、フラグメントが正しく機能しません。

PlaceSelectionListener をアクティビティに追加する

PlaceSelectionListener は、ユーザーの選択に応じて場所を返す処理を行います。次のコードは、フラグメントへの参照を作成し、AutocompleteSupportFragment にリスナーを追加する方法を示しています。

Kotlin

    // Initialize the AutocompleteSupportFragment.
    val autocompleteFragment =
        supportFragmentManager.findFragmentById(R.id.autocomplete_fragment)
                as AutocompleteSupportFragment

    // Specify the types of place data to return.
    autocompleteFragment.setPlaceFields(listOf(Place.Field.ID, Place.Field.NAME))

    // Set up a PlaceSelectionListener to handle the response.
    autocompleteFragment.setOnPlaceSelectedListener(object : PlaceSelectionListener {
        override fun onPlaceSelected(place: Place) {
            // TODO: Get info about the selected place.
            Log.i(TAG, "Place: ${place.name}, ${place.id}")
        }

        override fun onError(status: Status) {
            // TODO: Handle the error.
            Log.i(TAG, "An error occurred: $status")
        }
    })

      

Java

    // Initialize the AutocompleteSupportFragment.
    AutocompleteSupportFragment autocompleteFragment = (AutocompleteSupportFragment)
            getSupportFragmentManager().findFragmentById(R.id.autocomplete_fragment);

    // Specify the types of place data to return.
    autocompleteFragment.setPlaceFields(Arrays.asList(Place.Field.ID, Place.Field.NAME));

    // Set up a PlaceSelectionListener to handle the response.
    autocompleteFragment.setOnPlaceSelectedListener(new PlaceSelectionListener() {
        @Override
        public void onPlaceSelected(@NonNull Place place) {
            // TODO: Get info about the selected place.
            Log.i(TAG, "Place: " + place.getName() + ", " + place.getId());
        }


        @Override
        public void onError(@NonNull Status status) {
            // TODO: Handle the error.
            Log.i(TAG, "An error occurred: " + status);
        }
    });

      

オプション 2: インテントを使用して、オートコンプリート アクティビティを起動する

アプリで別のナビゲーション フローを使用する場合(たとえば、検索フィールドからではなく、アイコンからオートコンプリート サービスをトリガーする場合など)、アプリでインテントを使用して、オートコンプリートを起動することができます。

インテントを使用してオートコンプリート ウィジェットを起動するには、次の手順を実行します。

  1. Autocomplete.IntentBuilder を使用してインテントを作成し、目的の Autocomplete モードを渡します。
  2. インテントを起動して、結果でユーザーが選択した場所の予測を処理するために使用できるアクティビティ結果ランチャー registerForActivityResult を定義します。

オートコンプリート インテントを作成する

以下の例では、Autocomplete.IntentBuilder を使用してインテントを作成し、オートコンプリート ウィジェットをインテントとして起動します。

Kotlin

    // Set the fields to specify which types of place data to
    // return after the user has made a selection.
    val fields = listOf(Place.Field.ID, Place.Field.NAME)

    // Start the autocomplete intent.
    val intent = Autocomplete.IntentBuilder(AutocompleteActivityMode.FULLSCREEN, fields)
        .build(this)
    startAutocomplete.launch(intent)

      

Java

    // Set the fields to specify which types of place data to
    // return after the user has made a selection.
    List<Place.Field> fields = Arrays.asList(Place.Field.ID, Place.Field.NAME);

    // Start the autocomplete intent.
    Intent intent = new Autocomplete.IntentBuilder(AutocompleteActivityMode.FULLSCREEN, fields)
            .build(this);
    startAutocomplete.launch(intent);

      

インテントを使用してオートコンプリート ウィジェットを起動する場合、オーバーレイ モードまたは全画面モードを選択できます。各表示モードのスクリーンショットを以下に示します。

オーバーレイ モードで表示すると、オートコンプリート ウィジェットが通話 UI の上に重ねて表示されます。
図 1: オーバーレイ モードのオートコンプリート ウィジェット
全画面モードで表示すると、オートコンプリート ウィジェットが画面全体に表示されます。
図 2: FULLSCREEN モードのオートコンプリート ウィジェット

インテントの結果のコールバックを登録する

ユーザーがプレイスを選択したときに通知を受け取るには、次の例に示すように、アクティビティを起動して結果を処理する registerForActivityResult() ランチャーを定義します。ユーザーが予測を選択すると、結果オブジェクトに含まれるインテントで提供されます。インテントは Autocomplete.IntentBuilder によってビルドされているため、Autocomplete.getPlaceFromIntent() メソッドによってプレイス オブジェクトを抽出できます。

Kotlin

private val startAutocomplete =
    registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result: ActivityResult ->
        if (result.resultCode == Activity.RESULT_OK) {
            val intent = result.data
            if (intent != null) {
                val place = Autocomplete.getPlaceFromIntent(intent)
                Log.i(
                    TAG, "Place: ${place.name}, ${place.id}"
                )
            }
        } else if (result.resultCode == Activity.RESULT_CANCELED) {
            // The user canceled the operation.
            Log.i(TAG, "User canceled autocomplete")
        }
    }

      

Java

private final ActivityResultLauncher<Intent> startAutocomplete = registerForActivityResult(
        new ActivityResultContracts.StartActivityForResult(),
        result -> {
            if (result.getResultCode() == Activity.RESULT_OK) {
                Intent intent = result.getData();
                if (intent != null) {
                    Place place = Autocomplete.getPlaceFromIntent(intent);
                    Log.i(TAG, "Place: ${place.getName()}, ${place.getId()}");
                }
            } else if (result.getResultCode() == Activity.RESULT_CANCELED) {
                // The user canceled the operation.
                Log.i(TAG, "User canceled autocomplete");
            }
        });

      

プログラムでプレイスの予測結果を取得する

オートコンプリート ウィジェットで提供される UI の代わりに、カスタムの検索 UI を作成できます。この UI を作成するには、アプリのプログラムでプレイスの予測結果を取得する必要があります。アプリで PlacesClient.findAutocompletePredictions() を呼び出して、次のパラメータを含む FindAutocompletePredictionsRequest オブジェクトを渡すことにより、Autocomplete API によって予測されるプレイスの名前や住所のリストを取得できます。

  • 必須: ユーザーが入力したテキストを含む query 文字列。
  • 推奨: AutocompleteSessionToken。ユーザー検索のクエリと選択フェーズを、請求処理のために個別のセッションにグループ化します。セッションは、ユーザーが検索語句を入力し始めたときに開始され、ユーザーが場所を選択すると終了します。
  • 推奨: RectangularBounds オブジェクト。緯度と経度の範囲を指定して、結果を指定された地域に制限します。
  • 省略可: 2 文字の国コード(ISO 3166-1 alpha-2)を 1 つ以上指定して、結果を制限する国を指定します。
  • 省略可: TypeFilter。指定したプレイスタイプに結果を制限するために使用できます。サポートされるプレイスタイプは次のとおりです。

    • TypeFilter.GEOCODE - お店やサービスの情報は返されず、ジオコーディングの結果のみが返されます。このリクエストは、はっきり特定できない場所を明確にするために使用します。
    • TypeFilter.ADDRESS - 正確な住所を持つオートコンプリートの結果のみを返します。このタイプのリクエストは、ユーザーが完全な住所を指定して検索することがわかっている場合に使用します。
    • TypeFilter.ESTABLISHMENT - お店やサービスのプレイスのみを返します。
    • TypeFilter.REGIONS - 次のいずれかのタイプに一致するプレイスのみを返します。

    • LOCALITY

    • SUBLOCALITY

    • POSTAL_CODE

    • COUNTRY

    • ADMINISTRATIVE_AREA_LEVEL_1

    • ADMINISTRATIVE_AREA_LEVEL_2

    • TypeFilter.CITIES - LOCALITY または ADMINISTRATIVE_AREA_LEVEL_3 に一致する結果のみを返します。

  • 省略可: リクエストの送信元のロケーションを指定する LatLngsetOrigin() を呼び出すと、サービスはレスポンス内の各自動入力予測について、指定された起点からの距離(distanceMeters)をメートル単位で返します。

プレイスタイプの詳細については、プレイスタイプのガイドをご覧ください。

次の例は、PlacesClient.findAutocompletePredictions() の完全な呼び出しを示しています。

Kotlin

    // Create a new token for the autocomplete session. Pass this to FindAutocompletePredictionsRequest,
    // and once again when the user makes a selection (for example when calling fetchPlace()).
    val token = AutocompleteSessionToken.newInstance()

    // Create a RectangularBounds object.
    val bounds = RectangularBounds.newInstance(
        LatLng(-33.880490, 151.184363),
        LatLng(-33.858754, 151.229596)
    )
    // Use the builder to create a FindAutocompletePredictionsRequest.
    val request =
        FindAutocompletePredictionsRequest.builder()
            // Call either setLocationBias() OR setLocationRestriction().
            .setLocationBias(bounds)
            //.setLocationRestriction(bounds)
            .setOrigin(LatLng(-33.8749937, 151.2041382))
            .setCountries("AU", "NZ")
            .setTypesFilter(listOf(PlaceTypes.ADDRESS))
            .setSessionToken(token)
            .setQuery(query)
            .build()
    placesClient.findAutocompletePredictions(request)
        .addOnSuccessListener { response: FindAutocompletePredictionsResponse ->
            for (prediction in response.autocompletePredictions) {
                Log.i(TAG, prediction.placeId)
                Log.i(TAG, prediction.getPrimaryText(null).toString())
            }
        }.addOnFailureListener { exception: Exception? ->
            if (exception is ApiException) {
                Log.e(TAG, "Place not found: ${exception.statusCode}")
            }
        }

      

Java

    // Create a new token for the autocomplete session. Pass this to FindAutocompletePredictionsRequest,
    // and once again when the user makes a selection (for example when calling fetchPlace()).
    AutocompleteSessionToken token = AutocompleteSessionToken.newInstance();

    // Create a RectangularBounds object.
    RectangularBounds bounds = RectangularBounds.newInstance(
            new LatLng(-33.880490, 151.184363),
            new LatLng(-33.858754, 151.229596));
    // Use the builder to create a FindAutocompletePredictionsRequest.
    FindAutocompletePredictionsRequest request = FindAutocompletePredictionsRequest.builder()
            // Call either setLocationBias() OR setLocationRestriction().
            .setLocationBias(bounds)
            //.setLocationRestriction(bounds)
            .setOrigin(new LatLng(-33.8749937, 151.2041382))
            .setCountries("AU", "NZ")
            .setTypesFilter(Arrays.asList(PlaceTypes.ADDRESS))
            .setSessionToken(token)
            .setQuery(query)
            .build();

    placesClient.findAutocompletePredictions(request).addOnSuccessListener((response) -> {
        for (AutocompletePrediction prediction : response.getAutocompletePredictions()) {
            Log.i(TAG, prediction.getPlaceId());
            Log.i(TAG, prediction.getPrimaryText(null).toString());
        }
    }).addOnFailureListener((exception) -> {
        if (exception instanceof ApiException) {
            ApiException apiException = (ApiException) exception;
            Log.e(TAG, "Place not found: " + apiException.getStatusCode());
        }
    });

      

API は TaskFindAutocompletePredictionsResponse を返します。FindAutocompletePredictionsResponse には、予測された場所を表す AutocompletePrediction オブジェクトのリストが含まれています。クエリやフィルタ条件に対応する既知のプレイスがない場合、リストは空になることがあります。

予測されるプレイスごとに次のメソッドを呼び出して、プレイス詳細を取得できます。

  • getFullText(CharacterStyle) は、プレイスの説明の全文を返します。これはプライマリ テキストとセカンダリ テキストを組み合わせたものです。例: 「Eiffel Tower, Avenue Anatole France, Paris, France」。また、CharacterStyle を使用すると、説明文の中で検索内容と一致する部分を、指定のスタイルでハイライト表示できます。CharacterStyle パラメータは省略可能です。ハイライト表示する必要がない場合は、このパラメータを null に設定してください。
  • getPrimaryText(CharacterStyle) は、プレイスを説明するメインテキストを返します。これは通常、プレイスの名前です。例: 「エッフェル塔」、「123 Pitt Street」。
  • getSecondaryText(CharacterStyle) は、プレイスの補足説明のテキストを返します。これは、オートコンプリートの予測結果で 2 行目に表示するテキストなどに適しています。例:「Avenue Anatole France, Paris, France」、「Sydney, New South Wales」。
  • getPlaceId() は、予測された場所のプレイス ID を返します。プレイス ID は、プレイスを一意に識別するテキスト表記の ID です。この ID を使用して、後で Place オブジェクトを再取得できます。Places SDK for Android のプレイス ID の詳細については、プレイス情報をご覧ください。プレイス ID の一般的な情報については、プレイス ID の概要をご覧ください。
  • getPlaceTypes() は、このプレイスに関連付けられているプレイスタイプのリストを返します。
  • getDistanceMeters() は、この場所とリクエストで指定された出発地との間の直線距離(メートル単位)を返します。

セッション トークン

セッション トークンは、予測入力検索でのユーザーのクエリと選択フェーズを、請求処理のために個別のセッションにグループ化します。セッションは、ユーザーが検索語句を入力し始めたときに開始され、ユーザーが場所を選択すると終了します。セッションによっては、複数の検索語句が入力された後に、1 つの場所が選択される場合もあります。セッションが終了すると、トークンは無効になります。アプリでは、セッションごとに新しいトークンを生成する必要があります。すべてのプログラマティック 自動入力セッションでセッション トークンを使用することをおすすめします(フラグメントを埋め込む場合や、インテントを使用して自動入力を起動する場合、API が自動的に処理します)。

Places SDK for Android は、AutocompleteSessionToken を使用して各セッションを識別します。アプリは、新しいセッションを開始するたびに新しいセッション トークンを渡し、その後の fetchPlace() の呼び出しで同じトークンとプレイス ID を渡して、ユーザーが選択したプレイスの Place Details を取得する必要があります。

セッション トークンの詳細

オートコンプリートの結果を制限する

オートコンプリートの結果を特定の地域に制限したり、1 つ以上のプレイスタイプ、または最大 5 か国に結果をフィルタしたりできます。これらの制約は、自動入力アクティビティ、AutocompleteSupportFragment、プログラムによる自動入力 API に適用できます。

結果を制約するには、次の操作を行います。

  • 指定した範囲内の結果を優先するには、setLocationBias() を呼び出します(指定した範囲外の結果が返されることもあります)。
  • 指定した地域内の検索結果のみを表示するには、setLocationRestriction() を呼び出します(指定した地域内の検索結果のみが返されます)。
  • 特定の場所のタイプに一致する結果のみを返すには、setTypesFilter() を呼び出します(たとえば、TypeFilter.ADDRESS を指定すると、正確な住所が示された結果のみが返されます)。
  • 指定した 5 か国以内の結果のみを返すには、setCountries() を呼び出します。国は、ISO 3166-1 Alpha-2 に準拠した 2 文字の国コードで指定してください。

特定の地域の結果を優先して返す

オートコンプリートで特定の地域の結果を優先して返すには、RectangularBounds を渡して setLocationBias() を呼び出します。次のコードサンプルは、フラグメント インスタンスで setLocationBias() を呼び出して、オーストラリアのシドニー周辺のオートコンプリート候補を優先して返します。

Kotlin

    autocompleteFragment.setLocationBias(
        RectangularBounds.newInstance(
            LatLng(-33.880490, 151.184363),
            LatLng(-33.858754, 151.229596)
        )
    )

      

Java

    autocompleteFragment.setLocationBias(RectangularBounds.newInstance(
            new LatLng(-33.880490, 151.184363),
            new LatLng(-33.858754, 151.229596)));

      

結果を特定の地域に制限する

オートコンプリートの結果を特定の地域に制限するには、RectangularBounds を渡して setLocationRestriction() を呼び出します。次のコードサンプルは、フラグメント インスタンスで setLocationRestriction() を呼び出して、オーストラリアのシドニー周辺のオートコンプリート候補を優先して返します。

Kotlin

    autocompleteFragment.setLocationRestriction(
        RectangularBounds.newInstance(
            LatLng(-33.880490, 151.184363),
            LatLng(-33.858754, 151.229596)
        )
    )

      

Java

    autocompleteFragment.setLocationRestriction(RectangularBounds.newInstance(
            new LatLng(-33.880490, 151.184363),
            new LatLng(-33.858754, 151.229596)));

      

注: この制限はルート全体にのみ適用されます。ルートの 1 つが位置情報の制限と重なる場合、長方形の境界外にある合成結果が返されることがあります。

場所のタイプまたはタイプ コレクションで結果をフィルタする

特定のプレイスタイプのみを返すように、オートコンプリート リクエストの結果を制限できます。プレイスタイプの表 1、2、3 に記載されているプレイスタイプまたはタイプのコレクションを使用してフィルタを指定します。何も指定しないと、すべてのタイプが返されます。

オートコンプリート結果をフィルタするには、setTypesFilter() を呼び出してフィルタを設定します。

タイプまたはタイプ コレクション フィルタを指定するには:

  • setTypesFilter() を呼び出し、プレイスタイプに記載されている表 1 と表 2 のタイプ値を最大 5 つ指定します。タイプ値は、PlaceTypes の定数で定義されます。

  • setTypesFilter() を呼び出し、プレイスタイプの表 3 に示すタイプ コレクションを指定します。コレクション値は、PlaceTypes の定数で定義されます。

    リクエストでは、表 3 のタイプのうち、1 つのみが許可されます。表 3 の値を指定する場合、表 1 または表 2 の値は指定できません。指定すると、エラーが発生します。

次のコードサンプルでは、AutocompleteSupportFragmentsetTypesFilter() を呼び出し、複数の型値を指定します。

Kotlin

    autocompleteFragment.setTypesFilter(listOf("landmark", "restaurant", "store"))

      

Java

    autocompleteFragment.setTypesFilter(Arrays.asList("landmark", "restaurant", "store"));

      

次のコードサンプルは、AutocompleteSupportFragmentsetTypesFilter() を呼び出して、タイプ コレクションを指定して正確な住所が示された結果のみを返すようにフィルタを設定しています。

Kotlin

    autocompleteFragment.setTypesFilter(listOf(PlaceTypes.ADDRESS))

      

Java

    autocompleteFragment.setTypesFilter(Arrays.asList(PlaceTypes.ADDRESS, PlaceTypes.ESTABLISHMENT));

      

次のコードサンプルは、IntentBuildersetTypesFilter() を呼び出して、型コレクションを指定して正確な住所が示された結果のみを返すようにフィルタを設定しています。

Kotlin

    val intent = Autocomplete.IntentBuilder(AutocompleteActivityMode.FULLSCREEN, fields)
        .setTypesFilter(listOf(PlaceTypes.ADDRESS))
        .build(this)

      

Java

    Intent intent = new Autocomplete.IntentBuilder(
            AutocompleteActivityMode.FULLSCREEN, fields)
            .setTypesFilter(Arrays.asList(PlaceTypes.ADDRESS))
            .build(this);

      

国で結果をフィルタする

オートコンプリートの結果を最大 5 か国にフィルタするには、setCountries() を呼び出して国コードを設定します。その後、フィルタをフラグメントまたはインテントに渡します。国は、ISO 3166-1 Alpha-2 に準拠した 2 文字の国コードで指定してください。

次のコードサンプルは、AutocompleteSupportFragmentsetCountries() を呼び出して、指定した国内のみの検索結果を返すようにフィルタを設定しています。

Kotlin

    autocompleteFragment.setCountries("AU", "NZ")

      

Java

    autocompleteFragment.setCountries("AU", "NZ");

      

使用量上限

Places SDK for Android を含む Places API の使用は、1 日あたりのリクエスト数(QPD)の上限が撤廃されました。ただし、次の使用制限は引き続き適用されます。

  • レート制限は 6,000 QPM(1 分あたりのリクエスト回数)です。これは、同じプロジェクトの認証情報を使用するすべてのアプリケーションのクライアント側リクエストとサーバー側リクエストの合計として計算されます。

アプリに属性を表示する

  • アプリでプログラムを使ってオートコンプリート サービスを使用する場合は、UI に「Powered by Google」の帰属情報を表示するか、UI を Google ブランドマップ内に表示する必要があります。
  • アプリでオートコンプリート ウィジェットを使用する場合は、追加の対応は必要ありません(必要な帰属情報がデフォルトで表示されます)。
  • ID でプレイスを取得した後に追加のプレイス情報を取得して表示する場合は、サードパーティ属性も表示する必要があります。

詳細については、アトリビューションに関するドキュメントをご覧ください。

Place Autocomplete の最適化

このセクションでは、Place Autocomplete サービスを最大限に活用するためのヒントを紹介します。

概要は次のとおりです。

  • 機能的なユーザー インターフェースを最も手早く作成するには、Maps JavaScript API Autocomplete ウィジェット、Places SDK for Android Autocomplete ウィジェット、または Places SDK for iOS Autocomplete UI コントロールを使用します。
  • Place Autocomplete のデータ フィールドの基本を理解します。
  • 位置情報のバイアスと位置情報の制限のフィールドは省略可能ですが、予測入力のパフォーマンスに大きく影響する場合があります。
  • エラー処理を使用して、API がエラーを返した場合に、アプリでグレースフル デグラデーションが行われるようにします。
  • アプリでは、選択肢がない場合でもユーザーが操作を続行できるようにします。

費用の最適化に関するヒント

基本的な費用の最適化

Place Autocomplete サービスの費用を最適化するには、Place Details と Place Autocomplete ウィジェットのフィールド マスクを使用して、必要な場所のデータ フィールドのみを返すよう設定します。

高度な費用の最適化

リクエストあたりの料金設定を利用し、Place Details の代わりに選択された場所に関する Geocoding API の結果をリクエストするためには、Place Autocomplete のプログラマティック実装を行うことをおすすめします。次の両方に該当する場合は、リクエストあたりの料金設定と Geocoding API を組み合わせた方が、セッションあたり(セッション ベース)の料金設定よりも費用対効果が高くなります。

  • ユーザーが選択した場所の緯度 / 経度または住所のみが必要な場合。その場合は、Geocoding API の方が、Place Details の呼び出しよりも少ないコストでこの情報を提供できます。
  • ユーザーが予測結果を選択するまでの予測入力候補リクエストの回数が、平均 4 回以下の場合。その場合は、リクエストあたりの料金設定の方がセッションあたりの料金設定よりも費用対効果が高くなります。
ニーズに合った Place Autocomplete 実装を選ぶ際は、次の質問に対する答えを考え、それに対応するタブを選択するとヒントが表示されます。

アプリケーションで、選択された予測結果の住所と緯度 / 経度以外の情報が必要ですか?

はい。その他の情報も必要です

セッション ベースの Place Autocomplete と Place Details を併用します。
アプリケーションで、場所の名前、お店やサービスのステータス、始業時間などの Place Details が必要になるため、Place Autocomplete 実装では、セッション トークン(プログラマティック実装か、JavaScriptAndroid、または iOS ウィジェットへの組み込み)を使用することをおすすめします。合計では、セッションあたり 0.017 ドルに加え、リクエストするデータ フィールドに応じた対象のプレイスデータ SKU の費用がかかります。1

ウィジェット実装
セッション管理が JavaScriptAndroid、または iOS ウィジェットに自動的に組み込まれます。これには、選択された予測結果での Place Autocomplete リクエストと Place Details リクエストの両方が含まれます。必要なプレイスデータ フィールドのみをリクエストするように、必ず fields パラメータを指定してください。

プログラマティック実装
Place Autocomplete リクエストでセッション トークンを使用します。選択された予測結果に関する Place Details をリクエストする際は、次のパラメータを含めます。

  1. Place Autocomplete レスポンスのプレイス ID
  2. Place Autocomplete リクエストで使用されるセッション トークン
  3. 必要な場所のデータ フィールドを指定する fields パラメータ

いいえ。住所と場所のみが必要です

Place Autocomplete 使用時のパフォーマンスによっては、アプリケーションで Places Details を使用するよりも、Geocoding API を使用した方が費用対効果が高くなる場合があります。アプリケーションの予測入力の効率は、ユーザーの入力内容や、アプリケーションが使用される場所、パフォーマンス最適化のベスト プラクティスが導入されているかどうかによって変わります。

次の質問に答えるためには、ユーザーがアプリケーション内で Place Autocomplete の予測を選択するまでに、平均でどのくらいの文字数を入力するのかを分析する必要があります。

ユーザーが Place Autocomplete の予測を選択するまでに実行されるリクエスト数は、平均で 4 回以下ですか?

はい

セッション トークンを使用せずにプログラムによって Place Autocomplete を実装し、選択された場所の予測で Geocoding API を呼び出します。
Geocoding API は、リクエスト 1 件につき 0.005 ドルで住所と緯度 / 経度の座標が提供されます。Place Autocomplete - Per Request のリクエスト 4 件の料金は 0.01132 ドルになるため、4 件のリクエストと、選択された場所予測に関する Geocoding API の呼び出しを合わせた料金は、0.01632 ドルになります。これは、Per Session Autocomplete でのセッション 1 回あたりの料金 0.017 ドルよりも少ないコストです。1

パフォーマンスに関するベスト プラクティスを導入し、できるだけ少ない入力文字数でユーザーが求める情報を提供できるようすることをおすすめします。

いいえ

セッション ベースの Place Autocomplete と Place Details を併用します。
ユーザーが Place Autocomplete の予測を選択するまでの平均リクエスト回数が、セッションあたりの料金を超えるため、Place Autocomplete 実装では、Place Autocomplete リクエストと、関連する Place Details リクエストの両方でセッション トークンを使用することをおすすめします(合計費用はセッションあたり 0.017 ドル)。1

ウィジェット実装
セッション管理が JavaScriptAndroid、または iOS ウィジェットに自動的に組み込まれます。これには、選択された予測結果での Place Autocomplete リクエストと Place Details リクエストの両方が含まれます。基本データ フィールドのみをリクエストするように、必ず fields パラメータを指定してください。

プログラマティック実装
Place Autocomplete リクエストでセッション トークンを使用します。選択された予測結果に関する Place Details をリクエストする際は、次のパラメータを含めます。

  1. Place Autocomplete レスポンスのプレイス ID
  2. Place Autocomplete リクエストで使用されるセッション トークン
  3. 住所やジオメトリなどの基本データ フィールドを指定する fields パラメータ

Place Autocomplete リクエストを遅らせることを検討する
ユーザーが最初の 3~4 文字を入力するまで Place Autocomplete リクエストを遅らせて、アプリケーションでのリクエスト数を減らすこともできます。たとえば、ユーザーが 3 文字目を入力してから、1 文字ごとに Place Autocomplete リクエストを行うとします。あるユーザーが、7 文字目を入力してから予測を選択し、Geocoding API リクエストが 1 回実行されました。この場合の合計費用は、0.01632 ドル(4 x Autocomplete Per Request 1 回の料金 0.00283 ドル + ジオコーディング 1 回の料金 0.005 ドル)となります。1

リクエストを遅らせることで、プログラマティック リクエストの回数を平均 4 回以下に抑えられる場合は、高パフォーマンスで Place Autocomplete と Geocoding API を併用する実装に関するガイダンスをご覧ください。なお、リクエストを遅らせると、1 文字入力するたびに予測が表示されはずと考えているユーザーには、遅延と受けとられる場合もあります。

パフォーマンスに関するベスト プラクティスを導入し、できるだけ少ない入力文字数でユーザーが求める情報を提供できるようすることをおすすめします。


  1. ここで提示されている料金は米ドルです。料金について詳しくは、Google Maps Platform の課金のページをご覧ください。

パフォーマンスに関するベスト プラクティス

Place Autocomplete のパフォーマンスを最適化するためのガイドラインは次のとおりです。

  • Place Autocomplete 実装に、国別のポリシー、場所のバイアス、言語設定(プログラマティック実装の場合)を追加します。ウィジェットはユーザーのブラウザやモバイル デバイスから言語設定を選択するため、ウィジェットでは言語設定は不要です。
  • Place Autocomplete が地図に関連付けられている場合は、地図のビューポートを基準に場所にバイアスをかけることができます。
  • ユーザーがいずれかの予測入力候補を選択しなかった場合は(通常は目的の住所が候補に挙がらなかったことが原因)、ユーザーの元の入力内容を再利用して、より関連性の高い結果を取得できます。
    • ユーザーが住所情報のみを入力することが予想される場合は、Geocoding API の呼び出しで、ユーザーの元の入力内容を再利用します。
    • ユーザーが特定の場所に関する検索語句(名前や住所)を入力することが予想される場合は、Find Place リクエストを使用します。特定の地域の結果のみが求められる場合は、場所のバイアスを使用します。
    Geocoding API へのフォールバックが最適となるその他のシナリオは次のとおりです。
    • 建物内の特定のユニットやアパートの住所など、サブプレミス住所を入力するユーザー。たとえば、チェコ語の住所「Stroupežnického 3191/17, Praha」では、Place Autocomplete で部分的な予測が生成されます。
    • ユーザーがニューヨークの「23-30 29th St, Queens」や、ハワイのカウアイ島の「47-380 Kamehameha Hwy, Kaneohe」など、道路区間のプレフィックスを入力する場合。

トラブルシューティング

さまざまなエラーが発生する可能性がありますが、一般的にアプリでよく発生するエラーの主な原因は、設定エラー(誤った API キーが使用された、API キーが正しく設定されていないなど)または割り当てエラー(アプリで割り当てを超過した)です。割り当ての詳細については、使用量の上限をご覧ください。

オートコンプリート コントロールの使用時に発生するエラーは、onActivityResult() コールバックで返されます。結果のステータス メッセージを取得するには、Autocomplete.getStatus() を呼び出します。