Method: computeRouteMatrix

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

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

たとえば、次のように指定します。

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

すべてのメッセージで問題ないように見えるため、status をフィールド マスクに含めることが重要です。ワイルドカード レスポンス フィールド マスクの使用はおすすめしません。理由は次のとおりです。*

  • 必要なフィールドのみを選択することで、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,
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "trafficModel": enum (TrafficModel),
  "transitPreferences": {
    object (TransitPreferences)
  }
}
フィールド
origins[]

object (RouteMatrixOrigin)

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

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

object (RouteMatrixDestination)

必須。レスポンス行列の列を決定するデスティネーションの配列。

travelMode

enum (RouteTravelMode)

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

routingPreference

enum (RoutingPreference)

(省略可)ルートの計算方法を指定します。サーバーは選択されたルーティング設定を使用してルートを計算しようとします。ルーティングの設定がエラーまたは長いレイテンシになると、エラーが返されます。このオプションを指定できるのは travelModeDRIVE または TWO_WHEELER の場合だけです。そうでない場合、リクエストは失敗します。

departureTime

string (Timestamp format)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の解像度で小数点以下 9 桁まで指定できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

arrivalTime

string (Timestamp format)

(省略可)到着時刻。注: RouteTravelModeTRANSIT に設定されている場合にのみ設定できます。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 言語コード。詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier を参照してください。サポートされている言語の一覧については、言語のサポートをご覧ください。この値を指定しない場合、表示言語は最初のオリジンの場所から推定されます。

regionCode

string

(省略可)地域コード。ccTLD(「トップレベル ドメイン」)の 2 文字の値で指定します。詳しくは、https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains をご覧ください。

extraComputations[]

enum (ExtraComputation)

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

trafficModel

enum (TrafficModel)

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

transitPreferences

object (TransitPreferences)

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

レスポンスの本文

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)

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

小数点以下 9 桁以下で指定し、末尾が「s」で終わる秒数。例: "3.5s"

staticDuration

string (Duration format)

交通状況を考慮しないルートの移動時間。

小数点以下 9 桁以下で指定し、末尾が「s」で終わる秒数。例: "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)

必須。目的地の地点

外計算

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

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

RouteMatrixElementCondition

返されるルートの条件。

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

ローカライズされた値

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

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)

運賃はテキスト形式で表記されます。