Method: resolveNames

將地點名稱 (或地址) 清單解析為 Google 地圖上的特定地理空間實體 (例如地點)。

HTTP 要求

POST https://mapstools.googleapis.com/v1alpha:resolveNames

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

要求主體

要求主體會包含結構如下的資料：

JSON 表示法 
{
  "queries": [
    {
      object (LocationQuery)
    }
  ],
  "locationBias": {
    object (LocationBias)
  },
  "regionCode": string
}
欄位
queries[]

object (LocationQuery)

必填。要解析的位置查詢清單。最多可指定 20 項查詢。
locationBias

object (LocationBias)

(選用步驟) 選用區域，可影響解析結果。如果指定，解析結果會偏向靠近這個區域的實體。加入 locationBias 或 regionCode 通常能縮小搜尋範圍，提供更準確的結果。

如果同時指定 locationBias 和 regionCode，locationBias 的優先順序高於 regionCode。
regionCode

string

(選用步驟) 選用的區域代碼，用於偏好解析結果。如果指定，解析結果會偏向位於指定區域內或附近的實體。請使用 CLDR 區域代碼。例如「US」或「CA」。加入 locationBias 或 regionCode 通常能縮小搜尋範圍，提供更準確的結果。

如果同時指定 locationBias 和 regionCode，locationBias 的優先順序高於 regionCode。

回應主體

v1alpha.resolveNames 的回應訊息。

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

JSON 表示法 
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  },
  "saveToMapsUrl": string
}
欄位
results[]

object (Result)

僅供輸出。位置查詢中已解析的實體清單。保證與要求 queries 索引 1:1 對應。索引 i 的空白字串表示該查詢的解析失敗。如果解析失敗，請查看 failedRequests 欄位，瞭解錯誤狀態。
failedRequests

map (key: integer, value: object (Status))

僅供輸出。傳達部分失敗的地圖。鍵是 queries 欄位中失敗要求的索引。值則是錯誤狀態，詳細說明解析失敗的原因。

這個物件中包含 "key": value 組合的清單，例如 { "name": "wrench", "mass": "1.3kg", "count": "3" }。
saveToMapsUrl

string

僅供輸出。這個連結可將所有成功解析的實體儲存到 Google 地圖。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/maps-platform.mapstools

LocationQuery

位置查詢代表可透過 Google 地圖解析的特定位置實體。目前僅支援地點名稱和地址做為位置查詢。

JSON 表示法 
{
  "text": string
}
欄位
text

string

必填。文字查詢，用於解析 Google 地圖上的特定地理空間實體，例如地點或地址。查詢越具體，解決方案就越準確。例如「舊金山」、「Googleplex, Mountain View, CA」、「1600 Amphitheatre Parkway, Mountain View, CA」或「巴黎艾菲爾鐵塔」。查詢必須是特定地址或地點名稱。不支援連鎖店名稱 (例如星巴克) 等大概位置，或「餐廳」等搜尋查詢。

LocationBias

要偏向解析結果的區域。

JSON 表示法 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "viewport": {
    object (Viewport)
  }
  // End of mutually exclusive fields.
}
欄位
地點偏誤的類型。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位：
viewport

object (Viewport)

由定界框定義的可視區域。
互斥欄位結束。

結果

根據指定位置查詢解析出的單一實體，以及解析結果的信賴水準。

JSON 表示法 
{
  "entity": {
    object (Entity)
  },
  "confidence": enum (Confidence)
}
欄位
entity

object (Entity)

僅供輸出。從位置查詢解析出的實體。
confidence

enum (Confidence)

僅供輸出。解析度的信賴水準。

可信度

解析度的信賴水準。

列舉
CONFIDENCE_UNSPECIFIED 預設值。這個值不會用到。
MEDIUM 中等可信度表示解析結果可能正確，但可能還有其他候選項目。
HIGH 高信賴度表示解析結果正確，且代表特定地理空間實體 (例如特定地點)。