AutocompleteSuggestion クラス
google.maps.places.AutocompleteSuggestion
クラス
予測入力候補の結果。
const {AutocompleteSuggestion} = await google.maps.importLibrary("places")
を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
静的メソッド | |
---|---|
fetchAutocompleteSuggestions |
fetchAutocompleteSuggestions(autocompleteRequest) パラメータ:
戻り値:
Promise<{suggestions:Array<AutocompleteSuggestion>}> AutocompleteSuggestion のリストを取得します。 リクエストで AutocompleteRequest.sessionToken が指定されている場合、Place.fetchFields を初めて呼び出すとき、結果の PlacePrediction s の PlacePrediction.toPlace によって返される各 Place で、そのセッション トークンが自動的に含まれます。 |
プロパティ | |
---|---|
placePrediction |
タイプ:
PlacePrediction optional 返された結果の人が読める形式の名前が含まれます。店舗の検索結果の場合、通常はビジネス名と住所です。 この AutocompleteSuggestion の取得に使用された AutocompleteRequest で AutocompleteRequest.sessionToken が指定されている場合、PlacePrediction.toPlace の呼び出しによって返された Place で Place.fetchFields を初めて呼び出すときに、同じトークンが自動的に含まれます。 |
AutocompleteRequest インターフェース
google.maps.places.AutocompleteRequest
インターフェース
AutocompleteSuggestion.fetchAutocompleteSuggestions
のリクエスト インターフェース。
プロパティ | |
---|---|
input |
タイプ:
string 検索するテキスト文字列。 |
includedPrimaryTypes optional |
タイプ:
Array<string> optional プライマリの場所タイプ(「restaurant」、「gas_station」など)が含まれます。 このリストに主要なタイプが含まれている場合にのみ、プレイスが返されます。最大 5 つの値を指定できます。タイプが指定されていない場合は、すべての Place タイプが返されます。 |
includedRegionCodes optional |
タイプ:
Array<string> optional 指定された地域の結果のみを含めます。最大 15 個の CLDR 2 文字の地域コードで指定します。空のセットは結果を制限しません。 locationRestriction と includedRegionCodes の両方が設定されている場合、結果は交差領域に配置されます。 |
inputOffset optional |
タイプ:
number optional input 内のカーソル位置を示す input の 0 から始まる Unicode 文字オフセット。カーソルの位置は、返される予測に影響する可能性があります。指定しない場合、デフォルトで input の長さになります。 |
language optional |
タイプ:
string optional 結果を返す言語。デフォルトではブラウザの言語設定が使用されます。 input で使用されている言語が language と異なる場合、または返された Place にローカル言語から language への翻訳がない場合、結果は複数の言語で表示されることがあります。 |
locationBias optional |
タイプ:
LocationBias optional 指定された場所を優先するよう結果にバイアスを設定します。 locationBias または locationRestriction のいずれか 1 つのみを設定する必要があります。どちらも設定されていない場合、結果は IP アドレスによってバイアスされます。つまり、IP アドレスが不正確な位置にマッピングされ、バイアス シグナルとして使用されます。 |
locationRestriction optional |
タイプ:
LocationRestriction optional 結果を特定の場所に制限します。 locationBias または locationRestriction のいずれか 1 つのみを設定する必要があります。どちらも設定されていない場合、結果は IP アドレスによってバイアスされます。つまり、IP アドレスが不正確な位置にマッピングされ、バイアス シグナルとして使用されます。 |
origin optional |
タイプ:
LatLng|LatLngLiteral optional 目的地点までの測地線距離を計算する出発地点( PlacePrediction.distanceMeters として返されます)。この値を省略すると、測地線距離は返されません。 |
region optional |
タイプ:
string optional 地域コード。CLDR の 2 文字の地域コードで指定します。これは、住所の形式、結果のランキングに影響し、返される結果に影響する可能性があります。これにより、結果が指定されたリージョンに制限されることはありません。 |
|