Method: computeRoutes

ターミナルと中間ウェイポイントのセットを指定すると、プライマリ ルートとともに、オプションの代替ルートを返します。

注: このメソッドでは、入力にレスポンス フィールド マスクを指定する必要があります。レスポンス フィールド マスクは、URL パラメータ $fields または fields を使用するか、HTTP/gRPC ヘッダー X-Goog-FieldMask を使用して指定できます(使用可能な URL パラメータとヘッダーをご覧ください)。値は、フィールドパスのカンマ区切りのリストです。フィールドパスの作成方法に関する詳細なドキュメントをご覧ください。

たとえば、このメソッドでは次のようにします。

  • 使用可能なすべてのフィールドのフィールド マスク(手動検査用): X-Goog-FieldMask: *
  • ルートレベルの所要時間、距離、ポリラインのフィールド マスク(本番環境の設定例): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

ワイルドカード(*)レスポンス フィールド マスクを使用するか、最上位レベルでフィールド マスクを指定することはおすすめしません。理由は次のとおりです。routes

  • 必要なフィールドのみを選択すると、サーバーの計算サイクルを節約できるため、レイテンシを短縮して結果を返すことができます。
  • 本番環境ジョブで必要なフィールドのみを選択すると、レイテンシのパフォーマンスが安定します。今後、レスポンス フィールドが追加される可能性があります。追加されたフィールドによって計算時間が長くなる可能性があります。すべてのフィールドを選択した場合、または最上位レベルですべてのフィールドを選択した場合、追加された新しいフィールドがレスポンスに自動的に含まれるため、パフォーマンスが低下する可能性があります。
  • 必要なフィールドのみを選択すると、レスポンス サイズが小さくなり、ネットワーク スループットが向上します。

HTTP リクエスト

POST https://routes.googleapis.com/directions/v2:computeRoutes

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "arrivalTime": string,
  "computeAlternativeRoutes": boolean,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "languageCode": string,
  "regionCode": string,
  "units": enum (Units),
  "optimizeWaypointOrder": boolean,
  "requestedReferenceRoutes": [
    enum (ReferenceRoute)
  ],
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "trafficModel": enum (TrafficModel),
  "transitPreferences": {
    object (TransitPreferences)
  }
}
フィールド
origin

object (Waypoint)

必須。出発地のウェイポイント。

destination

object (Waypoint)

必須。目的地のウェイポイント。

intermediates[]

object (Waypoint)

省略可。ルート上のウェイポイントのセット(終点は除く)。停車地点または通過地点として指定できます。最大 25 個の中間地点がサポートされています。

travelMode

enum (RouteTravelMode)

省略可。移動手段を指定します。

routingPreference

enum (RoutingPreference)

省略可。ルートの計算方法を指定します。サーバーは、選択したルーティング設定を使用してルートを計算しようとします。ルーティング設定でエラーが発生した場合やレイテンシが長すぎる場合は、エラーが返されます。このオプションを指定できるのは、travelModeDRIVE または TWO_WHEELER の場合のみです。それ以外の場合は、リクエストが失敗します。

polylineQuality

enum (PolylineQuality)

省略可。ポリラインの品質に関する設定を指定します。

polylineEncoding

enum (PolylineEncoding)

省略可。ポリラインに使用するエンコードを指定します。

departureTime

string (Timestamp format)

省略可。出発時刻。この値を設定しない場合は、デフォルトでリクエストを行った時刻になります。注: 過去の departureTime を指定できるのは、RouteTravelModeTRANSIT に設定されている場合のみです。交通機関のルートについては、過去 7 日間または未来 100 日間まで利用できます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

arrivalTime

string (Timestamp format)

省略可。到着時刻。注: RouteTravelModeTRANSIT に設定されている場合にのみ設定できます。departureTime または arrivalTime のどちらか一方だけ指定できます。交通機関のルートについては、過去 7 日間または未来 100 日間まで利用できます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

computeAlternativeRoutes

boolean

省略可。ルートに加えて代替ルートを計算するかどうかを指定します。中間地点があるリクエストに対しては、代替ルートは返されません。

routeModifiers

object (RouteModifiers)

省略可。ルートの計算方法に影響する、満たす必要がある一連の条件。

languageCode

string

省略可。「en-US」や「sr-Latn」などの BCP-47 言語コード。詳しくは、Unicode ロケール識別子をご覧ください。サポートされている言語の一覧については、言語サポートをご覧ください。この値を指定しない場合、表示言語はルート リクエストのロケーションから推測されます。

regionCode

string

省略可。ccTLD(「トップレベル ドメイン」)の 2 文字の値として指定される地域コード。詳細については、国コード トップレベル ドメインをご覧ください。

units

enum (Units)

省略可。表示フィールドの測定単位を指定します。これらのフィールドには、NavigationInstructioninstruction フィールドが含まれます。ルート、区間、歩数の距離、所要時間に使用される計量単位は、この値の影響を受けません。この値を指定しない場合、表示単位は最初のオリジンの位置から推測されます。

optimizeWaypointOrder

boolean

省略可。true に設定すると、サービスは指定された中間ウェイポイントの順序を変更して、ルートの全体的な費用を最小限に抑えようとします。中間地点のいずれかが via 地点である場合、リクエストは失敗します。ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index を使用して新しい順序を探します。X-Goog-FieldMask ヘッダーで ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index がリクエストされていない場合、リクエストは失敗します。optimizeWaypointOrder が false に設定されている場合、ComputeRoutesResponse.optimized_intermediate_waypoint_index は空になります。

requestedReferenceRoutes[]

enum (ReferenceRoute)

省略可。デフォルトのルートに加えて、リクエストの一部として計算する参照ルートを指定します。参照ルートは、デフォルト ルートとは異なるルート計算目標を持つルートです。たとえば、FUEL_EFFICIENT 参照ルートの計算では、燃費が最適なルートを生成するさまざまなパラメータが考慮されます。この機能を使用する場合は、結果のルートで routeLabels を探します。

extraComputations[]

enum (ExtraComputation)

省略可。リクエストの完了に使用できる追加の計算のリスト。注: これらの追加計算により、レスポンスに追加のフィールドが返される場合があります。これらの追加フィールドは、レスポンスで返されるようにフィールドマスクで指定する必要があります。

trafficModel

enum (TrafficModel)

省略可。所要時間を計算する上での仮定条件を指定します。この設定に応じて、RouteRouteLeg の duration フィールドに返される値が変わります。この値は、過去の平均データに基づく予測所要時間となります。TrafficModel は、RoutingPreferenceTRAFFIC_AWARE_OPTIMAL に設定され、RouteTravelModeDRIVE に設定されているリクエストでのみ使用できます。トラフィックがリクエストされ、TrafficModel が指定されていない場合のデフォルトは BEST_GUESS です。

transitPreferences

object (TransitPreferences)

省略可。TRANSIT ルートで返されるルートに影響する設定を指定します。注: transitPreferences は、RouteTravelModeTRANSIT に設定されている場合にのみ指定できます。

レスポンスの本文

v2.computeRoutes はレスポンス メッセージを返します。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "routes": [
    {
      object (Route)
    }
  ],
  "fallbackInfo": {
    object (FallbackInfo)
  },
  "geocodingResults": {
    object (GeocodingResults)
  }
}
フィールド
routes[]

object (Route)

compute_alternatives_routes を指定すると、計算されたルートの配列(最大 3 つ)が含まれ、指定しない場合、1 つのルートのみ含まれます。この配列に複数のエントリが含まれている場合、最初のエントリが最も推奨されるルートです。配列が空の場合、ルートが見つからなかったことを意味します。

fallbackInfo

object (FallbackInfo)

サーバーがすべての入力設定でルート結果を計算できない場合、別の計算方法にフォールバックすることがあります。フォールバック モードが使用されている場合、このフィールドにはフォールバック レスポンスに関する詳細情報が含まれます。それ以外の場合、このフィールドは設定されません。

geocodingResults

object (GeocodingResults)

住所として指定されたウェイポイントのジオコーディング レスポンス情報。

PolylineQuality

ポリラインの品質を指定する値のセット。

列挙型
POLYLINE_QUALITY_UNSPECIFIED ポリラインの品質の設定が指定されていません。デフォルトは OVERVIEW です。
HIGH_QUALITY 高品質のポリーラインを指定します。OVERVIEW よりも多くのポイントを使用して構成されますが、レスポンス サイズが大きくなります。より高い精度が必要な場合に使用します。
OVERVIEW 少数のポイントを使用して構成される、ルート全体を示すポリラインを指定します。ルートの概要を表示する場合に使用します。このオプションを使用すると、HIGH_QUALITY オプションを使用する場合と比べてリクエスト レイテンシが低くなります。

PolylineEncoding

返されるポリラインの優先タイプを指定します。

列挙型
POLYLINE_ENCODING_UNSPECIFIED ポリライン タイプの設定が指定されていません。デフォルトは ENCODED_POLYLINE です。
ENCODED_POLYLINE ポリライン エンコード アルゴリズムを使用してエンコードされたポリラインを指定します。
GEO_JSON_LINESTRING GeoJSON LineString 形式を使用してポリラインを指定します。

ReferenceRoute

ComputeRoutesRequest でサポートされている参照ルート。

列挙型
REFERENCE_ROUTE_UNSPECIFIED 使用されません。この値を含むリクエストは失敗します。
FUEL_EFFICIENT 燃費効率の良いルート。
SHORTER_DISTANCE

移動距離が短いルート。この機能は試験運用中です。

DRIVE リクエストの場合、この機能は運転の快適性よりも短い距離を優先します。たとえば、高速道路ではなく一般道を優先したり、未舗装の道路を走行したり、駐車場を横切ったりする場合もあります。この機能では、Google マップが違法と認識している運転操作は返されません。

BICYCLE リクエストと TWO_WHEELER リクエストの場合、この機能は requestedReferenceRoutes を指定しない場合と同じルートを返します。

この機能は、他の移動手段、中間経由地点、optimizeWaypointOrder には対応していません。そのようなリクエストは失敗します。ただし、任意の routingPreference で使用できます。

ExtraComputation

リクエストの完了時に実行する追加の計算。

列挙型
EXTRA_COMPUTATION_UNSPECIFIED 使用されません。この値を含むリクエストは失敗します。
TOLLS ルートの通行料金情報。
FUEL_CONSUMPTION ルートの推定燃料消費量。
TRAFFIC_ON_POLYLINE ルートのトラフィック アウェア ポリライン。
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions: 書式設定された HTML テキスト文字列として表示されます。このコンテンツはそのまま読み取られます。このコンテンツは表示専用です。プログラムで解析しないでください。
FLYOVER_INFO_ON_POLYLINE ルートの飛行情報。この情報を返すには、routes.polyline_details.flyover_info フィールドマスクを指定する必要があります。現在、このデータはインドの一部の大都市でのみ入力されます。この機能は試験運用中であり、SKU や料金は変更される可能性があります。
NARROW_ROAD_INFO_ON_POLYLINE ルートの狭い道路に関する情報。この情報を返すには、routes.polyline_details.narrow_road_info フィールドマスクを指定する必要があります。現在、このデータはインドの一部の大都市でのみ入力されます。この機能は試験運用中であり、SKU や料金は変更される可能性があります。

ルート

ルートを含む。ルートは、始点、終点、中間地点をつなぐ一連の道路セグメントで構成されます。

JSON 表現
{
  "routeLabels": [
    enum (RouteLabel)
  ],
  "legs": [
    {
      object (RouteLeg)
    }
  ],
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "description": string,
  "warnings": [
    string
  ],
  "viewport": {
    object (Viewport)
  },
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  },
  "optimizedIntermediateWaypointIndex": [
    integer
  ],
  "localizedValues": {
    object (RouteLocalizedValues)
  },
  "routeToken": string,
  "polylineDetails": {
    object (PolylineDetails)
  }
}
フィールド
routeLabels[]

enum (RouteLabel)

Route のラベル。ルートの特定のプロパティを識別して他のものと比較するのに役立ちます。

legs[]

object (RouteLeg)

ルートを構成する区間(ウェイポイント間の経路セグメント)のコレクション。各区間は、2 つの via 以外の Waypoints 間の移動に対応しています。たとえば、中間地点のないルートには区間が 1 つだけあります。via 以外の中間地点が 1 つ含まれるルートには 2 つの区間があります。via 中間ウェイポイントが 1 つ含まれるルートには、1 つの区間があります。区間の順序は、originintermediatesdestination の順に地点の順序と一致します。

distanceMeters

integer

ルートの移動距離(メートル単位)。

duration

string (Duration format)

ルートを移動するのに必要な時間。routingPreferenceTRAFFIC_UNAWARE に設定すると、この値は staticDuration と同じになります。routingPreferenceTRAFFIC_AWARE または TRAFFIC_AWARE_OPTIMAL に設定すると、この値は交通状況を考慮して計算されます。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

staticDuration

string (Duration format)

交通状況を考慮しないルートの所要時間。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

polyline

object (Polyline)

全体的なルートのポリライン。このポリラインは、すべての legs を組み合わせたポリラインです。

description

string

ルートの説明。

warnings[]

string

ルートの表示時に表示する警告の配列。

viewport

object (Viewport)

ポリラインのビューポート境界ボックス。

travelAdvisory

object (RouteTravelAdvisory)

ルートに関する追加情報。

optimizedIntermediateWaypointIndex[]

integer

optimizeWaypointOrder を true に設定すると、このフィールドには中間ウェイポイントの最適化された順序が含まれます。それ以外の場合、このフィールドは空です。たとえば、出発地: LA、中間経由地: ダラス、バンゴー、フェニックス、目的地: ニューヨークと入力し、最適化された中間経由地の順序がフェニックス、ダラス、バンゴーの場合、このフィールドには [2, 0, 1] という値が含まれます。インプットで指定された最初の中間ウェイポイントのインデックスは 0 から始まります。

localizedValues

object (RouteLocalizedValues)

Route のプロパティのテキスト表現。

routeToken

string

Navigation SDK に渡してナビゲーション中にルートを再構築できる不透明なトークン。ルートの再ルーティングが発生した場合、ルートの作成時の元の意図が尊重されます。このトークンは不透明な blob として扱います。サービスがまったく同じルートを返しても値が変更される可能性があるため、リクエスト間で値を比較しないでください。

注: Route.route_token は、ComputeRoutesRequest.routing_preferenceTRAFFIC_AWARE または TRAFFIC_AWARE_OPTIMAL に設定されているリクエストでのみ使用できます。Route.route_token は、経由地点を含むリクエストではサポートされていません。

polylineDetails

object (PolylineDetails)

ポリラインに沿った詳細情報が含まれます。

RouteLabel

Route のラベル。ルートの特定のプロパティを識別して他のものと比較するのに役立ちます。

列挙型
ROUTE_LABEL_UNSPECIFIED デフォルト - 使用されません。
DEFAULT_ROUTE ルート計算で返されるデフォルトの「最適」ルート。
DEFAULT_ROUTE_ALTERNATE デフォルトの「最適」ルートの代替ルート。computeAlternativeRoutes が指定されている場合、このようなルートが返されます。
FUEL_EFFICIENT 燃費効率の良いルート。この値が設定されたルートは、燃料消費量などのエコ パラメータに最適化されていると判断されます。
SHORTER_DISTANCE 移動距離が短いルート。この機能は試験運用中です。

RouteLeg

via 以外のウェイポイントの間にセグメントが含まれています。

JSON 表現
{
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "steps": [
    {
      object (RouteLegStep)
    }
  ],
  "travelAdvisory": {
    object (RouteLegTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegLocalizedValues)
  },
  "stepsOverview": {
    object (StepsOverview)
  }
}
フィールド
distanceMeters

integer

ルート経路の移動距離(メートル単位)。

duration

string (Duration format)

経路を移動するのに必要な時間。route_preferenceTRAFFIC_UNAWARE に設定されている場合、この値は staticDuration と同じです。route_preferenceTRAFFIC_AWARE または TRAFFIC_AWARE_OPTIMAL の場合、この値は交通状況を考慮して計算されます。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

staticDuration

string (Duration format)

交通状況を考慮せずに計算された、区間の所要時間。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

polyline

object (Polyline)

この区間の全体的なポリライン。各 step のポリラインが含まれます。

startLocation

object (Location)

この区間の開始地点。この場所は、指定された origin とは異なる場合があります。たとえば、指定された origin が道路の近くにない場合、これは道路上の地点です。

endLocation

object (Location)

この区間の終点。この場所は、指定された destination とは異なる場合があります。たとえば、指定された destination が道路の近くにない場合、これは道路上の地点です。

steps[]

object (RouteLegStep)

このレグ内のセグメントを表すステップの配列。各ステップは 1 つのナビゲーション インストラクションを表します。

travelAdvisory

object (RouteLegTravelAdvisory)

ルート経路上の交通規制など、ユーザーに伝える必要がある追加情報を含めます。

localizedValues

object (RouteLegLocalizedValues)

RouteLeg のプロパティのテキスト表現。

stepsOverview

object (StepsOverview)

この RouteLeg の手順の概要情報。このフィールドは、乗換案内ルートの場合のみ入力されます。

ポリライン

エンコードされたポリラインをカプセル化します。

JSON 表現
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string,
  "geoJsonLinestring": {
    object
  }
  // End of list of possible types for union field polyline_type.
}
フィールド
共用体フィールド polyline_type。ポリラインのタイプをカプセル化します。デフォルトは encoded_polyline です。polyline_type は次のいずれかになります。
encodedPolyline

string

ポリライン エンコード アルゴリズムを使用したポリラインの文字列エンコード

geoJsonLinestring

object (Struct format)

GeoJSON LineString 形式を使用してポリラインを指定します。

RouteLegStep

RouteLeg のセグメントが含まれます。ステップは 1 つのナビゲーション指示に対応します。ルートの区間はステップで構成されます。

JSON 表現
{
  "distanceMeters": integer,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelAdvisory": {
    object (RouteLegStepTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegStepLocalizedValues)
  },
  "transitDetails": {
    object (RouteLegStepTransitDetails)
  },
  "travelMode": enum (RouteTravelMode)
}
フィールド
distanceMeters

integer

このステップの移動距離(メートル単位)。状況によっては、このフィールドに値が設定されていないことがあります。

staticDuration

string (Duration format)

このステップの所要時間(交通状況を考慮していない)。状況によっては、このフィールドに値が設定されていないことがあります。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

polyline

object (Polyline)

このステップに関連付けられたポリライン。

startLocation

object (Location)

このステップの開始地点。

endLocation

object (Location)

このステップの終了地点。

navigationInstruction

object (NavigationInstruction)

ナビの指示

travelAdvisory

object (RouteLegStepTravelAdvisory)

経路のステップで、ユーザーに伝える必要がある追加情報(交通制限区域の可能性など)が含まれます。

localizedValues

object (RouteLegStepLocalizedValues)

RouteLegStep のプロパティのテキスト表現。

transitDetails

object (RouteLegStepTransitDetails)

移動モードが TRANSIT の場合、このステップに関する詳細。

travelMode

enum (RouteTravelMode)

このステップで使用される移動手段。

Maneuver

現在のステップで行うナビゲーション アクション(左折、合流、直進など)を指定する値のセット。

列挙型
MANEUVER_UNSPECIFIED 使用されません。
TURN_SLIGHT_LEFT 少し左に曲がります。
TURN_SHARP_LEFT 急いで左折します。
UTURN_LEFT 左折して U ターンします。
TURN_LEFT 左折します。
TURN_SLIGHT_RIGHT 少し右に曲がる。
TURN_SHARP_RIGHT 右に急カーブする。
UTURN_RIGHT 右折 U ターンします。
TURN_RIGHT 右折します。
STRAIGHT まっすぐ進みます。
RAMP_LEFT 左側のランプを進みます。
RAMP_RIGHT 右側のランプを進みます。
MERGE 車線に加わる。
FORK_LEFT 左側の分岐を進みます。
FORK_RIGHT 右側の分岐を進みます。
FERRY フェリーに乗ります。
FERRY_TRAIN フェリーに乗り換える電車に乗ります。
ROUNDABOUT_LEFT ロータリー交差点を左折します。
ROUNDABOUT_RIGHT ロータリー交差点で右折します。
DEPART 最初の操作。
NAME_CHANGE 道路名の変更を示すために使用します。

RouteLegStepTravelAdvisory

ルートステップで発生する可能性のある交通制限ゾーンなど、ユーザーに伝える必要がある追加情報を含めます。

JSON 表現
{
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
フィールド
speedReadingIntervals[]

object (SpeedReadingInterval)

注: このフィールドは現在使用されていません。

RouteLegStepLocalizedValues

特定のプロパティのテキスト表現。

JSON 表現
{
  "distance": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
フィールド
distance

object (LocalizedText)

移動距離をテキスト形式で表します。

staticDuration

object (LocalizedText)

交通状況を考慮しない所要時間(テキスト形式)。

RouteLegStepTransitDetails

TRANSIT ルートに関連する RouteLegStep の追加情報。

JSON 表現
{
  "stopDetails": {
    object (TransitStopDetails)
  },
  "localizedValues": {
    object (TransitDetailsLocalizedValues)
  },
  "headsign": string,
  "headway": string,
  "transitLine": {
    object (TransitLine)
  },
  "stopCount": integer,
  "tripShortText": string
}
フィールド
stopDetails

object (TransitStopDetails)

ステップの到着停車地と出発停車地に関する情報。

localizedValues

object (TransitDetailsLocalizedValues)

RouteLegStepTransitDetails のプロパティのテキスト表現。

headsign

string

車両または出発駅に示されている、この路線を進む方向を指定します。多くの場合、この行先は終点に相当します。

headway

string (Duration format)

現時点で同じ停留所から出発するまでの予測時間を時間単位で指定します。たとえば、headway 秒の値が 600 の場合、バスを逃すと 10 分待つことになると予想されます。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

transitLine

object (TransitLine)

このステップで使用される交通機関の路線に関する情報。

stopCount

integer

出発地から到着地までの停留所の数。この数には到着地点の駅や停留所は含まれますが、出発地点の駅や停留所は含まれません。たとえば、A 駅を出発して、B 駅と C 駅を通り、D 駅に到着するルートの場合、

stopCount

3 を返します。

tripShortText

string

乗客が交通機関のルートを識別できるよう、時刻表と行先表示に表示されるテキスト。テキストは、運行日の特定の旅程を一意に識別できるような値にする必要があります。たとえば、「538」は、平日の 15 時 10 分にカリフォルニア州サンノゼを出発し、カリフォルニア州サクラメントに向かう Amtrak 列車の tripShortText です。

TransitStopDetails

RouteLegStep の交通機関の停留所に関する詳細。

JSON 表現
{
  "arrivalStop": {
    object (TransitStop)
  },
  "arrivalTime": string,
  "departureStop": {
    object (TransitStop)
  },
  "departureTime": string
}
フィールド
arrivalStop

object (TransitStop)

ステップの到着停留所に関する情報。

arrivalTime

string (Timestamp format)

ステップの予定到着時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

departureStop

object (TransitStop)

ステップの出発停留所に関する情報。

departureTime

string (Timestamp format)

ステップの出発予定時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

TransitStop

交通機関の停留所に関する情報。

JSON 表現
{
  "name": string,
  "location": {
    object (Location)
  }
}
フィールド
name

string

交通機関の停留所の名前。

location

object (Location)

停留所の位置(緯度と経度の座標で表した値)。

TransitDetailsLocalizedValues

RouteTransitDetails の値のローカライズされた説明。

JSON 表現
{
  "arrivalTime": {
    object (LocalizedTime)
  },
  "departureTime": {
    object (LocalizedTime)
  }
}
フィールド
arrivalTime

object (LocalizedTime)

時刻のテキスト表現(対応するタイムゾーンを含む)。

departureTime

object (LocalizedTime)

時刻のテキスト表現(対応するタイムゾーンを含む)。

LocalizedTime

時間のローカライズされた説明。

JSON 表現
{
  "time": {
    object (LocalizedText)
  },
  "timeZone": string
}
フィールド
time

object (LocalizedText)

特定のタイムゾーンで文字列として指定された時刻。

timeZone

string

タイムゾーンが含まれます。この値は、IANA タイムゾーン データベースで定義されたタイムゾーンの名前です(例: America/New_York)。

TransitLine

このステップで使用される交通機関の路線に関する情報が含まれます。

JSON 表現
{
  "agencies": [
    {
      object (TransitAgency)
    }
  ],
  "name": string,
  "uri": string,
  "color": string,
  "iconUri": string,
  "nameShort": string,
  "textColor": string,
  "vehicle": {
    object (TransitVehicle)
  }
}
フィールド
agencies[]

object (TransitAgency)

この交通機関の路線を運行している交通機関(または交通機関)。

name

string

この交通機関の路線の正式名称(例: 「8 Avenue Local」)。

uri

string

交通機関が提供するこの交通機関の路線の URI。

color

string

この路線の標識に一般的に使用される色。16 進数で表されます。

iconUri

string

この路線と関連付けられたアイコンの URI。

nameShort

string

この交通機関の路線の略称。この名前は通常、路線番号(「M7」や「355」など)です。

textColor

string

この路線の標識のテキストに一般的に使用される色。16 進数で表されます。

vehicle

object (TransitVehicle)

この交通機関の路線で運行されている乗り物の種別。

TransitAgency

交通機関の路線を運行している交通機関。

JSON 表現
{
  "name": string,
  "phoneNumber": string,
  "uri": string
}
フィールド
name

string

この交通機関の名前。

phoneNumber

string

交通機関の地域固有の形式の電話番号。

uri

string

交通機関の URI。

TransitVehicle

交通機関のルートで使用される車両に関する情報。

JSON 表現
{
  "name": {
    object (LocalizedText)
  },
  "type": enum (TransitVehicleType),
  "iconUri": string,
  "localIconUri": string
}
フィールド
name

object (LocalizedText)

この車両の名前(大文字)。

type

enum (TransitVehicleType)

使用する車両のタイプ。

iconUri

string

この乗り物の種別に関連付けられたアイコンの URI。

localIconUri

string

地域の交通標識に基づき、乗り物の種別に関連付けられたアイコンの URI。

TransitVehicleType

交通機関のルートの車両の種類。

列挙型
TRANSIT_VEHICLE_TYPE_UNSPECIFIED 未使用。
BUS バス。
CABLE_CAR ケーブルによって、通常は地上を走る車両。空中ケーブルカーは、タイプ GONDOLA_LIFT に入ることもあります。
COMMUTER_TRAIN 通勤列車。
FERRY フェリー。
FUNICULAR 険しい斜面をケーブルで引っ張る乗り物。ケーブルカーは一般的に 2 両編成で、車両は互いに重量のバランスを取ります。
GONDOLA_LIFT 空中ケーブルカー。
HEAVY_RAIL ヘビーレール。
HIGH_SPEED_TRAIN 高速列車。
INTERCITY_BUS 長距離バス。
LONG_DISTANCE_TRAIN 長距離列車。
METRO_RAIL ライトレール トランジット。
MONORAIL モノレール。
OTHER その他のすべての車両。
RAIL 鉄道。
SHARE_TAXI 乗合タクシーは、ルート上のどこでも乗客が乗り降りできるバスの一種です。
SUBWAY 地下を走るライトレール。
TRAM 地上を走るライトレール。
TROLLEYBUS トロリーバス。

RouteLegTravelAdvisory

ルートステップでユーザーに伝える必要がある追加情報(交通制限ゾーンの可能性など)が含まれます。

JSON 表現
{
  "tollInfo": {
    object (TollInfo)
  },
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
フィールド
tollInfo

object (TollInfo)

特定の RouteLeg の通行料に関する情報が含まれています。このフィールドは、RouteLeg に通行料が予想される場合にのみ入力されます。このフィールドが設定されていても、estimatedPrice サブフィールドに値が設定されていない場合、道路に通行料が含まれているものの、通行料の推定額は不明です。このフィールドが存在しない場合、RouteLeg には通行料はかかりません。

speedReadingIntervals[]

object (SpeedReadingInterval)

交通量の詳細を示す速度制限区間。TRAFFIC_AWARETRAFFIC_AWARE_OPTIMAL のルーティング設定の場合に適用されます。区間は、重複することなく RouteLeg のポリライン全体をカバーします。指定された区間の開始ポイントは、前の区間の終了ポイントと同じです。

例:

polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speedReadingIntervals: [A,C), [C,D), [D,G).

RouteLegLocalizedValues

特定のプロパティのテキスト表現。

JSON 表現
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
フィールド
distance

object (LocalizedText)

移動距離をテキスト形式で表します。

duration

object (LocalizedText)

テキスト形式で表され、クエリの地域にローカライズされた所要時間。交通状況を考慮します。注: 交通情報をリクエストしなかった場合、この値は staticDuration と同じ値になります。

staticDuration

object (LocalizedText)

交通状況を考慮しない所要時間(テキスト形式)。

StepsOverview

RouteLegStep のリストに関する概要情報を提供します。

JSON 表現
{
  "multiModalSegments": [
    {
      object (MultiModalSegment)
    }
  ]
}
フィールド
multiModalSegments[]

object (MultiModalSegment)

RouteLeg.steps のさまざまなマルチモーダル セグメントに関する概要情報。RouteLeg のステップにマルチモーダル セグメントが含まれていない場合、このフィールドには値が設定されません。

MultiModalSegment

RouteLeg.steps のさまざまなマルチモーダル セグメントに関する概要情報を提供します。マルチモーダル セグメントは、同じ RouteTravelMode を持つ連続する 1 つ以上の RouteLegStep として定義されます。RouteLeg のステップにマルチモーダル セグメントが含まれていない場合、このフィールドには値が設定されません。

JSON 表現
{
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelMode": enum (RouteTravelMode),
  "stepStartIndex": integer,
  "stepEndIndex": integer
}
フィールド
navigationInstruction

object (NavigationInstruction)

マルチモーダル セグメントの NavigationInstruction。

travelMode

enum (RouteTravelMode)

マルチモーダル セグメントの移動手段。

stepStartIndex

integer

マルチモーダル セグメントの開始点である対応する RouteLegStep インデックス。

stepEndIndex

integer

マルチモーダル セグメントの終了点である対応する RouteLegStep インデックス。

ビューポート

緯度と経度のビューポート。対角線上の 2 つの low ポイントと high ポイントで表されます。ビューポートは閉じた領域と見なされます。つまり、境界が含まれます。緯度の範囲は -90 ~ 90 度、経度の範囲は -180 ~ 180 度の範囲で指定してください。さまざまなケースには次のようなものがあります。

  • low = high の場合、ビューポートは単一のポイントで構成されます。

  • low.longitude > high.longitude の場合、経度の範囲が反転します(ビューポートが経度 180 度線を越えます)。

  • low.longitude = -180 度、high.longitude = 180 度の場合、ビューポートにはすべての経度が含まれます。

  • low.longitude = 180 度、high.longitude = -180 度の場合、経度の範囲は空になります。

  • low.latitude > high.latitude の場合、緯度範囲は空になります。

lowhigh の両方に値を入力する必要があります。また、(上記の定義で指定されているように)ボックスは空にできません。ビューポートが空の場合、エラーが発生します。

たとえば、このビューポートはニューヨーク市を完全に囲んでいます。

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

JSON 表現
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
フィールド
low

object (LatLng)

必須。ビューポートの低い部分。

high

object (LatLng)

必須。ビューポートの高さ。

RouteLocalizedValues

特定のプロパティのテキスト表現。

JSON 表現
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  },
  "transitFare": {
    object (LocalizedText)
  }
}
フィールド
distance

object (LocalizedText)

移動距離をテキスト形式で表します。

duration

object (LocalizedText)

テキスト形式で表され、クエリの地域にローカライズされた所要時間。交通状況を考慮します。注: 交通情報をリクエストしなかった場合、この値は staticDuration と同じ値になります。

staticDuration

object (LocalizedText)

交通状況を考慮しない所要時間(テキスト形式)。

transitFare

object (LocalizedText)

交通機関の運賃をテキスト形式で表します。

PolylineDetails

ポリラインの特定のインデックスまたは連続するセグメントに対応する詳細。ポイント P_0、P_1、...、P_N(ゼロベースのインデックス)を持つポリラインの場合、PolylineDetails は区間と関連メタデータを定義します。

JSON 表現
{
  "flyoverInfo": [
    {
      object (FlyoverInfo)
    }
  ],
  "narrowRoadInfo": [
    {
      object (NarrowRoadInfo)
    }
  ]
}
フィールド
flyoverInfo[]

object (FlyoverInfo)

ポリラインに沿ったストリートビューの詳細。

narrowRoadInfo[]

object (NarrowRoadInfo)

ポリラインに沿った狭い道路の詳細。

FlyoverInfo

ポリラインに沿ったフライオーバーに関する情報をカプセル化します。

JSON 表現
{
  "flyoverPresence": enum (RoadFeatureState),
  "polylinePointIndex": {
    object (PolylinePointIndex)
  }
}
フィールド
flyoverPresence

enum (RoadFeatureState)

出力専用。ポリラインの特定の区間にフライオーバーが存在するかどうかを示します。

polylinePointIndex

object (PolylinePointIndex)

ポリラインに沿った、ストリートビュー関連情報の場所。

RoadFeatureState

ポリラインの区間に沿った道路対象物の状態をカプセル化します。

列挙型
ROAD_FEATURE_STATE_UNSPECIFIED 道路対象物の状態が計算されませんでした(デフォルト値)。
EXISTS 道路の対象物が存在する。
DOES_NOT_EXIST 道路の対象物が存在しません。

PolylinePointIndex

ポリラインの詳細の開始インデックスと終了インデックスをカプセル化します。データが単一のポイントに対応している場合、startIndexendIndex は同じになります。

JSON 表現
{
  "startIndex": integer,
  "endIndex": integer
}
フィールド
startIndex

integer

ポリライン内のこの詳細の開始インデックス。

endIndex

integer

ポリライン内のこの詳細の終了インデックス。

NarrowRoadInfo

ポリラインに沿った狭い道路に関する情報をカプセル化します。

JSON 表現
{
  "narrowRoadPresence": enum (RoadFeatureState),
  "polylinePointIndex": {
    object (PolylinePointIndex)
  }
}
フィールド
narrowRoadPresence

enum (RoadFeatureState)

出力専用。ポリラインの特定の区間に狭い道路が存在するかどうかを示します。

polylinePointIndex

object (PolylinePointIndex)

ポリラインに沿った狭い道路に関する情報の位置。

GeocodingResults

出発地、目的地、中間地点の GeocodedWaypoints が含まれます。住所のウェイポイントにのみ入力されます。

JSON 表現
{
  "origin": {
    object (GeocodedWaypoint)
  },
  "destination": {
    object (GeocodedWaypoint)
  },
  "intermediates": [
    {
      object (GeocodedWaypoint)
    }
  ]
}
フィールド
origin

object (GeocodedWaypoint)

出発地のジオコーディングされたウェイポイント。

destination

object (GeocodedWaypoint)

目的地のジオコーディングされたウェイポイント。

intermediates[]

object (GeocodedWaypoint)

中間ジオコーディングされたウェイポイントのリスト。各ウェイポイントには、リクエストで指定された順序のウェイポイントのゼロベースの位置に対応するインデックス フィールドが含まれています。

GeocodedWaypoint

ウェイポイントとして使用された場所の詳細。住所のウェイポイントにのみ入力されます。住所がジオコーディングされた場所を特定するために、ジオコーディングの結果の詳細が含まれます。

JSON 表現
{
  "geocoderStatus": {
    object (Status)
  },
  "type": [
    string
  ],
  "partialMatch": boolean,
  "placeId": string,
  "intermediateWaypointRequestIndex": integer
}
フィールド
geocoderStatus

object (Status)

ジオコーディングの処理結果を示すステータス コードです。

type[]

string

結果のタイプ(0 個以上のタイプタグの形式)。サポートされているタイプ: 住所のタイプと住所コンポーネントのタイプ

partialMatch

boolean

ジオコーダによって、元のリクエストに完全一致する住所は見つからなかったものの、部分一致する住所は見つかったことを示します。元のリクエストで住所の表記が間違っていたり、不完全である可能性があります。

placeId

string

この結果のプレイス ID。

intermediateWaypointRequestIndex

integer

リクエスト内の対応する中間ウェイポイントのインデックス。対応するウェイポイントが中間ウェイポイントの場合にのみ入力されます。