Places Widgets

PlaceAutocompleteElement クラス

google.maps.places.PlaceAutocompleteElement クラス

PlaceAutocompleteElement は、Places Autocomplete API の UI コンポーネントを提供する HTMLElement サブクラスです。

カスタム要素:
<gmp-place-autocomplete included-primary-types="type1 type2 type3..." included-region-codes="c1 c2 c3..." name="string" origin="lat,lng|lat,lng,altitude" requested-language="string" requested-region="string" unit-system="metric|imperial" types="type1 type2 type3..."></gmp-place-autocomplete>

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

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

const {PlaceAutocompleteElement} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
PlaceAutocompleteElement
PlaceAutocompleteElement(options)
パラメータ: 
AlphaincludedPrimaryTypes
タイプ:  Array<string> optional
プライマリの場所タイプ（「restaurant」、「gas_station」など）が含まれます。

このリストに主要なタイプが含まれている場合にのみ、プレイスが返されます。最大 5 つの値を指定できます。タイプが指定されていない場合は、すべての Place タイプが返されます。
HTML 属性:
  • <gmp-place-autocomplete included-primary-types="type1 type2 type3..."></gmp-place-autocomplete>
AlphaincludedRegionCodes
タイプ:  Array<string> optional
指定された地域の結果のみを含めます。最大 15 個の CLDR 2 文字の地域コードで指定します。空のセットは結果を制限しません。locationRestriction と includedRegionCodes の両方が設定されている場合、結果は交差領域に配置されます。
HTML 属性:
  • <gmp-place-autocomplete included-region-codes="c1 c2 c3..."></gmp-place-autocomplete>
locationBias
タイプ:  LocationBias optional
場所を検索するときに使用するソフト バウンダリまたはヒント。
locationRestriction
タイプ:  LocationRestriction optional
検索結果を制限する範囲。
name
タイプ:  string optional
入力要素に使用する名前。詳しくは、https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name をご覧ください。入力の name 属性と同じ動作をします。この名前は、フォームが送信されるときに使用されます。詳しくは、https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form をご覧ください。
HTML 属性:
  • <gmp-place-autocomplete name="string"></gmp-place-autocomplete>
Alphaorigin
距離の計算の起点。指定しない場合、距離は計算されません。高度が指定されていても、計算には使用されません。
HTML 属性:
  • <gmp-place-autocomplete origin="lat,lng|lat,lng,altitude"></gmp-place-autocomplete>
requestedLanguage
タイプ:  string optional
可能な場合、結果が返される言語の言語識別子。選択した言語の検索結果のランキングが高くなる可能性がありますが、候補は選択した言語に限定されません。サポートされている言語の一覧をご覧ください。
HTML 属性:
  • <gmp-place-autocomplete requested-language="string"></gmp-place-autocomplete>
requestedRegion
タイプ:  string optional
結果のフォーマットと結果のフィルタリングに使用される地域コード。この国に限定して候補が表示されるわけではありません。地域コードには、ccTLD（「トップレベル ドメイン」）の 2 文字の値を指定します。ほとんどの ccTLD コードは ISO 3166-1 コードと同一ですが、いくつか注意が必要な例外もあります。たとえば、英国の ccTLD は「uk」（.co.uk）ですが、ISO 3166-1 コードは「gb」（厳密には「グレートブリテンおよび北アイルランド連合王国」のエンティティ用）です。
HTML 属性:
  • <gmp-place-autocomplete requested-region="string"></gmp-place-autocomplete>
AlphaunitSystem
タイプ:  UnitSystem optional
距離の表示に使用される単位系。指定しない場合、単位系は requestedRegion によって決定されます。
HTML 属性:
  • <gmp-place-autocomplete unit-system="metric|imperial"></gmp-place-autocomplete>
BetacomponentRestrictions
タイプ:  ComponentRestrictions optional
コンポーネントの制限。コンポーネントの制限は、予測を親コンポーネント内の予測のみに制限するために使用されます。（国など）。
Betatypes
タイプ:  Array<string> optional
返される予測のタイプ。サポートされているタイプについては、 デベロッパー ガイドをご覧ください。タイプが指定されていない場合は、すべてのタイプが返されます。
HTML 属性:
  • <gmp-place-autocomplete types="type1 type2 type3..."></gmp-place-autocomplete>
prediction-item
1 つの予測を表す予測のプルダウンの項目。
prediction-item-icon
予測リスト内の各項目の左に表示されるアイコン。
prediction-item-main-text
予測のメインテキストである prediction-item の一部。地理的位置の場合、ここには、「札幌」のような地名や「北十条 4 丁目」のような所番地が含まれます。デフォルトでは、prediction-item-main-text は黒で表示されます。予測アイテムに追加のテキストがある場合、そのテキストは予測アイテムのメインテキスト以外となり、予測アイテムのスタイルを継承します。デフォルトでは色はグレーになります。この追加のテキストは通常、住所です。
prediction-item-match
返される予測のうち、ユーザーの入力に一致する部分。デフォルトでは、この一致するテキストは太字でハイライト表示されます。一致テキストは prediction-item 内の任意の場所に存在します。prediction-item-main-text の一部であるとは限りません。
prediction-item-selected
ユーザーがキーボードで移動したときの項目。注: 選択した項目は、この部分スタイルと予測アイテムの部分スタイルの両方の影響を受けます。
prediction-list
プレイスの Autocomplete サービスが返す予測のリストを含む視覚要素。このリストは、PlaceAutocompleteElement の下にプルダウン リストとして表示されます。
BetaaddEventListener
addEventListener(type, listener[, options])
パラメータ: 
  • type:  string リッスンするイベント タイプを表す大文字と小文字を区別する文字列。
  • listener:  EventListener|EventListenerObject 通知を受け取るオブジェクト。これは、handleEvent メソッドを持つ関数またはオブジェクトである必要があります
  • options:  boolean|AddEventListenerOptions optional オプションをご覧ください。カスタム イベントでサポートされるのは capture と passive のみです。
戻り値:  void
指定されたイベントがターゲットに配信されるたびに呼び出される関数を設定します。addEventListener をご覧ください。
BetaremoveEventListener
removeEventListener(type, listener[, options])
パラメータ: 
  • type:  string イベント リスナーを削除するイベントのタイプを指定する文字列。
  • listener:  EventListener|EventListenerObject イベント ターゲットから削除するイベント ハンドラのイベント リスナー。
  • options:  boolean|EventListenerOptions optional オプションをご覧ください。
戻り値:  void
addEventListener で以前に登録されたイベント リスナーをターゲットから削除します。removeEventListener をご覧ください。
gmp-error
function(errorEvent)
引数: 
このイベントは、バックエンドへのリクエストが拒否されたときに発生します（API キーが正しくない場合など）。このイベントはバブリングしません。
gmp-select
function(placePredictionSelectEvent)
引数: 
このイベントは、ユーザーが場所の候補を選択したときに発生します。Place オブジェクトに変換できる PlacePrediction オブジェクトが含まれます。
gmp-placeselect
function(placeAutocompletePlaceSelectEvent)
引数: 
このイベントは、ユーザーが場所の候補を選択したときに発生します。Place オブジェクトが含まれます。

PlaceAutocompleteElementOptions インターフェース

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

PlaceAutocompleteElement を構築するためのオプション。各プロパティの説明については、PlaceAutocompleteElement クラスの同じ名前のプロパティを参照してください。
BetacomponentRestrictions optional
タイプ:  ComponentRestrictions optional
AlphaincludedPrimaryTypes optional
タイプ:  Array<string> optional
AlphaincludedRegionCodes optional
タイプ:  Array<string> optional
locationBias optional
タイプ:  LocationBias optional
locationRestriction optional
タイプ:  LocationRestriction optional
name optional
タイプ:  string optional
Alphaorigin optional
requestedLanguage optional
タイプ:  string optional
Betatypes optional
タイプ:  Array<string> optional
AlphaunitSystem optional
タイプ:  UnitSystem optional

PlaceAutocompletePlaceSelectEvent クラス

google.maps.places.PlaceAutocompletePlaceSelectEvent クラス

このイベントは、ユーザーが Place Autocomplete Element で場所を選択した後に作成されます。event.place を使用して選択にアクセスします。

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

const {PlaceAutocompletePlaceSelectEvent} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
Betaplace
タイプ:  Place

PlacePredictionSelectEvent クラス

google.maps.places.PlacePredictionSelectEvent クラス

このイベントは、ユーザーが PlaceAutocompleteElement で候補アイテムを選択した後に作成されます。event.placePrediction を使用して選択にアクセスします。

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

const {PlacePredictionSelectEvent} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
placePrediction
タイプ:  PlacePrediction

PlaceAutocompleteRequestErrorEvent クラス

google.maps.places.PlaceAutocompleteRequestErrorEvent クラス

このイベントは、ネットワーク リクエストに問題がある場合に PlaceAutocompleteElement によって出力されます。

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

const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。

PlaceDetailsElement クラス

google.maps.places.PlaceDetailsElement クラス

場所の詳細を表示する HTML 要素。configureFromPlace() メソッドまたは configureFromLocation() メソッドを使用して、レンダリングするコンテンツを指定します。Place Details Element を使用するには、Google Cloud コンソールでプロジェクトの Places UI Kit API を有効にします。

カスタム要素:
<gmp-place-details size="small"></gmp-place-details>

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

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

const {PlaceDetailsElement} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
PlaceDetailsElement
PlaceDetailsElement([options])
パラメータ: 
place
タイプ:  Place optional
読み取り専用。現在レンダリングされている場所の ID、位置、ビューポートを含む Place オブジェクト。
size
タイプ:  PlaceDetailsSize optional
PlaceDetailsElement のサイズ バリエーション。デフォルトでは、要素に PlaceDetailsSize.X_LARGE が表示されます。
HTML 属性:
  • <gmp-place-details size="small"></gmp-place-details>
  • <gmp-place-details size="medium"></gmp-place-details>
  • <gmp-place-details size="large"></gmp-place-details>
  • <gmp-place-details size="x-large"></gmp-place-details>
BetaaddEventListener
addEventListener(type, listener[, options])
パラメータ: 
  • type:  string リッスンするイベント タイプを表す大文字と小文字を区別する文字列。
  • listener:  EventListener|EventListenerObject 通知を受け取るオブジェクト。これは、handleEvent メソッドを持つ関数またはオブジェクトである必要があります
  • options:  boolean|AddEventListenerOptions optional オプションをご覧ください。カスタム イベントでサポートされるのは capture と passive のみです。
戻り値:  void
指定されたイベントがターゲットに配信されるたびに呼び出される関数を設定します。addEventListener をご覧ください。
configureFromLocation
configureFromLocation(location)
パラメータ: 
戻り値:  Promise<void> 場所データが読み込まれてレンダリングされると解決される Promise。
リバース ジオコーディングを使用して LatLng からウィジェットを構成します。
configureFromPlace
configureFromPlace(place)
パラメータ: 
  • place:  Place|{id:string} 詳細を表示する場所。
戻り値:  Promise<void> 場所データが読み込まれてレンダリングされると解決される Promise。
Place オブジェクトまたはプレイス ID からウィジェットを構成します。
BetaremoveEventListener
removeEventListener(type, listener[, options])
パラメータ: 
  • type:  string イベント リスナーを削除するイベントのタイプを指定する文字列。
  • listener:  EventListener|EventListenerObject イベント ターゲットから削除するイベント ハンドラのイベント リスナー。
  • options:  boolean|EventListenerOptions optional オプションをご覧ください。
戻り値:  void
addEventListener で以前に登録されたイベント リスナーをターゲットから削除します。removeEventListener をご覧ください。
gmp-load
function(event)
引数: 
このイベントは、要素が読み込まれてコンテンツがレンダリングされると発生します。このイベントはバブリングしません。
gmp-requesterror
function(event)
引数: 
このイベントは、バックエンドへのリクエストが拒否されたときに発生します（API キーが正しくない場合など）。このイベントはバブリングしません。

PlaceDetailsElementOptions インターフェース

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

PlaceDetailsElement のオプション。
size optional
タイプ:  PlaceDetailsSize optional
PlaceDetailsElement.sizeを見る

PlaceDetailsSize 定数

google.maps.places.PlaceDetailsSize 定数

PlaceDetailsElement のサイズ バリエーション。

const {PlaceDetailsSize} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
LARGE 大きな画像、基本情報、連絡先情報を含む大きなバリエーション。
MEDIUM 大きな画像と基本情報を含む中サイズのバリエーション。
SMALL 小さな画像と基本情報を含む小さなバリエーション。
X_LARGE 写真のコラージュ、レビュー、場所に関する包括的な情報を含む特大バリエーション。

PlaceListElement クラス

google.maps.places.PlaceListElement クラス

場所検索の結果をリストで表示する HTML 要素。configureFromSearchByTextRequest() メソッドまたは configureFromSearchNearbyRequest() メソッドを使用して、結果をレンダリングするリクエストを指定します。プレイス リスト要素を使用するには、Google Cloud コンソールでプロジェクトの Places UI Kit API を有効にします。

カスタム要素:
<gmp-place-list selectable></gmp-place-list>

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

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

const {PlaceListElement} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
PlaceListElement
PlaceListElement([options])
パラメータ: 
places
タイプ:  Array<Place>
読み取り専用。現在レンダリングされている場所の ID、位置、ビューポートを含む Place オブジェクトの配列。
selectable
タイプ:  boolean
リスト項目が選択可能かどうか。true の場合、リストアイテムはクリック時に gmp-placeselect イベントをディスパッチするボタンになります。キーボードによるナビゲーションと選択もサポートされています。
HTML 属性:
  • <gmp-place-list selectable></gmp-place-list>
BetaaddEventListener
addEventListener(type, listener[, options])
パラメータ: 
  • type:  string リッスンするイベント タイプを表す大文字と小文字を区別する文字列。
  • listener:  EventListener|EventListenerObject 通知を受け取るオブジェクト。これは、handleEvent メソッドを持つ関数またはオブジェクトである必要があります
  • options:  boolean|AddEventListenerOptions optional オプションをご覧ください。カスタム イベントでサポートされるのは capture と passive のみです。
戻り値:  void
指定されたイベントがターゲットに配信されるたびに呼び出される関数を設定します。addEventListener をご覧ください。
configureFromSearchByTextRequest
configureFromSearchByTextRequest(request)
パラメータ: 
  • request:  SearchByTextRequest 結果をレンダリングするリクエスト。SearchByTextRequest の fields プロパティは必須ではありません。
戻り値:  Promise<void> 場所データが読み込まれてレンダリングされると解決される Promise。
Places Text Search API リクエストの検索結果をレンダリングするようにウィジェットを構成します。
configureFromSearchNearbyRequest
configureFromSearchNearbyRequest(request)
パラメータ: 
  • request:  SearchNearbyRequest 結果をレンダリングするリクエスト。SearchNearbyRequest の fields プロパティは必須ではありません。
戻り値:  Promise<void> 場所データが読み込まれてレンダリングされると解決される Promise。
Places Nearby Search API リクエストの検索結果をレンダリングするようにウィジェットを構成します。
BetaremoveEventListener
removeEventListener(type, listener[, options])
パラメータ: 
  • type:  string イベント リスナーを削除するイベントのタイプを指定する文字列。
  • listener:  EventListener|EventListenerObject イベント ターゲットから削除するイベント ハンドラのイベント リスナー。
  • options:  boolean|EventListenerOptions optional オプションをご覧ください。
戻り値:  void
addEventListener で以前に登録されたイベント リスナーをターゲットから削除します。removeEventListener をご覧ください。
gmp-load
function(event)
引数: 
このイベントは、要素が読み込まれてコンテンツがレンダリングされると発生します。このイベントはバブリングしません。
gmp-placeselect
function(event)
引数: 
このイベントは、ユーザーが場所を選択したときに発生します。Place オブジェクトと、リスト内で選択された場所のインデックスが含まれます。
gmp-requesterror
function(event)
引数: 
このイベントは、バックエンドへのリクエストが拒否されたときに発生します（API キーが正しくない場合など）。このイベントはバブリングしません。

PlaceListElementOptions インターフェース

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

PlaceListElement のオプション。
selectable optional
タイプ:  boolean optional
PlaceListElement.selectableを見る

PlaceListPlaceSelectEvent クラス

google.maps.places.PlaceListPlaceSelectEvent クラス

このイベントは、ユーザーが場所を選択したときに PlaceListElement によって発行されます。

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

const {PlaceListPlaceSelectEvent} = await google.maps.importLibrary("places") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
index
タイプ:  number
選択した場所のリスト インデックス。
place
タイプ:  Place
選択された場所の ID、場所、ビューポートを含む Place オブジェクト。

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
詳細が正常に取得されたときに、詳細レスポンスに含める場所のフィールドを返します。フィールドの一覧については、PlaceResult をご覧ください。
getPlace
getPlace()
パラメータ: なし
戻り値:  PlaceResult ユーザーが選択した Place。
詳細が正常に取得された場合は、ユーザーが選択した場所の詳細を返します。それ以外の場合は、name プロパティが入力フィールドの現在の値に設定されたスタブ Place オブジェクトを返します。
setBounds
setBounds(bounds)
パラメータ: 
戻り値: なし
プレイスの結果を返す優先エリアを設定します。このエリアが優先されますが、このエリアに限定されません。
setComponentRestrictions
setComponentRestrictions(restrictions)
パラメータ: 
戻り値: なし
コンポーネントの制限を設定します。コンポーネントの制限は、予測を親コンポーネント内の予測のみに制限するために使用されます。（国など）。
setFields
setFields(fields)
パラメータ: 
  • fields:  Array<string> optional
戻り値: なし
詳細が正常に取得されたときに、詳細レスポンスで Place に含めるフィールドを設定します。フィールドの一覧については、PlaceResult をご覧ください。
setOptions
setOptions(options)
パラメータ: 
戻り値: なし
setTypes
setTypes(types)
パラメータ: 
  • types:  Array<string> optional 含める予測のタイプ。
戻り値: なし
返される予測のタイプを設定します。サポートされているタイプについては、 デベロッパー ガイドをご覧ください。タイプが指定されていない場合は、すべてのタイプが返されます。
継承: 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、types、name のフィールドのみが含まれます。place_id、types、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)
パラメータ: 
戻り値: なし
クエリ予測のバイアスに使用するリージョンを設定します。検索結果は、このエリアにバイアスがかかりますが、完全に制限されるわけではありません。
継承: addListener、 bindTo、 get、 notify、 set、 setValues、 unbind、 unbindAll
places_changed
function()
引数: なし
このイベントは、ユーザーがクエリを選択したときに発生します。新しい場所を取得するには、getPlaces を使用する必要があります。

SearchBoxOptions インターフェース

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

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