AutocompleteSuggestion-Klasse
google.maps.places.AutocompleteSuggestion
Klasse
Bibliothek "places"
Ein automatisch vervollständigter Vorschlag.
const {AutocompleteSuggestion} = await google.maps.importLibrary("places");
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 ist, wird dieses Sitzungstoken automatisch beim ersten Aufruf von Place.fetchFields für jede Place verwendet, die von PlacePrediction.toPlace für die resultierenden PlacePredictions zurückgegeben wird. |
Attribute | |
|---|---|
placePrediction
readonly |
Typ:
PlacePrediction optionalEnthält den menschenlesbaren Namen für das zurückgegebene Ergebnis. Bei Ergebnissen für Einrichtungen sind dies in der Regel der Name und die Adresse des Unternehmens. Wenn in der AutocompleteRequest, die zum Abrufen dieses AutocompleteSuggestion-Objekts verwendet wurde, ein AutocompleteRequest.sessionToken angegeben wurde, wird dasselbe Token automatisch beim ersten Aufruf von Place.fetchFields für das Place-Objekt verwendet, das von einem Aufruf von PlacePrediction.toPlace zurückgegeben wird. |
Schnittstelle AutocompleteRequest
Schnittstelle google.maps.places.AutocompleteRequest
Anfrageschnittstelle für AutocompleteSuggestion.fetchAutocompleteSuggestions.
Attribute | |
|---|---|
input |
Typ:
stringDer Textstring, nach dem gesucht werden soll. |
futureOpeningBusinessesIncluded
optional |
Typ:
boolean optionalOrtsvorschläge für Unternehmen, die noch nicht eröffnet sind, aber voraussichtlich in Zukunft eröffnet werden, werden berücksichtigt. |
includedPrimaryTypes
optional |
Typ:
Array<string> optionalEingeschlossener primärer Ortstyp (z. B. „restaurant“ oder „gas_station“). 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> optionalNur Ergebnisse in den angegebenen Regionen einschließen, angegeben als bis zu 15 zweistellige CLDR-Regionscodes. Ein leerer Satz schränkt die Ergebnisse nicht ein. Wenn sowohl locationRestriction als auch includedRegionCodes festgelegt sind, befinden sich die Ergebnisse im Schnittbereich. |
inputOffset
optional |
Typ:
number optionalEin nullbasierter Unicode-Zeichen-Offset von input, der die Cursorposition in input angibt. Die Cursorposition kann sich auf die zurückgegebenen Vervollständigungen auswirken. Wenn nichts angegeben ist, wird standardmäßig die Länge von input verwendet. |
language
optional |
Typ:
string optionalDie Sprache, in der die Ergebnisse zurückgegeben werden sollen. Standardmäßig wird die Spracheinstellung des Browsers 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 Landessprache in language verfügbar ist. |
locationBias
optional |
Typ:
LocationBias optionalErgebnisse für einen bestimmten Ort höher gewichten. Es sollte höchstens eines von locationBias und locationRestriction festgelegt sein. Wenn keines von beiden festgelegt ist, werden die Ergebnisse nach der IP-Adresse gewichtet. Das bedeutet, dass die IP-Adresse einem ungenauen Standort zugeordnet und als Gewichtungssignal verwendet wird. |
locationRestriction
optional |
Typ:
LocationRestriction optionalBeschränkt die Ergebnisse auf einen bestimmten Standort. Es sollte höchstens eines von locationBias und locationRestriction festgelegt sein. Wenn keines von beiden festgelegt ist, werden die Ergebnisse nach der IP-Adresse gewichtet. Das bedeutet, dass die IP-Adresse einem ungenauen Standort zugeordnet und als Gewichtungssignal verwendet wird. |
origin
optional |
Typ:
LatLng|LatLngLiteral optionalDer Ausgangspunkt, von dem aus die geodätische Entfernung zum Ziel berechnet werden soll (wird als PlacePrediction.distanceMeters zurückgegeben). Wenn dieser Wert weggelassen wird, wird die geodätische Entfernung nicht zurückgegeben. |
pureServiceAreaBusinessesIncluded
optional |
Typ:
boolean optionalUnternehmen, die nur in einem Einzugsgebiet tätig sind, werden einbezogen, wenn das Feld auf „true“ gesetzt ist. Ein reines Unternehmen ohne festen Standort in einem Einzugsgebiet ist ein Unternehmen, das Kunden vor Ort besucht oder direkt beliefert, aber an seiner Geschäftsadresse keine Kunden empfängt. Beispielsweise haben Reinigungsfirmen oder Klempner möglicherweise keine physische Adresse oder keinen Standort auf Google Maps. |
region
optional |
Typ:
string optionalDer Regionscode, angegeben als zweistelliger CLDR-Regionscode. Dies wirkt sich auf die Adressformatierung, das Ranking der Ergebnisse und möglicherweise auch auf die zurückgegebenen Ergebnisse aus. Die Ergebnisse werden dadurch nicht auf die angegebene Region beschränkt. |
sessionToken
optional |
Typ:
AutocompleteSessionToken optionalEin Token, das eine Autocomplete-Sitzung zu Abrechnungszwecken identifiziert. Generieren Sie über AutocompleteSessionToken ein neues Sitzungstoken. 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 für jede Anfrage innerhalb einer Sitzung verwendeten Anmeldedaten müssen zum selben Google Cloud Console-Projekt gehören. Sobald eine Sitzung beendet wird, ist das Token nicht mehr gültig. Ihre Anwendung 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 ist, wird dasselbe Token automatisch in den ersten Aufruf von fetchFields für ein Place eingefügt, das durch Aufrufen von PlacePrediction.toPlace für eines der resultierenden AutocompleteSuggestions zurückgegeben wird. Wir empfehlen folgende Richtlinien:
|
Klasse AutocompleteSessionToken
google.maps.places.AutocompleteSessionToken
Klasse
Bibliothek "places"
Stellt ein Sitzungstoken dar, das zum Erfassen einer Sitzung mit automatischer Vervollständigung verwendet wird.
const {AutocompleteSessionToken} = await google.maps.importLibrary("places");
Konstruktor | |
|---|---|
AutocompleteSessionToken |
AutocompleteSessionToken()Parameter: Keine
Creates a new instance of AutocompleteSessionToken. |
Klasse PlacePrediction
google.maps.places.PlacePrediction
Klasse
Bibliothek "places"
Vorhersageergebnisse für eine Place Autocomplete-Vorhersage.
const {PlacePrediction} = await google.maps.importLibrary("places");
Attribute | |
|---|---|
distanceMeters
readonly |
Typ:
number optionalDie Länge der Geodäte in Metern von origin, wenn origin angegeben ist. |
mainText
readonly |
Typ:
FormattableText optionalDer Name des Ortes. |
placeId
readonly |
Typ:
stringDie eindeutige Kennung des vorgeschlagenen Orts. Diese ID kann in anderen APIs verwendet werden, die Orts-IDs akzeptieren. |
secondaryText
readonly |
Typ:
FormattableText optionalStellt zusätzliche Merkmale zur Mehrdeutigkeitsauflösung dar (z. B. eine Stadt oder Region), um den Ort genauer zu identifizieren. |
text
readonly |
Typ:
FormattableTextEnthält den menschenlesbaren Namen für das zurückgegebene Ergebnis. Bei Ergebnissen für Einrichtungen sind dies 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 zusammenhängende UI-Elemente anzeigen möchten, können stattdessen PlacePrediction.mainText und PlacePrediction.secondaryText verwenden. |
types
readonly |
Typ:
Array<string>Liste der Typen, die für diesen Ort gelten, aus Tabelle A oder Tabelle B unter https://developers.google.com/maps/documentation/places/web-service/place-types. |
Methoden | |
|---|---|
|
fetchAddressValidation(request)Parameter:
Rückgabewert:
Promise<AddressValidation>Sendet eine Address Validation-Anfrage, die mit dieser Autocomplete-Sitzung verknüpft ist. Die Anfrage wird intern mit dem Autocomplete-Sitzungstoken gefüllt. Es werden nicht automatisch Ortsinformationen aus der „PlacePrediction“ einbezogen. Dies ist eine praktische Methode, die die Verwaltung von Autovervollständigungssitzungen erleichtert. |
toPlace |
toPlace()Parameter: Keine
Rückgabewert:
PlaceGibt eine Place-Darstellung dieser PlacePrediction zurück. Ein nachfolgender Aufruf von Place.fetchFields ist erforderlich, um vollständige Ortsdetails zu erhalten. Wenn in der AutocompleteRequest, die zum Abrufen dieser PlacePrediction verwendet wurde, ein AutocompleteRequest.sessionToken angegeben wurde, wird dasselbe Token automatisch beim Aufruf von fetchFields eingefügt. Alternativ wird bei Verwendung von PlaceAutocompleteElement der erste Aufruf von Place.fetchFields für ein von PlacePrediction.toPlace zurückgegebenes Place automatisch das Sitzungstoken enthalten. |
Klasse StringRange
google.maps.places.StringRange
Klasse
Bibliothek "places"
Identifiziert einen Teilstring in einem bestimmten Text.
const {StringRange} = await google.maps.importLibrary("places");
Attribute | |
|---|---|
endOffset
readonly |
Typ:
numberNullbasierter Offset des letzten Unicode-Zeichens des Teilstrings (exklusiv). |
startOffset
readonly |
Typ:
numberNullbasierter Offset des ersten Unicode-Zeichens des Teilstrings (einschließlich). |
Klasse FormattableText
google.maps.places.FormattableText
Klasse
Bibliothek "places"
Text, der eine Ortsvorhersage darstellt. Der Text kann unverändert verwendet oder formatiert werden.
const {FormattableText} = await google.maps.importLibrary("places");
Attribute | |
|---|---|
matches
readonly |
Typ:
Array<StringRange>Eine Liste von Stringbereichen, die angeben, wo die Eingabeanfrage in FormattableText.text übereinstimmt. Die Bereiche können verwendet werden, um bestimmte Teile von text zu formatieren. Die Teilstrings stimmen möglicherweise nicht genau mit AutocompleteRequest.input überein, wenn die Übereinstimmung durch andere Kriterien als den Stringabgleich ermittelt wurde (z. B. Rechtschreibkorrekturen oder Transliterationen). Diese Werte sind Unicode-Zeichen-Offsets von FormattableText.text. Die Bereiche sind garantiert in aufsteigenden Offset-Werten sortiert. |
text
readonly |
Typ:
stringText, der unverändert verwendet oder mit FormattableText.matches formatiert werden kann. |