Routes API はルートを計算するときに、ウェイポイントと 構成パラメータを指定します。その後、API がレスポンスを返し、 default ルートと 1 つ以上の代替ルートが格納されています。
レスポンスには、さまざまなタイプのルートやその他のデータを含めることができます。 指定する必要があります。
レスポンスに含めるには | こちらのドキュメントをご覧ください |
---|---|
車両のエンジンの種類に応じた、燃料またはエネルギー効率の最もよいルート。 | 環境に優しいルートを設定する |
最大 3 つの代替ルート | 代替ルートをリクエストする |
ルート全体、ルートの各区間および各ステップのポリライン あります。 | ルートのポリラインをリクエストする |
通行料金の割引を考慮した推定通行料金 運転手や車両で利用可能なパスなどです。 | 通行料金を計算する |
言語コードと測定単位(ヤードポンド法、またはヤードポンド法)別のローカライズされたレスポンス できます。 | ローカライズした値をリクエストする |
ナビゲーション手順を HTML テキスト文字列としてフォーマットするには、HTML_FORMATTED_NAVIGATION_INSTRUCTIONS を
extraComputations 。 |
追加の計算 |
入力オプションの一覧については、使用可能なルート オプションをご覧ください。 および リクエスト本文。
このレスポンスを使用して、お客様に情報を提供し、 選択する必要があります。
フィールド マスクについて
ルートを計算するメソッドを呼び出すときは、ルート モジュールを マスク。レスポンスで返されるフィールドを定義します。「 返されるフィールドのデフォルト リストです。このリストを省略すると、メソッドは エラーが発生します。
このドキュメントの例では、レスポンス オブジェクト全体を 考慮する必要があります本番環境では、次のようなレスポンスが返されます。 フィールド マスクで明示的に指定したフィールドのみを含めます。
詳しくは、返される情報を選択するをご覧ください。
著作権の表示について
検索結果をユーザーに表示するときは、次の著作権表示を含める必要があります。
Powered by Google, ©YEAR Google
例:
Powered by Google, ©2023 Google
ルート、区間、歩数について
Routes API から返されるレスポンスを確認する前に、 ルートを構成する構成要素を理解している必要があります
レスポンスには、次の各ルート コンポーネントに関する情報が含まれる場合があります。
経路: 出発地の地点から任意の地点までのルート全体 中間地点、目的地の地点です。経路は 1 つの経路と または複数の legs を含む。
区間: ルート上の 1 つのウェイポイントから、 あります各区間は 1 つ以上の独立したステップで構成されています。
ルートには、各ウェイポイントから次のウェイポイントまでの道の区間が 1 つずつ含まれています。 たとえば、ルートに出発地のウェイポイントが 1 つと、 1 つの区間が含まれます。各 出発地と目的地の後にルートに追加するウェイポイント API によって別の区間が追加されます。
API では、パススルー中間ウェイポイントの区間は追加されません。対象 たとえば、出発地のウェイポイント、通過地点、 中間地点があり、目的地の地点には、 地点を通過します。詳細 詳細情報については、以下をご覧ください。 通過地点を定義する。
ステップ: ルートの区間に沿った 1 つの手順。ステップは、 ルートの原子単位ですたとえば、1 つのステップが「メインで左折する」と示すことができます。 Street''.
回答の内容
JSON オブジェクト (API レスポンスを表す)には、次のトップレベル プロパティが含まれています。
routes
: 型の要素の配列 Route。routes
配列には、API から返されたルートごとに 1 つの要素が含まれます。 配列には最大 5 つの要素(デフォルト ルート、 環境に優しいルートと最大 3 つの代替ルートがあります。geocodingResults
: 型の要素の配列 GeocodingResults。 リクエストに含まれるすべての場所(出発地、目的地、中間) 「address string」または「Plus code」として指定した waypoint 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 配列を解読する
レスポンスには、各配列要素の型である routes
配列が含まれます。
Route。
各配列要素は出発地から目的地までのルート全体を表します。「
API は常に、デフォルト ルートと呼ばれる少なくとも 1 つのルートを返します。
追加のルートをリクエストできます。もし
環境に優しいルートの場合、配列には次の 2 つの要素を含めることができます。
デフォルトルートと環境に優しいルートの
両方が表示されますまたは、computeAlternativeRoutes
を以下に設定します。
リクエスト内の true
。レスポンスに最大 3 つの代替ルートを追加します。
配列内の各ルートは routeLabels
配列プロパティで識別されます。
値 | 説明 |
---|---|
DEFAULT_ROUTE |
デフォルト ルートを指定します。 |
FUEL_EFFICIENT |
環境に優しいルートを識別する。 |
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 つの指示に対応します。区間には常に
必要ありません。
steps
配列の各要素には navigationInstruction
が含まれます。
プロパティ、型
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
パラメータを使用して、 リクエストを サポートされている言語のリストの中から、 言語をご覧ください。Google はサポートされている 含まれているため、このリストがすべてを網羅しているとは限りません。指定した言語で名前を使用できない場合は、API で 最も近いものを選択します
指定した言語は、その言語が入力している検索結果にも API が返す選択と、返された順序。「 ジオコーダでは、次のように、言語によって略語の解釈が異なります。 道路の種類の略語、または道路の種類で有効な同義語 別の言語では作成できません。たとえば、utca と tér は ハンガリー語です
geocodingResults 配列について
リクエストに含まれるすべての場所(出発地、目的地、中間)
住所文字列またはプラスコードとして指定された場合、
API が、対応する場所を含む最も関連性の高い場所を見つけようとする
あります。各要素の
geocodingResults
配列に placeID
フィールドが含まれる
(場所 ID として地域を含む)と、場所を指定する type
フィールド
(street_address
、premise
、airport
など)。
geocodingResults
配列には次の 3 つのフィールドがあります。
origin
: 住所文字列または Plus Code として指定された場合、 出発地のプレイス ID。それ以外の場合、このフィールドはレスポンスから除外されます。destination
: 住所文字列または Plus Code として指定された場合。 目的地のプレイス ID。それ以外の場合、このフィールドは レスポンスが返されます。intermediates
: 中間のプレイス ID を含む配列 住所文字列または Plus Code として指定されたウェイポイント。「 地点 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」言語 指標があります。