Autocomplete Data

AutocompleteSuggestion クラス

google.maps.places.AutocompleteSuggestion クラス
ライブラリ "places"

予測入力の候補の結果。

const {AutocompleteSuggestion} = await google.maps.importLibrary("places");

静的メソッド
fetchAutocompleteSuggestions	fetchAutocompleteSuggestions(autocompleteRequest) パラメータ: autocompleteRequest: AutocompleteRequest 戻り値: Promise<{suggestions:Array<AutocompleteSuggestion>}> AutocompleteSuggestions のリストを取得します。 リクエストで AutocompleteRequest.sessionToken が指定されている場合、そのセッション トークンは、結果の PlacePrediction で PlacePrediction.toPlace によって返される各 Place で、Place.fetchFields を初めて呼び出すときに自動的に含まれます。

プロパティ
placePrediction readonly	タイプ: PlacePrediction optional 返された結果の人が読める形式の名前が含まれます。施設の結果の場合、通常はビジネスの名前と住所です。 この AutocompleteSuggestion の取得に使用された AutocompleteRequest で AutocompleteRequest.sessionToken が指定されていた場合、PlacePrediction.toPlace の呼び出しによって返された Place で初めて Place.fetchFields を呼び出すときに、同じトークンが自動的に含まれます。

AutocompleteRequest インターフェース

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

AutocompleteSuggestion.fetchAutocompleteSuggestions のリクエスト インターフェース。

プロパティ
input	タイプ: string 検索するテキスト文字列。
futureOpeningBusinessesIncluded 省略可	タイプ: boolean optional まだ開業していないが、将来開業する予定のビジネスの場所の予測を含めます。
includedPrimaryTypes 省略可	タイプ: Array<string> optional 含まれるプライマリ Place タイプ（「restaurant」や「gas_station」など）。 場所は、そのメインタイプがこのリストに含まれている場合にのみ返されます。最大 5 つの値を指定できます。タイプが指定されていない場合は、すべてのプレイスタイプが返されます。
includedRegionCodes 省略可	タイプ: Array<string> optional 指定されたリージョンの結果のみを含めます。最大 15 個の CLDR 2 文字のリージョン コードで指定します。空のセットを指定すると、結果は制限されません。locationRestriction と includedRegionCodes の両方が設定されている場合、結果は交差するエリアに配置されます。
inputOffset 省略可	タイプ: number optional input のカーソル位置を示す input のゼロベースの Unicode 文字オフセット。カーソルの位置は、返される予測に影響する可能性があります。指定しない場合、デフォルトで input の長さになります。
language 省略可	タイプ: string optional 結果を返す言語。デフォルトでは、ブラウザの言語設定が使用されます。input で使用されている言語が language と異なる場合や、返された Place に現地語から language への翻訳がない場合は、結果に複数の言語が混在することがあります。
locationBias 省略可	タイプ: LocationBias optional 指定した場所を優先するよう結果にバイアスを設定します。 locationBias または locationRestriction のいずれか 1 つのみを設定する必要があります。どちらも設定されていない場合、結果は IP アドレスによってバイアスされます。つまり、IP アドレスは不正確な位置にマッピングされ、バイアス信号として使用されます。
locationRestriction 省略可	タイプ: LocationRestriction optional 結果を指定したロケーションに制限します。 locationBias または locationRestriction のいずれか 1 つのみを設定する必要があります。どちらも設定されていない場合、結果は IP アドレスによってバイアスされます。つまり、IP アドレスは不正確な位置にマッピングされ、バイアス信号として使用されます。
origin 省略可	タイプ: LatLng|LatLngLiteral optional 目的地点までの測地線距離を計算する出発地点（PlacePrediction.distanceMeters として返されます）。この値を省略すると、測地線距離は返されません。
pureServiceAreaBusinessesIncluded 省略可	タイプ: boolean optional フィールドが true に設定されている場合は、非店舗型ビジネスのみを含めます。非店舗型ビジネスとは、客先に出向いてサービスや商品を提供し、ビジネス拠点の住所では接客しないビジネスです。たとえば、清掃サービスや配管工事などのビジネスは、Google マップに住所や所在地が掲載されていない場合があります。
region 省略可	タイプ: string optional 地域コード。CLDR の 2 文字の地域コードで指定します。これは、住所の形式、結果のランキングに影響し、返される結果に影響する可能性があります。これにより、結果が指定したリージョンに制限されることはありません。
sessionToken 省略可	タイプ: AutocompleteSessionToken optional 請求処理のために予測入力セッションを識別するトークン。AutocompleteSessionToken を介して新しいセッション トークンを生成します。 セッションは、ユーザーが検索語句を入力し始めたときに開始され、ユーザーが場所を選択して Place.fetchFields を呼び出すと終了します。セッションによっては、複数の検索語句が入力された後に、1 つの fetchFields 呼び出しが行われる場合もあります。セッション内の各リクエストに使用される認証情報は、同じ Google Cloud コンソール プロジェクトに属している必要があります。セッションが終了すると、トークンは無効になります。アプリでは、セッションごとに新しいトークンを生成する必要があります。sessionToken パラメータを省略する場合や、セッション トークンを再利用する場合は、セッション トークンが指定されていない場合と同様にセッションが課金されます（各リクエストが個別に課金されます）。 AutocompleteSuggestion.fetchAutocompleteSuggestions へのリクエストでセッション トークンが指定されている場合、結果の AutocompleteSuggestion のいずれかで PlacePrediction.toPlace を呼び出すことで返される Place で fetchFields を最初に呼び出すときに、同じトークンが自動的に含まれます。 次のガイドラインに従うことをおすすめします。 すべての Place Autocomplete 呼び出しにセッション トークンを使用します。 セッションごとに新しいトークンを生成します。 新しいセッションごとに固有のセッション トークンを渡すようにしてください。複数のセッションで同じトークンを使用すると、リクエストごとに課金されます。

AutocompleteSessionToken クラス

google.maps.places.AutocompleteSessionToken クラス
ライブラリ "places"

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

const {AutocompleteSessionToken} = await google.maps.importLibrary("places");

コンストラクタ
AutocompleteSessionToken	AutocompleteSessionToken() パラメータ: なし AutocompleteSessionToken の新しいインスタンスを作成します。

PlacePrediction クラス

google.maps.places.PlacePrediction クラス
ライブラリ "places"

Place Autocomplete の予測入力候補。

const {PlacePrediction} = await google.maps.importLibrary("places");

プロパティ
distanceMeters readonly	タイプ: number optional origin が指定されている場合、origin からの測地線の長さ（メートル単位）。
mainText readonly	タイプ: FormattableText optional 場所の名前を表します。
placeId readonly	タイプ: string 提案された場所の固有識別子。この識別子は、プレイス ID を受け入れる他の API で使用できます。
secondaryText readonly	タイプ: FormattableText optional 場所をさらに識別するための追加の曖昧性除去機能（都市や地域など）を表します。
text readonly	タイプ: FormattableText 返された結果の人が読める形式の名前が含まれます。施設の結果の場合、通常はビジネスの名前と住所です。 text は、単一の UI 要素を表示するデベロッパーにおすすめです。2 つの別々の、しかし関連する UI 要素を表示したいデベロッパーは、代わりに PlacePrediction.mainText と PlacePrediction.secondaryText を使用することをおすすめします。
types readonly	タイプ: Array<string> https://developers.google.com/maps/documentation/places/web-service/place-types の表 A または表 B に記載されている、この場所に適用されるタイプのリスト。

メソッド
fetchAddressValidation	注: v=Beta チャンネルでのみ利用できます。 fetchAddressValidation(request) パラメータ: request: AddressValidationRequest 戻り値: Promise<AddressValidation> この予測入力セッションに関連付けられた Address Validation リクエストを送信します（内部でリクエストに予測入力セッション トークンが入力されます）。PlacePrediction の場所情報は自動的に含まれません。これは、予測入力セッションの管理に役立つ便利なメソッドです。
toPlace	toPlace() パラメータ: なし 戻り値: Place この PlacePrediction の Place 表現を返します。場所の詳細をすべて取得するには、Place.fetchFields を呼び出す必要があります。 この PlacePrediction の取得に使用された AutocompleteRequest で AutocompleteRequest.sessionToken が指定されていた場合、fetchFields の呼び出し時に同じトークンが自動的に含まれます。 または、PlaceAutocompleteElement を使用する場合、PlacePrediction.toPlace によって返された Place で Place.fetchFields を最初に呼び出すと、セッション トークンが自動的に含まれます。

StringRange クラス

google.maps.places.StringRange クラス
ライブラリ "places"

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

const {StringRange} = await google.maps.importLibrary("places");

プロパティ
endOffset readonly	タイプ: number 部分文字列の最後の Unicode 文字の 0 ベースのオフセット（この値は含まれない）。
startOffset readonly	タイプ: number 部分文字列の最初の Unicode 文字のゼロベースのオフセット（この値を含む）。

FormattableText クラス

google.maps.places.FormattableText クラス
ライブラリ "places"

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

const {FormattableText} = await google.maps.importLibrary("places");

プロパティ
matches readonly	タイプ: Array<StringRange> FormattableText.text で入力リクエストが一致した場所を識別する文字列範囲のリスト。範囲を使用して、text の特定の部分をフォーマットできます。文字列の一致以外の条件（スペル修正や文字変換など）によって一致が判断された場合、部分文字列は AutocompleteRequest.input と完全一致しない可能性があります。これらの値は FormattableText.text の Unicode 文字オフセットです。範囲は、オフセット値の昇順で並べ替えられます。
text readonly	タイプ: string そのまま使用するか、FormattableText.matches でフォーマットするテキスト。