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>
指定されたオートコンプリート リクエストに基づいて、プレイス オートコンプリートの予測を取得します。
getQueryPredictions
getQueryPredictions(request, callback)
パラメータ: 
戻り値: None
指定されたクエリ オートコンプリート リクエストに基づいてクエリ オートコンプリート予測を取得します。

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 インターフェース

AutocompletePrediction のリストを含む AutocompleteService.getPlacePredictions の呼び出しによって返される 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 も使用できます。

AutocompleteSessionToken クラス

google.maps.places.AutocompleteSessionToken クラス

オートコンプリート セッションのトラッキングに使用されるセッション トークンです。一連の AutocompleteService.getPlacePredictions 呼び出しの後に単一の PlacesService.getDetails 呼び出しを指定できます。

const {AutocompleteSessionToken} = await google.maps.importLibrary("places") を呼び出してアクセスします。詳しくは、Maps JavaScript API のライブラリをご覧ください。
AutocompleteSessionToken
AutocompleteSessionToken()
パラメータ: なし
AutocompleteSessionToken の新しいインスタンスを作成します。

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>
上記の説明における個々の用語に関する情報。最初にカテゴリ名（たとえば「レストラン」）が表示される。地名は具体的なものから順に並べられます。例: 「港区」、「東京」
place_id optional
タイプ:  string optional
予測が場所である場合にのみ使用できます。Place Details サービス（PlacesService.getDetails を参照）を使用して、この場所の詳細を取得するのに使用できる場所 ID。

PredictionTerm インターフェース

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

予測語句を表します。
offset
タイプ:  number
場所の説明における、この用語の始点からのオフセット（Unicode 文字）。
value
タイプ:  string
この用語の値。例: 「Taco Bell」

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
セカンダリ テキストは、プレイス サービスで候補として表示された場所の説明です。通常はこの場所の場所です。