AutocompleteRequest インターフェース
google.maps.places.AutocompleteRequest
インターフェース
AutocompleteSuggestion.fetchAutocompleteSuggestions
のリクエスト インターフェース。
プロパティ | |
---|---|
input |
タイプ:
string 検索するテキスト文字列。 |
includedPrimaryTypes optional |
タイプ:
Array<string> optional プライマリ 場所のタイプが含まれている(「レストラン」や「ガソリンスタンド」など)。 プレイスは、その主なタイプがこのリストに含まれている場合にのみ返されます。最大 5 つの値を指定できます。タイプを指定しない場合は、すべての場所のタイプが返されます。 |
includedRegionCodes optional |
タイプ:
Array<string> optional 指定した地域の結果のみを表示します。指定は、最大 15 個の CLDR 2 文字の地域コードで指定します。空のセットは結果を制限しません。 locationRestriction と includedRegionCodes の両方が設定されている場合、結果は交差領域に配置されます。 |
inputOffset optional |
タイプ:
number optional input 内のカーソル位置を示す 0 ベースの Unicode 文字オフセット input 。カーソルの位置は、返される予測に影響する可能性があります。指定しない場合、デフォルトは 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 地域コード(CLDR の 2 文字の地域コードで指定)。これは住所のフォーマット、結果のランキングに影響し、返される結果にも影響する可能性があります。指定したリージョンに結果が制限されることはありません。 |
sessionToken optional |
タイプ:
AutocompleteSessionToken optional 請求目的で Autocomplete セッションを識別するトークン。 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 文字の 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 でフォーマットできるテキスト。 |