AutocompleteService-Klasse
google.maps.places.AutocompleteService
Klasse
Enthält Methoden zum Abrufen von Autocomplete-Vervollständigungen.
Zugriff durch Anrufen von const {AutocompleteService} = await google.maps.importLibrary("places")
.
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.
Konstruktor | |
---|---|
AutocompleteService |
AutocompleteService() Parameter:Keine
Erstellt eine neue Instanz von AutocompleteService . |
Methoden | |
---|---|
getPlacePredictions |
getPlacePredictions(request[, callback]) Parameter:
Rückgabewert:
Promise<AutocompleteResponse> Ruft Vorschläge für die automatische Vervollständigung von Orten basierend auf der bereitgestellten Autocomplete-Anfrage ab. |
getQueryPredictions |
getQueryPredictions(request, callback) Parameter:
Rückgabewert:Keiner
Ruft Vorhersagen für die automatische Vervollständigung von Suchanfragen basierend auf der bereitgestellten Anfrage für die automatische Vervollständigung von Suchanfragen ab. |
AutocompletionRequest-Schnittstelle
google.maps.places.AutocompletionRequest
-Schnittstelle
Eine Anfrage zur automatischen Vervollständigung, die an AutocompleteService.getPlacePredictions
gesendet werden soll.
Attribute | |
---|---|
input |
Typ:
string Der Nutzer hat einen Eingabestring eingegeben. |
|
Typ:
LatLngBounds|LatLngBoundsLiteral optional Grenzwerte für die Vorhersageverzerrung. Die Vorhersagen werden auf die angegebene bounds ausgerichtet, sind aber nicht darauf beschränkt. Sowohl location als auch radius werden ignoriert, wenn bounds festgelegt ist. |
componentRestrictions optional |
Typ:
ComponentRestrictions optional Die Einschränkungen für die Komponente. Mit Komponentenbeschränkungen werden Vorhersagen auf die übergeordnete Komponente beschränkt. Zum Beispiel das Land. |
language optional |
Typ:
string optional Eine Sprach-ID für die Sprache, in der die Ergebnisse nach Möglichkeit zurückgegeben werden sollen. Ergebnisse in der ausgewählten Sprache werden möglicherweise höher eingestuft, aber Vorschläge sind nicht auf diese Sprache beschränkt. Hier finden Sie eine Liste der unterstützten Sprachen. |
|
Typ:
LatLng optional Standort für die Vorhersage-Bias. Vorhersagen werden in Richtung der angegebenen location und radius tendieren. Alternativ kann auch bounds verwendet werden. |
locationBias optional |
Typ:
LocationBias optional Eine weiche Grenze oder ein Hinweis, der bei der Suche nach Orten verwendet werden soll. |
locationRestriction optional |
Typ:
LocationRestriction optional Grenzen zum Einschränken von Suchergebnissen. |
offset optional |
Typ:
number optional Die Zeichenposition im Eingabeterm, an der der Dienst Text für Vorhersagen verwendet (die Position des Cursors im Eingabefeld). |
origin optional |
Typ:
LatLng|LatLngLiteral optional Der Ort, von dem AutocompletePrediction.distance_meters berechnet wird. |
|
Typ:
number optional Der Radius des Bereichs, der für die Vorhersage verwendet wird. Die radius wird in Metern angegeben und muss immer von einer location -Eigenschaft begleitet werden. Alternativ kann auch bounds verwendet werden. |
region optional |
Typ:
string optional Ein Regionscode, der für die Ergebnisformatierung und ‑filterung verwendet wird. Die Vorschläge werden dadurch nicht auf dieses Land beschränkt. Für den Regionscode ist ein zweistelliger Ländercode der Top-Level-Domain (ccTLD) zulässig. Die meisten ccTLD-Codes entsprechen den ISO 3166-1-Codes, mit folgenden Ausnahmen. So lautet beispielsweise die ccTLD des Vereinigten Königreichs „uk“ ( .co.uk ), der ISO 3166-1-Code dagegen „gb“ (technisch für das Land „Vereinigtes Königreich Großbritannien und Nordirland“). |
sessionToken optional |
Typ:
AutocompleteSessionToken optional Eindeutige Referenz, mit der einzelne Anfragen in Sitzungen zusammengefasst werden. |
types optional |
Typ:
Array<string> optional Die Arten von Vorhersagen, die zurückgegeben werden sollen. Informationen zu den unterstützten Typen finden Sie im Entwicklerhandbuch. Wenn keine Typen angegeben sind, werden alle Typen zurückgegeben. |
AutocompleteResponse-Schnittstelle
google.maps.places.AutocompleteResponse
-Schnittstelle
Eine Autocomplete-Antwort, die vom Aufruf von AutocompleteService.getPlacePredictions
zurückgegeben wird und eine Liste von AutocompletePrediction
enthält.
Attribute | |
---|---|
predictions |
Die Liste der AutocompletePrediction s. |
Schnittstelle QueryAutocompletionRequest
google.maps.places.QueryAutocompletionRequest
-Schnittstelle
Eine QueryAutocompletion-Anfrage, die an QueryAutocompleteService
gesendet werden soll.
Attribute | |
---|---|
input |
Typ:
string Der Nutzer hat einen Eingabestring eingegeben. |
bounds optional |
Typ:
LatLngBounds|LatLngBoundsLiteral optional Grenzwerte für die Vorhersageverzerrung. Die Vorhersagen werden auf die angegebene bounds ausgerichtet, sind aber nicht darauf beschränkt. Sowohl location als auch radius werden ignoriert, wenn bounds festgelegt ist. |
location optional |
Typ:
LatLng optional Standort für die Vorhersage-Bias. Vorhersagen werden in Richtung der angegebenen location und radius tendieren. Alternativ kann auch bounds verwendet werden. |
offset optional |
Typ:
number optional Die Zeichenposition im Eingabeterm, an der der Dienst Text für Vorhersagen verwendet (die Position des Cursors im Eingabefeld). |
radius optional |
Typ:
number optional Der Radius des Bereichs, der für die Vorhersage verwendet wird. Die radius wird in Metern angegeben und muss immer von einer location -Eigenschaft begleitet werden. Alternativ kann auch bounds verwendet werden. |
ComponentRestrictions-Schnittstelle
google.maps.places.ComponentRestrictions
-Schnittstelle
Definiert die Komponenteneinschränkungen, die mit dem Autocomplete-Dienst verwendet werden können.
Attribute | |
---|---|
country optional |
Typ:
string|Array<string> optional Beschränkt Vorschläge auf das angegebene Land (ISO 3166-1 Alpha-2-Ländercode, Groß-/Kleinschreibung wird nicht beachtet). Beispiel: 'us' , 'br' oder 'au' . Sie können einen oder ein Array mit bis zu fünf Ländercode-Strings angeben. |
AutocompletePrediction-Schnittstelle
google.maps.places.AutocompletePrediction
-Schnittstelle
Stellt eine einzelne automatische Vervollständigung dar.
Attribute | |
---|---|
description |
Typ:
string Dies ist die unformatierte Version der vom Places-Dienst vorgeschlagenen Anfrage. |
matched_substrings |
Typ:
Array<PredictionSubstring> Eine Reihe von Teilstrings in der Beschreibung des Orts, die mit Elementen in der Nutzereingabe übereinstimmen und sich zum Hervorheben dieser Teilstrings eignen. Jeder Teilstring wird durch einen Offset und eine Länge in Unicode-Zeichen identifiziert. |
place_id |
Typ:
string Eine Orts-ID, mit der Details zu diesem Ort über den Dienst „Place Details“ abgerufen werden können (siehe PlacesService.getDetails ). |
structured_formatting |
Strukturierte Informationen zur Beschreibung des Orts, unterteilt in einen Haupttext und einen sekundären Text, einschließlich eines Arrays mit übereinstimmenden Teilstrings aus der AutoComplete-Eingabe, die durch einen Offset und eine Länge in Unicode-Zeichen identifiziert werden. |
terms |
Typ:
Array<PredictionTerm> Informationen zu den einzelnen Begriffen in der obigen Beschreibung, von der spezifischsten zur am wenigsten spezifischen. Beispiele: „Taco Bell“, „Willits“ und „CA“. |
types |
Typ:
Array<string> Ein Array von Typen, zu denen die Vorhersage gehört, z. B. 'establishment' oder 'geocode' . |
distance_meters optional |
Typ:
number optional Die Entfernung des Ortes vom AutocompletionRequest.origin in Metern. |
Schnittstelle QueryAutocompletePrediction
google.maps.places.QueryAutocompletePrediction
-Schnittstelle
Stellt eine einzelne automatische Vervollständigung für eine Suchanfrage dar.
Attribute | |
---|---|
description |
Typ:
string Dies ist die unformatierte Version der vom Places-Dienst vorgeschlagenen Anfrage. |
matched_substrings |
Typ:
Array<PredictionSubstring> Eine Reihe von Teilstrings in der Beschreibung des Orts, die mit Elementen in der Nutzereingabe übereinstimmen und sich zum Hervorheben dieser Teilstrings eignen. Jeder Teilstring wird durch einen Offset und eine Länge in Unicode-Zeichen identifiziert. |
terms |
Typ:
Array<PredictionTerm> Informationen zu einzelnen Begriffen in der obigen Beschreibung. Kategorische Begriffe stehen an erster Stelle (z. B. „Restaurant“). Adressbegriffe werden von der spezifischsten zur am wenigsten spezifischen Ebene angezeigt. Beispiel: „San Francisco“ und „CA“. |
place_id optional |
Typ:
string optional Nur verfügbar, wenn die Vorhersage ein Ort ist. Eine Orts-ID, mit der Details zu diesem Ort über den Dienst „Place Details“ abgerufen werden können (siehe PlacesService.getDetails ). |
PredictionTerm-Schnittstelle
google.maps.places.PredictionTerm
-Schnittstelle
Stellt einen Vorhersagebegriff dar.
Attribute | |
---|---|
offset |
Typ:
number Der Offset des Beginns dieses Begriffs in der Beschreibung des Orts in Unicode-Zeichen. |
value |
Typ:
string Der Wert dieses Begriffs, z. B. „Taco Bell“. |
PredictionSubstring-Schnittstelle
google.maps.places.PredictionSubstring
-Schnittstelle
Stellt einen Vorhersage-Teilstring dar.
Attribute | |
---|---|
length |
Typ:
number Die Länge des Teilstrings. |
offset |
Typ:
number Der Offset zum Beginn des Teilstrings im Beschreibungsstring. |
StructuredFormatting-Schnittstelle
google.maps.places.StructuredFormatting
-Schnittstelle
Enthält strukturierte Informationen zur Beschreibung des Orts, unterteilt in einen Haupttext und einen sekundären Text, einschließlich eines Arrays mit übereinstimmenden Teilstrings aus der AutoComplete-Eingabe, die durch ein Offset und eine Länge in Unicode-Zeichen identifiziert werden.
Attribute | |
---|---|
main_text |
Typ:
string Dies ist der Haupttextteil der unformatierten Beschreibung des vom Places-Dienst vorgeschlagenen Orts. In der Regel der Name des Orts. |
main_text_matched_substrings |
Typ:
Array<PredictionSubstring> Eine Reihe von Teilstrings im Haupttext, die mit Elementen in der Nutzereingabe übereinstimmen und sich zum Hervorheben dieser Teilstrings eignen. Jeder Teilstring wird durch einen Offset und eine Länge in Unicode-Zeichen identifiziert. |
secondary_text |
Typ:
string Dies ist der sekundäre Textteil der unformatierten Beschreibung des vom Places-Dienst vorgeschlagenen Orts. Normalerweise der Standort des Orts. |