Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

ストリートビュー Static API のベストプラクティス

HTTP インターフェースのコレクションである Google Maps Platform 静的ウェブ API は、ウェブページに直接埋め込むための画像を生成します。

Google Maps Platform ウェブサービスは、地図アプリケーションに地理データを提供する HTTP インターフェースのコレクションです。

このガイドでは、画像リクエストとウェブサービスリクエストの設定、サービスレスポンスの処理に役立つ一般的な方法について説明します。Street View Static API の詳細については、デベロッパーガイドをご覧ください。

Street View Static API は静的ウェブ API として機能し、メタデータサービスはウェブサービスとして機能します。メタデータサービスの詳細については、ストリートビュー画像のメタデータをご覧ください。

静的ウェブ API とは

Google Maps Platform の静的ウェブ API を使用すると、JavaScript や動的なページ読み込みを必要とせずに、Google マップの画像をウェブページに埋め込むことができます。静的ウェブ API は、標準の HTTPS リクエストを使用して送信される URL パラメータに基づいて画像を作成します。

一般的な Street View Static API リクエストの形式は次のとおりです。

  https://www.googleapis.com/streetview/z/x/y?parameters

ウェブサービスとは

Google Maps Platform ウェブサービスは、外部サービスから Maps API データをリクエストし、Maps アプリケーション内でそのデータを使用するためのインターフェースです。これらのサービスは、Google Maps Platform 利用規約のライセンス制限に従って、地図と組み合わせて使用するように設計されています。

Maps APIs ウェブサービスは、特定の URL に対して HTTP または HTTPS リクエストを使用し、URL パラメータまたは JSON 形式の POST データをサービスの引数として渡します。通常、これらのサービスは、アプリケーションによる解析や処理のために、レスポンスの本文でデータを JSON として返します。

Street View Static API メタデータリクエストの形式は次のとおりです。

https://maps.googleapis.com/maps/api/streetview/parameters

SSL と TLS のアクセス

API キーを使用する、またはユーザーデータを含む Google Maps Platform のすべてのリクエストには HTTPS が必要です。機密データを含む HTTP 経由のリクエストは拒否される可能性があります。

有効な URL の作成

「有効」な URL とは何か、説明の必要はないと考えられるかもしれませんが、それほど単純なことではありません。ブラウザのアドレスバーに入力される URL には特殊文字（"上海+中國" など）が含まれている場合があります。このような特殊文字は、ブラウザで別のエンコードに内部的に変換してから送信する必要があります。同様に、UTF-8 入力を生成または受け付けるコードでは、UTF-8 の文字が使用された URL を「有効」な URL として扱うことがありますが、それらの文字はウェブサーバーに送信する前に変換する必要があります。このプロセスは、URL エンコードまたはパーセントエンコードと呼ばれます。

特殊文字

すべての URL は URI（Uniform Resource Identifier）仕様で規定されている構文に従う必要があるため、特殊文字を変換する必要があります。つまり、URL には、ASCII 文字の特別なサブセット（よく使用される英数記号および URL 内で制御文字として使用される予約文字）のみを含める必要があります。次の表は、こうした特殊記号をまとめたものです。

有効な URL 文字の概要

セット	文字	URL での使用法
英数字	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`）など
未予約	- _ . ~	テキスト文字列
予約済み	! * ' ( ) ; : @ & = + $ , / ? % # [ ]	制御文字やテキスト文字列

有効な URL を作成するときは、表に記載されている文字のみを使用する必要があります。しかし、URL での使用がこの文字セットだけに制限された場合、通常は 2 つの問題が発生します。1 つは省略、もう 1 つは置き換えです。

処理する文字が上記のセットに含まれない場合。たとえば、「上海+中國」のような英語以外の文字は、上記の文字を使用してエンコードする必要があります。一般的な命名規則では、URL 内で使用できないスペースもプラス記号 '+' を使用して表します。
上記のセットに予約文字として含まれる文字を、リテラル文字として使用する必要がある場合。たとえば、「?」は URL 内でクエリ文字列の先頭を示すために使用されます。文字列「?　and the Mysterions」を使用する場合は、文字 '?' をエンコードする必要があります。

URL エンコードが必要なすべての文字を、'%' と、UTF-8 文字に対応する 2 文字の 16 進数値を使用してエンコードします。たとえば、UTF-8 の「上海+中國」は、「%E4%B8%8A%E6%B5%B7%2B%E4%B8%AD%E5%9C%8B」として URL エンコードされます。文字列「? and the Mysterians」は、「%3F+and+the+Mysterians」または「%3F%20and%20the%20Mysterians」として URL エンコードされます。

エンコードが必要な一般的な文字

エンコードする必要がある一般的な文字は次のとおりです。

危険な文字	エンコードされた値
スペース	`%20`
"	`%22`
<	`%3C`
>	`%3E`
#	`%23`
%	`%25`
\|	`%7C`

ユーザー入力から受け取った URL の変換には、場合によって注意が必要です。たとえば、ユーザーが住所を「5th&Main St.」と入力することも考えられます。通常は、ユーザー入力をリテラル文字として処理して、URL をパーツから作成する必要があります。

さらに、URL は、すべての Google Maps Platform ウェブサービスと Static Web API で 16,384 文字に制限されています。ほとんどのサービスでは、この文字制限に達することはめったにありません。ただし、複数のパラメータを持つ特定のサービスでは、URL が長くなる可能性があります。

Google API の適切な使用

API クライアントの設計が不適切な場合、インターネットやサーバーに大きな負荷がかかる可能性があります。このセクションでは、API クライアントのベストプラクティスについて説明します。これらのベストプラクティスに従うことで、API の意図しない不正使用によってアプリケーションがブロックされるのを防ぐことができます。

指数バックオフ

まれに、リクエストで問題が発生することがあります。4xx または 5xx の HTTP レスポンスコードが返されたり、クライアントと Google のサーバー間のどこかで TCP 接続が失敗したりすることがあります。多くの場合、元のリクエストが失敗しても、フォローアップリクエストが成功することがあるため、リクエストを再試行する価値があります。ただし、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 in the following code 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 the request didn't produce an IOError, parse the result.
            result = json.load(response)

            if result["status"] == "OK":
                return result["timeZoneId"]
            elif result["status"] != "UNKNOWN_ERROR":
                # Many API errors can't be fixed by a retry, such as
                # INVALID_REQUEST or ZERO_RESULTS. Don't retry 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 on each retry.


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

アプリケーションの呼び出しチェーンの上位に再試行コードがないことを確認します。このコードがあると、リクエストが立て続けに繰り返される可能性があります。

同期リクエスト

Google の API への同期リクエストが大量に発生すると、Google のインフラストラクチャに対する分散型サービス拒否（DDoS）攻撃のように見えるため、それに応じて処理されます。この問題を回避するには、API リクエストがクライアント間で同期されないようにします。

たとえば、現在のタイムゾーンの時刻を表示するアプリケーションについて考えてみましょう。このアプリケーションは、表示される時刻を更新できるように、クライアントオペレーティングシステムでアラームを設定して、毎分の開始時に起動している可能性があります。アラームに関連付けられた処理の一部として、アプリケーションで API 呼び出しを行わないでください。

固定アラームに応答して API 呼び出しを行うのは、API 呼び出しが時間とともに均等に分散されるのではなく、異なるデバイス間でも 1 分の開始時に同期されるため、望ましくありません。設計が不適切なアプリケーションがこの処理を行うと、毎分の開始時にトラフィックが通常の 60 倍に急増します。

代わりに、ランダムに選択された時間に設定された 2 つ目のアラームを持つようにアプリケーションを設計できます。2 回目のアラームが起動すると、アプリケーションは必要な API を呼び出し、結果を保存します。アプリは、1 分の開始時にディスプレイを更新する際、API を再度呼び出すのではなく、以前に保存された結果を使用します。このアプローチでは、API 呼び出しが時間とともに均等に分散されます。また、API 呼び出しは、ディスプレイの更新時にレンダリングを遅延させません。

分の開始時以外は、1 時間の開始時や毎日の深夜 0 時など、一般的な同期時刻をターゲットにしないでください。

レスポンスの処理

ウェブサービスリクエストに対する個々のレスポンスの正確な形式は保証されません。一部の要素が欠落していたり、複数の場所に存在したりする可能性があるため、特定のレスポンスで返される形式が異なるクエリでも同じであると想定しないでください。代わりに、式を使用してレスポンスを処理し、適切な値を選択します。

このセクションでは、ウェブサービスレスポンスからこれらの値を動的に抽出する方法について説明します。

Google マップのウェブサービスは、理解しやすいがユーザーフレンドリーではないレスポンスを提供します。クエリを実行するときに、データセットを表示するのではなく、いくつかの特定の値を抽出したい場合があります。通常は、ウェブサービスからのレスポンスを解析し、必要な値のみを抽出します。

使用する解析スキームは、JSON で出力を返すかどうかによって異なります。JSON レスポンスはすでに JavaScript オブジェクトの形式になっているため、クライアント側の JavaScript 内で処理できます。