応答
GetTravelCostMatrix からの出力には多数のルート シーケンスが含まれます。各ルート シーケンスには、マトリクス ルートで使用される候補の始点と終点、および計算された各ルートの時間と距離が含まれます。OptimizeBy オプションの設定によって、出力にマトリクスのすべてのルートを含めることも、各始点/終点間の最適ルートのみを含めることもできます。
GetTravelCostMatrix でマトリクスの始点と終点の間にルートが見つからないと、サーバー ログにエラーが記録されますが、確認できたルートはすべて返されます。例えば、始点 A と終点 1 および 2 があって、GetTravelCostMatrix が A から 1 へのルートは見つけられても、A から 2 へのルートを見つけられない場合、GetTravelCostMatrix は A から 1 へのルートを返し、A から 2 へのルートは見つけられなかったことをログに記録します。
GetTravelCostMatrix の出力は、ReturnRouteCostMatrix オプションの設定に応じて、リスト形式かオブジェクト形式になります。オブジェクト出力を直接操作することはできません。
応答要素 |
書式 |
説明 |
---|---|---|
Distance | String |
始点から終点までの距離。値の単位は、DistanceUnits 要素に設定された単位になります。 |
DistanceUnits | String |
距離に使用される単位です。次のいずれかです。
|
EndPointRef | String |
入力で終点が指定された順序に対応する参照 ID。最初に指定された終点の参照 ID は 1、2 番目に指定された終点の参照 ID は 2、以降も同様になります。入力の緯度/経度座標を Get Travel Cost Matrix が返す参照 ID と関連付ける独自プロセスを作成する必要があります。 |
EndPointID | String |
Input ステージの ID フィールドで、対応する終点に割り当てた ID。例えば、最初の終点の EndPointID が N、2 つめの終点の EndPointID が O (以下同様) となっている場合があります。 注: このフィールドが有効になるのは、[ルート コスト マトリクス フォーマット] フィールドが [階層] に設定されている場合だけです。
|
StartPointRef | String |
入力で始点が指定された順序に対応する参照 ID。最初に指定された始点の参照 ID は 1、2 番目に指定された始点の参照 ID は 2、以降も同様になります。入力の緯度/経度座標を Get Travel Cost Matrix が返す参照 ID と関連付ける独自プロセスを作成する必要があります。 |
StartPointID | String |
Input ステージの ID フィールドにおいて対応する始点に割り当てた識別子。例えば、最初の始点の StartPointID が A、2 つめの始点の StartPointID が B (以下同様) となっている場合があります。 注: このフィールドが有効になるのは、[ルート コスト マトリクス フォーマット] フィールドが [階層] に設定されている場合だけです。
|
Time | String |
始点から終点までの合計時間。値の単位は、TimeUnits 要素に設定された単位になります。 |
TimeUnits | String |
時間に使用される単位です。次のいずれかです。
|
Status |
文字列 [1] |
マッチが成功したか失敗したかを表します。
|
Status.Code |
文字列 [100] |
失敗の原因 (ある場合)。 |
Status.Description |
String |
Status.Code に示された失敗の説明です。 |