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://routes.googleapis.com/distanceMatrix/v2:computeRouteMatrix

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

リクエストの本文

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

JSON 表現 
{
  "origins": [
    {
      object (RouteMatrixOrigin)
    }
  ],
  "destinations": [
    {
      object (RouteMatrixDestination)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "departureTime": string,
  "arrivalTime": string,
  "languageCode": string,
  "regionCode": string,
  "units": enum (Units),
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "trafficModel": enum (TrafficModel),
  "transitPreferences": {
    object (TransitPreferences)
  }
}
フィールド
origins[]

object (RouteMatrixOrigin)

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

  • 出発地の数と placeId または address で指定された目的地の数の合計は 50 以下にする必要があります。
  • いずれの場合も、出発地の数 × 目的地の数の積は 625 を超えないようにする必要があります。
  • routePreference が TRAFFIC_AWARE_OPTIMAL に設定されている場合、出発地の数 × 目的地の数の積が 100 以下である必要があります。
  • travelMode が TRANSIT に設定されている場合は、出発地の数 × 目的地の数を 100 以下にしてください。
destinations[]

object (RouteMatrixDestination)

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

enum (RouteTravelMode)

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

enum (RoutingPreference)

省略可。ルートの計算方法を指定します。サーバーは、選択されたルーティング設定を使用してルートの計算を試みます。ルーティング設定によってエラーや余分なレイテンシが発生した場合は、エラーが返されます。このオプションは、travelMode が DRIVE または TWO_WHEELER の場合にのみ指定できます。それ以外の場合、リクエストは失敗します。
departureTime

string (Timestamp format)

省略可。出発時刻。この値を設定しない場合、この値はデフォルトでリクエストを行った時刻になります。注: RouteTravelMode が TRANSIT に設定されている場合のみ、過去の departureTime を指定できます。

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

string (Timestamp format)

省略可。到着時刻。注: RouteTravelMode が TRANSIT に設定されている場合にのみ設定できます。departureTime または arrivalTime のいずれかを指定できます。両方は指定できません。

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

string

省略可。「en-US」や「sr-Latn」などの BCP-47 言語コード。詳細については、Unicode ロケール識別子をご覧ください。サポートされている言語の一覧については、言語サポートをご覧ください。この値を指定しない場合、表示言語は最初のオリジンの位置から推測されます。
regionCode

string

省略可。ccTLD（「トップレベル ドメイン」）の 2 文字の値として指定される地域コード。詳しくは、国コード トップレベル ドメインをご覧ください。
units

enum (Units)

省略可。表示フィールドの測定単位を指定します。
extraComputations[]

enum (ExtraComputation)

省略可。リクエストの完了に使用できる追加計算のリスト。注: これらの追加の計算により、レスポンスに追加のフィールドが返される場合があります。これらの追加フィールドは、レスポンスで返されるフィールド マスクでも指定する必要があります。
trafficModel

enum (TrafficModel)

省略可。所要時間を計算する上での仮定条件を指定します。この設定は、過去の平均に基づくトラフィックの予測時間を含む RouteMatrixElement の duration フィールドに返される値に影響します。RoutingPreference から TRAFFIC_AWARE_OPTIMAL、RouteTravelMode から DRIVE に変更。トラフィックがリクエストされ、TrafficModel が指定されていない場合のデフォルトは BEST_GUESS です。
transitPreferences

object (TransitPreferences)

省略可。TRANSIT ルートに対して返されるルートに影響を与える設定を指定します。注: transitPreferences を指定できるのは、RouteTravelMode が TRANSIT に設定されている場合のみです。

レスポンスの本文

v2.computeRouteMatrix API の出発地と目的地のペアに対して計算されたルート情報が含まれています。この proto をクライアントにストリーミングできます。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "status": {
    object (Status)
  },
  "condition": enum (RouteMatrixElementCondition),
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  },
  "fallbackInfo": {
    object (FallbackInfo)
  },
  "localizedValues": {
    object (LocalizedValues)
  },
  "originIndex": integer,
  "destinationIndex": integer
}
フィールド
status

object (Status)

この要素のエラー ステータス コード。
condition

enum (RouteMatrixElementCondition)

ルートが見つかったかどうかを示します。ステータスとは無関係。
distanceMeters

integer

ルートの移動距離（メートル単位）。
duration

string (Duration format)

ルートの移動に必要な時間。routingPreference を TRAFFIC_UNAWARE に設定した場合、この値は staticDuration と同じです。routingPreference を TRAFFIC_AWARE または TRAFFIC_AWARE_OPTIMAL に設定した場合、この値は交通状況を考慮して計算されます。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
staticDuration

string (Duration format)

交通状況を考慮せずにルートを移動する時間。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
travelAdvisory

object (RouteTravelAdvisory)

ルートに関する追加情報。例: 規制情報や通行料金の情報
fallbackInfo

object (FallbackInfo)

サーバーがこの特定の出発地と目的地のペアに対して指定された設定でルートを計算できない場合、別の計算モードを使用するようにフォールバックすることがあります。フォールバック モードが使用されている場合、このフィールドにはフォールバック レスポンスに関する詳細情報が含まれます。それ以外の場合、このフィールドは設定されません。
localizedValues

object (LocalizedValues)

RouteMatrixElement のプロパティのテキスト表現。
originIndex

integer

リクエストに含まれるオリジンのゼロベースのインデックス。
destinationIndex

integer

リクエスト内の宛先のゼロベースのインデックス。

RouteMatrixOrigin

ComputeRouteMatrixRequest の単一の送信元

JSON 表現 
{
  "waypoint": {
    object (Waypoint)
  },
  "routeModifiers": {
    object (RouteModifiers)
  }
}
フィールド
waypoint

object (Waypoint)

必須。出発地の地点
routeModifiers

object (RouteModifiers)

省略可。これを出発地とするすべてのルートの修飾子

RouteMatrixDestination

ComputeRouteMatrixRequest の単一の宛先

JSON 表現 
{
  "waypoint": {
    object (Waypoint)
  }
}
フィールド
waypoint

object (Waypoint)

必須。目的地の地点

ExtraComputation

リクエストの完了時に実行する追加の計算。

列挙型
EXTRA_COMPUTATION_UNSPECIFIED 使用されません。この値を含むリクエストは失敗します。
TOLLS マトリックス要素の通行料金情報。

RouteMatrixElementCondition

返されるルートの状態。

列挙型
ROUTE_MATRIX_ELEMENT_CONDITION_UNSPECIFIED 要素の status が OK でない場合にのみ使用されます。
ROUTE_EXISTS ルートが見つかり、要素について対応する情報が入力されました。
ROUTE_NOT_FOUND 経路が見つかりませんでした。distanceMeters や duration などの経路情報を含むフィールドは、この要素に入力されません。

LocalizedValues

特定のプロパティのテキスト表現。

JSON 表現 
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  },
  "transitFare": {
    object (LocalizedText)
  }
}
フィールド
distance

object (LocalizedText)

テキスト形式で表される移動距離。
duration

object (LocalizedText)

交通状況を考慮してテキスト形式で表された所要時間。注: 交通情報がリクエストされていない場合、この値は staticDuration と同じ値になります。
staticDuration

object (LocalizedText)

交通状況を考慮せずにテキスト形式で表された所要時間。
transitFare

object (LocalizedText)

テキスト形式で表された交通機関運賃。