Method: places.autocomplete

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 (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "includedPrimaryTypes": [
    string
  ],
  "includedRegionCodes": [
    string
  ],
  "languageCode": string,
  "regionCode": string,
  "origin": {
    object (LatLng)
  },
  "inputOffset": integer,
  "includeQueryPredictions": boolean,
  "sessionToken": string,
  "includePureServiceAreaBusinesses": boolean
}
Felder
input

string

Erforderlich. Der Textstring, in dem gesucht werden soll.
locationBias

object (LocationBias)

Optional. Ergebnisse für einen bestimmten Ort höher gewichten.

Es sollte höchstens eines von locationBias oder locationRestriction festgelegt sein. Wenn keines der beiden festgelegt ist, werden die Ergebnisse durch die IP-Adresse verzerrt. Das bedeutet, dass die IP-Adresse einem ungenauen Standort zugeordnet und als Verzerrungssignal verwendet wird.
locationRestriction

object (LocationRestriction)

Optional. Ergebnisse auf einen bestimmten Standort beschränken.

Es sollte höchstens eines von locationBias oder locationRestriction festgelegt sein. Wenn keines der beiden festgelegt ist, werden die Ergebnisse durch die IP-Adresse verzerrt. Das bedeutet, dass die IP-Adresse einem ungenauen Standort zugeordnet und als Verzerrungssignal verwendet wird.
includedPrimaryTypes[]

string

Optional. Enthält den primären Ortstyp (z. B. „restaurant“ oder „gas_station“) in „Place Types“ (https://developers.google.com/maps/documentation/places/web-service/place-types) oder nur (regions) oder nur (cities). 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[]

string

Optional. Es werden nur Ergebnisse in den angegebenen Regionen berücksichtigt. Diese werden als bis zu 15 zweistellige CLDR-Regionscodes angegeben. Eine leere Gruppe schränkt die Ergebnisse nicht ein. Wenn sowohl locationRestriction als auch includedRegionCodes festgelegt sind, befinden sich die Ergebnisse im Schnittbereich.
languageCode

string

Optional. Die Sprache, in der Ergebnisse zurückgegeben werden sollen. Die Standardeinstellung ist „en-US“. Die Ergebnisse können in verschiedenen Sprachen vorliegen, wenn die in input verwendete Sprache von languageCode abweicht oder für den zurückgegebenen Ort keine Übersetzung aus der Landessprache in languageCode vorhanden ist.
regionCode

string

Optional. Der Regionscode, angegeben als zweistelliger CLDR-Regionscode. Das wirkt sich auf die Adressformatierung, das Ergebnisranking und möglicherweise auch darauf aus, welche Ergebnisse zurückgegeben werden. Die Ergebnisse werden dadurch nicht auf die angegebene Region beschränkt. Verwenden Sie region_code_restriction, um die Ergebnisse auf eine Region einzugrenzen.
origin

object (LatLng)

Optional. Der Startpunkt, von dem aus die geodätische Entfernung zum Ziel berechnet werden soll (wird als distanceMeters zurückgegeben). Wenn dieser Wert weggelassen wird, wird die geodätische Entfernung nicht zurückgegeben.
inputOffset

integer

Optional. Ein nullbasierter Unicode-Zeichenabstand von input, der die Cursorposition in input angibt. Die Cursorposition kann sich darauf auswirken, welche Vorschläge zurückgegeben werden.

Wenn das Feld leer ist, wird standardmäßig die Länge von input verwendet.
includeQueryPredictions

boolean

Optional. Wenn „true“ festgelegt ist, enthält die Antwort sowohl Orts- als auch Suchanfragevorschläge. Andernfalls werden in der Antwort nur Ortsvorschläge zurückgegeben.
sessionToken

string

Optional. Ein String, der eine Autocomplete-Sitzung zu Abrechnungszwecken identifiziert. Muss ein URL- und Dateinamen-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 beginnt, und endet, wenn er einen Ort auswählt und ein Aufruf zu „Place Details“ oder „Address Validation“ erfolgt. Jede Sitzung kann mehrere Abfragen und eine Anfrage vom Typ „Place Details“ oder „Address Validation“ umfassen. Die Anmeldedaten, die für jede Anfrage innerhalb einer Sitzung verwendet werden, müssen zu demselben 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.

Wir empfehlen folgende Richtlinien:

  • Verwenden Sie Sitzungstokens für alle Place Autocomplete-Aufrufe.
  • Für jede Sitzung muss ein neues Token generiert werden. Wir empfehlen die Verwendung einer UUID der Version 4.
  • Die Anmeldedaten, die für alle Anfragen für die automatische Vervollständigung von Orten, „Places Details“ und die Adressbestätigung innerhalb einer Sitzung verwendet werden, müssen zu demselben Cloud Console-Projekt gehören.
  • Für jede neue Sitzung muss ein eindeutiges Sitzungstoken weitergegeben werden. Wenn Sie dasselbe Token für mehr als eine Sitzung verwenden, wird jede Anfrage separat in Rechnung gestellt.
includePureServiceAreaBusinesses

boolean

Optional. Fügen Sie Unternehmen ohne festen Standort in einem Einzugsgebiet hinzu, wenn das Feld auf „true“ gesetzt ist. Unternehmen ohne festen Standort in einem Einzugsgebiet sind Unternehmen, die Kunden vor Ort besuchen oder direkt beliefern, aber an ihrer Geschäftsadresse keine Kunden empfangen. Dazu gehören z. B. Reinigungsfirmen oder Klempner. Diese Unternehmen haben keine Adresse oder keinen Standort auf Google Maps. Für diese Unternehmen werden keine Felder wie location, plusCode und andere standortbezogene Felder zurückgegeben.

Antworttext

Antwort-Prototyp für places.autocomplete.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
Felder
suggestions[]

object (Suggestion)

Enthält eine Liste mit Vorschlägen, sortiert in absteigender Reihenfolge nach Relevanz.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

LocationBias

Die Region, in der gesucht werden soll. Die Ergebnisse sind möglicherweise in der angegebenen Region verzerrt.

JSON-Darstellung 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Felder

Union-Feld type.

Für type ist nur einer der folgenden Werte zulässig:
rectangle

object (Viewport)

Ein Ansichtsbereich, der durch eine Nordost- und eine Südwestecke definiert ist.
circle

object (Circle)

Ein Kreis, der durch einen Mittelpunkt und einen Radius definiert ist.

LocationRestriction

Die Region, in der gesucht werden soll. Die Ergebnisse werden auf die angegebene Region beschränkt.

JSON-Darstellung 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Felder

Union-Feld type.

Für type ist nur einer der folgenden Werte zulässig:
rectangle

object (Viewport)

Ein Ansichtsbereich, der durch eine Nordost- und eine Südwestecke definiert ist.
circle

object (Circle)

Ein Kreis, der durch einen Mittelpunkt und einen Radius definiert ist.

Vorschlag

Ein Vorschlag für die automatische Vervollständigung.

JSON-Darstellung 
{

  // Union field kind can be only one of the following:
  "placePrediction": {
    object (PlacePrediction)
  },
  "queryPrediction": {
    object (QueryPrediction)
  }
  // End of list of possible types for union field kind.
}
Felder

Union-Feld kind.

Für kind ist nur einer der folgenden Werte zulässig:
placePrediction

object (PlacePrediction)

Eine Vorhersage für einen Ort.
queryPrediction

object (QueryPrediction)

Eine Vorhersage für eine Suchanfrage.

PlacePrediction

Vorhersageergebnisse für eine Place Autocomplete-Vorhersage.

JSON-Darstellung 
{
  "place": string,
  "placeId": string,
  "text": {
    object (FormattableText)
  },
  "structuredFormat": {
    object (StructuredFormat)
  },
  "types": [
    string
  ],
  "distanceMeters": integer
}
Felder
place

string

Der Ressourcenname des vorgeschlagenen Orts. Dieser Name kann in anderen APIs verwendet werden, die Ortsnamen akzeptieren.
placeId

string

Die eindeutige Kennung des vorgeschlagenen Orts. Diese Kennung kann in anderen APIs verwendet werden, die Orts-IDs akzeptieren.
text

object (FormattableText)

Der für Menschen lesbare Name des zurückgegebenen Ergebnisses. Bei Ergebnissen für Unternehmen sind dies in der Regel der Name und die Adresse des Unternehmens.

text wird Entwicklern empfohlen, die ein einzelnes UI-Element anzeigen möchten. Entwickler, die zwei separate, aber zusammenhängende UI-Elemente anzeigen möchten, sollten stattdessen structuredFormat verwenden. Es gibt zwei Möglichkeiten, eine Ortsvorhersage darzustellen. Nutzer sollten nicht versuchen, structuredFormat in text oder umgekehrt zu parsen.

Dieser Text kann sich von dem displayName unterscheiden, das von „places.get“ zurückgegeben wird.

Kann in verschiedenen Sprachen verfasst sein, wenn die Anfragen input und languageCode in verschiedenen Sprachen sind oder wenn für den Ort keine Übersetzung aus der Landessprache in languageCode verfügbar ist.
structuredFormat

object (StructuredFormat)

Eine Aufschlüsselung der Ortsvorhersage in Haupttext mit dem Namen des Orts und sekundären Text mit zusätzlichen eindeutigen Merkmalen (z. B. einer Stadt oder Region).

structuredFormat wird Entwicklern empfohlen, die zwei separate, aber zusammenhängende UI-Elemente anzeigen möchten. Entwickler, die ein einzelnes UI-Element anzeigen möchten, sollten stattdessen text verwenden. Es gibt zwei Möglichkeiten, eine Ortsvorhersage darzustellen. Nutzer sollten nicht versuchen, structuredFormat in text oder umgekehrt zu parsen.
types[]

string

Liste der Typen, die für diesen Ort gelten, aus Tabelle A oder Tabelle B in https://developers.google.com/maps/documentation/places/web-service/place-types.

Ein Typ ist eine Kategorisierung eines Orts. Orte mit demselben Typ haben ähnliche Merkmale.
distanceMeters

integer

Die Länge der Geodäten in Metern von origin, falls origin angegeben ist. Bei bestimmten Vorhersagen wie Routen wird dieses Feld möglicherweise nicht ausgefüllt.

FormattableText

Text, der eine Orts- oder Suchanfrage darstellt. Der Text kann unverändert oder formatiert verwendet werden.

JSON-Darstellung 
{
  "text": string,
  "matches": [
    {
      object (StringRange)
    }
  ]
}
Felder
text

string

Text, der unverändert verwendet oder mit matches formatiert werden kann.
matches[]

object (StringRange)

Eine Liste von Stringbereichen, die angeben, wo die Eingabeanfrage in text übereinstimmt. Mit den Bereichen können bestimmte Teile von text formatiert werden. Die Teilstrings stimmen möglicherweise nicht genau mit input überein, wenn die Übereinstimmung anhand anderer Kriterien als der Stringübereinstimmung ermittelt wurde (z. B. Rechtschreibkorrekturen oder Transliterationen).

Diese Werte sind Unicode-Zeichenabstände von text. Die Bereiche sind garantiert in aufsteigender Reihenfolge der Offsetwerte angeordnet.

StringRange

Ermittelt einen Teilstring in einem bestimmten Text.

JSON-Darstellung 
{
  "startOffset": integer,
  "endOffset": integer
}
Felder
startOffset

integer

Der nullbasierte Offset des ersten Unicode-Zeichens des Strings (einschließlich).
endOffset

integer

Der Offset des letzten Unicode-Zeichens (ab Null) (exklusiv).

StructuredFormat

Enthält eine Aufschlüsselung einer Orts- oder Suchanfragevorhersage in Haupttext und sekundären Text.

Bei Ortsvorschlägen enthält der Haupttext den spezifischen Namen des Orts. Bei Suchanfragevorschlägen enthält der Haupttext die Suchanfrage.

Der sekundäre Text enthält zusätzliche Merkmale zur Klärung von Mehrdeutigkeiten (z. B. eine Stadt oder Region), um den Ort weiter zu identifizieren oder die Suchanfrage zu verfeinern.

JSON-Darstellung 
{
  "mainText": {
    object (FormattableText)
  },
  "secondaryText": {
    object (FormattableText)
  }
}
Felder
mainText

object (FormattableText)

Der Name des Orts oder der Suchanfrage.
secondaryText

object (FormattableText)

Stellt zusätzliche Merkmale zur Klärung von Mehrdeutigkeiten dar (z. B. eine Stadt oder Region), um den Ort weiter zu identifizieren oder die Suchanfrage zu verfeinern.

QueryPrediction

Vorhersageergebnisse für eine automatische Vervollständigung von Suchanfragen.

JSON-Darstellung 
{
  "text": {
    object (FormattableText)
  },
  "structuredFormat": {
    object (StructuredFormat)
  }
}
Felder
text

object (FormattableText)

Der vorhergesagte Text. Dieser Text stellt keinen Ort dar, sondern eine Textabfrage, die in einem Suchendpunkt verwendet werden kann, z. B. in der Textsuche.

text wird Entwicklern empfohlen, die ein einzelnes UI-Element anzeigen möchten. Entwickler, die zwei separate, aber zusammenhängende UI-Elemente anzeigen möchten, sollten stattdessen structuredFormat verwenden. Es gibt zwei verschiedene Möglichkeiten, eine Suchanfragevorhersage darzustellen. Nutzer sollten nicht versuchen, structuredFormat in text oder umgekehrt zu parsen.

Kann in verschiedenen Sprachen sein, wenn die Anfrage input und languageCode in verschiedenen Sprachen sind oder wenn für einen Teil der Anfrage keine Übersetzung aus der Landessprache in languageCode verfügbar ist.
structuredFormat

object (StructuredFormat)

Eine Aufschlüsselung der Suchanfragevorhersage in Haupttext mit der Suchanfrage und sekundären Text mit zusätzlichen eindeutigen Merkmalen (z. B. einer Stadt oder Region).

structuredFormat wird Entwicklern empfohlen, die zwei separate, aber zusammenhängende UI-Elemente anzeigen möchten. Entwickler, die ein einzelnes UI-Element anzeigen möchten, sollten stattdessen text verwenden. Es gibt zwei verschiedene Möglichkeiten, eine Suchanfragevorhersage darzustellen. Nutzer sollten nicht versuchen, structuredFormat in text oder umgekehrt zu parsen.