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 に送信される QueryAutoComplete リクエスト。
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
これは、プレイス サービスによって推奨されたクエリをフォーマットされていないバージョンで示したものです。
matched_substrings
ユーザーの入力要素と一致する、場所の説明に含まれる部分文字列のセットで、部分文字列をハイライト表示するために使用します。各部分文字列は、Unicode 文字で表現されたオフセットと長さで識別されます。
place_id
タイプ:  string
Place Details サービス（PlacesService.getDetails を参照）を使用してこの場所の詳細を取得する際に使用できるプレイス ID。
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
これは、プレイス サービスによって推奨されたクエリをフォーマットされていないバージョンで示したものです。
matched_substrings
ユーザーの入力要素と一致する、場所の説明に含まれる部分文字列のセットで、部分文字列をハイライト表示するために使用します。各部分文字列は、Unicode 文字で表現されたオフセットと長さで識別されます。
terms
タイプ:  Array<PredictionTerm>
上記の説明の個々の用語に関する情報。カテゴリ用語を最初に来ます（「レストラン」など）。住所の語順は具体性の低いものから順に表示されます。例: 「San Francisco」や「CA」。
place_id optional
タイプ:  string optional
予測が場所の場合のみ使用できます。Place Details サービス（PlacesService.getDetails を参照）を使用してこの場所の詳細を取得する際に使用できるプレイス ID。

PredictionTerm インターフェース

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

予測キーワードを表します。
offset
タイプ:  number
場所の説明に含まれるこの語句の開始位置のオフセット（Unicode 文字）。
value
タイプ:  string
この語句の値（例: 「タコベル」）。

PredictionSubstring インターフェース

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

予測部分文字列を表します。
length
タイプ:  number
部分文字列の長さ。
offset
タイプ:  number
description 文字列内の部分文字列の先頭までのオフセット。

StructuredFormatting インターフェースを作成します

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

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