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,
  "includeFutureOpeningBusinesses": boolean
}
Felder
input

string

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

object (LocationBias)

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

Es sollte höchstens eines von locationBias und locationRestriction festgelegt sein. 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

object (LocationRestriction)

Optional. Suchergebnisse auf einen bestimmten Ort beschränken.

Es sollte höchstens eines von locationBias und locationRestriction festgelegt sein. 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.
includedPrimaryTypes[]

string

Optional. Der primäre Ortstyp (z. B. „restaurant“ oder „gas_station“) ist in den Ortstypen (https://developers.google.com/maps/documentation/places/web-service/place-types) enthalten 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. Schließen Sie nur Ergebnisse in den angegebenen Regionen ein, die als bis zu 15 zweistellige CLDR-Regionencodes angegeben werden. Ein leerer Satz 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 die Ergebnisse zurückgegeben werden sollen. Die Standardeinstellung ist „en-US“. Die Ergebnisse können in gemischten Sprachen vorliegen, wenn die in input verwendete Sprache von languageCode abweicht oder wenn für den zurückgegebenen Ort keine Übersetzung aus der lokalen Sprache in languageCode vorhanden ist.
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. Die Ergebnisse werden dadurch nicht auf die angegebene Region beschränkt. Verwenden Sie region_code_restriction, um die Ergebnisse auf eine Region zu beschränken.
origin

object (LatLng)

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

integer

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 leer, wird standardmäßig die Länge von input verwendet.
includeQueryPredictions

boolean

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

string

Optional. Ein String, der eine Autocomplete-Sitzung zu Abrechnungszwecken identifiziert. Muss eine URL- und Dateinamen-kompatible Base64-Zeichenfolge mit maximal 36 ASCII-Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

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

Wir empfehlen folgende Richtlinien:

  • Verwenden Sie Sitzungstokens für alle Place Autocomplete-Aufrufe.
  • Generieren Sie für jede Sitzung ein neues Token. Die Verwendung einer UUID der Version 4 wird empfohlen.
  • Achten Sie darauf, dass die Anmeldedaten, die für alle Anfragen für Place Autocomplete, Place Details und Address Validation 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 separat in Rechnung gestellt.
includePureServiceAreaBusinesses

boolean

Optional. Schließen Sie Unternehmen ohne festen Standort in einem Einzugsgebiet ein, 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. Dazu gehören z. B. Reinigungsfirmen oder Klempner. Diese Unternehmen haben keine physische Adresse oder keinen Standort bei Google Maps. Für diese Unternehmen werden von Places keine Felder wie location, plusCode und andere standortbezogene Felder zurückgegeben.
includeFutureOpeningBusinesses

boolean

Optional. Bei Einstellung auf „true“ werden auch Unternehmen berücksichtigt, die noch nicht geöffnet sind, aber in Zukunft öffnen werden.

Antworttext

Antwort-Proto 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, die in absteigender Reihenfolge nach Relevanz sortiert sind.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

LocationBias

Die Region, in der gesucht werden soll. Die Ergebnisse können auf die angegebene Region ausgerichtet 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 Viewport, der durch eine Nordost- und eine Südwest-Ecke definiert wird.
circle

object (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 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 Viewport, der durch eine Nordost- und eine Südwest-Ecke definiert wird.
circle

object (Circle)

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

Vorschlag

Ein Ergebnis für einen automatisch vervollständigten Vorschlag.

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

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)

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 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 von dem displayName unterscheiden, der von „places.get“ zurückgegeben wird.

Die Antwort kann in verschiedenen Sprachen verfasst sein, wenn die Anfrage input und languageCode in verschiedenen Sprachen gestellt werden oder wenn für den Ort keine Übersetzung von der lokalen Sprache in languageCode vorhanden ist.
structuredFormat

object (StructuredFormat)

Eine Aufschlüsselung der Ortsvorhersage in Haupttext mit dem Namen des Orts und sekundären Text mit zusätzlichen Unterscheidungsmerkmalen wie einer Stadt oder Region.

structuredFormat wird für Entwickler empfohlen, die zwei separate, aber zusammengehörige 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 Ortsvorhersage darzustellen. Nutzer sollten nicht versuchen, structuredFormat in text zu parsen oder umgekehrt.
types[]

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.

Ein Typ ist eine Kategorisierung eines Orts. Orte mit gemeinsamen Typen haben ähnliche Eigenschaften.
distanceMeters

integer

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

FormattableText

Text, der eine Orts- oder Abfragevorhersage darstellt. Der Text kann unverändert verwendet oder formatiert 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 Sie bestimmte Teile von text formatieren. Die Teilstrings müssen nicht genau mit input übereinstimmen, wenn die Übereinstimmung anhand anderer Kriterien als String-Abgleich ermittelt wurde, z. B. durch Rechtschreibkorrekturen oder Transliterationen.

Diese Werte sind Unicode-Zeichen-Offsets von text. Die Bereiche sind garantiert nach aufsteigenden Offsetwerten sortiert.

StringRange

Gibt einen Teilstring in einem bestimmten Text an.

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

integer

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

integer

Nullbasierter Offset des letzten Unicode-Zeichens (exklusiv).

StructuredFormat

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

Bei Ortsvorhersagen enthält der Haupttext den genauen Namen des Orts. Bei Vorhersagen für Anfragen enthält der Haupttext die Anfrage.

Der sekundäre Text enthält zusätzliche Informationen zur Unterscheidung (z. B. eine Stadt oder Region), um den Ort weiter zu identifizieren oder die Anfrage zu verfeinern.

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

object (FormattableText)

Stellt den Namen des Orts oder der Anfrage dar.
secondaryText

object (FormattableText)

Stellt zusätzliche disambiguierende Attribute (z. B. eine Stadt oder Region) dar, um den Ort weiter zu identifizieren oder die Anfrage zu verfeinern.

QueryPrediction

Vorhersageergebnisse für eine automatische Vervollständigung.

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

object (FormattableText)

Der vorhergesagte Text. Dieser Text stellt keinen Ort dar, sondern eine Textanfrage, die in einem Such-Endpoint (z. B. Text Search) verwendet werden könnte.

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

Die Antwort kann in verschiedenen Sprachen verfasst sein, wenn die Anfrage input und languageCode in verschiedenen Sprachen formuliert sind oder wenn für einen Teil der Anfrage keine Übersetzung von der lokalen Sprache 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 disambiguierenden Merkmalen (z. B. einer Stadt oder Region).

structuredFormat wird für Entwickler empfohlen, die zwei separate, aber zusammengehörige UI-Elemente anzeigen möchten. Entwickler, die ein einzelnes UI-Element anzeigen möchten, sollten stattdessen text verwenden. Sie sind zwei verschiedene Möglichkeiten, eine Suchvorhersage darzustellen. Nutzer sollten nicht versuchen, structuredFormat in text zu parsen oder umgekehrt.