AutocompleteRequest インターフェース
google.maps.places.AutocompleteRequest
インターフェース
AutocompleteSuggestion.fetchAutocompleteSuggestions
のリクエスト インターフェース。
プロパティ | |
---|---|
input |
タイプ:
string 検索するテキスト文字列。 |
includedPrimaryTypes optional |
タイプ:
Array<string> optional メインの場所タイプ(「レストラン」、「ガソリン スタンド」など)が含まれている。 プレイスは、その主要なタイプがこのリストに含まれている場合にのみ返されます。最大 5 つの値を指定できます。タイプが指定されていない場合は、すべてのプレイスタイプが返されます。 |
includedRegionCodes optional |
タイプ:
Array<string> optional 指定した地域の結果のみを含めます。CLDR の 2 文字の地域コードを最大 15 個指定します。セットが空の場合、結果は制限されません。 locationRestriction と includedRegionCodes の両方を設定した場合、結果は交差点のエリアに配置されます。 |
inputOffset optional |
タイプ:
number optional input 内のカーソル位置を示す、input のゼロベースの Unicode 文字オフセット。カーソルの位置は、返される予測結果に影響を与える場合があります。指定しない場合、デフォルトで input の長さになります。 |
language optional |
タイプ:
string optional 結果を返す言語。ブラウザの言語設定がデフォルトで使用されます。 input で使用されている言語が language と異なる場合、または返されたプレイスにローカル言語から 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 2 文字の CLDR 地域コードとして指定された地域コード。これは、住所の形式や結果のランキングに影響するほか、返される結果にも影響する場合があります。指定したリージョンに結果が制限されることはありません。 |
sessionToken optional |
タイプ:
AutocompleteSessionToken optional 請求処理のために予測入力セッションを識別するトークン。 AutocompleteSessionToken で新しいセッション トークンを生成します。セッションはユーザーがクエリの入力を開始すると開始され、場所を選択して Place.fetchFields を呼び出すと終了します。各セッションには複数のクエリがあり、その後に 1 回の fetchFields 呼び出しが続きます。セッション内の各リクエストに使用される認証情報は、同じ Google Cloud コンソール プロジェクトに属している必要があります。セッションが終了するとトークンは無効になるため、アプリはセッションごとに新しいトークンを生成する必要があります。sessionToken パラメータを省略した場合、またはセッション トークンを再利用する場合は、セッション トークンが指定されていない場合と同様にセッションが課金されます(各リクエストは個別に課金されます)。次のガイドラインをおすすめします。
|
AutocompleteSessionToken クラス
google.maps.places.AutocompleteSessionToken
クラス
予測入力セッションのトラッキングに使用されるセッション トークンを表します。
const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
コンストラクタ | |
---|---|
AutocompleteSessionToken |
AutocompleteSessionToken() パラメータ: なし
AutocompleteSessionToken の新しいインスタンスを作成します。 |
AutocompleteSuggestion クラス
google.maps.places.AutocompleteSuggestion
クラス
予測入力の候補の結果。
const {AutocompleteSuggestion} = await google.maps.importLibrary("places")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
静的メソッド | |
---|---|
fetchAutocompleteSuggestions |
fetchAutocompleteSuggestions(autocompleteRequest) パラメータ:
戻り値:
Promise<{suggestions:Array<AutocompleteSuggestion>}> AutocompleteSuggestions のリストを取得します。 |
プロパティ | |
---|---|
placePrediction |
タイプ:
PlacePrediction optional 返された結果の、人が読める形式の名前が含まれます。ビジネスの確立の結果の場合は、通常、ビジネスの名前と住所になります。 |
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 は、プレイス 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 から、このプレイスに適用されるタイプのリスト。 |
メソッド | |
---|---|
toPlace |
toPlace() パラメータ: なし
戻り値:
Place この PlacePrediction のプレイス表現を返します。Place の詳細をすべて取得するには、その後の Place.fetchFields の呼び出しが必要です。 |
StringRange クラス
google.maps.places.StringRange
クラス
指定されたテキスト内の部分文字列を識別します。
const {StringRange} = await google.maps.importLibrary("places")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
endOffset |
タイプ:
number 部分文字列の最後の Unicode 文字のゼロベースのオフセット(この値を含まない)。 |
startOffset |
タイプ:
number 部分文字列の最初の Unicode 文字のゼロベースのオフセット(両端を含む)。 |
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 で書式設定されたテキスト。 |