AutocompleteService クラス
google.maps.places.AutocompleteService
クラス
オートコンプリート候補の取得に関連するメソッドが含まれます。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
v=beta
を使用している場合は、const {AutocompleteService} = await google.map.importLibrary("places")
を呼び出してアクセスできます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
コンストラクタ | |
---|---|
AutocompleteService |
AutocompleteService() パラメータ: なし
AutocompleteService の新しいインスタンスを作成します。 |
Methods | |
---|---|
getPlacePredictions |
getPlacePredictions(request[, callback]) パラメータ:
戻り値:
Promise<AutocompleteResponse> 指定されたオートコンプリート リクエストに基づいて、プレイス オートコンプリートの予測を取得します。 |
getQueryPredictions |
getQueryPredictions(request, callback) パラメータ:
戻り値: None
指定されたクエリ オートコンプリート リクエストに基づいてクエリ オートコンプリートの予測を取得します。 |
AutocompletionRequest インターフェース
google.maps.places.AutocompletionRequest
インターフェース
AutocompleteService.getPlacePredictions
に送信するオートコンプリート リクエスト。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
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 も使用できます。 |
offset optional |
タイプ:
number optional サービスが予測のためにテキストを使用する入力キーワード内の文字位置(入力フィールド内のカーソルの位置)。 |
origin optional |
タイプ:
LatLng|LatLngLiteral optional |
radius optional |
タイプ:
number optional 予測バイアスに使用される領域の半径。 radius はメートル単位で指定し、常に location プロパティを伴う必要があります。また、bounds も使用できます。 |
region optional |
タイプ:
string optional 結果の形式設定と結果のフィルタリングに使用される地域コード。候補が表示される国は制限されません。地域コードは 2 文字の ccTLD(「トップレベル ドメイン」)を受け入れます。ほとんどの 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 レスポンス。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
predictions |
タイプ:
Array<AutocompletePrediction> AutocompletePrediction のリスト。 |
QueryAutocompletionRequest インターフェース
google.maps.places.QueryAutocompletionRequest
インターフェース
QueryAutocompleteService
に送信される QueryAutocompletion リクエスト。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
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
呼び出しと、その後の 1 つの PlacesService.getDetails
呼び出しのいずれかです。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
v=beta
を使用している場合は、const {AutocompleteSessionToken} = await google.map.importLibrary("places")
を呼び出してアクセスできます。詳しくは、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 |
タイプ:
Array<PredictionSubstring> 場所の説明の、ユーザー入力の要素と一致する部分文字列のセット。部分文字列をハイライト表示する場合に適しています。各部分文字列は、Unicode 文字で表されるオフセットと長さで識別されます。 |
place_id |
タイプ:
string Place Details サービスを使用して、この場所の詳細を取得するために使用できる場所 ID( PlacesService.getDetails を参照)。 |
structured_formatting |
タイプ:
StructuredFormatting 場所の説明に関する構造化された情報です。メイン テキストとセカンダリ テキストに分かれています。これには、オートコンプリート入力の一致する部分文字列の配列が含まれます。オフセットと長さで識別され、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 |
タイプ:
Array<PredictionSubstring> 場所の説明の、ユーザー入力の要素と一致する部分文字列のセット。部分文字列をハイライト表示する場合に適しています。各部分文字列は、Unicode 文字で表されるオフセットと長さで識別されます。 |
terms |
タイプ:
Array<PredictionTerm> 上記の説明に含まれる個々の語句に関する情報。カテゴリ用語が最初に来ます(「レストラン」など)。住所の用語は、最も限定的なものから順に表示されます。例: 「港区」、「神奈川県」 |
place_id optional |
タイプ:
string optional 予測がプレイスの場合にのみ使用できます。Place Details サービスを使用して、この場所の詳細を取得するために使用できる場所 ID( PlacesService.getDetails を参照)。 |
PredictionTerm インターフェース
google.maps.places.PredictionTerm
インターフェース
予測語句を表します。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
offset |
タイプ:
number 場所の説明におけるこの語句の始まりのオフセット(Unicode 文字)。 |
value |
タイプ:
string このキーワードの値(「Taco Bell」など)。 |
PredictionSubstring インターフェース
google.maps.places.PredictionSubstring
インターフェース
予測部分文字列を表します。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
length |
タイプ:
number 部分文字列の長さ。 |
offset |
タイプ:
number description 文字列内での部分文字列の先頭へのオフセット。 |
StructuredFormatting インターフェース
google.maps.places.StructuredFormatting
インターフェース
場所の説明を構造化した情報です。メイン テキストとセカンダリ テキストに分かれており、オートコンプリート入力の一致する部分文字列の配列(オフセットと長さで識別)が Unicode 文字で表現されています。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
main_text |
タイプ:
string プレイス サービスが提案する場所の書式なし説明のメインのテキスト部分です。通常は場所の名前。 |
main_text_matched_substrings |
タイプ:
Array<PredictionSubstring> メインテキストの中で、ユーザーの入力要素に一致する部分文字列のセットで、部分文字列をハイライト表示する場合に適しています。各部分文字列は、Unicode 文字で表されるオフセットと長さで識別されます。 |
secondary_text |
タイプ:
string プレイス サービスが提案する場所の書式なし説明のセカンダリ テキストです。通常はその場所の場所です。 |