Klasse AutocompleteSuggestion
google.maps.places.AutocompleteSuggestion
Klasse
Ein Ergebnis für einen Vorschlag für die automatische Vervollständigung.
Zugriff durch Anrufen 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. Wenn in der Anfrage ein AutocompleteRequest.sessionToken angegeben wird, wird dieses Sitzungstoken automatisch beim ersten Aufruf von Place.fetchFields für jedes Place , das von PlacePrediction.toPlace für die resultierenden PlacePrediction s zurückgegeben wird, eingefügt. |
Attribute | |
---|---|
placePrediction |
Typ:
PlacePrediction optional Enthält den für Menschen lesbaren Namen für das zurückgegebene Ergebnis. Bei Ergebnissen für Niederlassungen sind das in der Regel der Name und die Adresse des Unternehmens. Wenn im AutocompleteRequest, mit dem diese AutocompleteSuggestion abgerufen wurde, ein AutocompleteRequest.sessionToken angegeben wurde, wird dasselbe Token automatisch eingefügt, wenn Place.fetchFields zum ersten Mal für die Place aufgerufen wird, die von einem Aufruf von PlacePrediction.toPlace zurückgegeben wird. |
AutocompleteRequest-Schnittstelle
google.maps.places.AutocompleteRequest
-Schnittstelle
Anfrageschnittstelle für AutocompleteSuggestion.fetchAutocompleteSuggestions
.
Attribute | |
---|---|
input |
Typ:
string Die Textzeichenfolge, nach der gesucht werden soll. |
includedPrimaryTypes optional |
Typ:
Array<string> optional Der primäre Ortstyp (z. B. „restaurant“ oder „gas_station“) ist enthalten. 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 Schließen Sie nur Ergebnisse in den angegebenen Regionen ein, die als bis zu 15 zweistellige CLDR-Regionencodes angegeben werden. Ein leeres Set schränkt die Ergebnisse nicht ein. Wenn sowohl locationRestriction als auch includedRegionCodes festgelegt sind, befinden sich die Ergebnisse im Schnittbereich. |
inputOffset optional |
Typ:
number optional Ein nullbasiertes Unicode-Zeichen-Offset von input , das die Cursorposition in input angibt. Die Cursorposition kann sich darauf auswirken, welche Vorschläge zurückgegeben werden. Wenn nicht angegeben, wird standardmäßig die Länge von input verwendet. |
language optional |
Typ:
string optional Die Sprache, in der die Ergebnisse zurückgegeben werden sollen. Die Spracheinstellung des Browsers wird standardmäßig verwendet. Die Ergebnisse können in verschiedenen Sprachen vorliegen, wenn die in input verwendete Sprache von language abweicht oder wenn für den zurückgegebenen Ort keine Übersetzung aus der lokalen Sprache in language vorhanden ist. |
locationBias optional |
Typ:
LocationBias optional Ergebnisse für einen bestimmten Ort höher gewichten Es sollte höchstens eine der beiden Optionen locationBias oder locationRestriction festgelegt werden. Wenn beides nicht festgelegt ist, werden die Ergebnisse anhand der IP-Adresse gewichtet. Das bedeutet, dass die IP-Adresse einem ungenauen Standort zugeordnet und als Gewichtungssignal verwendet wird. |
locationRestriction optional |
Typ:
LocationRestriction optional Suchergebnisse auf einen bestimmten Ort beschränken. Es sollte höchstens eine der beiden Optionen locationBias oder locationRestriction festgelegt werden. Wenn beides nicht festgelegt ist, werden die Ergebnisse anhand der IP-Adresse gewichtet. Das bedeutet, dass die IP-Adresse einem ungenauen Standort zugeordnet und als Gewichtungssignal verwendet wird. |
origin optional |
Typ:
LatLng|LatLngLiteral optional Der Ausgangspunkt, von dem aus die geodätische Entfernung zum Ziel berechnet wird (als PlacePrediction.distanceMeters zurückgegeben). 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 Adressformatierung und das Ranking der Ergebnisse aus und kann beeinflussen, welche Ergebnisse zurückgegeben werden. Die Ergebnisse werden dadurch 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 wird gestartet, wenn der Nutzer mit der Eingabe beginnt, und endet, wenn er einen Ort auswählt und Place.fetchFields aufruft. Jede Sitzung kann mehrere Abfragen und einen fetchFields -Aufruf umfassen. Die Anmeldedaten, die für jede Anfrage innerhalb einer Sitzung verwendet werden, müssen zum selben Google Cloud Console-Projekt gehören. Sobald eine Sitzung beendet wird, ist das Token nicht mehr gültig. Ihre App muss für jede Sitzung ein neues Token generieren. Wenn Sie den sessionToken -Parameter weglassen oder ein Sitzungstoken wiederverwenden, wird die Sitzung so in Rechnung gestellt, als wäre kein Sitzungstoken bereitgestellt worden. Jede Anfrage wird separat abgerechnet. Wenn in der Anfrage an AutocompleteSuggestion.fetchAutocompleteSuggestions ein Sitzungstoken angegeben wird, wird dasselbe Token automatisch in den ersten Aufruf von fetchFields für ein Place aufgenommen, das durch Aufrufen von PlacePrediction.toPlace für eines der resultierenden AutocompleteSuggestion s zurückgegeben wird. Wir empfehlen die folgenden Richtlinien:
|
AutocompleteSessionToken-Klasse
google.maps.places.AutocompleteSessionToken
Klasse
Stellt ein Sitzungstoken dar, das zum Tracking einer Sitzung mit automatischer Vervollständigung verwendet wird.
Zugriff durch Anrufen 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 PlacePrediction
google.maps.places.PlacePrediction
Klasse
Vorhersageergebnisse für eine Place Autocomplete-Vorhersage.
Zugriff durch Anrufen 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ätischen Linie in Metern ab origin , falls origin angegeben ist. |
mainText |
Typ:
FormattableText optional Stellt den Namen des Orts dar. |
placeId |
Typ:
string Die eindeutige Kennung des vorgeschlagenen Orts. Diese Kennung kann in anderen APIs verwendet werden, die Orts-IDs akzeptieren. |
secondaryText |
Typ:
FormattableText optional Stellt zusätzliche disambiguierende Attribute (z. B. eine Stadt oder Region) zur weiteren Identifizierung des Orts dar. |
text |
Typ:
FormattableText Enthält den für Menschen lesbaren Namen für das zurückgegebene Ergebnis. Bei Ergebnissen für Niederlassungen sind das in der Regel der Name und die Adresse des Unternehmens. text wird für Entwickler empfohlen, die ein einzelnes UI-Element anzeigen möchten. Entwickler, die zwei separate, aber zusammengehörige UI-Elemente anzeigen möchten, sollten stattdessen PlacePrediction.mainText und PlacePrediction.secondaryText verwenden. |
types |
Typ:
Array<string> Liste der Typen, die für diesen Ort aus Tabelle A oder Tabelle B unter https://developers.google.com/maps/documentation/places/web-service/place-types gelten. |
Methoden | |
---|---|
|
fetchAddressValidation(request) Parameter:
Rückgabewert:Keiner
Sendet eine Address Validation-Anfrage, die mit dieser Autocomplete-Sitzung verknüpft ist (die Anfrage wird intern mit dem Autocomplete-Sitzungstoken ausgefüllt). Es werden keine Ortsinformationen aus der PlacePrediction automatisch eingefügt. Diese Methode dient lediglich dazu, die Verwaltung von Autocomplete-Sitzungen zu vereinfachen. |
toPlace |
toPlace() Parameter:Keine
Rückgabewert:
Place Gibt eine Place -Darstellung dieser PlacePrediction zurück. Ein nachfolgender Aufruf von Place.fetchFields ist erforderlich, um vollständige Ortsdetails abzurufen. Wenn in der AutocompleteRequest , die zum Abrufen dieser PlacePrediction verwendet wurde, ein AutocompleteRequest.sessionToken angegeben wurde, wird dasselbe Token automatisch beim Aufrufen von „fetchFields“ eingefügt. Alternativ wird bei Verwendung von PlaceAutocompleteElement beim ersten Aufruf von Place.fetchFields für ein von PlacePrediction.toPlace zurückgegebenes Place automatisch das Sitzungstoken eingefügt. |
Klasse StringRange
google.maps.places.StringRange
Klasse
Identifiziert einen Teilstring in einem bestimmten Text.
Zugriff durch Anrufen 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 (exklusiv). |
startOffset |
Typ:
number Nullbasiertes Offset des ersten Unicode-Zeichens des Teilstrings (einschließlich). |
FormattableText-Klasse
google.maps.places.FormattableText
Klasse
Text, der eine Ortsvorhersage darstellt. Der Text kann unverändert verwendet oder formatiert werden.
Zugriff durch Anrufen 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 übereinstimmt. Mit den Bereichen können Sie bestimmte Teile von text formatieren. Die Teilstrings stimmen möglicherweise nicht genau mit AutocompleteRequest.input überein, wenn die Übereinstimmung anhand anderer Kriterien als String-Abgleich ermittelt wurde, z. B. durch Rechtschreibkorrekturen oder Transliterationen. Diese Werte sind Unicode-Zeichen-Offsets von FormattableText.text . Die Bereiche sind garantiert nach aufsteigenden Offsetwerten sortiert. |
text |
Typ:
string Text, der unverändert verwendet oder mit FormattableText.matches formatiert werden kann. |