Method: places.searchNearby

搜尋附近地點。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "languageCode": string,
  "regionCode": string,
  "includedTypes": [
    string
  ],
  "excludedTypes": [
    string
  ],
  "includedPrimaryTypes": [
    string
  ],
  "excludedPrimaryTypes": [
    string
  ],
  "maxResultCount": integer,
  "locationRestriction": {
    object (LocationRestriction)
  },
  "rankPreference": enum (RankPreference)
}
欄位
languageCode

string

地點詳細資料將以偏好語言顯示 (如有)。如未指定或無法辨識語言代碼,系統可能會傳回任何語言的地點詳細資料,如果有此類詳細資料,則偏好英文。

目前支援的語言清單:https://developers.google.com/maps/faq#languagesupport

regionCode

string

要求來源的 Unicode 國家/地區代碼 (CLDR)。這個參數是用來顯示地點詳細資料,例如特定區域的地點名稱 (如果有的話)。這個參數會根據適用法律影響結果。

詳情請參閱 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html

請注意,系統目前不支援 3 位數區碼。

includedTypes[]

string

包含的地點類型 (例如「餐廳」或「gas_station」):https://developers.google.com/maps/documentation/places/web-service/place-types

最多可以指定表 A 中的 50 個類型。

如有任何衝突類型,例如某個類型同時出現在 includeTypes 和 excludedTypes 中,則會傳回 INVALID_TRUE 錯誤。

如果指定的地點類型具有多個類型限制,系統只會傳回符合所有限制的地點。舉例來說,假設我們有 {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]},傳回的地點會提供「餐廳」但並非以「餐廳」為主要營運。

excludedTypes[]

string

排除的地點類型 (例如「餐廳」或「gas_station」):來自 https://developers.google.com/maps/documentation/places/web-service/place-types

最多可以指定表 A 中的 50 個類型。

如果客戶同時提供 includeTypes (例如餐廳) 和 excludedTypes (例如咖啡廳),回應中應包含餐廳而非咖啡店的地點。回應包含至少與其中一個 includeTypes 相符,但不包含任何 excludedTypes 的地點。

如有任何衝突類型,例如某個類型同時出現在 includeTypes 和 excludedTypes 中,則會傳回 INVALID_TRUE 錯誤。

如果指定的地點類型具有多個類型限制,系統只會傳回符合所有限制的地點。舉例來說,假設我們有 {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]},傳回的地點會提供「餐廳」但並非以「餐廳」為主要營運。

includedPrimaryTypes[]

string

包含主要地點類型 (例如「餐廳」或「gas_station」):https://developers.google.com/maps/documentation/places/web-service/place-types。凡是與地點相關聯的支援類型表格,都只能有一個主要類型。

最多可以指定表 A 中的 50 個類型。

如果出現任何衝突的主要類型,例如某個類型同時出現在 includePrimaryTypes 和 excludedPrimaryTypes 中,系統就會傳回 INVALID_TRUE 錯誤。

如果指定的地點類型具有多個類型限制,系統只會傳回符合所有限制的地點。舉例來說,假設我們有 {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]},傳回的地點會提供「餐廳」但並非以「餐廳」為主要營運。

excludedPrimaryTypes[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types 排除主要地點類型 (例如「餐廳」或「gas_station」)。

最多可以指定表 A 中的 50 個類型。

如果出現任何衝突的主要類型,例如某個類型同時出現在 includePrimaryTypes 和 excludedPrimaryTypes 中,系統就會傳回 INVALID_TRUE 錯誤。

如果指定的地點類型具有多個類型限制,系統只會傳回符合所有限制的地點。舉例來說,假設我們有 {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]},傳回的地點會提供「餐廳」但並非以「餐廳」為主要營運。

maxResultCount

integer

要傳回的結果數上限。這個值必須介於 1 至 20 (預設) 之間 (含首尾)。如未設定號碼,則會改回使用上限。如果將數字設為負數或超過上限,系統會傳回 INVALID_src 錯誤。

locationRestriction

object (LocationRestriction)

必要欄位。要搜尋的區域。

rankPreference

enum (RankPreference)

結果在回應中的排名方式。

回應主體

「搜尋附近」適用的回應 proto。

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "places": [
    {
      object (Place)
    }
  ]
}
欄位
places[]

object (Place)

符合使用者需求的地點清單,例如地點類型、地點數量和特定位置限制。

LocationRestriction

要搜尋的區域。

JSON 表示法
{

  // Union field type can be only one of the following:
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
欄位

聯集欄位 type

type 只能採用下列其中一種設定:

circle

object (Circle)

以中心點和半徑定義的圓形。

RankPreference

結果在回應中的排名方式。

列舉
RANK_PREFERENCE_UNSPECIFIED 未設定 RankPreference 值。根據預設,將使用按 POPULARITY 的排名。
DISTANCE 按照距離將結果排名。
POPULARITY 依熱門程度將搜尋結果排名。