Places Autocomplete Service

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

AutocompleteService クラス

google.maps.places.AutocompleteService クラス

オートコンプリート予測の取得に関連するメソッドが含まれています。

&libraries=places URL パラメータが必要です。詳しくは、Maps JavaScript API のライブラリをご覧ください。

AutocompleteService
AutocompleteService()
パラメータ: なし
AutocompleteService の新しいインスタンスを作成します。
getPlacePredictions
getPlacePredictions(request[, callback])
パラメータ:
提供されたオートコンプリート リクエストに基づいて、プレイス オートコンプリートの予測を取得します。
getQueryPredictions
getQueryPredictions(request, callback)
パラメータ:
戻り値: なし
提供されたクエリ オートコンプリート リクエストに基づいてクエリ オートコンプリート予測を取得します。

AutocompletionRequest インターフェース

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

AutocompleteService.getPlacePredictions に送信するオートコンプリート リクエスト。

&libraries=places URL パラメータが必要です。詳しくは、Maps JavaScript API のライブラリをご覧ください。

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

AutocompleteResponse インターフェース

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

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

&libraries=places URL パラメータが必要です。詳しくは、Maps JavaScript API のライブラリをご覧ください。

predictions
AutocompletePrediction のリスト。

QueryAutocompletionRequest インターフェース

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

QueryAutocompleteService に送信される QueryAutocompletion リクエスト。

&libraries=places URL パラメータが必要です。詳しくは、Maps JavaScript API のライブラリをご覧ください。

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

AutocompleteSessionToken クラス

google.maps.places.AutocompleteSessionToken クラス

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

&libraries=places URL パラメータが必要です。詳しくは、Maps JavaScript API のライブラリをご覧ください。

AutocompleteSessionToken
AutocompleteSessionToken()
パラメータ: なし
AutocompleteSessionToken の新しいインスタンスを作成します。

ComponentRestrictions インターフェース

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

オートコンプリート サービスで使用できるコンポーネントの制限を定義します。

&libraries=places URL パラメータが必要です。詳しくは、Maps JavaScript API のライブラリをご覧ください。

country optional
タイプ: string|Array<string> optional
予測を指定の国に制限します(ISO 3166-1 Alpha-2 国コード。大文字と小文字は区別されません)。たとえば、'us''br''au' です。1 つだけ使用するか、最大 5 つの国コードの配列を指定できます。

AutocompletePrediction インターフェース

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

単一のオートコンプリート予測を表します。

&libraries=places URL パラメータが必要です。詳しくは、Maps JavaScript API のライブラリをご覧ください。

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

単一のクエリ オートコンプリート予測を表します。

&libraries=places URL パラメータが必要です。詳しくは、Maps JavaScript API のライブラリをご覧ください。

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

予測語句を表します。

&libraries=places URL パラメータが必要です。詳しくは、Maps JavaScript API のライブラリをご覧ください。

offset
タイプ: number
場所の説明におけるこの用語の先頭のオフセット(Unicode 文字)。
value
タイプ: string
この用語の値。たとえば、「タコベル」などです。

PredictionSubstring インターフェース

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

予測部分文字列を表します。

&libraries=places URL パラメータが必要です。詳しくは、Maps JavaScript API のライブラリをご覧ください。

length
タイプ: number
部分文字列の長さ。
offset
タイプ: number
部分文字列へのオフセットは、説明文字列内で開始します。

StructuredFormatting インターフェース

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

場所の説明を構造化した情報で、メイン テキストとセカンダリ テキストに分かれています。これには、オートコンプリート入力の照合された部分文字列の配列(オフセットと長さで識別される Unicode 文字)が含まれます。

&libraries=places URL パラメータが必要です。詳しくは、Maps JavaScript API のライブラリをご覧ください。

main_text
タイプ: string
プレイス サービスで提案された、場所の説明の書式なしテキストのメイン テキスト部分です。通常は場所の名前です。
main_text_matched_substrings
ユーザーのテキスト内の要素に一致する、メインテキスト内の部分文字列のセット。これらの部分文字列をハイライトする場合に適しています。各部分文字列は、Unicode 文字で表されるオフセットと長さで識別されます。
secondary_text
タイプ: string
プレイス サービスで提案された場所のフォーマットされていない説明のサブテキスト部分です。通常はその場所の場所です。