Places Autocomplete Service

AutocompleteService クラス

google.maps.places.AutocompleteService クラス

予測入力候補の取得に関連するメソッドが含まれます。

const {AutocompleteService} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
AutocompleteService
AutocompleteService()
パラメータ: なし
AutocompleteService の新しいインスタンスを作成します。
getPlacePredictions
getPlacePredictions(request[, callback])
パラメータ: 
戻り値:  Promise<AutocompleteResponse>
指定された予測入力リクエストに基づいて、Place Autocomplete の候補を取得します。
getQueryPredictions
getQueryPredictions(request, callback)
パラメータ: 
戻り値: なし
指定されたオートコンプリート リクエストに基づいて、クエリのオートコンプリート予測を取得します。

AutocompletionRequest インターフェース

google.maps.places.AutocompletionRequest インターフェース

AutocompleteService.getPlacePredictions に送信される予測入力リクエスト。
input
タイプ:  string
ユーザーが入力文字列を入力しました。
bounds optional
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
予測バイアスの境界。予測は、指定された bounds に偏りますが、それに限定されません。bounds が設定されている場合、location と radius の両方が無視されます。
componentRestrictions optional
タイプ:  ComponentRestrictions optional
コンポーネントの制限。コンポーネントの制限は、予測を親コンポーネント内の予測のみに制限するために使用されます。（国など）。
language optional
タイプ:  string optional
可能な場合、結果が返される言語の言語識別子。選択した言語の検索結果のランキングが高くなる可能性がありますが、候補は選択した言語に限定されません。サポートされている言語の一覧をご覧ください。
location optional
タイプ:  LatLng optional
予測バイアスのロケーション。予測は、指定された location と radius に偏ります。または、bounds を使用することもできます。
locationBias optional
タイプ:  LocationBias optional
場所を検索するときに使用するソフト バウンダリまたはヒント。
locationRestriction optional
タイプ:  LocationRestriction optional
検索結果を制限する範囲。
offset optional
タイプ:  number optional
サービスが予測にテキストを使用する入力語句内の文字位置（入力フィールド内のカーソルの位置）。
origin optional
タイプ:  LatLng|LatLngLiteral optional
AutocompletePrediction.distance_meters の計算元となる場所。
radius optional
タイプ:  number optional
予測バイアスに使用されるエリアの半径。radius はメートル単位で指定され、常に location プロパティを伴う必要があります。または、bounds を使用することもできます。
region optional
タイプ:  string optional
結果のフォーマットと結果のフィルタリングに使用される地域コード。この国に限定して候補が表示されるわけではありません。地域コードには、ccTLD（「トップレベル ドメイン」）の 2 文字の値を指定します。ほとんどの ccTLD コードは ISO 3166-1 コードと同一ですが、いくつか注意が必要な例外もあります。たとえば、英国の ccTLD は「uk」（.co.uk）ですが、ISO 3166-1 コードは「gb」（厳密には「グレートブリテンおよび北アイルランド連合王国」のエンティティ用）です。
sessionToken optional
タイプ:  AutocompleteSessionToken optional
個々のリクエストをセッションにバンドルするために使用される一意の参照。
types optional
タイプ:  Array<string> optional
返される予測のタイプ。サポートされているタイプについては、 デベロッパー ガイドをご覧ください。タイプが指定されていない場合は、すべてのタイプが返されます。

AutocompleteResponse インターフェース

google.maps.places.AutocompleteResponse インターフェース

AutocompleteService.getPlacePredictions の呼び出しによって返される、AutocompletePrediction のリストを含む Autocomplete レスポンス。
predictions
AutocompletePrediction のリスト。

QueryAutocompletionRequest インターフェース

google.maps.places.QueryAutocompletionRequest インターフェース

QueryAutocompleteService に送信される QueryAutocompletion リクエスト。
input
タイプ:  string
ユーザーが入力文字列を入力しました。
bounds optional
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
予測バイアスの境界。予測は、指定された bounds に偏りますが、それに限定されません。bounds が設定されている場合、location と radius の両方が無視されます。
location optional
タイプ:  LatLng optional
予測バイアスのロケーション。予測は、指定された location と radius に偏ります。または、bounds を使用することもできます。
offset optional
タイプ:  number optional
サービスが予測にテキストを使用する入力語句内の文字位置（入力フィールド内のカーソルの位置）。
radius optional
タイプ:  number optional
予測バイアスに使用されるエリアの半径。radius はメートル単位で指定され、常に location プロパティを伴う必要があります。または、bounds を使用することもできます。

ComponentRestrictions インターフェース

google.maps.places.ComponentRestrictions インターフェース

オートコンプリート サービスで使用できるコンポーネントの制限を定義します。
country optional
タイプ:  string|Array<string> optional
予測を特定の国に制限します（ISO 3166-1 Alpha-2 の国コード。大文字と小文字は区別されません）。例: 'us'、'br'、'au'1 つの文字列を指定することも、最大 5 つの国コード文字列の配列を指定することもできます。

AutocompletePrediction インターフェース

google.maps.places.AutocompletePrediction インターフェース

単一のオートコンプリート候補を表します。
description
タイプ:  string
これは、Places サービスによって提案されたクエリの未フォーマット バージョンです。
matched_substrings
ユーザーの入力要素と一致する、場所の説明内の一連の部分文字列。これらの部分文字列をハイライト表示するのに適しています。各サブストリングは、Unicode 文字で表されるオフセットと長さで識別されます。
place_id
タイプ:  string
プレイス ID。プレイスの詳細サービスを使用してこの場所の詳細を取得するために使用できます（PlacesService.getDetails を参照）。
structured_formatting
場所の説明に関する構造化された情報。メインテキストとセカンダリ テキストに分割され、予測入力の入力から一致した部分文字列の配列が含まれます。オフセットと長さで識別され、Unicode 文字で表されます。
terms
タイプ:  Array<PredictionTerm>
上記の説明の個々の用語に関する情報（最も具体的なものから最も具体的でないものまで）。たとえば、「Taco Bell」、「Willitis」、「CA」などです。
types
タイプ:  Array<string>
予測が属する型の配列（'establishment'、'geocode' など）。
distance_meters optional
タイプ:  number optional
AutocompletionRequest.origin からの場所までの距離（メートル単位）。

QueryAutocompletePrediction インターフェース

google.maps.places.QueryAutocompletePrediction インターフェース

単一のクエリ オートコンプリート予測を表します。
description
タイプ:  string
これは、Places サービスによって提案されたクエリの未フォーマット バージョンです。
matched_substrings
ユーザーの入力要素と一致する、場所の説明内の一連の部分文字列。これらの部分文字列をハイライト表示するのに適しています。各サブストリングは、Unicode 文字で表されるオフセットと長さで識別されます。
terms
タイプ:  Array<PredictionTerm>
上記の説明の個々の用語に関する情報。カテゴリ用語が先頭にきます（「レストラン」など）。住所の用語は、最も具体的なものから最も具体的でないものの順に表示されます。例: 「San Francisco」、「CA」。
place_id optional
タイプ:  string optional
予測が場所の場合にのみ使用できます。プレイス ID。プレイスの詳細サービスを使用してこの場所の詳細を取得するために使用できます（PlacesService.getDetails を参照）。

PredictionTerm インターフェース

google.maps.places.PredictionTerm インターフェース

予測項を表します。
offset
タイプ:  number
この用語が場所の説明で始まる位置の Unicode 文字によるオフセット。
value
タイプ:  string
この用語の値（例: 「Taco Bell」）。

PredictionSubstring インターフェース

google.maps.places.PredictionSubstring インターフェース

予測部分文字列を表します。
length
タイプ:  number
部分文字列の長さ。
offset
タイプ:  number
説明文字列内の部分文字列の開始位置までのオフセット。

StructuredFormatting インターフェース

google.maps.places.StructuredFormatting インターフェース

場所の説明に関する構造化された情報が含まれます。メインテキストとセカンダリ テキストに分割され、予測入力の入力から一致した部分文字列の配列が含まれます。オフセットと長さで識別され、Unicode 文字で表されます。
main_text
タイプ:  string
これは、Places サービスによって提案された場所の書式なしの説明のメインテキスト部分です。通常は場所の名前です。
main_text_matched_substrings
ユーザーの入力要素と一致する、メインテキスト内の一連の部分文字列。これらの部分文字列をハイライト表示するのに適しています。各サブストリングは、Unicode 文字で表されるオフセットと長さで識別されます。
secondary_text
タイプ:  string
これは、Places サービスによって提案された場所の書式なしの説明の 2 番目のテキスト部分です。通常は場所の位置情報。