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 以下にする必要があります。
  • routePreference が 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 の概要をご覧ください。