AutocompleteService-Klasse
Klasse
google.maps.places.AutocompleteService
Bibliothek "places"
Enthält Methoden zum Abrufen von automatischen Vervollständigungen.
const {AutocompleteService} = await google.maps.importLibrary("places");
Konstruktor | |
|---|---|
AutocompleteService |
AutocompleteService()Parameter: Keine
Erstellt eine neue Instanz von AutocompleteService. |
Methoden | |
|---|---|
getPlacePredictions |
getPlacePredictions(request[, callback])Parameter:
Rückgabewert:
Promise<AutocompleteResponse>Ruft automatische Vervollständigungen für Orte basierend auf der angegebenen Anfrage für die automatische Vervollständigung ab. |
getQueryPredictions |
getQueryPredictions(request, callback)Parameter:
Rückgabewert: Keiner
Ruft automatische Vervollständigungen für Abfragen basierend auf der angegebenen Anfrage für die automatische Vervollständigung ab. |
AutocompletionRequest-Schnittstelle
Schnittstelle
google.maps.places.AutocompletionRequest
Eine Anfrage zur automatischen Vervollständigung, die an AutocompleteService.getPlacePredictions gesendet werden soll.
Attribute | |
|---|---|
input |
Typ:
stringDer vom Nutzer eingegebene Eingabestring. |
optional |
Typ:
LatLngBounds|LatLngBoundsLiteral optionalGrenzwerte für die Vorhersagegewichtung. Bei den Vervollständigungen werden Orte innerhalb des angegebenen bounds bevorzugt, sind aber nicht auf sie beschränkt. Sowohl location als auch radius werden ignoriert, wenn bounds festgelegt ist. |
componentRestrictions
optional |
Typ:
ComponentRestrictions optionalDie Einschränkungen der Komponente. Mit Komponentenbeschränkungen werden Vervollständigungen auf die übergeordnete Komponente beschränkt. Beispiel: das Land. |
language
optional |
Typ:
string optionalEine Sprachkennung 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, Vorschläge sind jedoch nicht auf diese Sprache beschränkt. Hier finden Sie eine Liste der unterstützten Sprachen. |
optional |
Typ:
LatLng optionalStandort für die Vorhersagegewichtung. Die Vorhersagen werden auf die angegebenen location und radius ausgerichtet. Alternativ kann bounds verwendet werden. |
locationBias
optional |
Typ:
LocationBias optionalEine weiche Grenze oder ein Hinweis, der bei der Suche nach Orten verwendet werden soll. |
locationRestriction
optional |
Typ:
LocationRestriction optionalGrenzen, um die Suchergebnisse einzuschränken. |
offset
optional |
Typ:
number optionalDie Zeichenposition im Eingabebegriff, an der der Dienst Text für Vervollständigungen verwendet (die Position des Cursors im Eingabefeld). |
origin
optional |
Typ:
LatLng|LatLngLiteral optionalDer Standort, von dem aus AutocompletePrediction.distance_meters berechnet wird. |
optional |
Typ:
number optionalDer Radius des Bereichs, der für die Vorhersagegewichtung verwendet wird. Der radius wird in Metern angegeben und muss immer von einer location-Property begleitet werden. Alternativ kann bounds verwendet werden. |
region
optional |
Typ:
string optionalEin Regionscode, der für die Formatierung und Filterung der Ergebnisse verwendet wird. Die Vorschläge werden nicht auf dieses Land beschränkt. Für den Regionscode ist ein zweistelliger Wert für die ccTLD („Top-Level-Domain“) 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 gesehen für das Vereinigte Königreich Großbritannien und Nordirland). |
sessionToken
optional |
Typ:
AutocompleteSessionToken optionalEindeutige Referenz, mit der einzelne Anfragen zu Sitzungen zusammengefasst werden. |
types
optional |
Typ:
Array<string> optionalDie Typen von Vervollständigungen, die zurückgegeben werden sollen. Informationen zu unterstützten Typen finden Sie im Entwicklerhandbuch. Wenn keine Typen angegeben sind, werden alle Typen zurückgegeben. |
Schnittstelle AutocompleteResponse
Schnittstelle
google.maps.places.AutocompleteResponse
Eine Autocomplete-Antwort, die vom Aufruf von AutocompleteService.getPlacePredictions zurückgegeben wird und eine Liste von AutocompletePredictions enthält.
Attribute | |
|---|---|
predictions |
Typ:
Array<AutocompletePrediction>Die Liste der AutocompletePredictions. |
QueryAutocompletionRequest-Schnittstelle
Schnittstelle
google.maps.places.QueryAutocompletionRequest
Eine QueryAutocompletion-Anfrage, die an QueryAutocompleteService gesendet werden soll.
Attribute | |
|---|---|
input |
Typ:
stringDer vom Nutzer eingegebene Eingabestring. |
bounds
optional |
Typ:
LatLngBounds|LatLngBoundsLiteral optionalGrenzwerte für die Vorhersagegewichtung. Bei den Vervollständigungen werden Orte innerhalb des angegebenen bounds bevorzugt, sind aber nicht auf sie beschränkt. Sowohl location als auch radius werden ignoriert, wenn bounds festgelegt ist. |
location
optional |
Typ:
LatLng optionalStandort für die Vorhersagegewichtung. Die Vorhersagen werden auf die angegebenen location und radius ausgerichtet. Alternativ kann bounds verwendet werden. |
offset
optional |
Typ:
number optionalDie Zeichenposition im Eingabebegriff, an der der Dienst Text für Vervollständigungen verwendet (die Position des Cursors im Eingabefeld). |
radius
optional |
Typ:
number optionalDer Radius des Bereichs, der für die Vorhersagegewichtung verwendet wird. Der radius wird in Metern angegeben und muss immer von einer location-Property begleitet werden. Alternativ kann bounds verwendet werden. |
ComponentRestrictions-Schnittstelle
Schnittstelle
google.maps.places.ComponentRestrictions
Definiert die Komponenteneinschränkungen, die mit dem Autocomplete-Dienst verwendet werden können.
Attribute | |
|---|---|
country
optional |
Typ:
string|Array<string> optionalBeschränkt Vorschläge auf das angegebene Land (ISO 3166-1 Alpha-2-Ländercode, Groß-/Kleinschreibung wird nicht berücksichtigt). Beispiel: 'us', 'br' oder 'au'. Sie können einen einzelnen Ländercode oder ein Array mit bis zu fünf Ländercodes angeben. |
AutocompletePrediction-Schnittstelle
Schnittstelle
google.maps.places.AutocompletePrediction
Stellt eine einzelne automatische Vervollständigung dar.
Attribute | |
|---|---|
description |
Typ:
stringDies ist die unformatierte Version der Suchanfrage, die vom Places-Dienst vorgeschlagen wird. |
matched_substrings |
Typ:
Array<PredictionSubstring>Eine Reihe von Teilstrings in der Beschreibung des Ortes, die mit Elementen in der Nutzereingabe übereinstimmen. Diese Teilstrings können hervorgehoben werden. Jeder Teilstring wird durch einen Offset und eine Länge identifiziert, die in Unicode-Zeichen angegeben werden. |
place_id |
Typ:
stringEine Orts-ID, mit der Details zu diesem Ort über den Place Details-Dienst abgerufen werden können (siehe PlacesService.getDetails). |
structured_formatting |
Typ:
StructuredFormattingStrukturierte Informationen zur Beschreibung des Ortes, aufgeteilt in einen Haupttext und einen Sekundärtext, einschließlich eines Arrays von übereinstimmenden Teilstrings aus der Eingabe für die automatische Vervollständigung, die durch einen Offset und eine Länge in Unicode-Zeichen identifiziert werden. |
terms |
Typ:
Array<PredictionTerm>Informationen zu einzelnen Begriffen in der obigen Beschreibung, von den spezifischsten bis zu den am wenigsten spezifischen. Beispiel: „Taco Bell“, „Willitis“ und „CA“. |
types |
Typ:
Array<string>Ein Array von Typen, zu denen die Vervollständigung gehört, z. B. 'establishment' oder 'geocode'. |
distance_meters
optional |
Typ:
number optionalDie Entfernung des Ortes zum AutocompletionRequest.origin in Metern. |
QueryAutocompletePrediction-Schnittstelle
Schnittstelle
google.maps.places.QueryAutocompletePrediction
Stellt eine einzelne automatische Vervollständigung für eine Abfrage dar.
Attribute | |
|---|---|
description |
Typ:
stringDies ist die unformatierte Version der Suchanfrage, die vom Places-Dienst vorgeschlagen wird. |
matched_substrings |
Typ:
Array<PredictionSubstring>Eine Reihe von Teilstrings in der Beschreibung des Ortes, die mit Elementen in der Nutzereingabe übereinstimmen. Diese Teilstrings können hervorgehoben werden. Jeder Teilstring wird durch einen Offset und eine Länge identifiziert, die in Unicode-Zeichen angegeben werden. |
terms |
Typ:
Array<PredictionTerm>Informationen zu einzelnen Begriffen in der obigen Beschreibung. Kategorische Begriffe stehen an erster Stelle (z. B. „Restaurant“). Die Adressbegriffe werden von der spezifischsten bis zur am wenigsten spezifischen Angabe angezeigt. Beispiel: „San Francisco“ und „CA“. |
place_id
optional |
Typ:
string optionalNur verfügbar, wenn die Vervollständigung ein Ort ist. Eine Orts-ID, mit der Details zu diesem Ort über den Place Details-Dienst abgerufen werden können (siehe PlacesService.getDetails). |
PredictionTerm-Schnittstelle
Schnittstelle
google.maps.places.PredictionTerm
Stellt einen Vorhersagebegriff dar.
Attribute | |
|---|---|
offset |
Typ:
numberDer Offset (in Unicode-Zeichen) des Anfangs dieses Begriffs in der Beschreibung des Ortes. |
value |
Typ:
stringDer Wert dieses Begriffs, z. B. „Taco Bell“. |
PredictionSubstring-Schnittstelle
Schnittstelle
google.maps.places.PredictionSubstring
Stellt einen Teilstring einer Vervollständigung dar.
Attribute | |
|---|---|
length |
Typ:
numberDie Länge des Teilstrings. |
offset |
Typ:
numberDer Offset zum Anfang des Teilstrings innerhalb des Beschreibungsstrings. |
StructuredFormatting-Schnittstelle
Schnittstelle
google.maps.places.StructuredFormatting
Enthält strukturierte Informationen zur Beschreibung des Ortes, aufgeteilt in einen Haupttext und einen Sekundärtext, einschließlich eines Arrays von übereinstimmenden Teilstrings aus der Eingabe für die automatische Vervollständigung, die durch einen Offset und eine Länge in Unicode-Zeichen identifiziert werden.
Attribute | |
|---|---|
main_text |
Typ:
stringDies ist der Haupttextteil der unformatierten Beschreibung des Ortes, der vom Places-Dienst vorgeschlagen wird. Normalerweise 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 identifiziert, die in Unicode-Zeichen angegeben werden. |
secondary_text |
Typ:
stringDies ist der sekundäre Textteil der unformatierten Beschreibung des Orts, der vom Places-Dienst vorgeschlagen wird. Normalerweise der Standort des Ortes. |