Method: places.searchNearby

Nach Orten in der Nähe von Standorten 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)
  },
  "includeFutureOpeningBusinesses": boolean
}
Felder
languageCode

string

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

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, im Unicode-Format. Dieser Parameter wird verwendet, um die Details zum Ort wie den regionsspezifischen Ortsnamen anzuzeigen, sofern verfügbar. Der Parameter kann sich je nach geltendem Recht auf die 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.
includedTypes[]

string

Eingeschlossener Ortstyp (z. B. "restaurant" oder "gas_station") aus 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 widersprüchliche Typen gibt, d.h. ein Typ sowohl in „includedTypes“ als auch in „excludedTypes“ vorkommt, wird ein INVALID_ARGUMENT-Fehler zurückgegeben.

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

string

Ausgeschlossener Ortstyp (z. B. "restaurant" oder "gas_station") aus 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 Client sowohl „includedTypes“ (z.B. „restaurant“) als auch „excludedTypes“ (z.B. „cafe“) angibt, sollten die Ergebnisse Orte enthalten, die „restaurant“ sind, aber nicht „cafe“. Die Antwort enthält Orte, die mindestens einem der „includedTypes“ und keinem der „excludedTypes“ entsprechen.

Wenn es widersprüchliche Typen gibt, d.h. ein Typ sowohl in „includedTypes“ als auch in „excludedTypes“ vorkommt, wird ein INVALID_ARGUMENT-Fehler zurückgegeben.

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

string

Eingeschlossener primärer Ortstyp (z.B. "restaurant" oder "gas_station") aus https://developers.google.com/maps/documentation/places/web-service/place-types. Einem Ort kann nur ein primärer Typ aus der Tabelle der unterstützten Typen zugeordnet sein.

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

Wenn es widersprüchliche primäre Typen gibt, d.h. ein Typ sowohl in „includedPrimaryTypes“ als auch in „excludedPrimaryTypes“ vorkommt, wird ein INVALID_ARGUMENT-Fehler zurückgegeben.

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

string

Ausgeschlossener primärer Ortstyp (z.B. "restaurant" oder "gas_station") aus 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 widersprüchliche primäre Typen gibt, d.h. ein Typ sowohl in „includedPrimaryTypes“ als auch in „excludedPrimaryTypes“ vorkommt, wird ein INVALID_ARGUMENT-Fehler zurückgegeben.

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

integer

Maximale Anzahl der zurückzugebenden Ergebnisse. Der Wert muss zwischen 1 und 20 (Standard) liegen. Wenn die Zahl nicht festgelegt ist, wird der Höchstwert verwendet. Wenn die Zahl negativ ist oder den Höchstwert überschreitet, wird ein INVALID_ARGUMENT-Fehler 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 das Routing zu den Suchergebnissen auswirken.
includeFutureOpeningBusinesses

boolean

Optional. Wenn „true“, werden auch Unternehmen berücksichtigt, die noch nicht geöffnet sind, aber in Zukunft öffnen.

Antworttext

Antwort-Proto für „Nearby Search“.

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 die Anforderungen des Nutzers erfüllen, z. B. Ortstypen, Anzahl der Orte und bestimmte Standortbeschränkungen.
routingSummaries[]

object (RoutingSummary)

Eine Liste mit Routenzusammenfassungen, wobei jeder Eintrag dem entsprechenden Ort mit demselben Index im Feld places zugeordnet ist. Wenn die Routenzusammenfassung 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, falls angefordert.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/maps-platform.places.nearbysearch
  • https://www.googleapis.com/auth/maps-platform.places
  • 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 einen Mittelpunkt und einen Radius definiert wird.

RankPreference

Wie die Ergebnisse in der Antwort sortiert werden.

Enums
RANK_PREFERENCE_UNSPECIFIED Wert für „RankPreference“ nicht festgelegt. Standardmäßig wird nach Beliebtheit sortiert.
DISTANCE Ergebnisse nach Entfernung sortieren.
POPULARITY Ergebnisse nach Beliebtheit sortieren.