ルート マトリックスのリクエストは、出発地と目的地のウェイポイントの配列を入力として受け取ります。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
のレスポンス プロパティを使用して、レスポンス内の各ルートを識別します。これらのプロパティには、ルートの計算に使用される入力の origin と入力の destination 地点のゼロベースのインデックスが含まれます。つまり、リクエスト内の最初の出発地のウェイポイントと最初の目的地のウェイポイントは配列のインデックス 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) } } … ]