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),
  "routingParameters": {
    object (RoutingParameters)
  }
}
欄位
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

包含的 Place type (例如「restaurant」或「gas_station」)，請參閱 https://developers.google.com/maps/documentation/places/web-service/place-types。

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

如果有任何相衝突的類型，也就是在 includedTypes 和 excludedTypes 中同時出現某個類型，系統會傳回 INVALID_ARGUMENT 錯誤。

如果指定的地點類型含有多個類型限制，系統只會傳回符合所有限制的地點。舉例來說，如果我們有 {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}，則傳回的結果會是提供「餐廳」相關服務，但主要並非以「餐廳」為主要營業項目的地點。
excludedTypes[]

string

排除的 Place 類型 (例如「restaurant」或「gas_station」)，請參閱 https://developers.google.com/maps/documentation/places/web-service/place-types。

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

如果用戶端同時提供 includedTypes (例如餐廳) 和 excludedTypes (例如咖啡廳)，回應就應包含餐廳，但不包含咖啡廳。回應會包含至少與一個 includedTypes 相符，且不與任何 excludedTypes 相符的地點。

如果有任何相衝突的類型，也就是在 includedTypes 和 excludedTypes 中同時出現某個類型，系統會傳回 INVALID_ARGUMENT 錯誤。

如果指定的地點類型含有多個類型限制，系統只會傳回符合所有限制的地點。舉例來說，如果我們有 {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}，則傳回的結果會是提供「餐廳」相關服務，但主要並非以「餐廳」為主要營業項目的地點。
includedPrimaryTypes[]

string

包含主要地點類型 (例如「餐廳」或「加油站」)，詳情請參閱 https://developers.google.com/maps/documentation/places/web-service/place-types。地點只能具有單一主要類型，且該類型必須是與該地點相關聯的支援類型表格中列出的類型。

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

如果有任何衝突的主要類型，也就是在 includedPrimaryTypes 和 excludedPrimaryTypes 中同時出現某個類型，系統會傳回 INVALID_ARGUMENT 錯誤。

如果指定的地點類型含有多個類型限制，系統只會傳回符合所有限制的地點。舉例來說，如果我們有 {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}，則傳回的結果會是提供「餐廳」相關服務，但主要並非以「餐廳」為主要營業項目的地點。
excludedPrimaryTypes[]

string

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

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

如果有任何衝突的主要類型，也就是在 includedPrimaryTypes 和 excludedPrimaryTypes 中都出現某個類型，系統會傳回 INVALID_ARGUMENT 錯誤。

如果指定的地點類型含有多個類型限制，系統只會傳回符合所有限制的地點。舉例來說，如果我們有 {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}，則傳回的結果會是提供「餐廳」相關服務，但主要並非以「餐廳」為主要營業項目的地點。
maxResultCount

integer

要傳回的結果數上限。必須介於 1 到 20 (預設) 之間，含兩者。如果未設定數字，則會改為使用上限。如果數字設為負數或超過上限，系統會傳回 INVALID_ARGUMENT 錯誤。
locationRestriction

object (LocationRestriction)

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

enum (RankPreference)

回應中結果的排序方式。
routingParameters

object (RoutingParameters)

選用設定。影響搜尋結果路由的參數。

回應主體

搜尋附近地點的回應原型檔。

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

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

object (Place)

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

object (RoutingSummary)

路徑摘要清單，其中每個項目都會連結至 places 欄位中相同索引的對應位置。如果某個地點沒有路線摘要，摘要會包含空白項目。這個清單應包含與地點清單相同數量的項目 (如果有要求的話)。

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 值。預設會使用「依熱門程度排序」。
DISTANCE 依距離排序結果。
POPULARITY 依熱門程度排序結果。