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 auf einen bestimmten Standort.

Es darf höchstens locationBias oder locationRestriction festgelegt werden. Wenn beides nicht festgelegt ist, werden die Ergebnisse nach IP-Adresse gewichtet, d. h., die IP-Adresse wird einem ungenauen Standort zugeordnet und zur Gewichtung verwendet.

locationRestriction

object (LocationRestriction)

Optional. Ergebnisse auf einen bestimmten Standort beschränken

Es darf höchstens locationBias oder locationRestriction festgelegt werden. Wenn beides nicht festgelegt ist, werden die Ergebnisse nach IP-Adresse gewichtet, d. h., die IP-Adresse wird einem ungenauen Standort zugeordnet und zur Gewichtung verwendet.

includedPrimaryTypes[]

string

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[]

string

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 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 sich die in input verwendete Sprache von languageCode unterscheidet oder wenn für den zurückgegebenen Ort keine Übersetzung von der lokalen Sprache in languageCode vorliegt.

regionCode

string

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 region_code_restriction, um die Ergebnisse auf eine Region zu beschrä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 keine geodätische Entfernung zurückgegeben.

inputOffset

integer

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

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

includeQueryPredictions

boolean

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

string

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 sessionToken weggelassen wird oder Sie ein Sitzungstoken wiederverwenden, wird die Sitzung so abgerechnet, als wäre kein Sitzungstoken angegeben 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. Es wird empfohlen, eine UUID der Version 4 zu verwenden.
  • Die Anmeldedaten, die für alle „Place Autocomplete“-, „Place Details“- und „Address Validation“-Anfragen innerhalb einer Sitzung verwendet werden, müssen zum selben Cloud Console-Projekt gehören.
  • Für jede neue Sitzung muss ein eindeutiges Sitzungstoken übergeben werden. Wenn Sie dasselbe Token für mehr als eine Sitzung verwenden, wird jede Anfrage einzeln in Rechnung gestellt.

Antworttext

Antwortproto für „place.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)

Darstellungsbereich, der durch eine Nordost- und eine Südwestecke 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)

Darstellungsbereich, der durch eine Nordost- und eine Südwestecke definiert wird

circle

object (Circle)

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

Vorschlag

Ein Ergebnis eines Autocomplete-Vorschlags.

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 Vervollständigung für einen Ort.

queryPrediction

object (QueryPrediction)

Eine Vorhersage für eine Abfrage.

PlacePrediction

Vorhersageergebnisse für einen Place Autocomplete-Vorschlag.

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

string

Der Ressourcenname des vorgeschlagenen Ortes. Er kann auch in anderen APIs verwendet werden, die Ortsnamen akzeptieren.

placeId

string

Die eindeutige ID des vorgeschlagenen Orts Sie kann auch in anderen APIs verwendet werden, die Orts-IDs akzeptieren.

text

object (FormattableText)

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.

text wird für Entwickler empfohlen, die ein einzelnes UI-Element anzeigen möchten. Entwickler, die zwei separate, aber verwandte UI-Elemente anzeigen möchten, können stattdessen structuredFormat verwenden. Es gibt zwei verschiedene Möglichkeiten, einen vorgeschlagenen Ort darzustellen. Nutzer sollten nicht versuchen, structuredFormat in text zu parsen oder umgekehrt.

Dieser Text kann sich von dem von „places.get“ zurückgegebenen displayName unterscheiden.

Möglicherweise sind gemischte Sprachen verfügbar, wenn die Anfrage input und languageCode in verschiedenen Sprachen sind oder für den Ort keine Übersetzung von der Landessprache in languageCode verfügbar ist.

structuredFormat

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

structuredFormat wird für Entwickler empfohlen, die zwei separate, aber verwandte 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, einen vorgeschlagenen Ort darzustellen. Nutzer sollten nicht versuchen, structuredFormat in text zu parsen oder umgekehrt.

types[]

string

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

integer

Die Länge der Geodäte in Metern ab origin, wenn origin angegeben ist. Für bestimmte Vervollständigungen wie Routen wird dieses Feld möglicherweise nicht ausgefüllt.

FormattableText

Text, der einen Ort oder eine Abfragevorhersage darstellt. Der Text kann unverändert oder formatiert verwendet werden.

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

string

Text, der so verwendet oder mit matches formatiert werden kann.

matches[]

object (StringRange)

Eine Liste von Stringbereichen, die angeben, wo die Eingabeanfrage in text übereinstimmte. Mit den Bereichen können bestimmte Teile von text formatiert werden. Die Teilstrings sind möglicherweise keine genauen Übereinstimmungen mit input, wenn sie nicht durch den Stringabgleich, sondern durch andere Kriterien bestimmt wurden (z. B. Rechtschreibkorrekturen oder Transkriptionen).

Diese Werte sind Unicode-Zeichen-Offsets von text. Die Bereiche werden garantiert in zunehmenden Offset-Werten geordnet.

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 (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 (FormattableText)
  },
  "secondaryText": {
    object (FormattableText)
  }
}
Felder
mainText

object (FormattableText)

Stellt den Namen des Orts oder der Suchanfrage dar

secondaryText

object (FormattableText)

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 (FormattableText)
  },
  "structuredFormat": {
    object (StructuredFormat)
  }
}
Felder
text

object (FormattableText)

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“).

text wird für Entwickler empfohlen, die ein einzelnes UI-Element anzeigen möchten. Entwickler, die zwei separate, aber verwandte 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 sind oder ein Teil der Abfrage keine Übersetzung von der lokalen Sprache in languageCode enthält.

structuredFormat

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

structuredFormat wird für Entwickler empfohlen, die zwei separate, aber verwandte 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.