Places Autocomplete Service (deprecated)

AutocompleteService クラス

class google.maps.places.AutocompleteService
library "places"

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

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

AutocompleteResponse インターフェース

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

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

QueryAutocompletionRequest インターフェース

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

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

ComponentRestrictions インターフェース

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

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

AutocompletePrediction インターフェース

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

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

QueryAutocompletePrediction インターフェース

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

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

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
これは、Places サービスによって提案された場所の、書式設定されていない説明のメインテキスト部分です。通常は場所の名前です。
main_text_matched_substrings
ユーザーの入力要素と一致する、メインテキスト内の一連の部分文字列。これらの部分文字列をハイライト表示するのに適しています。各部分文字列は、Unicode 文字で表されるオフセットと長さによって識別されます。
secondary_text
タイプ: string
これは、Places サービスによって提案された場所の未フォーマットの説明の、2 番目のテキスト部分です。通常は場所の所在地です。