Method: computeRouteMatrix

出発地と目的地のリストを受け取り、出発地と目的地の各組み合わせのルート情報を含むストリームを返します。

注: このメソッドでは、入力でレスポンス フィールド マスクを指定する必要があります。レスポンス フィールド マスクは、URL パラメータ $fields または fields を使用するか、HTTP/gRPC ヘッダー X-Goog-FieldMask を使用して指定できます（使用可能な URL パラメータとヘッダーをご覧ください）。値はフィールドパスのカンマ区切りのリストです。詳しくは、フィールド パスの作成方法をご覧ください。

たとえば、このメソッドでは次のようになります。

  • 使用可能なすべての項目のフィールド マスク（手動検査用）: X-Goog-FieldMask: *
  • ルートの所要時間、距離、要素のステータス、条件、要素のインデックスのフィールド マスク（本番環境の設定例）: X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration

フィールド マスクに status を含めることが重要です。含めないと、すべてのメッセージが正しく機能するようになります。以下の理由により、ワイルドカード（*）レスポンス フィールド マスクの使用はおすすめしません。

  • 必要なフィールドのみを選択することで、サーバーの計算サイクルが節約され、低レイテンシで結果を返すことができます。
  • 本番環境のジョブに必要なフィールドのみを選択することで、安定したレイテンシ パフォーマンスを確保できます。今後、レスポンス フィールドがさらに追加される可能性があります。また、このような新しいフィールドでは計算時間が増加する可能性があります。すべてのフィールドを選択した場合や、トップレベルのすべてのフィールドを選択した場合、新しく追加したフィールドが自動的にレスポンスに含まれるため、パフォーマンスが低下する可能性があります。
  • 必要なフィールドのみを選択すると、レスポンス サイズが小さくなり、ネットワーク スループットが向上します。

HTTP リクエスト

POST https://routespreferred.googleapis.com/v1alpha:computeRouteMatrix

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "origins": [
    {
      object (RouteMatrixOrigin)
    }
  ],
  "destinations": [
    {
      object (RouteMatrixDestination)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "departureTime": string
}
フィールド
origins[]

object (RouteMatrixOrigin)

必須。レスポンス マトリックスの行を決定するオリジンの配列。出発地と目的地のカーディナリティには、いくつかのサイズ制限が適用されます。

  • 要素の数（出発地 × 目的地）は、どのような場合でも 625 を超えないようにする必要があります。
  • routesPreference が TRAFFIC_AWARE_OPTIMAL に設定されている場合、要素の数（出発地 × 目的地）は 100 以下にする必要があります。
  • placeId として指定する地点（出発地 + 目的地）の数は 50 以下にする必要があります。
destinations[]

object (RouteMatrixDestination)

必須。レスポンス マトリックスの列を決定する宛先の配列。
travelMode

enum (RouteTravelMode)

省略可。移動手段を指定します。
routingPreference

enum (RoutingPreference)

省略可。ルートの計算方法を指定します。サーバーは、選択されたルーティング設定を使用してルートの計算を試みます。ルーティング設定によってエラーや余分なレイテンシが発生した場合は、エラーが返されます。将来的には、優先されるオプションから有効な結果が得られない場合に別のオプションを使用するフォールバック メカニズムが実装される可能性があります。このオプションは、travelMode が DRIVE または TWO_WHEELER の場合にのみ指定できます。それ以外の場合、リクエストは失敗します。
departureTime

string (Timestamp format)

省略可。出発時刻。この値を設定しない場合は、リクエストを行った時刻がデフォルトになります。発生済みの時刻をこの値に設定すると、リクエストは失敗します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

レスポンスの本文

成功した場合、レスポンスの本文には RouteMatrixElement のインスタンスが含まれます。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/maps-platform.routespreferred

詳しくは、OAuth 2.0 の概要をご覧ください。