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/v4/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, werden Navigationspunkte für alle Mobilitätsformen zurückgegeben.
languageCode

string

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

string

Optional. Regionscode. Der Regionscode, angegeben als zweistelliger Wert für die länderspezifische Top-Level-Domain (ccTLD). Der Parameter wirkt sich auf die Ergebnisse gemäß geltendem Recht aus. Durch diesen Parameter werden die Ergebnisse des Dienstes zwar beeinflusst, aber nicht vollständig eingeschränkt.

Union-Feld primary_query. Fragen Sie das primäre Ziel ab. 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 Zielgruppen werden auf Grundlage der angegebenen Primärabfrage erstellt.

Hinweis: Es werden nur Orte und Adressen unterstützt, die als Navigationsziel verwendet werden können. Beispielsweise kann ein Ort, der ein Haus oder einen Apartmentkomplex darstellt, als Primärabfrage verwendet werden, Orte, die eine Ortschaft oder ein Verwaltungsgebiet darstellen, jedoch nicht. Für primary_query ist nur einer der folgenden Werte zulässig:
place

string

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

object (SearchDestinationsRequest.AddressQuery)

Eine Adresse.
locationQuery

object (SearchDestinationsRequest.LocationQuery)

Ein genauer 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ärabfrage eindeutig identifiziert werden kann. Andernfalls gibt der Dienst möglicherweise mehrere Ergebnisse zur Klärung 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
  • https://www.googleapis.com/auth/maps-platform.destinations

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 Adresse im Format einer Postanschrift.
addressQuery

string

Eine Adresse, die als einzelne 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 werden oder die zurückgegebenen Ziele vergröbert oder verfeinert werden.

Wenn beispielsweise GROUNDS angegeben ist, haben alle zurückgegebenen Ziele einen primären Ort mit dem Strukturtyp GROUNDS. Dies kann dazu führen, dass einige Ziele, die nicht Teil eines Geländes sind, herausgefiltert werden oder dass die zurückgegebenen Ziele auf die Ebene des Geländes vergröbert werden.

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

enum (SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability)

Optional. Wenn angegeben, werden nur Ziele zurückgegeben, die die entsprechenden Adressierbarkeitskriterien 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ätscampus, ein Apartmentkomplex oder ein Einkaufszentrum.

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

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

Enums
ADDRESSABILITY_UNSPECIFIED Wenn nichts angegeben ist, wählt der Dienst einen sinnvollen 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 untergeordnetes Ziel mit einer Adresse oder einem Namen auf Straßenebene.

Ziel

Ein Ziel. Dazu gehören der Hauptort, 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 durch primary_query in der Anfrage identifiziert wird.
containingPlaces[]

object (PlaceView)

Die weniger genauen Orte, in denen der primäre Ort enthalten ist. Beispiel: der Apartmentkomplex, zu dem dieses Gebäude gehört.
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)

Orientierungspunkte, die verwendet werden können, um zu kommunizieren, wo sich das Ziel befindet, oder um 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,
  "placeId": string,
  "displayName": {
    object (LocalizedText)
  },
  "primaryType": string,
  "types": [
    string
  ],
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "structureType": enum (PlaceView.StructureType),
  "location": {
    object (LatLng)
  },
  "displayPolygon": {
    object
  },
  "addressComponents": [
    {
      object (PlaceView.AddressComponent)
    }
  ]
}
Felder
place

string

Der Ressourcenname dieses Orts im Format places/{placeId}. Kann zum Suchen des Orts verwendet werden.
placeId

string

Die eindeutige Kennung eines Orts.
displayName

object (LocalizedText)

Menschenlesbare Beschreibung des Ortes. Beispiel: „Gate B“, „McDonalds“
primaryType

string

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

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

string

Alle mit diesem Ort verknüpften Ortstypen. Eine Liste der möglichen Werte finden Sie unter https://developers.google.com/maps/documentation/places/web-service/place-types.
formattedAddress

string

Einzeilige Adresse.
postalAddress

object (PostalAddress)

Strukturierte Adresse.
structureType

enum (PlaceView.StructureType)

Der Typ des Gebäudes, das diesem Ort entspricht.
location

object (LatLng)

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

object (Struct format)

Der Polygonumriss des Ortes 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, sodass ein displayPolygon-Objekt mehrere Polygone darstellen kann.
addressComponents[]

object (PlaceView.AddressComponent)

Wiederholte Komponenten für jede Ortsebene.

PlaceView.AddressComponent

Die strukturierten Komponenten, aus denen die formatierte Adresse besteht, sofern diese Informationen verfügbar sind.

JSON-Darstellung 
{
  "longText": string,
  "shortText": string,
  "types": [
    string
  ],
  "languageCode": string
}
Felder
longText

string

Die Volltextbeschreibung oder der Name der Adresskomponente. Beispielsweise könnte eine Adresskomponente für das Land Australien den Langnamen „Australia“ haben.
shortText

string

Ein abgekürzter Textname für die Adresskomponente, falls vorhanden. Beispielsweise könnte eine Adresskomponente für das Land Australien den Kurznamen „AU“ haben.
types[]

string

Ein Array, das den Typ bzw. die Typen der Adresskomponente angibt.

Weitere Informationen finden Sie unter https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types.
languageCode

string

Die Sprache, die zum Formatieren dieser Komponente verwendet wird, in CLDR-Notation.

Sehenswürdigkeit

Orientierungspunkte werden verwendet, um den Zielort anzugeben oder die Ankunft am Zielort 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 menschenlesbare Beschreibung, wie das Ziel mit dem Orientierungspunkt zusammenhängt. Beispiel: „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 Zielorts verwendet werden kann.
straightLineDistanceMeters

number

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

number

Nur Ausgabe. Die Entfernung von diesem Orientierungspunkt zum Ziel in Metern.
Union-Feld landmark. Die Sehenswürdigkeit. Für landmark ist nur einer der folgenden Werte zulässig:
place

object (PlaceView)

Der Ort, der diese Sehenswürdigkeit darstellt.

Landmark.Tag

Die Liste aller möglichen Tags, die beschreiben, wie eine Sehenswürdigkeit im Kontext eines Ziels verwendet werden kann.

Wenn eine Adresse sowohl das Tag ADDRESS als auch das Tag ARRIVAL hat, ist die Sehenswürdigkeit sowohl lokal bekannt als auch in der Nähe des Ziels.

Enums
TAG_UNSPECIFIED Nicht verwendet.
ADDRESS Ein lokal bekannter Ort, der verwendet werden kann, um den ungefähren Standort des Ziels zu ermitteln. In der Regel 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 dient, um das Ziel zu erreichen. Nützlich für die Navigation, wenn Sie sich in der Nähe des Ziels befinden. Diese Landmarke kann sich beispielsweise auf der gegenüberliegenden Straßenseite des Ziels befinden. Ein Orientierungspunkt mit diesem Tag ist in der Regel näher am Ziel als Orientierungspunkte mit dem Tag ADDRESS.

Eingang

Ein Eingang ist ein einzelnes Koordinatenpaar aus Breiten- und Längengrad, das die Position eines Ein- und Ausgangs 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

Das Gebäude, in dem sich dieser Eingang befindet, im Format places/{placeId}.

Entrance.Tag

Merkmale, die einen Einstiegspunkt beschreiben.

Enums
TAG_UNSPECIFIED Nicht verwendet.
PREFERRED

Der Eingang bietet wahrscheinlich physischen Zugang zum Hauptort im 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 Hauptort, bietet aber nicht unbedingt Zugang zu diesem Ort.

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

Wenn der Hauptort ein Gebäude ist, sind die PREFERRED-Eingänge diejenigen, die in den „Hauptteil“ des Gebäudes führen. In einem Einkaufszentrum sind die PREFERRED-Eingänge beispielsweise diejenigen, 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 Hauptort und ein nicht PREFERRED-Eingang bietet möglicherweise Zugang zum Hauptort.