ルートのレスポンスを確認する

欧州経済領域（EEA）のデベロッパー

請求先住所が欧州経済領域内にある場合は、2025 年 7 月 8 日より、 Google Maps Platform の EEA における利用規約 がこのサービスのご利用に適用されます。機能は地域によって異なります。詳細。

Routes API は、ルートを計算する際に、指定した地点と構成パラメータを入力として使用します。API は、デフォルトのルートと 1 つ以上の代替ルートを含むレスポンスを返します。

リクエストするフィールドに応じて、レスポンスにはさまざまな種類のルートやその他のデータを含めることができます。

レスポンスに含める場合	こちらのドキュメントをご覧ください
車両のエンジンの種類に応じた、燃費やエネルギー効率に優れた最も良いルート。	環境に優しいルートを構成する
最大 3 つの代替ルート	代替ルートをリクエストする
ルート全体、ルートの各区間、区間の各ステップ のポリライン。	ルートのポリラインをリクエストする
運転手または車両が利用できる通行料金の割引 またはパスを考慮した推定通行料金。	通行料金を計算する
言語コードと測定単位（ヤードポンド法または メートル法）によるローカライズされたレスポンス。	ローカライズされた値をリクエストする
ナビゲーション手順を HTML テキスト文字列として書式設定するには、HTML_FORMATTED_NAVIGATION_INSTRUCTIONS を extraComputations に追加します。	追加の計算

入力オプションの完全なリストについては、利用可能なルート オプション と リクエスト本文をご覧ください。

レスポンスを使用すると、要件に適したルートを選択するために必要な情報をユーザーに提供できます。

注: さまざまな種類のリクエストに対する API の処理方法について詳しくは、デモをお試しください。デモでは、住所を入力して、レスポンスを可視化されたコンテンツとして表示できます。

フィールド マスクについて

ルートを計算するメソッドを呼び出す場合は、レスポンスで返されるフィールドを定義するフィールド マスクを指定する必要があります。返されるフィールドのデフォルトのリストはありません。このリストを省略すると、メソッドからエラーが返されます。

このドキュメントの例では、フィールド マスクを考慮せずにレスポンス オブジェクト全体を示しています。本番環境では、レスポンスにはフィールド マスクで明示的に指定したフィールドのみが含まれます。

詳細については、返す情報を選択するをご覧ください。

著作権の表示について

結果をユーザーに表示する場合は、次の著作権表示を含める必要があります。

Powered by Google, ©YEAR Google

次に例を示します。

Powered by Google, ©2023 Google

ルート、区間、ステップについて

Routes API から返されるレスポンスを確認する前に、ルートを構成するコンポーネントについて理解しておく必要があります。

レスポンスには、これらのルート コンポーネントに関する情報が含まれる場合があります。

• ルート: 出発地点から、 中間地点を経由して、目的地までの移動全体。ルートは 1 つ以上の区間で構成されます。

• 区間: ルート内の 1 つの地点からルート内の次の地点までの パス。各区間は、1 つ以上の個別のステップで構成されます。

  ルートには、各地点から次の地点までのパスの個別の区間が含まれます。 たとえば、ルートに 1 つの出発地点と 1 つの目的地が含まれている場合、ルートには 1 つの区間が含まれます。出発地と目的地の後にルートに追加する 地点（中間地点）ごとに、API は個別の区間を追加します。

  API は、通過型の中間地点の区間を追加しません。 たとえば、出発地点、通過型の中間地点、目的地を含むルートには、地点を通過しながら出発地から目的地までの 1 つの区間のみが含まれます。通過型地点の詳細については、 通過型地点を定義するをご覧ください。

• ステップ: ルートの区間に沿った 1 つの指示。ステップは、ルートの最も細かい単位です。たとえば、ステップは「メインストリートを左折」を示すことができます。

レスポンスの内容

API レスポンスを表す JSON オブジェクト には、次の最上位プロパティが含まれます。

• routes： Route 型の要素の配列。 routes 配列には、API から返されるルートごとに 1 つの要素が含まれます。配列には、デフォルトのルート、環境に優しいルート、最大 3 つの代替ルートの最大 5 つの要素を含めることができます。

• geocodingResults： GeocodingResults 型の要素の配列。 リクエスト内の場所（出発地、目的地、中間地点 ）を住所文字列 またはプラスコードとして指定すると、 API はプレイス ID の検索を行います。この配列の各要素には、場所に対応するプレイス ID が含まれます。リクエスト内の場所がプレイス ID または緯度と経度の座標 として指定されている場合は含まれません。 プレイス ID または緯度と経度の座標を使用してすべての場所を指定した場合、この配列は提供されません。

• fallbackInfo： FallbackInfo 型。 API がすべての入力プロパティからルートを計算できない場合は、別の計算方法を使用するフォールバックが行われることがあります。フォールバック モードが使用されている場合、このフィールドにはフォールバック レスポンスに関する詳細情報が含まれます。それ以外の場合、このフィールドは設定されません。

レスポンスの形式は次のとおりです。

{
  // The routes array.
  "routes": [
    {
      object (Route)
    }
  ],
  // The place ID lookup results.
  "geocodingResults": [
    {
      object (GeocodedWaypoint)
    }
  ],
  // The fallback property.
  "fallbackInfo": {
    object (FallbackInfo)
  }
}

ルート配列を解読する

レスポンスには routes 配列が含まれます。各配列要素は Route 型です。 各配列要素は、出発地から目的地までのルート全体を表します。API は常に、デフォルトのルートと呼ばれるルートを 1 つ以上返します。

追加のルートをリクエストできます。環境に優しいルートをリクエストすると、配列にデフォルトのルートと環境に優しいルートの 2 つの要素を含めることができます。または、リクエストで computeAlternativeRoutes を true に設定して、最大 3 つの代替ルートをレスポンスに追加します。

配列内の各ルートは、routeLabels 配列プロパティで識別されます。

値	説明
DEFAULT_ROUTE	デフォルトのルートを識別します。
FUEL_EFFICIENT	環境に優しいルートを識別します。
DEFAULT_ROUTE_ALTERNATE	代替ルートを示します。I

legs 配列には、ルートの各区間の定義が含まれます。残りの プロパティ（distanceMeters、duration、polyline, など）には、ルート全体の 情報が含まれます。

{
  "routeLabels": [
    enum (RouteLabel)
  ],
  "legs": [
    {
      object (RouteLeg)
    }
  ],
  "distanceMeters": integer,
  "duration": string,
  "routeLabels": [string],
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "description": string,
  "warnings": [
    string
  ],
  "viewport": {
    object (Viewport)
  },
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  }
  "routeToken": string
}

現在の運転状況やその他の要因により、デフォルトのルートと環境に優しいルートが同じになることがあります。この場合、routeLabels 配列には DEFAULT_ROUTE と FUEL_EFFICIENT の両方のラベルが含まれます。

{
  "routes": [
    {
      "routeLabels": [
        "DEFAULT_ROUTE",
        "FUEL_EFFICIENT"
      ],
     …
    }
  ]
}

区間配列について

レスポンスの各 route には legs 配列が含まれます。各 legs 配列 要素は RouteLeg 型です。 配列内の各区間は、ルートに沿った 1 つの地点から次の地点までのパスを定義します。ルートには常に 1 つ以上の区間が含まれます。

legs プロパティには、steps 配列内の区間に沿った各ステップの定義が含まれます。distanceMeters、duration、polyline などの残りのプロパティには、区間に関する情報が含まれます。

{
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "steps": [
    {
      object (RouteLegStep)
    }
  ],
  "travelAdvisory": {
    object (RouteLegTravelAdvisory)
  }
}

ステップ配列について

レスポンスの各区間には steps 配列が含まれます。各 steps 配列 要素は RouteLegStep 型です。 ステップは、区間に沿った 1 つの指示に対応します。区間には常に 1 つ以上のステップが含まれます。

steps 配列の各要素には、ステップの指示を含む navigationInstruction NavigationInstruction 型の property プロパティが含まれます。次に例を示します。

"navigationInstruction": {
  "maneuver": "TURN_LEFT",
  "instructions": "Turn left toward Frontage Rd"
}

instructions には、ステップに関する追加情報が含まれる場合があります。次に例を示します。

"navigationInstruction": {
  "maneuver": "TURN_SLIGHT_LEFT",
  "instructions": "Slight left (signs for I-90 W/Worcester)nParts of this road may be closed at certain times or days"
}

ステップの残りのプロパティには、distanceMeters、duration、polyline など、ステップに関する情報が記述されています。

{
  "distanceMeters": integer,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "navigationInstruction": {
    object (NavigationInstruction)
  }
}

ステップの指示の言語を指定する

API は、優先言語を遵守しながら、必要に応じてユーザーが読めるスクリプトに音訳されたルート情報をローカル言語で返します。住所の構成要素はすべて同じ言語で返されます。

• リクエストの languageCode パラメータを使用して、サポートされている言語の リストからルートの言語を明示的に設定します。サポート対象の言語は頻繁に更新されるため、このリストで網羅されていない場合があります。

• 指定した言語で名前が使用できない場合、API は最も近い一致を使用します。

• 指定した言語は、API が返す結果のセットと、返される順序に影響する可能性があります。ジオコーダは、言語によって略語の解釈が異なります。たとえば、通りの種類の略語や、ある言語では有効でも別の言語では有効でない同義語などです。たとえば、ハンガリー語では utca と tér は通りの同義語です。

geocodingResults 配列について

リクエスト内の場所（出発地、目的地、中間地点）が住所文字列 またはプラスコード として指定されている場合、API は対応するプレイス ID を持つ最も関連性の高い場所を見つけようとします。 geocodingResults 配列の各要素には、場所をプレイス ID として含む placeID フィールドと、場所のタイプ（street_address、premise、airport など）を指定する type フィールドが含まれます。

注: API には、プレイス ID または緯度と経度の座標として指定されたリクエスト内の場所は含まれません。すべてがこれらの形式の場合、この配列は提供されません。

geocodingResults 配列には 3 つのフィールドが含まれます。

• origin: 住所文字列またはプラスコードとして指定された場合は、出発地のプレイス ID。それ以外の場合、このフィールドはレスポンスから省略されます。

• destination: 住所文字列またはプラスコードとして指定された場合は、目的地のプレイス ID。それ以外の場合、このフィールドはレスポンスから省略されます。

• intermediates: 住所文字列またはプラスコードとして指定された中間地点のプレイス ID を含む配列。プレイス ID または緯度と経度の座標を使用して中間地点を指定すると、レスポンスから省略されます。レスポンスの intermediateWaypointRequestIndex プロパティを使用して、リクエスト内の中間地点がレスポンス内のプレイス ID に対応しているかどうかを判断します。

注: リクエストされた場所が存在しない場合や見つからない場合でも、API はレスポンスの geocodingResults 配列にデータを入力します。ただし、見つからない場所のルートを計算できないため、routes 配列は空になります。

"geocodingResults": {
    "origin": {
        "geocoderStatus": {},
        "type": [
             enum (Type)
        ],
        "placeId": string
    },
    "destination": {
        "geocoderStatus": {},
        "type": [
            enum (Type)
        ],
        "placeId": string
    },
    "intermediates": [
        {
            "geocoderStatus": {},
            "intermediateWaypointRequestIndex": integer,
            "type": [
                enum (Type)
            ],
            "placeId": string
        },
        {
           "geocoderStatus": {},
           "intermediateWaypointRequestIndex": integer,
            "type": [
                enum (Type)
            ],
            "placeId": string
        }
    ]
}

ローカライズされたレスポンス値について

ローカライズされたレスポンス値は、返されたパラメータ値のローカライズされたテキストを提供する追加のレスポンス フィールドです。移動時間、距離、単位系（メートル法またはヤードポンド法）のローカライズされたテキストが提供されます。フィールド マスクを使用してローカライズされた値をリクエストし、言語と単位系を指定するか、API によって推測された値を使用できます。詳細については、 LocalizedValues をご覧ください。

たとえば、ドイツ語（de）の言語コードとヤードポンド法を指定すると、distanceMeters の値は 49889.7 になりますが、その距離の測定値をドイツ語とヤードポンド法で示すローカライズされたテキスト（「31 Meile」）も取得できます。

ローカライズされた値の表示例を次に示します。

{ "localized_values":
  {
    "distance": { "text": "31,0 Meile/n" },
    "duration": { "text": 38 Minuten}.
    "static_duration": { "text": 36 Minuten}.
  }
}

注: 予想される所要時間には 2 つの値があります。 duration は指定した交通状況モデルを使用し、 static_duration は交通状況を考慮しません。したがって、リクエストした交通状況モデルが TRAFFIC_UNAWARE の場合、これらの時間は同じになります。

言語または単位系を指定しない場合、API は次のように言語と単位を推測します。

• ComputeRoutes メソッドは、出発地点から場所と距離 の単位を推測します。したがって、米国でのルーティング リクエストの場合、API は en-US 言語と IMPERIAL 単位を推測します。
• ComputeRouteMatrix メソッドのデフォルトは、言語が「en-US」、 単位がメートル法です。