Places Autocomplete Service

AutocompleteService クラス

google.maps.places.AutocompleteService クラス

Autocomplete の予測の取得に関連するメソッドが含まれています。

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

AutocompletionRequest インターフェース

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

AutocompleteService.getPlacePredictions に送信される Autocomplete リクエスト。
input
タイプ:  string
ユーザーが入力文字列を入力しました。
bounds optional
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
予測バイアスの境界。予測は指定された bounds に偏向しますが、これに限定されません。bounds が設定されている場合、location と radius の両方が無視されます。
componentRestrictions optional
タイプ:  ComponentRestrictions optional
コンポーネントの制限事項。コンポーネントの制限は、予測を親コンポーネント内のものに制限するために使用されます。（国など）。
language optional
タイプ:  string optional
結果を返す言語の言語 ID（可能であれば）。選択した言語の結果は上位に表示されますが、候補は選択した言語に限定されません。サポートされている言語の一覧をご覧ください。
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 の呼び出しによって返される Autocomplete レスポンス。AutocompletePrediction のリストが含まれます。
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 番目のテキスト部分です。通常は場所の場所です。