Method: computeRouteMatrix

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

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

たとえば、次のメソッドでは、

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

フィールド マスクに status を含めることが重要です。そうしないと、すべてのメッセージが OK と表示されます。Google では、ワイルドカード（*）レスポンス フィールド マスクの使用は推奨されていません。理由は次のとおりです。

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

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 以下にする必要があります。
  • routingPreference が 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 を指定できます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
arrivalTime

string (Timestamp format)

省略可。到着時刻。注: RouteTravelMode が TRANSIT に設定されている場合にのみ設定できます。departureTime または arrivalTime のどちらか一方だけ指定できます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
languageCode

string

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

string

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

enum (Units)

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

enum (ExtraComputation)

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

enum (TrafficModel)

省略可。交通状況での所要時間を計算するときに使用する仮定を指定します。この設定に応じて、RouteMatrixElement の所要時間フィールドに返される値が変わります。この値は、過去の平均データに基づく予測所要時間となります。TrafficModel は、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)

交通機関の運賃をテキスト形式で表します。