Method: places.searchNearby

Nach Orten in der Nähe von Orten suchen

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "languageCode": string,
  "regionCode": string,
  "includedTypes": [
    string
  ],
  "excludedTypes": [
    string
  ],
  "includedPrimaryTypes": [
    string
  ],
  "excludedPrimaryTypes": [
    string
  ],
  "maxResultCount": integer,
  "locationRestriction": {
    object (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  }
}
Felder
languageCode

string

Details zum Ort werden in der bevorzugten Sprache angezeigt, sofern verfügbar. Wenn der Sprachcode nicht angegeben oder nicht erkannt wird, können Details zu Orten in beliebiger Sprache zurückgegeben werden. Wenn solche Details vorhanden sind, wird bevorzugt Englisch verwendet.

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

string

Der Länder-/Regionscode (CLDR) des Standorts, von dem die Anfrage stammt. Mit diesem Parameter werden die Details zum Ort angezeigt, z. B. der regionsspezifische Ortsname, sofern verfügbar. Der Parameter kann sich auf die Ergebnisse auswirken, die gemäß anwendbarem Recht angezeigt werden.

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

Dreistellige Regionscodes werden derzeit nicht unterstützt.
includedTypes[]

string

Eingeschlossener Ortstyp (z. B. „restaurant“ oder „gas_station“) von https://developers.google.com/maps/documentation/places/web-service/place-types.

Es können bis zu 50 Typen aus Tabelle A angegeben werden.

Wenn es zu Konflikten kommt, d.h. ein Typ sowohl in „includedTypes“ als auch in „excludedTypes“ enthalten ist, wird der Fehler INVALID_ARGUMENT zurückgegeben.

Wenn ein Ortstyp mit mehreren Typbeschränkungen angegeben ist, werden nur Orte zurückgegeben, die alle Einschränkungen erfüllen. Wenn wir beispielsweise {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} haben, bieten die zurückgegebenen Orte Dienstleistungen im Zusammenhang mit „Restaurants“, sind aber nicht in erster Linie als „Restaurants“ tätig.
excludedTypes[]

string

Ausgeschlossener Ortstyp (z. B. „restaurant“ oder „gas_station“) von https://developers.google.com/maps/documentation/places/web-service/place-types.

Es können bis zu 50 Typen aus Tabelle A angegeben werden.

Wenn der Kunde sowohl „includedTypes“ (z.B. „restaurant“) als auch „excludedTypes“ (z.B. „cafe“) angibt, sollte die Antwort Orte enthalten, die Restaurants, aber keine Cafés sind. Die Antwort enthält Orte, die mindestens einem der „includedTypes“ entsprechen und keinem der „excludedTypes“.

Wenn es zu Konflikten kommt, d.h. ein Typ sowohl in „includedTypes“ als auch in „excludedTypes“ enthalten ist, wird der Fehler INVALID_ARGUMENT zurückgegeben.

Wenn ein Ortstyp mit mehreren Typbeschränkungen angegeben ist, werden nur Orte zurückgegeben, die alle Einschränkungen erfüllen. Wenn wir beispielsweise {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} haben, bieten die zurückgegebenen Orte Dienstleistungen im Zusammenhang mit „Restaurants“, sind aber nicht in erster Linie als „Restaurants“ tätig.
includedPrimaryTypes[]

string

Enthält den primären Ortstyp (z.B. „restaurant“ oder „gas_station“) von https://developers.google.com/maps/documentation/places/web-service/place-types. Ein Ort kann nur einen primären Typ aus der Tabelle „Unterstützte Typen“ haben.

Es können bis zu 50 Typen aus Tabelle A angegeben werden.

Wenn es zu Konflikten bei den Haupttypen kommt, d.h. ein Typ sowohl in „includedPrimaryTypes“ als auch in „excludedPrimaryTypes“ enthalten ist, wird der Fehler INVALID_ARGUMENT zurückgegeben.

Wenn ein Ortstyp mit mehreren Typbeschränkungen angegeben ist, werden nur Orte zurückgegeben, die alle Einschränkungen erfüllen. Wenn wir beispielsweise {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} haben, bieten die zurückgegebenen Orte Dienstleistungen im Zusammenhang mit „Restaurants“, sind aber nicht in erster Linie als „Restaurants“ tätig.
excludedPrimaryTypes[]

string

Ausgeschlossener primärer Ortstyp (z.B. „restaurant“ oder „gas_station“) von https://developers.google.com/maps/documentation/places/web-service/place-types.

Es können bis zu 50 Typen aus Tabelle A angegeben werden.

Wenn es zu Konflikten bei den Haupttypen kommt, d.h. ein Typ sowohl in „includedPrimaryTypes“ als auch in „excludedPrimaryTypes“ enthalten ist, wird der Fehler INVALID_ARGUMENT zurückgegeben.

Wenn ein Ortstyp mit mehreren Typbeschränkungen angegeben ist, werden nur Orte zurückgegeben, die alle Einschränkungen erfüllen. Wenn wir beispielsweise {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} haben, bieten die zurückgegebenen Orte Dienstleistungen im Zusammenhang mit „Restaurants“, sind aber nicht in erster Linie als „Restaurants“ tätig.
maxResultCount

integer

Maximale Anzahl der zurückzugebenden Ergebnisse. Der Wert muss zwischen 1 und 20 (Standard) liegen. Wenn die Zahl nicht festgelegt ist, wird das Oberlimit verwendet. Wenn die Zahl negativ ist oder das Oberlimit überschreitet, wird der Fehler INVALID_ARGUMENT zurückgegeben.
locationRestriction

object (LocationRestriction)

Erforderlich. Die Region, in der gesucht werden soll.
rankPreference

enum (RankPreference)

Wie die Ergebnisse in der Antwort sortiert werden.
routingParameters

object (RoutingParameters)

Optional. Parameter, die sich auf die Weiterleitung zu den Suchergebnissen auswirken.

Antworttext

Antwort-Prototyp für die Suche in der Nähe.

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

JSON-Darstellung 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ]
}
Felder
places[]

object (Place)

Eine Liste von Orten, die den Anforderungen des Nutzers entspricht, z. B. Ortstypen, Anzahl der Orte und spezifische Standorteinschränkungen.
routingSummaries[]

object (RoutingSummary)

Eine Liste von Routenzusammenfassungen, bei der jeder Eintrag dem entsprechenden Ort mit demselben Index im Feld places zugeordnet ist. Wenn die Zusammenfassung der Route für einen der Orte nicht verfügbar ist, enthält sie einen leeren Eintrag. Diese Liste sollte so viele Einträge wie die Liste der Orte enthalten, sofern dies erforderlich ist.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

LocationRestriction

Die Region, in der gesucht werden soll.

JSON-Darstellung 
{

  // Union field type can be only one of the following:
  "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:
circle

object (Circle)

Ein Kreis, der durch Mittelpunkt und Radius definiert ist.

RankPreference

Wie die Ergebnisse in der Antwort sortiert werden.

Enums
RANK_PREFERENCE_UNSPECIFIED Der Wert für „RankPreference“ ist nicht festgelegt. Standardmäßig wird die Rangfolge nach BELIEBTHET verwendet.
DISTANCE Die Ergebnisse werden nach Entfernung sortiert.
POPULARITY Die Ergebnisse werden nach Beliebtheit sortiert.