ルート マトリックスを計算する

Routes Preferred API の ComputeRouteMatrix メソッドを使用して、複数の出発地と目的地のルートの距離と所要時間を計算できます。ComputeRouteMatrix は、ストリーミング gRPC 呼び出しと REST HTTP 呼び出しの両方をサポートしています。

ComputeRouteMatrix は、出発地と目的地のペアのリストを指定して、各出発地から目的地まで、ルートの距離と所要時間を計算します。ストリームの各要素は 1 つのルートの情報に対応しています

ComputeRouteMatrix メソッドには、距離行列サービスに比べて次のような利点があります。

  • ストリーミングでは、行列全体が計算される前に要素を返すことができるため、レイテンシを短縮できます。
  • ComputeRouteMatrix にはトラフィック計算用の詳細なオプションがあり、品質とレイテンシのトレードオフを行うことができます。
  • リクエストは Google のインフラストラクチャ内で高い優先度で実行されるため、可用性が向上します。
  • 地点の方向（進行方向）と道路脇の情報を指定できます。
  • 通行料金情報とともに、ルートの距離と到着予定時刻を返すようにリクエストできます。

ComputeRouteMatrix メソッドを有効にする

コードで ComputeRouteMatrix メソッドを使用する前に、それを有効にする必要があります。Routes Preferred API のメソッドを有効にする方法については、スタートガイドをご覧ください。

ComputeRouteMatrix メソッドの使用

ComputeRouteMatrix メソッドは、Routes Preferred v1 エンドポイントで使用できます。

詳細については、次のドキュメントをご覧ください。

gRPC: https://developers.google.com/maps/documentation/routes_preferred/reference/rpc/google.maps.routes.v1

REST: https://developers.google.com/maps/documentation/routes_preferred/reference/rest/v1/TopLevel/computeRouteMatrix

次の一般的な手順は、gRPC を使用して ComputeRouteMatrix メソッドを呼び出す方法を示しています。

  1. googleapis リポジトリから必要なプロトコル バッファを確認します。

    https://github.com/googleapis/googleapis/tree/master/google/maps/routes

    Go などの一部のビルドシステムでは、この処理が自動的に行われる場合があります。

  2. 任意の言語とビルドツールのセットを使用して、関連するプロトコル バッファ コードを生成します。

  3. リクエストを生成します。リクエストでは、次の 2 つの必須メタデータを送信する必要があります。

    • X-Goog-Api-Key に API キーを設定する必要があります。

    • X-Goog-Fieldmask には、レスポンスに必要なフィールドのカンマ区切りのリストを設定する必要があります。たとえば、X-Goog-FieldMask: originIndex,destinationIndex,duration,distanceMeters,status です。ワイルドカード文字（*）を使用してすべてのフィールドを示すことができますが、これは推奨されません。ワイルドカード文字を使用して API レスポンスをテストし、理解しますが、本番環境のコードでフィールド マスクには必要なフィールドを明示的にリストします。

      フィールド マスク文字列の作成方法の詳細については、https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto をご覧ください。不要なフィールドを無効にすると、追加の計算が必要になるため、レイテンシを短縮できます。必要なフィールドを指定し、より多くの計算を必要とする新しいフィールドを後で追加しても、レイテンシは安定します。

  4. routespreferred.googleapis.com:443 にリクエストを送信します。TLS プロトコルを使用する必要があります。

ComputeRouteMatrix メソッドの使用例については、ルート マトリックス（ベータ版）の例の計算をご覧ください。

ComputeRouteMatrix メソッドの特徴の 1 つは、エラーコードをストリーム全体または個々の要素に対して返すことができることです。たとえば、リクエストの形式が正しくない場合（オリジンがゼロなど）、ストリーム接続はエラーを返します。ただし、エラーがストリームの一部の要素にのみ適用される場合（オリジンに無効な場所 ID を設定する場合など）、そのエラーの影響を受ける要素にのみエラーコードが含まれます。

ストリームによって返される要素は、どのような順序でも必ず返されるとは限りません。このため、各要素には origin_index と destination_index が含まれます。リクエストで指定された出発地と目的地の場合、ルートの出発地は特定の要素の origins[origin_index] と等しく、ルートの目的地は destinations[destination_index] と等しくなります。これらの配列にはゼロのインデックスが付加されます。出発地と目的地のリストの順序を保存することが重要です。

通行料金の計算

通行料金の計算については、通行料金を計算するをご覧ください。

通行料金の計算例については、ルート マトリックスの計算例をご覧ください。