Autocomplete Data (new)

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 を初めて呼び出すとき、結果の PlacePredictions の 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 文字の地域コードで指定します。これは、住所の形式、結果のランキングに影響し、返される結果に影響する可能性があります。これにより、結果が指定されたリージョンに制限されることはありません。
sessionToken optional
タイプ:  AutocompleteSessionToken optional
請求処理のために Autocomplete セッションを識別するトークン。AutocompleteSessionToken を介して新しいセッション トークンを生成します。

セッションは、ユーザーが検索語句を入力し始めたときに開始され、ユーザーが場所を選択して Place.fetchFields を呼び出すと終了します。セッションによっては、複数の検索語句が入力された後に、1 つの fetchFields 呼び出しが行われる場合もあります。セッション内の各リクエストで使用される認証情報は、同じ Google Cloud コンソール プロジェクトに属している必要があります。セッションが終了すると、トークンは無効になります。アプリでは、セッションごとに新しいトークンを生成する必要があります。sessionToken パラメータを省略する場合や、セッション トークンを再利用する場合は、セッション トークンが指定されていない場合と同様にセッションが課金されます（各リクエストが個別に課金されます）。

AutocompleteSuggestion.fetchAutocompleteSuggestions へのリクエストでセッション トークンが指定されている場合、同じトークンが、結果の AutocompleteSuggestion のいずれかで PlacePrediction.toPlace を呼び出して返された Place の最初の fetchFields 呼び出しに自動的に含まれます。

次のガイドラインに従うことをおすすめします。
  • すべての Place Autocomplete 呼び出しにセッション トークンを使用します。
  • セッションごとに新しいトークンを生成します。
  • 新しいセッションごとに固有のセッション トークンを渡すようにしてください。複数のセッションで同じトークンを使用すると、リクエストごとに課金されます。

AutocompleteSessionToken クラス

google.maps.places.AutocompleteSessionToken クラス

予測入力セッションのトラッキングに使用されるセッション トークンを表します。

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

PlacePrediction クラス

google.maps.places.PlacePrediction クラス

Place Autocomplete の予測の予測結果。

const {PlacePrediction} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
distanceMeters
タイプ:  number optional
origin が指定されている場合、origin からの測地線の長さ（メートル単位）。
mainText
タイプ:  FormattableText optional
プレイスの名前を表します。
placeId
タイプ:  string
提案されたプレイスの一意の識別子。この識別子は、プレイス ID を受け入れる他の API で使用できます。
secondaryText
タイプ:  FormattableText optional
プレイスをさらに識別するための追加の曖昧さ回避機能（都市や地域など）を表します。
text
タイプ:  FormattableText
返された結果の人が読める形式の名前が含まれます。店舗の検索結果の場合、通常はビジネス名と住所です。

text は、単一の UI 要素を表示したいデベロッパーにおすすめです。関連する 2 つの UI 要素を別々に表示したい場合は、代わりに PlacePrediction.mainText と PlacePrediction.secondaryText を使用することをおすすめします。
types
タイプ:  Array<string>
https://developers.google.com/maps/documentation/places/web-service/place-types の表 A または表 B に記載されている、このプレイスに適用されるタイプのリスト。
BetafetchAddressValidation
fetchAddressValidation(request)
パラメータ: 
戻り値:  Promise<AddressValidation>
この予測入力セッションに関連付けられた Address Validation リクエストを送信します（内部で、予測入力セッション トークンを使用してリクエストを入力します）。PlacePrediction の場所情報は自動的に含まれません。これは、予測入力セッションの管理に役立つ便利なメソッドです。
toPlace
toPlace()
パラメータ: なし
戻り値:  Place
この PlacePrediction の Place 表現を返します。完全な Place の詳細を取得するには、後続の Place.fetchFields の呼び出しが必要です。

この PlacePrediction の取得に使用された AutocompleteRequest で AutocompleteRequest.sessionToken が指定されている場合、fetchFields の呼び出し時に同じトークンが自動的に含まれます。

または、PlaceAutocompleteElement を使用する場合、PlacePrediction.toPlace によって返された Place で Place.fetchFields を最初に呼び出すと、セッション トークンが自動的に含まれます。

StringRange クラス

google.maps.places.StringRange クラス

指定されたテキスト内の部分文字列を識別します。

const {StringRange} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
endOffset
タイプ:  number
部分文字列の最後の Unicode 文字の 0 ベースのオフセット（この値は含まれない）。
startOffset
タイプ:  number
部分文字列の最初の Unicode 文字の 0 から始まるオフセット（この値は含まれる）。

FormattableText クラス

google.maps.places.FormattableText クラス

場所の予測を表すテキスト。テキストはそのまま使用することも、書式設定することもできます。

const {FormattableText} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
matches
タイプ:  Array<StringRange>
入力リクエストが FormattableText.text のどこで一致したかを識別する文字列範囲のリスト。範囲を使用して、text の特定の部分をフォーマットできます。文字列の一致以外の条件（スペル修正や音訳など）で一致が判断された場合、部分文字列は AutocompleteRequest.input と完全一致しないことがあります。これらの値は、FormattableText.text の Unicode 文字オフセットです。範囲は、オフセット値の昇順で並べ替えられます。
text
タイプ:  string
そのまま使用するか、FormattableText.matches でフォーマットできるテキスト。