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
}
Felder
input

string

Erforderlich. Die Textzeichenfolge, nach der gesucht werden soll.
locationBias

object (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

object (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.
includedPrimaryTypes[]

string

Optional. Primärer Ortstyp (z. B. „Restaurant“ oder „Tankstelle“) aus Tabelle A oder Tabelle B in Ortstypen (https://developers.google.com/maps/documentation/places/web-service/place-types), nur (Regionen) oder nur (Städte) 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[]

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.
languageCode

string

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 input verwendete Sprache von languageCode unterscheidet oder der zurückgegebene Ort keine Übersetzung aus der lokalen Sprache in languageCode hat.
regionCode

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. Dadurch werden die Ergebnisse nicht auf die angegebene Region beschränkt. Verwenden Sie region_code_restriction, um die Ergebnisse auf eine Region einzuschränken.
origin

object (LatLng)

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

integer

Optional. Ein nullbasierter Unicode-Zeichen-Offset von input, der die Cursorposition in input angibt. Die Cursorposition kann beeinflussen, welche Vorhersagen zurückgegeben werden.

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

boolean

Optional. Falls wahr, enthält die Antwort sowohl Orts- als auch Abfragevorhersagen. Andernfalls werden in der Antwort nur Ortsvorhersagen zurückgegeben.
sessionToken

string

Optional. Ein String, der eine Autocomplete-Sitzung zu Abrechnungszwecken identifiziert. Muss aus einer URL und einem sicheren Base64-String mit einem Dateinamen und maximal 36 ASCII-Zeichen bestehen. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

Die Sitzung beginnt, wenn der Nutzer beginnt, eine Suchanfrage einzugeben, und endet, wenn er einen Ort auswählt und ein „Place Details“- oder „Address Validation“-Aufruf erfolgt. Jede Sitzung kann mehrere Abfragen enthalten, gefolgt von einer „Place Details“- oder „Address Validation“-Anfrage. 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:

  • Verwenden Sie für alle „Place Autocomplete“-Aufrufe Sitzungstokens.
  • Generieren Sie für jede Sitzung ein neues Token. Es wird empfohlen, eine UUID Version 4 zu verwenden.
  • Achten Sie darauf, dass die Anmeldedaten, die für alle Place Autocomplete-, Place Details- und Address Validation-Anfragen innerhalb einer Sitzung verwendet werden, zum selben 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 einzeln abgerechnet.

Antworttext

Antwortprototyp 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 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 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 Darstellungsbereich, der von einer nordöstlichen und einer südwestlichen Ecke definiert wird.
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 Darstellungsbereich, der von einer nordöstlichen und einer südwestlichen Ecke definiert wird.
circle

object (Circle)

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

Vorschlag

Ein Ergebnis 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 Abfrage.

PlacePrediction

Vorhersageergebnisse für eine Place Autocomplete-Vervollständigung.

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 ID des vorgeschlagenen Orts. Diese ID kann in anderen APIs verwendet werden, die Orts-IDs akzeptieren.
text

object (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 structuredFormat verwenden. Es gibt zwei verschiedene Möglichkeiten, eine Ortsvorhersage darzustellen. Nutzer sollten nicht versuchen, structuredFormat in text zu parsen oder umgekehrt.

Dieser Text kann sich vom displayName unterscheiden, der von places.get zurückgegeben wird.

Kann in unterschiedlichen Sprachen vorliegen, wenn die Anfrage input und languageCode in verschiedenen Sprachen vorliegen oder es für den Ort keine Übersetzung aus der Landessprache in languageCode gibt.
structuredFormat

object (StructuredFormat)

Eine Aufschlüsselung der Ortsvervollständigung in Haupttext mit dem Namen des Orts und Sekundärtext mit zusätzlichen eindeutigen Merkmalen (z. B. eine Stadt oder Region).

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

string

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

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

integer

Die Länge der Geodäte in Metern von origin, wenn origin angegeben ist. Bestimmte Vervollständigungen wie Routen werden in diesem Feld möglicherweise nicht ausgefüllt.

FormattableText

Text, der eine Orts- oder Abfragevorhersage darstellt. Der Text kann in der vorliegenden Form verwendet oder formatiert werden.

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

string

Text, der in der vorliegenden Form verwendet oder mit matches formatiert werden kann.
matches[]

object (StringRange)

Eine Liste von Stringbereichen, die angeben, wo die Eingabeanfrage in text übereinstimmte. Die Bereiche können zum Formatieren bestimmter Teile von text verwendet werden. Die Teilstrings stimmen möglicherweise nicht genau mit 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 text. Die Bereiche werden garantiert in zunehmenden Offset-Werten sortiert.

StringRange

Kennzeichnet eine Teilzeichenfolge in einem gegebenen Text.

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

integer

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

integer

Nullbasierter Offset des letzten Unicode-Zeichens (ausschließlich).

StructuredFormat

Enthält eine Aufschlüsselung einer Orts- oder Abfragevorhersage in Haupt- und Sekundärtext.

Bei Place-Vervollständigungen enthält der Haupttext den genauen Namen des Orts. Bei Suchanfragenvorhersagen enthält der Haupttext die Abfrage.

Der Sekundärtext enthält zusätzliche Unterscheidungsmerkmale (wie 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 Abfrage.
secondaryText

object (FormattableText)

Zusätzliche eindeutige Merkmale (wie eine Stadt oder Region) zur weiteren Identifizierung des Orts oder zur Verfeinerung der Anfrage

QueryPrediction

Vorhersageergebnisse für eine Query Autocomplete-Vorhersage.

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. „Text Search“).

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 structuredFormat verwenden. Es gibt zwei verschiedene Möglichkeiten, eine Abfragevorhersage darzustellen. Nutzer sollten nicht versuchen, structuredFormat in text zu parsen oder umgekehrt.

Kann in gemischten Sprachen vorliegen, wenn die Anfrage input und languageCode in verschiedenen Sprachen vorliegen oder für einen Teil der Abfrage keine Übersetzung aus der lokalen Sprache in languageCode verfügbar ist.
structuredFormat

object (StructuredFormat)

Eine Aufschlüsselung der Vervollständigung der Suchanfrage in Haupttext mit der Anfrage und Sekundärtext mit zusätzlichen Unterscheidungsmerkmalen (z. B. eine Stadt oder Region).

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