ルート行列リクエストは、出発地と目的地のウェイポイントの配列を入力として受け取ります。Routes API は、各出発地ウェイポイントから各目的地ウェイポイントまでのルートを計算します。たとえば、2 つの出発地点と 2 つの目的地点を指定すると、API は 4 つの個別のルートを計算します。
API レスポンスには配列が含まれます。各配列要素は、1 つの出発地のウェイポイントから 1 つの目的地のウェイポイントへのルートに相当します。したがって、2 つの出発地と 2 つの目的地の地点を指定すると、レスポンス配列には、計算されたルートごとに 1 つずつ、4 つの要素が含まれます。
レスポンスを使用して、さまざまなルート オプションをユーザーに提示し、ユーザーが要件に適したルートを選択できるようにします。
フィールド マスクについて
メソッドを呼び出してルートを計算する場合は、レスポンスで返されるフィールドを定義するフィールドマスクを指定する必要があります。返されるフィールドのデフォルト リストはありません。このリストを省略すると、メソッドはエラーを返します。
このドキュメントの例では、フィールド マスクを考慮せずにレスポンス オブジェクト全体を示しています。本番環境では、フィールドマスクで明示的に指定したフィールドのみがレスポンスに含まれます。
詳細については、返される情報を選択するをご覧ください。
著作権の表示について
結果をユーザーに表示する際は、次の著作権に関する声明を含める必要があります。
Powered by Google, ©YEAR Google
次に例を示します。
Powered by Google, ©2023 Google
レスポンスでルートを特定する
レスポンス内の各ルートを特定するには、originIndex レスポンス プロパティと destinationIndex レスポンス プロパティを使用します。これらのプロパティには、ルートの計算に使用される入力出発地と入力目的地のウェイポイントのゼロベースのインデックスが含まれています。つまり、リクエスト内の最初の出発地のウェイポイントと最初の目的地のウェイポイントは、配列インデックス 0 にあります。
たとえば、レスポンスのルートには次の情報が含まれます。
"originIndex": 1, "destinationIndex": 0
これらのプロパティは、ルートが入力配列のインデックス 1 の出発地のウェイポイントと、インデックス 0 の目的地のウェイポイントから計算されたことを示します。
次のルートの場合:
"originIndex": 4, "destinationIndex": 1
ルートは、入力配列のインデックス 4 の出発地のウェイポイントと、入力配列のインデックス 1 の目的地のウェイポイントから計算されました。
レスポンスについて
API レスポンスを表す JSON オブジェクトには配列が含まれます。各配列要素は、1 つの出発地のウェイポイントから 1 つの目的地のウェイポイントへのルートを定義します。
各ルートは、originIndex プロパティと destinationIndex プロパティに加えて、distanceMeters、duration、travelAdvisory など、そのルートに固有の情報も含みます。
レスポンスの形式は次のとおりです。
[
// One array element for each combination of origin and destination waypoints.
{
// The route for source waypoint 0 and destination waypoint 0.
"originIndex": 0,
"destinationIndex": 0,
"status": {
object (Status)
},
"condition": enum (RouteMatrixElementCondition),
"distanceMeters": integer,
"duration": string,
"staticDuration": string,
"travelAdvisory": {
object (RouteTravelAdvisory)
},
"fallbackInfo": {
object (FallbackInfo)
}
}
{
// The route for source waypoint 0 and destination waypoint 1.
"originIndex": 0,
"destinationIndex": 1,
"status": {
object (Status)
},
"condition": enum (RouteMatrixElementCondition),
"distanceMeters": integer,
"duration": string,
"staticDuration": string,
"travelAdvisory": {
object (RouteTravelAdvisory)
},
"fallbackInfo": {
object (FallbackInfo)
}
}
…
]