- HTTP リクエスト
- リクエストの本文
- レスポンスの本文
- RouteMatrixOrigin
- RouteMatrixDestination
- 余分な計算
- RouteMatrixElementCondition
- LocalizedValues
出発地と目的地のリストを受け取り、出発地と目的地の組み合わせごとのルート情報を含むストリームを返します。
注: このメソッドでは、入力にレスポンス フィールド マスクを指定する必要があります。レスポンス フィールド マスクを指定するには、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 ( |
フィールド | |
---|---|
origins[] |
必須。レスポンス マトリックスの行を決定するオリジンの配列。出発地と目的地のカーディナリティには、いくつかのサイズ制限が適用されます。
|
destinations[] |
必須。レスポンス行列の列を決定するデスティネーションの配列。 |
travelMode |
(省略可)移動手段を指定します。 |
routingPreference |
(省略可)ルートの計算方法を指定します。サーバーは選択されたルーティング設定を使用してルートを計算しようとします。ルーティングの設定がエラーまたは長いレイテンシになると、エラーが返されます。このオプションを指定できるのは |
departureTime |
(省略可)出発時刻。この値を設定しなかった場合、リクエストを行った時刻がデフォルトになります。注: RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の解像度で小数点以下 9 桁まで指定できます。例: |
arrivalTime |
(省略可)到着時刻。注: RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の解像度で小数点以下 9 桁まで指定できます。例: |
languageCode |
(省略可)「en-US」や「sr-Latn」などの BCP-47 言語コード。詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier を参照してください。サポートされている言語の一覧については、言語のサポートをご覧ください。この値を指定しない場合、表示言語は最初のオリジンの場所から推定されます。 |
regionCode |
(省略可)地域コード。ccTLD(「トップレベル ドメイン」)の 2 文字の値で指定します。詳しくは、https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains をご覧ください。 |
extraComputations[] |
(省略可)リクエストを完了するために使用できる追加の計算のリスト。注: これらの計算を行うと、レスポンスに余分なフィールドが返されることがあります。これらの追加のフィールドは、レスポンスで返されるようにフィールド マスクで指定する必要があります。 |
trafficModel |
(省略可)所要時間を計算する上での仮定条件を指定します。この設定は、 |
transitPreferences |
(省略可) |
レスポンスの本文
v2.computeRouteMatrix API の出発地と目的地のペアに対して計算されたルート情報が含まれます。この proto は、クライアントにストリーミングできます。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{ "status": { object ( |
フィールド | |
---|---|
status |
この要素のエラー ステータス コードです。 |
condition |
ルートが見つかったかどうかを示します。ステータスとは無関係です。 |
distanceMeters |
ルートの移動距離(メートル単位)。 |
duration |
ルートの移動にかかる時間です。 小数点以下 9 桁以下で指定し、末尾が「 |
staticDuration |
交通状況を考慮しないルートの移動時間。 小数点以下 9 桁以下で指定し、末尾が「 |
travelAdvisory |
ルートに関する追加情報。(制限情報や通行料金情報など) |
fallbackInfo |
場合によっては、サーバーがこの特定の出発地と目的地のペアについて、指定された設定を使用してルートを計算できない場合、別のコンピューティング モードを使用するようフォールバックすることがあります。代替モードが使用されている場合、このフィールドには代替レスポンスに関する詳細情報が含まれます。それ以外の場合、このフィールドは未設定です。 |
localizedValues |
|
originIndex |
リクエスト内のオリジンのゼロベースのインデックス。 |
destinationIndex |
リクエスト内の宛先のゼロベースのインデックス。 |
RouteMatrixOrigin
ComputeRouteMatrixRequest の単一のオリジン
JSON 表現 |
---|
{ "waypoint": { object ( |
フィールド | |
---|---|
waypoint |
必須。出発地点 |
routeModifiers |
(省略可)これを原点とするすべてのルートの修飾子 |
RouteMatrixDestination
ComputeRouteMatrixRequest の単一の宛先
JSON 表現 |
---|
{
"waypoint": {
object ( |
フィールド | |
---|---|
waypoint |
必須。目的地の地点 |
外計算
リクエストの完了時に実施する追加の計算。
列挙型 | |
---|---|
EXTRA_COMPUTATION_UNSPECIFIED |
使用されません。 この値を含むリクエストは失敗します。 |
TOLLS |
マトリックス要素の有料道路情報。 |
RouteMatrixElementCondition
返されるルートの条件。
列挙型 | |
---|---|
ROUTE_MATRIX_ELEMENT_CONDITION_UNSPECIFIED |
要素の status が OK でない場合にのみ使用します。 |
ROUTE_EXISTS |
ルートが見つかったので、対応する情報が要素に入力されました。 |
ROUTE_NOT_FOUND |
経路が見つかりませんでした。ルート情報(distanceMeters 、duration など)を含むフィールドは、要素内で入力されません。 |
ローカライズされた値
特定のプロパティのテキスト表現。
JSON 表現 |
---|
{ "distance": { object ( |
フィールド | |
---|---|
distance |
テキスト形式で表される移動距離。 |
duration |
交通状況を考慮したテキスト形式で示された所要時間。注: 交通情報がリクエストされなかった場合、この値は staticDuration と同じ値になります。 |
staticDuration |
交通量を考慮せずにテキスト形式で表現された所要時間。 |
transitFare |
運賃はテキスト形式で表記されます。 |