Method: geocode.destinations.searchDestinations

Mit dieser Methode wird eine Zielsuche durchgeführt und eine Liste von Zielen zurückgegeben.

HTTP-Anfrage

POST https://geocode.googleapis.com/v4beta/geocode/destinations

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "travelModes": [
    enum (NavigationPoint.TravelMode)
  ],
  "languageCode": string,
  "regionCode": string,

  // Union field primary_query can be only one of the following:
  "place": string,
  "addressQuery": {
    object (SearchDestinationsRequest.AddressQuery)
  },
  "locationQuery": {
    object (SearchDestinationsRequest.LocationQuery)
  }
  // End of list of possible types for union field primary_query.
}
Felder
travelModes[]

enum (NavigationPoint.TravelMode)

Optional. Die Mobilitätsformen, nach denen Navigationspunkte gefiltert werden sollen. Dies wirkt sich auf das Feld navigationPoints aus, das in der Antwort zurückgegeben wird. Wenn leer, können Navigationspunkte aller Mobilitätsformen zurückgegeben werden.
languageCode

string

Optional. Die Sprache, in der die Ergebnisse zurückgegeben werden sollen.
regionCode

string

Optional. Regionscode. Der Regionscode, angegeben als zweistelliger Ländercode der Top-Level-Domain (ccTLD). Der Parameter wirkt sich auf die Ergebnisse aus, die auf dem anwendbaren Recht basieren. Dieser Parameter beeinflusst auch die Ergebnisse des Dienstes, schränkt sie aber nicht vollständig ein.

Union-Feld primary_query. Fragen Sie nach dem primären Ziel. Das kann ein Ort, eine vollständig angegebene Adresse oder ein LatLng-Standort sein. Einige Orte und Adressen mit minimalen Informationen können nicht in ein Ziel umgewandelt werden.

Die Ziele basieren auf der angegebenen Primärabfrage.

Hinweis: Es werden nur Orte und Adressen unterstützt, die als Navigationsziel verwendet werden können. Ein Ort, der ein Haus oder einen Wohnkomplex darstellt, kann beispielsweise als primäre Anfrage verwendet werden. Orte, die eine Ortschaft oder eine Verwaltungseinheit darstellen, können jedoch nicht als primäre Anfrage verwendet werden. Für primary_query ist nur einer der folgenden Werte zulässig:
place

string

Der Ressourcenname eines Orts im Format places/{placeId}.
addressQuery

object (SearchDestinationsRequest.AddressQuery)

Eine Adresse.
locationQuery

object (SearchDestinationsRequest.LocationQuery)

Einen genauen Standort.

Antworttext

Antwortnachricht für DestinationService.SearchDestinations.

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

JSON-Darstellung 
{
  "destinations": [
    {
      object (Destination)
    }
  ]
}
Felder
destinations[]

object (Destination)

Eine Liste mit Zielen.

Der Dienst gibt ein Ergebnis zurück, wenn ein primäres Ziel anhand der primären Anfrage eindeutig identifiziert werden kann. Andernfalls gibt der Dienst möglicherweise mehrere Ergebnisse zur Eindeutigkeit oder keine Ergebnisse zurück.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

SearchDestinationsRequest.AddressQuery

Die Adresse, nach der Sie suchen möchten. Geben Sie Adressen im vom Postdienst des jeweiligen Landes verwendeten Format an.

JSON-Darstellung 
{

  // Union field kind can be only one of the following:
  "address": {
    object (PostalAddress)
  },
  "addressQuery": string
  // End of list of possible types for union field kind.
}
Felder
Union-Feld kind. Die Adressabfrage. Für kind ist nur einer der folgenden Werte zulässig:
address

object (PostalAddress)

Eine Straßenadresse im Format einer Postanschrift.
addressQuery

string

Eine Adresse, die als eine Zeile formatiert ist.

SearchDestinationsRequest.LocationQuery

Eine Standortanfrage, um ein primäres Ziel in der Nähe zu ermitteln.

Hinweis: Wenn sich die Standortanfrage in einem Gebäude mit untergeordneten Räumlichkeiten befindet, kann es sein, dass der zurückgegebene primäre Ort eine untergeordnete Räumlichkeit ist. In diesen Fällen enthält das Feld „containingPlaces“ das Gebäude.

JSON-Darstellung 
{
  "placeFilter": {
    object (SearchDestinationsRequest.LocationQuery.PlaceFilter)
  },

  // Union field kind can be only one of the following:
  "location": {
    object (LatLng)
  }
  // End of list of possible types for union field kind.
}
Felder
placeFilter

object (SearchDestinationsRequest.LocationQuery.PlaceFilter)

Optional. Filter, die auf Zielkandidaten angewendet werden sollen.
Union-Feld kind. Die Standortabfrage. Für kind ist nur einer der folgenden Werte zulässig:
location

object (LatLng)

Ein genauer LatLng-Standort.

SearchDestinationsRequest.LocationQuery.PlaceFilter

Filter, die auf Zielkandidaten angewendet werden sollen.

JSON-Darstellung 
{
  "structureType": enum (PlaceView.StructureType),
  "addressability": enum (SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability)
}
Felder
structureType

enum (PlaceView.StructureType)

Optional. Wenn angegeben, haben alle Ziele garantiert einen primären Ort mit diesem Strukturtyp. Dies kann dazu führen, dass einige Ziele herausgefiltert oder die zurückgegebenen Ziele gröber oder feiner dargestellt werden.

Wenn beispielsweise GROUNDS angegeben ist, haben alle zurückgegebenen Ziele einen primären Ort mit dem Strukturtyp GROUNDS. Das kann dazu führen, dass einige Ziele herausgefiltert werden, die nicht Teil eines Grundstücks sind, oder dass die zurückgegebenen Ziele auf die Grundstücksebene reduziert werden.

Dieses Feld kann auch verwendet werden, um leichter Polygone für die Darstellung von Gebäuden zu extrahieren. Wenn beispielsweise BUILDING angegeben ist, wird das Anzeigepolygon des primären Orts für das Gebäude am angegebenen Ort verwendet.
addressability

enum (SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability)

Optional. Falls angegeben, werden nur Ziele zurückgegeben, die die entsprechenden Kriterien für die Adressierbarkeit erfüllen.

PlaceView.StructureType

Der Typ der Struktur, die dieser Ort darstellt.

Enums
STRUCTURE_TYPE_UNSPECIFIED Nicht verwendet.
POINT Ein Punktstandort.
SECTION Ein Unterabschnitt eines Gebäudes.
BUILDING Ein Gebäude.
GROUNDS Ein großes Gebiet, das in der Regel mehrere Gebäude umfasst, z. B. ein Universitätsgelände, ein Wohnkomplex oder ein Einkaufszentrum.

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

Definiert Optionen für die Filterung der Adressierbarkeit. In Zukunft werden möglicherweise neue Werte hinzugefügt.

Enums
ADDRESSABILITY_UNSPECIFIED Wenn kein Wert angegeben ist, wählt der Dienst einen angemessenen Standardwert aus.
ANY Die Adressierbarkeit ist kein Filterkriterium. Ziele werden unabhängig von ihrer Adressierbarkeit zurückgegeben.
PRIMARY Alle zurückgegebenen Ziele haben einen primären Ort mit einer Adresse oder einem Namen auf Straßenebene.
WEAK Alle zurückgegebenen Ziele haben entweder einen primären Ort oder ein Unterziel mit einer Adresse oder einem Namen auf Straßenebene.

Ziel

Ein Ziel Dazu gehören der primäre Ort, zugehörige Orte, Eingänge und Navigationspunkte.

JSON-Darstellung 
{
  "primary": {
    object (PlaceView)
  },
  "containingPlaces": [
    {
      object (PlaceView)
    }
  ],
  "subDestinations": [
    {
      object (PlaceView)
    }
  ],
  "landmarks": [
    {
      object (Landmark)
    }
  ],
  "entrances": [
    {
      object (Entrance)
    }
  ],
  "navigationPoints": [
    {
      object (NavigationPoint)
    }
  ]
}
Felder
primary

object (PlaceView)

Der primäre Ort, der von primary_query in der Anfrage angegeben wurde.
containingPlaces[]

object (PlaceView)

Die weniger genauen Orte, die den primären Ort enthalten. Zum Beispiel der Wohnkomplex, in dem sich dieses Gebäude befindet.
subDestinations[]

object (PlaceView)

Genauere Unterziele des primären Ortes. Beispiel: Einheiten in einem Gebäude.

Hinweis: Im Vergleich zu SubDestination, das von der Places API zurückgegeben wird, ist diese Liste von untergeordneten Zielen umfassender und jedes untergeordnete Ziel enthält mehr Informationen.
landmarks[]

object (Landmark)

Sehenswürdigkeiten, die verwendet werden können, um den Standort des Ziels anzugeben oder die Ankunft zu erleichtern.
entrances[]

object (Entrance)

Eingänge für dieses Ziel.
navigationPoints[]

object (NavigationPoint)

Navigationspunkte für dieses Ziel.

PlaceView

Stellt eine Ansicht eines Orts in der Places API dar. Außerdem enthält sie zusätzliche Informationen zu Zielen, z. B. den Strukturtyp und das Anzeigepolygon.

In einigen Fällen kann sich ein PlaceView mit derselben Orts-ID von dem unterscheiden, was von der Places API für die Felder types und displayName zurückgegeben wird.

JSON-Darstellung 
{
  "place": string,
  "displayName": {
    object (LocalizedText)
  },
  "primaryType": string,
  "types": [
    string
  ],
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "structureType": enum (PlaceView.StructureType),
  "location": {
    object (LatLng)
  },
  "displayPolygon": {
    object
  }
}
Felder
place

string

Der Ressourcenname dieses Orts im Format places/{placeId}.
displayName

object (LocalizedText)

Menschenlesbare Ortsbeschreibung. Beispiele: „Gate B“, „McDonalds“
primaryType

string

Der primäre Ortstyp dieses Orts. Eine Liste der möglichen Werte finden Sie unter https://developers.google.com/maps/documentation/places/web-service/place-types.

Hinweis: Dieses Feld wird nicht immer ausgefüllt. In solchen Fällen sollten Sie das Feld types verwenden.
types[]

string

Alle zugehörigen Ortstypen dieses Orts. Eine Liste der möglichen Werte finden Sie unter https://developers.google.com/maps/documentation/places/web-service/place-types.
formattedAddress

string

Eine Zeile für die Adresse.
postalAddress

object (PostalAddress)

Strukturierte Adresse.
structureType

enum (PlaceView.StructureType)

Der Strukturtyp, der diesem Ort entspricht.
location

object (LatLng)

Der Standort dieses Orts. Bei Orten mit Anzeigepolygonen kann dies ein guter Ort sein, um eine Markierung auf der Karte zu platzieren.
displayPolygon

object (Struct format)

Die Polygonumrisslinie des Orts im GeoJSON-Format gemäß RFC 7946: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6.

Hinweis: Das RFC 7946-Format unterstützt MultiPolygons. Ein displayPolygon-Objekt kann also mehrere Polygone darstellen.

Sehenswürdigkeit

Orientierungspunkte werden verwendet, um das Ziel zu kommunizieren oder die Ankunft am Ziel zu erleichtern.

JSON-Darstellung 
{
  "relationalDescription": {
    object (LocalizedText)
  },
  "tags": [
    enum (Landmark.Tag)
  ],
  "straightLineDistanceMeters": number,
  "travelDistanceMeters": number,

  // Union field landmark can be only one of the following:
  "place": {
    object (PlaceView)
  }
  // End of list of possible types for union field landmark.
}
Felder
relationalDescription

object (LocalizedText)

Eine für Menschen lesbare Beschreibung, wie das Ziel mit dem Orientierungspunkt zusammenhängt. Beispiele: „In der Nähe des Empire State Building“ oder „Gegenüber dem Weißen Haus“.
tags[]

enum (Landmark.Tag)

Tags, die beschreiben, wie das Wahrzeichen im Kontext des Ziels verwendet werden kann.
straightLineDistanceMeters

number

Nur Ausgabe. Die Luftlinie von diesem Orientierungspunkt zum Ziel in Metern.
travelDistanceMeters

number

Nur Ausgabe. Die Entfernung vom Straßennetz von diesem Orientierungspunkt zum Zielort in Metern.
Union-Feld landmark. Die Markierung. Für landmark ist nur einer der folgenden Werte zulässig:
place

object (PlaceView)

Der Ort, der dieses Wahrzeichen repräsentiert.

Landmark.Tag

Die Liste aller möglichen Tags, die beschreiben, wie ein Wahrzeichen im Kontext eines Reiseziels verwendet werden kann.

Wenn eine Adresse sowohl das Tag ADDRESS als auch das Tag ARRIVAL hat, ist das Wahrzeichen sowohl lokal bekannt als auch in der Nähe des Zielorts.

Enums
TAG_UNSPECIFIED Nicht verwendet.
ADDRESS Ein lokal bekannter Ort, der verwendet werden kann, um den allgemeinen Standort des Ziels zu identifizieren. Normalerweise innerhalb weniger Hundert Meter vom Ziel entfernt. Diese ähneln den Orientierungspunkten, die von der Funktion „Adressdeskriptoren“ der Geocoding API zurückgegeben werden: https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors.
ARRIVAL Ein Ort, der als Orientierungshilfe dienen kann, um das Ziel zu erreichen. Nützlich für die Navigation, wenn Sie sich in der Nähe des Ziels befinden. Das kann beispielsweise ein Ort sein, der sich auf der gegenüberliegenden Straßenseite des Ziels befindet. Ein Orientierungspunkt mit diesem Tag liegt in der Regel näher am Ziel als Orientierungspunkte mit dem Tag ADDRESS.

Eingang

Ein Eingang ist ein einzelnes Breiten-/Längengrad-Koordinatenpaar, das den Standort eines Ein- und Ausgangspunkts für einen Ort definiert.

JSON-Darstellung 
{
  "location": {
    object (LatLng)
  },
  "tags": [
    enum (Entrance.Tag)
  ],
  "place": string
}
Felder
location

object (LatLng)

Der Standort des Eingangs.
tags[]

enum (Entrance.Tag)

Eine Liste von Tags, die den Eingang beschreiben.
place

string

Die Struktur, auf der sich dieser Eingang physisch befindet, im Format places/{placeId}.

Entrance.Tag

Merkmale, die einen Einstieg beschreiben.

Enums
TAG_UNSPECIFIED Nicht verwendet.
PREFERRED

Der Eingang bietet wahrscheinlich physischen Zugang zum primären Ort am zurückgegebenen Ziel. Ein Ort kann mehrere bevorzugte Eingänge haben. Wenn ein Eingang dieses Tag nicht hat, befindet er sich zwar physisch im selben Gebäude wie der primäre Ort, bietet aber nicht unbedingt Zugang zum Ort.

Wenn der primäre Ort beispielsweise ein Restaurant in einem Einkaufszentrum ist, sind die „PREFERRED“-Eingänge wahrscheinlich die Eingänge, die direkt ins Restaurant führen. Die anderen zurückgegebenen Eingänge sind andere Eingänge für das Gebäude, z. B. Eingänge zu anderen Restaurants im Einkaufszentrum.

Wenn der primäre Ort ein Gebäude ist, sind die PREFERRED-Eingänge diejenigen, die in den „Hauptteil“ des Gebäudes führen. In einem Einkaufszentrum sind beispielsweise die Eingänge PREFERRED, die den Zugang zum Hauptfoyer ermöglichen. Wenn ein Eingang nur den Zugang zu einem Geschäft an der Seite des Gebäudes ermöglicht, ist er kein PREFERRED-Eingang.

Hinweis: Ein PREFERRED-Eingang bietet möglicherweise keinen Zugang zum primären Ort und ein nicht PREFERRED-Eingang bietet möglicherweise Zugang zum primären Ort.