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

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

本指南將說明一些常見做法，協助您設定網路服務要求和處理服務回應。如需 Routes API 的完整說明文件，請參閱開發人員指南。

什麼是網路服務？

Google 地圖平台網路服務是一種介面，可用於向外部服務要求 Maps API 資料，並在 Google 地圖應用程式中使用這些資料。根據《Google 地圖平台服務條款》的「授權限制」規定，這些服務的設計目的是與地圖搭配使用。

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

以下範例顯示 computeRoutes 方法的 REST POST 要求網址：

https://routes.googleapis.com/directions/v2:computeRoutes

在 JSON 要求內文中加入要求選項。要求主體包含來源和目的地位置，以及您想在路線上設定的任何選項。

注意：所有 Routes API 應用程式都需要驗證。進一步瞭解驗證憑證。

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 呼叫與分鐘同步，甚至在不同裝置之間同步，而非在一段時間內平均分配。設計不良的應用程式會在每分鐘的開始時，產生比正常值高出六十倍的流量尖峰。

相反地，一個可能的良好設計是將第二個鬧鐘設為隨機選擇的時間。當第二個鬧鐘觸發時，應用程式會呼叫所需的任何 API，並儲存結果。當應用程式要在分鐘開始時更新顯示內容時，會使用先前儲存的結果，而不是再次呼叫 API。使用這種方法時，API 呼叫會在一段時間內平均分散。此外，在更新顯示畫面時，API 呼叫不會延遲轉譯。

除了分鐘開始時間之外，您也應避免在小時開始時間和每天午夜開始時間同步處理。

處理回應

注意：由於無法保證網頁服務要求的個別回應確切格式 (部分元素可能會遺漏或位於多個位置)，因此請勿假設任何特定回應的回傳格式會與不同查詢相同。相反地，您應該處理回應，並透過運算式選取適當值。

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

Google 地圖網路服務提供的回應雖然容易理解，但不一定符合使用者需求。執行查詢時，您可能會想擷取幾個特定值，而不是顯示一組資料。一般來說，您會想要剖析網路服務的回應，並只擷取您感興趣的值。

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