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

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

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

什麼是網路服務？

Google 地圖平台網路服務是一種介面，可讓您向外部服務要求 Maps API 資料，以及使用 Google 地圖應用程式中的資料。這些服務會根據《Google 地圖平台服務條款》的授權限制，與地圖搭配使用。

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

將 HTTP POST 要求傳送至 validateAddress 方法，以便驗證位址：

https://addressvalidation.googleapis.com/v1:validateAddress

將 JSON 主體傳遞至要求，定義要驗證的地址

注意：所有 Address Validation 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 的網址長度上限都是 16384 個字元。對於大部分的服務而言，很少出現接近此字元限制的情況。但請注意，某些服務的幾個參數可能會產生較長的網址。

有禮貌使用 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 內處理。