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

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

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

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

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

このレスポンスを使用して、要件に合った適切なルートを選択するために必要な情報を顧客に提供できます。

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

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

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

詳しくは、返品する情報の選択をご覧ください。

著作権の表示について

検索結果をユーザーに表示するときは、著作権に関する次の文言を含める必要があります。

Powered by Google, ©YEAR Google

例:

Powered by Google, ©2023 Google

ルート、区間、歩数について

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

ルート、区間、ステップ。

レスポンスには、次の各ルート コンポーネントに関する情報を含めることができます。

  • ルート: 出発地の地点から任意の中間地点を通る地点、目的地の地点までのルート全体。1 つのルートは 1 つ以上の区間で構成されます。

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

    ルートには、各地点から次の地点に至る経路の区間が含まれます。たとえば、ルートに出発地の地点と目的地の地点が 1 つだけ含まれている場合、ルートには 1 つの区間が含まれます。出発地と目的地の後にある地点（中間地点）に地点を追加すると、API によって個別の区間が追加されます。

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

  • ステップ: ルートの区間に沿った 1 つの指示。ステップはルートの最もアトミックな単位です。たとえば、1 つのステップに「大通りを左折」と示すことができます。

レスポンスの内容

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

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

  • geocodingResults: GeocodingResults 型の要素の配列。住所文字列または Plus Code として指定されたリクエスト内の場所（出発地、目的地、中間地点）ごとに、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 環境に優しいルートを識別する ID を指定します。
DEFAULT_ROUTE_ALTERNATE 代替ルートを示します。

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"
      ],
     …
    }
  ]
}

legs 配列について

レスポンスの各 route には legs 配列が含まれます。この各 legs 配列要素は RouteLeg 型です。配列内の各区間は、ルート上の地点から次の地点までの経路を定義します。ルートには常に 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 つの命令に対応します。区間には常に少なくとも 1 つのステップが含まれます。

steps 配列の各要素には、ステップ命令を格納した Navigation 命令 型の navigationInstruction プロパティが含まれています。例:

"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 が返す結果のセットや返される順序に影響を与える可能性があります。ジオコーダによる略語の解釈は言語によって異なります。たとえば、番地の略語や、ある言語では有効だが別の言語では使用できない類義語など、略語の解釈は言語によって異なります。たとえば、ハンガリー語では utca と tér は「ストリート」の同義語です。

geocodingResults の配列について

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

geocodingResults 配列には次の 3 つのフィールドがあります。

  • origin: 住所文字列または Plus Code として指定された場合は、出発地のプレイス ID。それ以外の場合、このフィールドはレスポンスに含まれません。

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

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

"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}.
  }
}

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

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