- HTTP-Anfrage
- Anfragetext
- Antworttext
- LocationBias
- LocationRestriction
- Vorschlag
- PlacePrediction
- FormattableText
- StringRange
- StructuredFormat
- QueryPrediction
Gibt Vorhersagen für die angegebene Eingabe zurück.
HTTP-Anfrage
POST https://places.googleapis.com/v1/places:autocomplete
Die URL verwendet die Syntax der gRPC-Transcodierung.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{ "input": string, "locationBias": { object ( |
Felder | |
---|---|
input |
Erforderlich. Die Textzeichenfolge, nach der gesucht werden soll. |
locationBias |
Optional. Gewichtet die Ergebnisse auf einen bestimmten Standort. Es darf höchstens |
locationRestriction |
Optional. Ergebnisse auf einen bestimmten Standort beschränken Es darf höchstens |
includedPrimaryTypes[] |
Optional. Primärer Ortstyp (z. B. „Restaurant“ oder „Tankstelle“) aus https://developers.google.com/maps/documentation/places/web-service/place-types 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. Es werden nur Ergebnisse in den angegebenen Regionen berücksichtigt, die aus bis zu 15 zweistelligen CLDR-Regionscodes bestehen. Ein leerer Satz schränkt die Ergebnisse nicht ein. Wenn sowohl |
languageCode |
Optional. Die Sprache, in der die Ergebnisse zurückgegeben werden sollen. Die Standardeinstellung ist „en-US“. Die Ergebnisse können in gemischten Sprachen vorliegen, wenn sich die in |
regionCode |
Optional. Der Regionscode, angegeben als zweistelliger CLDR-Regionscode. Dies wirkt sich auf die Adressformatierung, das Ranking der Ergebnisse und möglicherweise darauf aus, welche Ergebnisse zurückgegeben werden. Dadurch werden die Ergebnisse nicht auf die angegebene Region beschränkt. Verwenden Sie |
origin |
Optional. Der Startpunkt, von dem aus die geodätische Entfernung zum Ziel berechnet werden soll (zurückgegeben als |
inputOffset |
Optional. Ein nullbasierter Unicode-Zeichen-Offset von Wenn das Feld leer ist, wird standardmäßig die Länge |
includeQueryPredictions |
Optional. Bei „true“ enthält die Antwort sowohl Vorschläge für Orte als auch Suchanfragen. Andernfalls werden in der Antwort nur Ortsvorschläge zurückgegeben. |
sessionToken |
Optional. Ein String, der eine Autocomplete-Sitzung zu Abrechnungszwecken identifiziert. Muss ein URL- und Dateiname-sicherer Base64-String mit maximal 36 ASCII-Zeichen sein. Andernfalls wird der Fehler INVALID_ ARGUMENT zurückgegeben. Die Sitzung beginnt, wenn der Nutzer mit der Eingabe einer Suchanfrage beginnt, und endet, wenn er einen Ort auswählt und ein Aufruf von Place Details oder Address Validation ausgeführt wird. Jede Sitzung kann mehrere Abfragen umfassen, gefolgt von einer „Place Details“- oder „Address Validation“-Anfrage. Die für die einzelnen Anfragen innerhalb einer Sitzung verwendeten Anmeldedaten müssen zum selben Google Cloud Console-Projekt gehören. Sobald eine Sitzung beendet ist, ist das Token nicht mehr gültig. Ihre App muss für jede Sitzung ein neues Token generieren. Wenn der Parameter Wir empfehlen folgende Richtlinien:
|
Antworttext
Antwortproto für „place.autocomplete“.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{
"suggestions": [
{
object ( |
Felder | |
---|---|
suggestions[] |
Enthält eine Liste von Vorschlägen, die in absteigender Reihenfolge nach Relevanz sortiert sind. |
LocationBias
Die Region, in der gesucht werden soll. Die Ergebnisse können um die angegebene Region herum verzerrt sein.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld Für |
|
rectangle |
Darstellungsbereich, der durch eine Nordost- und eine Südwestecke definiert wird |
circle |
Ein Kreis, der durch einen Mittelpunkt und einen Radius definiert wird. |
LocationRestriction
Die Region, in der gesucht werden soll. Die Ergebnisse werden auf die angegebene Region beschränkt.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld Für |
|
rectangle |
Darstellungsbereich, der durch eine Nordost- und eine Südwestecke definiert wird |
circle |
Ein Kreis, der durch einen Mittelpunkt und einen Radius definiert wird. |
Vorschlag
Ein Ergebnis eines Autocomplete-Vorschlags.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld Für |
|
placePrediction |
Eine Vervollständigung für einen Ort. |
queryPrediction |
Eine Vorhersage für eine Abfrage. |
PlacePrediction
Vorhersageergebnisse für einen Place Autocomplete-Vorschlag.
JSON-Darstellung |
---|
{ "place": string, "placeId": string, "text": { object ( |
Felder | |
---|---|
place |
Der Ressourcenname des vorgeschlagenen Ortes. Er kann auch in anderen APIs verwendet werden, die Ortsnamen akzeptieren. |
placeId |
Die eindeutige ID des vorgeschlagenen Orts Sie kann auch in anderen APIs verwendet werden, die Orts-IDs akzeptieren. |
text |
Enthält den visuell lesbaren Namen des zurückgegebenen Ergebnisses. Bei Einrichtungsergebnissen handelt es sich hierbei in der Regel um den Namen und die Adresse des Unternehmens.
Dieser Text kann sich von dem von „places.get“ zurückgegebenen Möglicherweise sind gemischte Sprachen verfügbar, wenn die Anfrage |
structuredFormat |
Eine Aufschlüsselung der Ortsvervollständigung in einen Haupttext, der den Namen des Orts enthält, und in einen Sekundärtext mit zusätzlichen eindeutigen Merkmalen (z. B. einer Stadt oder Region).
|
types[] |
Liste der Typen aus Tabelle A oder Tabelle B in https://developers.google.com/maps/documentation/places/web-service/place-types, die für diesen Ort gelten. Ein Typ ist eine Kategorisierung eines Ortes. Orte mit gemeinsamen Typen haben ähnliche Eigenschaften. |
distanceMeters |
Die Länge der Geodäte in Metern ab |
FormattableText
Text, der einen Ort oder eine Abfragevorhersage darstellt. Der Text kann unverändert oder formatiert verwendet werden.
JSON-Darstellung |
---|
{
"text": string,
"matches": [
{
object ( |
Felder | |
---|---|
text |
Text, der so verwendet oder mit |
matches[] |
Eine Liste von Stringbereichen, die angeben, wo die Eingabeanfrage in Diese Werte sind Unicode-Zeichen-Offsets von |
StringRange
Kennzeichnet eine Teilzeichenfolge in einem gegebenen Text.
JSON-Darstellung |
---|
{ "startOffset": integer, "endOffset": integer } |
Felder | |
---|---|
startOffset |
Nullbasierter Offset des ersten Unicode-Zeichens des Strings (einschließlich). |
endOffset |
Nullbasierter Offset des letzten Unicode-Zeichens (exklusiv). |
StructuredFormat
Enthält eine Aufschlüsselung eines Orts- oder Abfragevorschlags in Haupt- und Sekundärtext.
Bei Vorschläge für Orte enthält der Haupttext den spezifischen Namen des Orts. Bei Vervollständigungen von Suchanfragen enthält der Haupttext die Suchanfrage.
Der Sekundärtext enthält zusätzliche Unterscheidungsmerkmale (wie eine Stadt oder Region) zur weiteren Identifizierung des Orts oder zur Verfeinerung der Abfrage.
JSON-Darstellung |
---|
{ "mainText": { object ( |
Felder | |
---|---|
mainText |
Stellt den Namen des Orts oder der Suchanfrage dar |
secondaryText |
Stellt zusätzliche Unterscheidungsmerkmale (wie eine Stadt oder Region) zur weiteren Identifizierung des Orts oder zur Verfeinerung der Suchanfrage dar. |
QueryPrediction
Vorhersageergebnisse für eine Query Autocomplete-Vorhersage.
JSON-Darstellung |
---|
{ "text": { object ( |
Felder | |
---|---|
text |
Der vervollständigte Text. Dieser Text stellt keinen Ort dar, sondern eine Textabfrage, die in einem Suchendpunkt verwendet werden könnte (z. B. „Text Search“).
Kann in gemischten Sprachen vorliegen, wenn die Anfrage |
structuredFormat |
Aufschlüsselung der Suchanfragevorhersage in den Haupttext mit der Suchanfrage und in den Sekundärtext mit zusätzlichen eindeutigen Merkmalen (z. B. eine Stadt oder Region).
|