本頁面由 Cloud Translation API 翻譯而成。

地理位置要求與回應

地理位置要求

系統會使用 POST 方法，將地理位置要求傳送至下列網址：

https://www.googleapis.com/geolocation/v1/geolocate?key=YOUR_API_KEY

您必須在要求中指定金鑰，並以 key 參數值的形式加入。key 是應用程式的 API 金鑰。這個金鑰會識別您的應用程式，以利配額管理。瞭解如何取得金鑰。

要求主體

要求內文必須採用 JSON 格式。如果未納入要求主體，系統會根據要求位置的 IP 位址傳回結果。系統支援下列欄位，除非另有說明，否則所有欄位均為選填：

欄位	JSON 類型	說明	附註
`homeMobileCountryCode`	`number` (`uint32`)	裝置家用網路的行動裝置國家/地區代碼 (MCC)。	支援 `radioType` `gsm` (預設)、`wcdma`、`lte` 和 `nr`，但不適用於 `cdma`。有效範圍：0 到 999。
`homeMobileNetworkCode`	`number` (`uint32`)	裝置家用網路的行動網路代碼。這是 GSM、WCDMA、LTE 和 NR 的 MNC。 CDMA 使用系統 ID (SID)	MNC 的有效範圍為 0 到 999。 SID 的有效範圍：0 到 32767。
`radioType`	`string`	行動無線電類型。支援的值為 `gsm`、`cdma`、`wcdma`、`lte` 和 `nr`。	雖然這個欄位為選填，但如果用戶端知道無線電類型，則應一律填寫這個欄位。如果省略這個欄位，Geolocation API 會預設為 `gsm`，如果假設的無線電類型不正確，將會導致結果無效或為零。
`carrier`	`string`	貨運公司名稱。
`considerIp`	`boolean`	指定在 Wi-Fi 和行動電話基地台訊號遺失、空白或不足以估算裝置位置時，是否要改用 IP 地理位置。	預設為 `true`。將 `considerIp` 設為 `false`，避免回溯。
`cellTowers`	`array`	基地台物件陣列。	請參閱下方的「Cell Tower Objects」一節。
`wifiAccessPoints`	`array`	Wi-Fi 存取點物件的陣列。	請參閱下方的「Wi-Fi 存取點物件」一節。

以下是 Geolocation API 要求主體的範例。

{
  "homeMobileCountryCode": 310,
  "homeMobileNetworkCode": 410,
  "radioType": "gsm",
  "carrier": "Vodafone",
  "considerIp": true,
  "cellTowers": [
    // See the Cell Tower Objects section below.
  ],
  "wifiAccessPoints": [
    // See the WiFi Access Point Objects section below.
  ]
}

基地台物件

要求主體的 cellTowers 陣列包含零或多個基地台物件。

欄位	JSON 類型	說明	附註
`cellId`	`number` (`uint32`)	儲存格的專屬 ID。	必要：`radioType` `gsm` (預設)、`cdma`、`wcdma` 和 `lte`；拒絕：`nr`。請參閱下方的「計算 cellId」一節，其中也列出各無線電類型的有效值範圍。
`newRadioCellId`	`number` (`uint64`)	NR (5G) 訊號格的專屬 ID。	必要 (`radioType` `nr`)；其他類型則會遭拒。請參閱下方的「計算 newRadioCellId」一節，其中也列出欄位的有效值範圍。
`locationAreaCode`	`number` (`uint32`)	GSM 和 WCDMA 網路的位置區域代碼 (LAC)。 CDMA 網路的網路 ID (NID)。 LTE 和 NR 網路的追蹤區域代碼 (TAC)。	必要，適用於 `radioType` `gsm` (預設) 和 `cdma`，其他值則為選用。有效範圍為 `gsm`、`cdma`、`wcdma` 和 `lte`：0 到 65535。有效範圍 (含 `nr`)：0 到 16777215。
`mobileCountryCode`	`number` (`uint32`)	基地台的行動裝置國家/地區代碼 (MCC)。	必要：`radioType` `gsm` (預設)、`wcdma`、`lte` 和 `nr`；不適用於 `cdma`。有效範圍：0 到 999。
`mobileNetworkCode`	`number` (`uint32`)	行動通信基地台的行動網路代碼。這是 GSM、WCDMA、LTE 和 NR 的 MNC。 CDMA 使用系統 ID (SID)。	必要。 MNC 的有效範圍：0 到 999。 SID 的有效範圍：0 到 32767。

系統不會使用下列選填欄位，但如果提供值，系統可能會納入。

欄位	JSON 類型	說明	附註
`age`	`number` (`uint32`)	自這個儲存格成為主要儲存格以來經過的毫秒數。	如果年齡為 0，則 `cellId` 或 `newRadioCellId` 代表目前的測量結果。
`signalStrength`	`number` (`double`)	以 dBm 為單位的無線電訊號強度。
`timingAdvance`	`number` (`double`)	時間提前值。

計算中 `cellId`

NR (5G) 之前的無線電類型會使用 32 位元 cellId 欄位，將網路基地台 ID 傳遞至 Geolocation API。

GSM (2G) 網路會直接使用 16 位元的 Cell ID (CID)。有效範圍：0 到 65535。
CDMA (2G) 網路會直接使用 16 位元基地台 ID (BID)。有效範圍：0 到 65535。
WCDMA (3G) 網路使用 UTRAN/GERAN Cell Identity (UC-ID)，這是 28 位元的整數值，會串連 12 位元的 Radio Network Controller Identifier (RNC-ID) 和 16 位元的 Cell ID (CID)。
公式：rnc_id << 16 | cid。
有效範圍：0 到 268435455。
注意：在 WCDMA 網路中只指定 16 位元 Cell ID 值，會導致結果不正確或為零。
LTE (4G) 網路使用 E-UTRAN Cell Identity (ECI)，這是 28 位元的整數值，會串連 20 位元的 E-UTRAN Node B Identifier (eNBId) 和 8 位元的 Cell ID (CID)。
公式：enb_id << 8 | cid。
有效範圍：0 到 268435455。
注意：在 LTE 網路中只指定 8 位元 Cell ID 值，會導致結果不正確或為零。

如果在 API 要求中放置超出這些範圍的值，可能會導致未定義的行為。API 可視 Google 裁量截斷數字，使其符合文件範圍、推斷 radioType 的修正內容，或傳回 NOT_FOUND 結果，但回應中不會顯示任何指標。

以下是 LTE 行動基地台物件的範例。

{
  "cellTowers": [
    {
      "cellId": 170402199,
      "locationAreaCode": 35632,
      "mobileCountryCode": 310,
      "mobileNetworkCode": 410,
      "age": 0,
      "signalStrength": -60,
      "timingAdvance": 15
    }
  ]
}

計算中 `newRadioCellId`

如果網路的 Cell ID 長度超過 32 位元，則會使用 64 位元的 newRadioCellId 欄位，將網路 Cell ID 傳遞至 Geolocation API。

NR (5G) 網路會使用 36 位元的新無線電基地台 ID (NCI)。
有效範圍：0 到 68719476735。

以下是 NR 細胞基地台物件的範例。

{
  "cellTowers": [
    {
      "newRadioCellId": 68719476735,
      "mobileCountryCode": 310,
      "mobileNetworkCode": 410,
      "age": 0,
      "signalStrength": -60,
    }
  ]
}

Wi-Fi 存取點物件

要求主體的 wifiAccessPoints 陣列必須包含兩個以上的 Wi-Fi 存取點物件，代表實體上不同的存取點裝置。macAddress 為必填欄位，其他欄位則為選填。

欄位	JSON 類型	說明	附註
`macAddress`	`string`	Wi-Fi 節點的 MAC 位址。通常稱為 BSS、BSSID 或 MAC 位址。	必要。以半形冒號 (`:`) 分隔的十六進位字串。只有通用管理 MAC 位址可透過 API 找到。系統會自動捨棄其他 MAC 位址，導致 API 要求實際上變成空白。詳情請參閱「捨棄無用的 Wi-Fi 存取點」。
`signalStrength`	`number` (`double`)	目前訊號強度，以 dBm 為單位。	Wi-Fi 存取點的 dBm 值通常為 -35 以下，範圍介於 -128 至 -10 dBm。請務必加上減號。如果值大於 -10 dBm，API 會傳回 `NOT FOUND`。
`age`	`number` (`uint32`)	自偵測到這個存取點以來經過的毫秒數。
`channel`	`number` (`uint32`)	用戶端與存取點通訊的管道。
`signalToNoiseRatio`	`number` (`double`)	目前訊號雜訊比，單位為 dB。

以下顯示 Wi-Fi 存取點物件範例。

{
  "macAddress": "f0:d5:bf:fd:12:ae",
  "signalStrength": -43,
  "signalToNoiseRatio": 0,
  "channel": 11,
  "age": 0
}

要求範例

如要使用範例資料試用 Geolocation API，請將下列 JSON 儲存至檔案：

{
  "considerIp": "false",
  "wifiAccessPoints": [
    {
      "macAddress": "3c:37:86:5d:75:d4",
      "signalStrength": -35,
      "signalToNoiseRatio": 0
    },
    {
      "macAddress": "30:86:2d:c4:29:d0",
      "signalStrength": -35,
      "signalToNoiseRatio": 0
    }
  ]
}

接著，您可以使用 cURL 從指令列提出要求：

$ curl -d @your_filename.json -H "Content-Type: application/json" -i "https://www.googleapis.com/geolocation/v1/geolocate?key=YOUR_API_KEY"

上述 MAC 位址的回應如下所示：

{
  "location": {
    "lat": 37.4241173,
    "lng": -122.0915717
  },
  "accuracy": 20
}

停用未使用的 Wi-Fi 存取點

移除具有macAddress的 Wi-Fi 存取點物件 (本機管理)，可提高以 Wi-Fi 做為輸入內容的 Geolocation API 呼叫成功率。如果經過篩選後，系統判斷地理位置 API 呼叫不會成功，則可使用舊版位置信號或信號較弱的 Wi-Fi AP 等緩解措施。這種做法是根據應用程式對位置估計值的需求，以及精確度和召回率要求，所做的取捨。下列篩選技術示範如何篩選輸入內容，但未顯示應用程式工程師可能會選擇套用的緩解措施。

本機管理的 MAC 位址對 API 來說並非實用的位置信號，因此系統會從要求中捨棄這類位址。如要移除這類 MAC 位址，請確保 macAddress 最重要位元組的第二個最低有效位元為 0，例如 02:00:00:00:00:00 中以 2 表示的 1 位元。廣播 MAC 位址 (FF:FF:FF:FF:FF:FF) 就是一個例子，可透過這個篩選器排除。

00:00:5E:00:00:00 和 00:00:5E:FF:FF:FF 之間的 MAC 位址範圍保留給 IANA 使用，通常用於網路管理和多點播送功能，因此無法做為位置信號。您也應從 API 的輸入內容中移除這些 MAC 位址。

舉例來說，可用的地理位置 MAC 位址可從名為 macs 的 macAddress 字串陣列中收集：

Java

String[] macs = {"12:34:56:78:9a:bc", "1c:34:56:78:9a:bc", "00:00:5e:00:00:01"};
ArrayList<String> _macs = new ArrayList<>(Arrays.asList(macs));
_macs.removeIf(m -> !(0 == (2 & Integer.parseInt(m.substring(1, 2), 16))
                      && !m.substring(0, 8).toUpperCase().equals("00:00:5E")));

Python

macs = ['12:34:56:78:9a:bc', '1c:34:56:78:9a:bc', '00:00:5e:00:00:01']
macs = [m for m in macs if (0 == (2 & int(m[1], 16)) and m[:8].upper() != '00:00:5E')]

JavaScript

macs = ['12:34:56:78:9a:bc', '1c:34:56:78:9a:bc', '00:00:5e:00:00:01'];
macs = macs.filter(m => 0 === (2 & Number.parseInt(m[1], 16))
                           && m.substr(0, 8).toUpperCase() !== '00:00:5E');

使用這個篩選器後，清單中只會剩下 1c:34:56:78:9a:bc。由於這份清單的 Wi-Fi MAC 位址少於 2 個，要求不會成功，且會傳回 HTTP 404 (notFound) 回應。

地理位置回應

如果地理位置要求成功，系統會傳回 JSON 格式的回應，其中定義位置和半徑。

location：使用者預估的經緯度座標 (以度為單位)。包含一個 lat 和一個 lng 子欄位。
accuracy：預估位置的準確度，單位為公尺。這代表以指定 location 為圓心的圓形半徑。

{
  "location": {
    "lat": 37.421875199999995,
    "lng": -122.0851173
  },
  "accuracy": 120
}

地理位置要求與回應 透過集合功能整理內容 你可以依據偏好儲存及分類內容。