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

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

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

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 リポジトリから必要な protobuffer をチェックアウトします。

    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] と同等です。これらの配列は 0 から始まります。送信元リストと宛先リストの順序を保存することが重要です。

通行料金の計算

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

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