Places Widgets

PlaceAutocompleteElement クラス

google.maps.places.PlaceAutocompleteElement クラス

Places API の AutocompleteView の実装

このクラスは PlaceAutocompleteElementOptions を実装します。

const {PlaceAutocompleteElement} = await google.maps.importLibrary("places") を呼び出してアクセスします。詳しくは、Maps JavaScript API のライブラリをご覧ください。
PlaceAutocompleteElement
PlaceAutocompleteElement(options)
パラメータ: 
element optional
タイプ:  HTMLElement|SVGElement optional
このフィールドは読み取り専用です。ビューの背後の DOM 要素。
inputElement
タイプ:  HTMLInputElement
オートコンプリートを表示する入力要素。
継承済み: componentRestrictions、 locationBias、locationRestriction、 requestedLanguage、requestedRegion、 types
addListener
addListener(eventName, handler)
パラメータ: 
  • eventName:  string
  • handler:  Function
戻り値:  MapsEventListener
指定されたリスナー関数を指定されたイベント名に追加します。
gmp-placeselect
function(place)
引数: 
ユーザーが場所の予測を選択すると、このイベントは発生します。プレイス オブジェクトを返します。
gmp-requesterror
function()
引数: なし
バックエンドに対するリクエストが拒否された場合（誤った API キーがある場合など）にこのイベントが発生します。このイベントはバブルではありません。

PlaceAutocompleteElementOptions インターフェース

google.maps.places.PlaceAutocompleteElementOptions インターフェース

PlaceAutocompleteElement の作成オプション。
inputElement
タイプ:  HTMLInputElement
オートコンプリートを表示する入力要素。
componentRestrictions optional
タイプ:  ComponentRestrictions optional
コンポーネントの制限コンポーネント制限は、予測を親コンポーネント内の予測のみに制限する場合に使用します。例: 国。
element optional
タイプ:  HTMLElement|SVGElement optional
このフィールドは読み取り専用です。ビューの背後の DOM 要素。
locationBias optional
タイプ:  LocationBias optional
場所を検索するときに使用する境界線やヒント。
locationRestriction optional
タイプ:  LocationRestriction optional
検索結果を制限する境界。
requestedLanguage optional
タイプ:  string optional
可能であれば、結果を返す言語の言語識別子。選択した言語の検索結果は上位に表示される場合がありますが、候補はこの言語に限定されません。サポートされている言語の一覧をご覧ください。
requestedRegion optional
タイプ:  string optional
結果の形式と結果のフィルタリングに使用される地域コード。この場合、候補がこの国に限定されません。地域コードは ccTLD（「トップレベル ドメイン」）の 2 文字の値を受け付けます。ほとんどの ccTLD コードは ISO 3166-1 コードと同一ですが、いくつか注意が必要な例外もあります。たとえば、英国の ccTLD は「uk」（.co.uk）ですが、ISO 3166-1 コードは「gb」（厳密にはイギリスと北アイルランドのエンティティ）です。
types optional
タイプ:  Array<string> optional
返される予測のタイプ。サポートされているタイプについては、 デベロッパー ガイドをご覧ください。型が指定されていない場合、すべての型が返されます。

Autocomplete クラス

google.maps.places.Autocomplete クラス

ユーザーのテキスト入力に基づいて場所の予測を提供するウィジェット。text 型の入力要素にアタッチされ、そのフィールドのテキスト入力をリッスンします。予測のリストはプルダウン リストとして表示され、テキストを入力すると更新されます。

このクラスは MVCObject を拡張します。

const {Autocomplete} = await google.maps.importLibrary("places") を呼び出してアクセスします。詳しくは、Maps JavaScript API のライブラリをご覧ください。
Autocomplete
Autocomplete(inputField[, opts])
パラメータ: 
指定されたオプションを使用して、指定された入力テキスト フィールドに接続する Autocomplete の新しいインスタンスを作成します。
getBounds
getBounds()
パラメータ: なし
戻り値:  LatLngBounds|undefined バイアスの範囲。
予測がバイアスされる境界を返します。
getFields
getFields()
パラメータ: なし
戻り値:  Array<string>|undefined
詳細の取得に成功したときに、詳細レスポンスに Place に含まれるフィールドを返します。フィールドの一覧については、PlaceResult をご覧ください。
getPlace
getPlace()
パラメータ: なし
戻り値:  PlaceResult ユーザーが選択した場所。
場所が正常に取得された場合に、ユーザーが選択した場所の詳細を返します。それ以外の場合は、name プロパティが入力フィールドの現在の値に設定されたスタブ Place オブジェクトを返します。
setBounds
setBounds(bounds)
パラメータ: 
戻り値: None
プレイス結果を返す優先領域を設定します。この地域では、この地域に関する情報は優先的に表示されますが、これに限定されません。
setComponentRestrictions
setComponentRestrictions(restrictions)
パラメータ: 
戻り値: None
コンポーネントの制限を設定します。コンポーネント制限は、予測を親コンポーネント内の予測のみに制限する場合に使用します。例: 国。
setFields
setFields(fields)
パラメータ: 
  • fields:  Array<string> optional
戻り値: None
詳細の取得が成功したときに、詳細レスポンスにそのプレイスを含めるフィールドを設定します。フィールドの一覧については、PlaceResult をご覧ください。
setOptions
setOptions(options)
パラメータ: 
戻り値: None
setTypes
setTypes(types)
パラメータ: 
  • types:  Array<string> optional 含める予測のタイプ。
戻り値: None
返される予測のタイプを設定します。サポートされているタイプについては、 デベロッパー ガイドをご覧ください。型が指定されていない場合、すべての型が返されます。
継承済み: addListener、 bindTo、 get、 notify、set、setValues、unbind、 unbindAll
place_changed
function()
引数: なし
ユーザーが選択したプレイスに対して PlaceResult が利用可能になると、このイベントは発生します。
ユーザーがコントロールによって提案されていない場所の名前を入力して Enter キーを押すか、Place Details リクエストが失敗した場合、PlaceResult には name プロパティへのユーザー入力が含まれ、他のプロパティは定義されません。

AutocompleteOptions インターフェース

google.maps.places.AutocompleteOptions インターフェース

Autocomplete オブジェクトに設定できるオプション。
bounds optional
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
場所を検索する領域です。
componentRestrictions optional
タイプ:  ComponentRestrictions optional
コンポーネントの制限コンポーネント制限は、予測を親コンポーネント内の予測のみに制限する場合に使用します。例: 国。
fields optional
タイプ:  Array<string> optional
詳細が正常に取得されたときに、詳細レスポンスに Place に追加するフィールド（課金対象）。['ALL'] が渡されると、使用可能なすべてのフィールドが返され、課金されます（本番環境のデプロイでは推奨されません）。フィールドの一覧については、PlaceResult をご覧ください。ネストされたフィールドはドットパスで指定できます（例: "geometry.location"）。デフォルトは ['ALL'] です。
placeIdOnly optional
タイプ:  boolean optional
プレイス ID のみを取得するかどうかを指定します。place_changed イベントが発生したときに利用できる PlaceResult は、place_id、type、name のフィールドのみです。place_id、type、description は Autocomplete サービスから返されます。デフォルトでは無効にされています。
strictBounds optional
タイプ:  boolean optional
クエリが送信された時点で Autocomplete ウィジェットが Autocomplete ウィジェットの境界内にある場所のみを返すことを示すブール値です。strictBounds を false（デフォルト）に設定すると、境界内に含まれる場所が優先されますが、これに限定されません。
types optional
タイプ:  Array<string> optional
返される予測のタイプ。サポートされているタイプについては、 デベロッパー ガイドをご覧ください。型が指定されていない場合、すべての型が返されます。

google.maps.places.SearchBox クラス

ユーザーのテキスト入力に基づいてクエリの予測を提供するウィジェット。text 型の入力要素にアタッチされ、そのフィールドのテキスト入力をリッスンします。予測のリストはプルダウン リストとして表示され、テキストを入力すると更新されます。

このクラスは MVCObject を拡張します。

const {SearchBox} = await google.maps.importLibrary("places") を呼び出してアクセスします。詳しくは、Maps JavaScript API のライブラリをご覧ください。
SearchBox
SearchBox(inputField[, opts])
パラメータ: 
指定されたオプションを使用して、指定された入力テキスト フィールドに接続する SearchBox の新しいインスタンスを作成します。
getBounds
getBounds()
パラメータ: なし
戻り値:  LatLngBounds|undefined
クエリ予測がバイアスされる境界を返します。
getPlaces
getPlaces()
パラメータ: なし
戻り値:  Array<PlaceResult>|undefined
places_changed イベントで使用するためにユーザーが選択したクエリを返します。
setBounds
setBounds(bounds)
パラメータ: 
戻り値: None
クエリ予測のバイアスに使用するリージョンを設定します。検索結果はこのエリアのみにバイアスされ、完全に限定されるわけではありません。
継承済み: addListener、 bindTo、 get、 notify、set、setValues、unbind、 unbindAll
places_changed
function()
引数: なし
このイベントは、ユーザーがクエリを選択したときに発生します。getPlaces を使用して新しい場所を取得する必要があります。

SearchBoxOptions インターフェース

google.maps.places.SearchBoxOptions インターフェース

SearchBox オブジェクトに設定できるオプション。
bounds optional
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
クエリ予測にバイアスをかける領域。予測は、これらの境界をターゲットとするクエリを優先しますが、これに限定されません。