使用 Map Management API 網路服務的最佳做法

Google 地圖平台網路服務是一系列 Google 服務的 HTTP 介面，可為地圖應用程式提供地理資料。

本指南說明設定網路服務要求和處理服務回應時，可派上用場的常見做法。如需 Map Management API 的完整說明文件，請參閱開發人員指南。

什麼是網路服務？

Google Maps Platform Web 服務是介面，可從外部服務要求 Maps API 資料，並在您的 Maps 應用程式中使用這些資料。根據《Google Maps Platform 服務條款》的授權限制，這些服務應與地圖搭配使用。

Google 地圖 API 網路服務會向特定網址發出 HTTP(S) 要求，並將網址參數和/或 JSON 格式的 POST 資料做為服務的引數傳遞。一般來說，這些服務會以 JSON 格式在回應主體中傳回資料，供應用程式剖析和/或處理。

以下範例顯示對「列出地圖設定」list MapConfigs 方法的 REST GET 要求：

https://mapmanagement.googleapis.com/v2beta/projects/PROJECT_NUMBER_OR_ID/mapConfigs

在要求中加入 OAuth 權杖。Authorization header

SSL/TLS 存取權

使用 API 金鑰或包含使用者資料的所有 Google 地圖平台要求，都必須透過 HTTPS 傳送。如果透過 HTTP 傳送含有機密資料的要求，可能會遭到拒絕。

建立有效網址

您可能認為網址是否「有效」一眼就能判斷，但實際情況不然。例如，在瀏覽器的網址列內輸入的網址可能包含特殊字元 (例如 "上海+中國")；瀏覽器必須在內部將這些字元轉譯為其他編碼方式才能傳送。同理可證，產生或接受 UTF-8 輸入值的任何程式碼都可能會將含有 UTF-8 字元的網址視為「有效網址」，但也需要先轉譯這些字元，才能向外傳送至網路伺服器。這個過程稱為網址編碼或百分比編碼。

注意：瀏覽器和/或服務可能會在傳送要求 URI 前自動進行網址編碼。如果網址編碼在簽署後變更要求，則使用加密編譯要求簽署的 API 可能會使簽章失效。為避免這個問題，請務必在簽署要求前，先對查詢字串進行網址編碼。

特殊字元

所有網址都必須符合統一資源 ID (URI) 規格指定的語法，因此我們必須轉譯特殊字元。實務上，這表示網址只能包含一部分特殊 ASCII 字元：慣用的英數字元符號，以及用做網址內控制字元的部分預留字元。下表摘要列出這些字元：

字元集	字元	網址使用情況
英數字元	a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9	文字字串、結構用途 (http)、通訊埠 (8080) 等。
非預留	- _ . ~	文字字串
預留	! * ' ( ) ; : @ & = + $ , / ? % # [ ]	控制字元和 (或) 文字字串

建立有效網址時，您必須確認網址僅包含表格中列出的字元。如果網址使用上述字元集，通常會導致兩個問題：一個是遺漏問題，一個則是代換問題：

• 您需要處理的字元不屬於上述字元集。舉例來說，外國語言的字元 (例如「上海+中國」) 就需要使用上述字元加以編碼。依照普遍慣例，空格 (網址內不允許使用) 通常也用加號 '+' 字元來表示。
• 字元屬於上方字元集中的預留字元，但需要直接使用。舉例來說，網址內會使用 ? 來表示查詢字串的開頭；如果您想使用「? and the Mysterions」這個字串，就必須對 '?' 字元進行編碼。

所有字元進行網址編碼時，都會使用 '%' 字元，外加對應至各自 UTF-8 字元的雙字元十六進位值。舉例來說，「上海+中國」以 UTF-8 編碼形式進行網址編碼的結果是 %E4%B8%8A%E6%B5%B7%2B%E4%B8%AD%E5%9C%8B，「? and the Mysterians」字串則是 %3F+and+the+Mysterians 或 %3F%20and%20the%20Mysterians。

需要編碼的常見字元

必須編碼的部分常見字元如下：

不安全的字元	經過編碼的值
空格	%20
"	%22
<	%3C
>	%3E
#	%23
%	%25
|	%7C

將使用者輸入內容轉換成網址的過程有時會遇到困難。舉例來說，使用者輸入的地址可能是「5th&Main St.」。一般來說，您應該根據各組成部分來建立網址，並將任何使用者輸入內容當成常值字元來處理。

此外，所有 Google 地圖平台網路服務和 Static Web API 的網址長度上限都是 16, 384 個字元。對於大部分的服務而言，很少出現接近此字元限制的情況。但請注意，某些服務的幾個參數可能會產生較長的網址。

禮貌使用 Google API

設計不良的 API 用戶端可能會對網際網路和 Google 伺服器造成不必要的負擔。本節包含 API 用戶端的一些最佳做法。遵循這些最佳做法，有助於避免應用程式因無意間濫用 API 而遭到封鎖。

指數型退讓

在極少數情況下，系統可能會無法順利處理您的要求，您可能會收到 4XX 或 5XX HTTP 回應代碼，或是 TCP 連線可能在用戶端和 Google 伺服器之間某處發生錯誤。通常值得重新嘗試要求，因為後續要求可能會在原始要求失敗時成功。不過，請勿只是重複向 Google 伺服器發出要求。這種迴圈行為可能會導致用戶端與 Google 之間的網路過載，進而對許多人造成問題。

較好的做法是重試，但每次嘗試之間要增加延遲時間。通常每次嘗試時，延遲時間會增加一個乘法因子，這種做法稱為「指數輪詢」。

舉例來說，假設某應用程式想對 Time Zone API 發出下列要求：

https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810,-119.6822510&timestamp=1331161200&key=YOUR_API_KEY

以下 Python 範例說明如何使用指數輪詢機制提出要求：

import json
import time
import urllib.error
import urllib.parse
import urllib.request

# The maps_key defined below isn't a valid Google Maps API key.
# You need to get your own API key.
# See https://developers.google.com/maps/documentation/timezone/get-api-key
API_KEY = "YOUR_KEY_HERE"
TIMEZONE_BASE_URL = "https://maps.googleapis.com/maps/api/timezone/json"


def timezone(lat, lng, timestamp):

    # Join the parts of the URL together into one string.
    params = urllib.parse.urlencode(
        {"location": f"{lat},{lng}", "timestamp": timestamp, "key": API_KEY,}
    )
    url = f"{TIMEZONE_BASE_URL}?{params}"

    current_delay = 0.1  # Set the initial retry delay to 100ms.
    max_delay = 5  # Set the maximum retry delay to 5 seconds.

    while True:
        try:
            # Get the API response.
            response = urllib.request.urlopen(url)
        except urllib.error.URLError:
            pass  # Fall through to the retry loop.
        else:
            # If we didn't get an IOError then parse the result.
            result = json.load(response)

            if result["status"] == "OK":
                return result["timeZoneId"]
            elif result["status"] != "UNKNOWN_ERROR":
                # Many API errors cannot be fixed by a retry, e.g. INVALID_REQUEST or
                # ZERO_RESULTS. There is no point retrying these requests.
                raise Exception(result["error_message"])

        if current_delay > max_delay:
            raise Exception("Too many retry attempts.")

        print("Waiting", current_delay, "seconds before retrying.")

        time.sleep(current_delay)
        current_delay *= 2  # Increase the delay each time we retry.


if __name__ == "__main__":
    tz = timezone(39.6034810, -119.6822510, 1331161200)
    print(f"Timezone: {tz}")

此外，您也應注意應用程式呼叫鏈中是否有重試程式碼，導致快速連續發出重複要求。

同步要求

大量同步要求傳送至 Google API 時，可能會被視為對 Google 基礎架構發動分散式阻斷服務 (DDoS) 攻擊，並受到相應處置。為避免這種情況，請確保 API 要求不會在用戶端之間同步處理。

舉例來說，假設某個應用程式會顯示目前時區的時間。這個應用程式可能會在用戶端作業系統中設定鬧鐘，在每分鐘開始時喚醒系統，以便更新顯示的時間。應用程式不應在與該警報相關聯的處理程序中發出任何 API 呼叫。

如果為了回應固定鬧鐘而發出 API 呼叫，會導致 API 呼叫與每分鐘的開頭時間同步 (即使是不同裝置也一樣)，而不是平均分配在一段時間內，因此不建議這麼做。如果應用程式設計不良，每分鐘開始時的流量會是正常流量的 60 倍。

建議您改為設定第二個鬧鐘，並隨機選擇時間。當第二個鬧鐘觸發時，應用程式會呼叫所需 API 並儲存結果。應用程式想在每分鐘開始時更新顯示畫面，就會使用先前儲存的結果，而不是再次呼叫 API。這樣一來，API 呼叫就會平均分散在一段時間內。此外，更新顯示器時，API 呼叫不會延遲算繪作業。

除了每分鐘的開頭，您也應避免以每小時的開頭和每天午夜的開頭為目標，以免發生其他常見的同步問題。

處理回應

注意：由於無法保證透過 Web 服務要求取得的個別回應格式完全一致 (可能缺少某些元素或元素出現在多個位置)，因此請勿假設不同查詢傳回的回應格式相同。您應處理回應，並透過運算式選取適當的值。

本章節討論如何從網路服務回應中，以動態方式擷取這些值。

Google 地圖網路服務提供的回應容易理解，但並非十分友善。執行查詢時，您可能不是想顯示一組資料，而是想擷取幾個特定值。一般來說，您會想剖析 Web 服務的回應，並只擷取感興趣的值。

您使用的剖析架構取決於是否要以 JSON 格式傳回輸出內容。JSON 回應已採用 JavaScript 物件的形式，因此可在用戶端以 JavaScript 本身處理。