Method: places.searchText

Textabfragebasierte Ortssuche

HTTP-Anfrage

POST https://places.googleapis.com/v1/places:searchText

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "pageSize": integer,
  "pageToken": string,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  }
}
Felder
textQuery

string

Erforderlich. Die Textabfrage für die Textsuche.

languageCode

string

Ortsdetails werden in der bevorzugten Sprache angezeigt, sofern verfügbar. Wenn der Sprachcode nicht angegeben oder nicht erkannt wird, können Ortsdetails beliebiger Sprachen zurückgegeben werden, wobei Englisch bevorzugt wird.

Aktuelle Liste der unterstützten Sprachen: https://developers.google.com/maps/faq#languagesupport.

regionCode

string

Der Unicode-Ländercode (CLDR) des Standorts, von dem die Anfrage stammt. Mit diesem Parameter werden die Ortsdetails angezeigt, z. B. der regionsspezifische Ortsname (falls verfügbar). Der Parameter kann sich gemäß anwendbarem Recht auf Ergebnisse auswirken.

Weitere Informationen finden Sie unter https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

Dreistellige Regionscodes werden derzeit nicht unterstützt.

rankPreference

enum (RankPreference)

Wie die Ergebnisse in der Antwort sortiert werden.

includedType

string

Der angeforderte Ortstyp. Eine vollständige Liste der unterstützten Typen finden Sie unter https://developers.google.com/maps/documentation/places/web-service/place-types. Es wird nur ein eingeschlossener Typ unterstützt.

openNow

boolean

Wird verwendet, um die Suche auf Orte einzuschränken, die derzeit geöffnet sind. Der Standardwert ist "false".

minRating

number

Filtern Sie Ergebnisse heraus, deren durchschnittliche Nutzerbewertung grundsätzlich unter diesem Grenzwert liegt. Ein gültiger Wert muss eine Gleitkommazahl zwischen 0 und 5 (einschließlich) mit einer Kadenz von 0,5 sein, d. h. [0, 0,5, 1,0, ... , 5,0] (jeweils einschließlich). Die Eingabe wird auf die nächste 0,5(Obergrenze) aufgerundet. Beispielsweise werden bei einer Bewertung von 0,6 alle Ergebnisse mit einer Bewertung unter 1,0 ausgeschlossen.

maxResultCount
(deprecated)

integer

Eingestellt: Verwenden Sie stattdessen pageSize.

Die maximale Anzahl von Ergebnissen pro Seite, die zurückgegeben werden können. Wenn die Anzahl der verfügbaren Ergebnisse größer als maxResultCount ist, wird ein nextPageToken zurückgegeben, der an pageToken übergeben werden kann, um die nächste Seite mit Ergebnissen in nachfolgenden Anfragen aufzurufen. Wenn 0 oder kein Wert angegeben ist, wird der Standardwert 20 verwendet. Der Maximalwert beträgt 20. Für Werte über 20 wird eine Umwandlung von 20 auf 20 vorgenommen. Negative Werte geben den Fehler INVALID_ ARGUMENT zurück.

Wenn sowohl maxResultCount als auch pageSize angegeben sind, wird maxResultCount ignoriert.

pageSize

integer

Optional. Die maximale Anzahl von Ergebnissen pro Seite, die zurückgegeben werden können. Wenn die Anzahl der verfügbaren Ergebnisse größer als pageSize ist, wird ein nextPageToken zurückgegeben, der an pageToken übergeben werden kann, um die nächste Seite mit Ergebnissen in nachfolgenden Anfragen aufzurufen. Wenn 0 oder kein Wert angegeben ist, wird der Standardwert 20 verwendet. Der Maximalwert beträgt 20, Werte über 20 werden auf 20 festgelegt. Negative Werte geben den Fehler INVALID_ ARGUMENT zurück.

Wenn sowohl maxResultCount als auch pageSize angegeben sind, wird maxResultCount ignoriert.

pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen TextSearch-Aufruf empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle für TextSearch bereitgestellten Parameter mit Ausnahme von pageToken, pageSize und maxResultCount mit dem ursprünglichen Aufruf übereinstimmen, über den das Seitentoken bereitgestellt wurde. Andernfalls wird der Fehler INVALID_ ARGUMENT zurückgegeben.

priceLevels[]

enum (PriceLevel)

Wird verwendet, um die Suche auf Orte zu beschränken, die mit bestimmten Preisstufen gekennzeichnet sind. Nutzer können beliebige Kombinationen von Preisstufen auswählen. Standardmäßig werden alle Preisstufen ausgewählt.

strictTypeFiltering

boolean

Wird verwendet, um eine strikte Filterung nach „includedType“ festzulegen. Wenn die Richtlinie auf „true“ gesetzt ist, werden nur Ergebnisse desselben Typs zurückgegeben. Die Standardeinstellung ist „false“.

locationBias

object (LocationBias)

Die Region, in der gesucht werden soll. Dieser Standort dient als Verzerrung, das heißt, dass Ergebnisse in der Nähe des angegebenen Standorts zurückgegeben werden können. Kann nicht zusammen mit „locationRestriction“ festgelegt werden.

locationRestriction

object (LocationRestriction)

Die Region, in der gesucht werden soll. Dieser Standort dient als Einschränkung, was bedeutet, dass keine Ergebnisse außerhalb des angegebenen Standorts zurückgegeben werden. Kann nicht zusammen mit locationBias festgelegt werden.

evOptions

object (EVOptions)

Optional. Die Optionen für durchsuchbare Elektrofahrzeuge einer Ortssuchanfrage festlegen

Antworttext

Antwortproto für „place.searchText“.

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung
{
  "places": [
    {
      object (Place)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string
}
Felder
places[]

object (Place)

Eine Liste von Orten, die den Kriterien der Textsuche des Nutzers entsprechen.

contextualContents[]

object (ContextualContent)

Experimentell: Weitere Informationen finden Sie unter https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

Eine Liste mit kontextbezogenen Inhalten, in der jeder Eintrag dem entsprechenden Ort im selben Index im Feld „Places“ zugeordnet ist. Die Inhalte, die für die textQuery in der Anfrage relevant sind, werden bevorzugt. Wenn der kontextbezogene Inhalt für einen der Orte nicht verfügbar ist, werden nicht kontextbezogene Inhalte zurückgegeben. Er ist nur leer, wenn die Inhalte für diesen Ort nicht verfügbar sind. Diese Liste sollte genauso viele Einträge enthalten wie die angeforderte Liste der Orte.

nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird oder leer ist, gibt es keine nachfolgenden Seiten.

RankPreference

Wie die Ergebnisse in der Antwort sortiert werden.

Enums
RANK_PREFERENCE_UNSPECIFIED Für eine kategoriale Abfrage wie „Restaurants in New York City“ ist RELEVANCE der Standardwert. Für nicht kategoriale Abfragen wie „Mountain View, CA“ empfehlen wir, rankpreferences nicht zu konfigurieren.
DISTANCE Ergebnisse werden nach Entfernung sortiert.
RELEVANCE Die Ergebnisse werden nach Relevanz sortiert. Die Sortierreihenfolge wird durch einen normalen Ranking-Stack bestimmt.

LocationBias

Die Region, in der gesucht werden soll. Dieser Standort dient als Verzerrung, das heißt, dass Ergebnisse in der Nähe des angegebenen Standorts zurückgegeben werden können.

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)

Rechteckfeld, das durch die nordöstliche und die südwestliche Ecke definiert wird rectangle.high() muss der nordöstliche Punkt des rechteckigen Darstellungsbereichs sein. rectangle.low() muss der südwestliche Punkt des rechteckigen Darstellungsbereichs sein. rectangle.low().latitude() darf nicht größer als rectangle.high().latitude() sein. Dies führt zu einem leeren Breitengradbereich. Ein rechteckiger Darstellungsbereich darf nicht breiter als 180 Grad sein.

circle

object (Circle)

Ein durch Mittelpunkt und Radius definierter Kreis.

LocationRestriction

Die Region, in der gesucht werden soll. Dieser Standort dient als Einschränkung, was bedeutet, dass keine Ergebnisse außerhalb des angegebenen Standorts zurückgegeben werden.

JSON-Darstellung
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  }
  // 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)

Rechteckfeld, das durch die nordöstliche und die südwestliche Ecke definiert wird rectangle.high() muss der nordöstliche Punkt des rechteckigen Darstellungsbereichs sein. rectangle.low() muss der südwestliche Punkt des rechteckigen Darstellungsbereichs sein. rectangle.low().latitude() darf nicht größer als rectangle.high().latitude() sein. Dies führt zu einem leeren Breitengradbereich. Ein rechteckiger Darstellungsbereich darf nicht breiter als 180 Grad sein.

EVOptions

Durchsuchbare Optionen für Elektrofahrzeuge einer Ortssuchanfrage.

JSON-Darstellung
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
Felder
minimumChargingRateKw

number

Optional. Erforderliche Mindestladeleistung in Kilowatt. Orte, deren Kosten unter dem angegebenen Tarif liegen, wird herausgefiltert.

connectorTypes[]

enum (EVConnectorType)

Optional. Die Liste der bevorzugten Steckertypen für Elektrofahrzeuge. Ein Ort, der keinen der aufgeführten Connector-Typen unterstützt, wird herausgefiltert.

ContextualContent

Experimentell: Weitere Informationen finden Sie unter https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

Inhalt im Kontext der Ortsanfrage

JSON-Darstellung
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
Felder
reviews[]

object (Review)

Liste der Rezensionen zu diesem Ort, die mit der Ortsanfrage zusammenhängen.

photos[]

object (Photo)

Informationen (einschließlich Quellenangaben) zu Fotos dieses Orts, die mit der Ortsanfrage verknüpft sind.

justifications[]

object (Justification)

Experimentell: Weitere Informationen finden Sie unter https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

Begründungen für den Ort.

Begründung

Experimentell: Weitere Informationen finden Sie unter https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

Begründungen für den Ort. Mit Begründungen wird die Frage beantwortet, warum ein Ort für Endnutzer von Interesse sein könnte.

JSON-Darstellung
{

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
Felder

Union-Feld justification.

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

reviewJustification

object (ReviewJustification)

Experimentell: Weitere Informationen finden Sie unter https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

Experimentell: Weitere Informationen finden Sie unter https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

ReviewJustification

Experimentell: Weitere Informationen finden Sie unter https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

Begründungen für Nutzerrezensionen. Dadurch wird ein Abschnitt der Nutzerrezension hervorgehoben, der für die Endanwendenden interessant ist. Wenn die Suchanfrage beispielsweise „feuerholzpizza“ lautet, hebt die Begründung der Rezension den für die Suchanfrage relevanten Text hervor.

JSON-Darstellung
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
Felder
highlightedText

object (HighlightedText)

review

object (Review)

Die Rezension, aus der der markierte Text generiert wird.

HighlightedText

Der von der Begründung hervorgehobene Text. Dies ist ein Teilbereich der Rezension selbst. Das genaue Wort, das markiert werden soll, ist durch HighlightedTextRange gekennzeichnet. Möglicherweise sind mehrere Wörter im Text hervorgehoben.

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

string

highlightedTextRanges[]

object (HighlightedTextRange)

Die Liste der Bereiche des markierten Textes.

HighlightedTextRange

Der Bereich des markierten Texts.

JSON-Darstellung
{
  "startIndex": integer,
  "endIndex": integer
}
Felder
startIndex

integer

endIndex

integer

BusinessAvailabilityAttributesJustification

Experimentell: Weitere Informationen finden Sie unter https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative. BusinessAvailabilityAttributes-Begründungen. Hier sehen Sie einige Attribute eines Unternehmens, die für Endnutzer von Interesse sein könnten.

JSON-Darstellung
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
Felder
takeout

boolean

Gibt an, ob an einem Ort Essen zum Mitnehmen angeboten wird.

delivery

boolean

Gibt an, ob ein Ort einen Lieferservice anbietet.

dineIn

boolean

Gibt an, ob an einem Ort Verzehr vor Ort angeboten wird