AutocompleteRequest.
google.maps.places.AutocompleteRequest
-Schnittstelle
Anfrageoberfläche für AutocompleteSuggestion.fetchAutocompleteSuggestions
.
Attribute | |
---|---|
input |
Typ:
string Die Textzeichenfolge, nach der gesucht werden soll. |
includedPrimaryTypes optional |
Typ:
Array<string> optional Primärer Ortstyp enthalten, z. B. „Restaurant“ oder „Tankstelle“ Ein Ort wird nur zurückgegeben, wenn sein primärer Typ in dieser Liste enthalten ist. Sie können bis zu fünf Werte angeben. Wenn keine Typen angegeben sind, werden alle Ortstypen zurückgegeben. |
includedRegionCodes optional |
Typ:
Array<string> optional Nur Ergebnisse in den angegebenen Regionen einschließen, die als bis zu 15 CLDR-Regionscodes mit zwei Zeichen angegeben sind. Ein leerer Satz schränkt die Ergebnisse nicht ein. Wenn sowohl locationRestriction als auch includedRegionCodes festgelegt sind, befinden sich die Ergebnisse im Bereich der Kreuzung. |
inputOffset optional |
Typ:
number optional Ein nullbasierter Unicode-Zeichen-Offset von input , der die Cursorposition in input angibt. Die Cursorposition kann beeinflussen, welche Vorhersagen zurückgegeben werden. Wenn keine Angabe erfolgt, wird standardmäßig die Länge von input verwendet. |
language optional |
Typ:
string optional Die Sprache, in der die Ergebnisse zurückgegeben werden sollen. Standardmäßig wird die Spracheinstellung des Browsers verwendet. Die Ergebnisse können in gemischten Sprachen vorliegen, wenn sich die in input verwendete Sprache von language unterscheidet oder der zurückgegebene Ort keine Übersetzung von der lokalen Sprache in language hat. |
locationBias optional |
Typ:
LocationBias optional Gewichtet die Ergebnisse nach einem bestimmten Standort. Es darf höchstens locationBias oder locationRestriction festgelegt werden. Wenn keines von beiden festgelegt ist, werden die Ergebnisse nach der IP-Adresse gewichtet, d. h., die IP-Adresse wird einem ungenauen Standort zugeordnet und als Gewichtungssignal verwendet. |
locationRestriction optional |
Typ:
LocationRestriction optional Beschränkt die Ergebnisse auf einen bestimmten Ort. Es darf höchstens locationBias oder locationRestriction festgelegt werden. Wenn keines von beiden festgelegt ist, werden die Ergebnisse nach der IP-Adresse gewichtet, d. h., die IP-Adresse wird einem ungenauen Standort zugeordnet und als Gewichtungssignal verwendet. |
origin optional |
Typ:
LatLng|LatLngLiteral optional Der Startpunkt, von dem aus die geodätische Entfernung zum Ziel berechnet werden soll (zurückgegeben als PlacePrediction.distanceMeters ). Wenn dieser Wert weggelassen wird, wird die geodätische Entfernung nicht zurückgegeben. |
region optional |
Typ:
string optional Der Regionscode, angegeben als zweistelliger CLDR-Regionscode. Dies wirkt sich auf die Formatierung der Adresse und das Ranking der Ergebnisse aus und kann beeinflussen, welche Ergebnisse zurückgegeben werden. Dadurch werden die Ergebnisse nicht auf die angegebene Region beschränkt. |
sessionToken optional |
Typ:
AutocompleteSessionToken optional Ein Token, das eine Autocomplete-Sitzung zu Abrechnungszwecken identifiziert. Generieren Sie ein neues Sitzungstoken über AutocompleteSessionToken . Die Sitzung beginnt, wenn der Nutzer beginnt, eine Suchanfrage einzugeben, und endet, wenn er einen Ort auswählt und Place.fetchFields aufruft. Jede Sitzung kann mehrere Abfragen enthalten, auf die ein fetchFields -Aufruf folgt. Die für jede Anfrage in einer Sitzung verwendeten Anmeldedaten müssen zum selben Google Cloud Console-Projekt gehören. Nach Abschluss einer Sitzung ist das Token nicht mehr gültig. Ihre App muss für jede Sitzung ein neues Token generieren. Wenn Sie den Parameter sessionToken weglassen oder ein Sitzungstoken wiederverwenden, wird die Sitzung so in Rechnung gestellt, als wäre kein Sitzungstoken bereitgestellt worden. Jede Anfrage wird separat abgerechnet. Wir empfehlen folgende Richtlinien:
|
AutocompleteSessionToken-Klasse
google.maps.places.AutocompleteSessionToken
-Klasse
Stellt ein Sitzungstoken dar, das zum Verfolgen einer Sitzung für die automatische Vervollständigung verwendet wird.
Zugriff durch Aufrufen von const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
. Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.
Konstruktor | |
---|---|
AutocompleteSessionToken |
AutocompleteSessionToken() Parameter:Keine
Creates a new instance of AutocompleteSessionToken . |
Klasse AutocompleteSuggestion
google.maps.places.AutocompleteSuggestion
-Klasse
Ein Ergebnis für die automatische Vervollständigung.
Zugriff durch Aufrufen von const {AutocompleteSuggestion} = await google.maps.importLibrary("places")
. Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.
Statische Methoden | |
---|---|
fetchAutocompleteSuggestions |
fetchAutocompleteSuggestions(autocompleteRequest) Parameter:
Rückgabewert:
Promise<{suggestions:Array<AutocompleteSuggestion>}> Ruft eine Liste von AutocompleteSuggestions ab. |
Attribute | |
---|---|
placePrediction |
Typ:
PlacePrediction optional Enthält den visuell lesbaren Namen des zurückgegebenen Ergebnisses. Bei Unterkünften sind dies normalerweise der Name und die Adresse des Unternehmens. |
PlacePrediction-Klasse
google.maps.places.PlacePrediction
-Klasse
Vorhersageergebnisse für eine Place Autocomplete-Vervollständigung.
Zugriff durch Aufrufen von const {PlacePrediction} = await google.maps.importLibrary("places")
. Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.
Attribute | |
---|---|
distanceMeters |
Typ:
number optional Die Länge der Geodäte in Metern von origin , wenn origin angegeben ist. |
mainText |
Typ:
FormattableText optional Der Name des Orts. |
placeId |
Typ:
string Die eindeutige ID des vorgeschlagenen Orts. Diese ID kann in anderen APIs verwendet werden, die Orts-IDs akzeptieren. |
secondaryText |
Typ:
FormattableText optional Zusätzliche eindeutige Merkmale (z. B. eine Stadt oder Region) zur weiteren Identifizierung des Orts |
text |
Typ:
FormattableText Enthält den visuell lesbaren Namen des zurückgegebenen Ergebnisses. Bei Unterkünften sind dies normalerweise der Name und die Adresse des Unternehmens. text wird Entwicklern empfohlen, die ein einzelnes UI-Element anzeigen möchten. Entwickler, die zwei separate, aber zusammengehörige UI-Elemente anzeigen möchten, können stattdessen PlacePrediction.mainText und PlacePrediction.secondaryText verwenden. |
types |
Typ:
Array<string> Liste der Typen, die auf diesen Ort aus Tabelle A oder Tabelle B unter https://developers.google.com/maps/documentation/places/web-service/place-types zutreffen. |
Methoden | |
---|---|
toPlace |
toPlace() Parameter:Keine
Rückgabewert:
Place Gibt eine Ortsdarstellung dieser PlacePrediction zurück. Ein weiterer Aufruf von Place.fetchFields ist erforderlich, um die vollständigen Ortsdetails abzurufen. |
StringRange-Klasse
google.maps.places.StringRange
-Klasse
Kennzeichnet eine Teilzeichenfolge in einem gegebenen Text.
Zugriff durch Aufrufen von const {StringRange} = await google.maps.importLibrary("places")
. Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.
Attribute | |
---|---|
endOffset |
Typ:
number Nullbasierter Offset des letzten Unicode-Zeichens des Teilstrings (ausschließlich). |
startOffset |
Typ:
number Nullbasierter Offset des ersten Unicode-Zeichens des Teilstrings (einschließlich). |
FormattableText-Klasse
google.maps.places.FormattableText
-Klasse
Text, der eine Ortsvorhersage darstellt. Der Text kann in der vorliegenden Form verwendet oder formatiert werden.
Zugriff durch Aufrufen von const {FormattableText} = await google.maps.importLibrary("places")
. Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.
Attribute | |
---|---|
matches |
Typ:
Array<StringRange> Eine Liste von Stringbereichen, die angeben, wo die Eingabeanfrage in FormattableText.text übereinstimmte. Die Bereiche können zum Formatieren bestimmter Teile von text verwendet werden. Die Teilstrings stimmen möglicherweise nicht genau mit AutocompleteRequest.input überein, wenn der Abgleich nicht auf den String-Abgleich beschränkt wurde (z. B. Rechtschreibkorrekturen oder Transliterationen). Diese Werte sind Unicode-Zeichen-Offsets von FormattableText.text . Die Bereiche werden garantiert in zunehmenden Offset-Werten sortiert. |
text |
Typ:
string Text, der in der vorliegenden Form verwendet oder mit FormattableText.matches formatiert werden kann. |