Method: computeRoutes

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

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

たとえば、次のように指定します。

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

Google では、ワイルドカード(*)レスポンス フィールド マスクの使用、またはトップレベル(routes)でのフィールド マスクの指定をおすすめしません。理由は次のとおりです。

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

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)

(省略可)出発時刻。この値を設定しなかった場合、リクエストを行った時刻がデフォルトになります。注: RouteTravelModeTRANSIT に設定されている場合にのみ、過去の departureTime を指定できます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の解像度で小数点以下 9 桁まで指定できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

arrivalTime

string (Timestamp format)

(省略可)到着時刻。注: RouteTravelModeTRANSIT に設定されている場合にのみ設定できます。departureTime または arrivalTime のいずれかを指定できます。両方を指定することはできません。

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 言語コード。詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier を参照してください。サポートされている言語の一覧については、言語のサポートをご覧ください。この値を指定しない場合、ルート リクエストの位置から表示言語が推測されます。

regionCode

string

(省略可)地域コード。ccTLD(「トップレベル ドメイン」)の 2 文字の値で指定します。詳しくは、https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains をご覧ください。

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 参照ルートの計算では、最適な燃料効率ルートを生成するさまざまなパラメータが考慮されます。

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)

住所として指定された地点のジオコーディング レスポンス情報が含まれます。

ポリラインの質

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

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

ポリラインのエンコード

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

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

単位

ディスプレイで使用される測定単位を指定する値のセット。

列挙型
UNITS_UNSPECIFIED 測定単位が指定されていません。デフォルトは、リクエストから推定される測定単位です。
METRIC 指標の単位。
IMPERIAL ヤード・ポンド単位(英語)。

ReferenceRoute

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

列挙型
REFERENCE_ROUTE_UNSPECIFIED 使用されません。 この値を含むリクエストは失敗します。
FUEL_EFFICIENT 燃費効率が良いルートこの値のラベルが付いたルートは、燃料消費量などのパラメータ向けに最適化されていると判断されます。

外計算

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

列挙型
EXTRA_COMPUTATION_UNSPECIFIED 使用されません。 この値を含むリクエストは失敗します。
TOLLS ルートの料金情報。
FUEL_CONSUMPTION ルートの推定燃料消費量。
TRAFFIC_ON_POLYLINE ルートの交通状況を認識するポリライン
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS ナビゲーション手順は、書式設定された HTML テキスト文字列で表されます。このコンテンツはそのまま読み取られます。これは表示専用です。プログラムで解析しないでください。

経路

ルートには、一連の始点、終点、中間点を結ぶ一連の道路セグメントが含まれています。

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
}
フィールド
routeLabels[]

enum (RouteLabel)

Route のラベル。ルートの特定のプロパティを特定して他のプロパティと比較する際に便利です。

legs[]

object (RouteLeg)

経路を構成する区間(地点間の経路セグメント)のコレクション。各区間は、2 つの via 以外の Waypoints 間のルートに対応しています。たとえば、中間地点のないルートには 1 区間しかありません。via 以外の中間地点を含むルートには、2 つの区間があります。中間地点 via を 1 つ含むルートには区間が 1 つあります。区間の順序は、origin から intermediates から destination までの地点の順序と一致します。

distanceMeters

integer

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

duration

string (Duration format)

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

小数点以下 9 桁以下で指定し、末尾が「s」で終わる秒数。例: "3.5s"

staticDuration

string (Duration format)

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

小数点以下 9 桁以下で指定し、末尾が「s」で終わる秒数。例: "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 に渡せる、ウェブセーフな base64 でエンコードされたルートトークン。これにより、Navigation SDK がナビゲーション中にルートを再構成できます。再ルーティングが発生した場合は、v2.computeRoutes を呼び出してルートを作成するときに、元のインテントを尊重します。お客様はこのトークンを不透明な blob として扱う必要があります。読み取りまたは変更用ではありません。注: Route.route_token は、ComputeRoutesRequest.routing_preferenceTRAFFIC_AWARE または TRAFFIC_AWARE_OPTIMAL に設定されているリクエストでのみ使用できます。Route.route_token は、地点を使うリクエストではサポートされていません。

ルートラベル

Route のラベル。ルートの特定のプロパティを特定して他のプロパティと比較する際に便利です。

列挙型
ROUTE_LABEL_UNSPECIFIED デフォルト - 未使用
DEFAULT_ROUTE ルート計算で返されるデフォルトの「最適な」ルート。
DEFAULT_ROUTE_ALTERNATE デフォルトの「最適」ルートに代わるものです。computeAlternativeRoutes を指定すると、このようなルートが返されます。
FUEL_EFFICIENT 燃費効率が良いルートこの値のラベルが付いたルートは、燃料消費量などのエコ パラメータ向けに最適化されています。

ルートレッグ

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 の場合、この値は交通状況を考慮して計算されます。

小数点以下 9 桁以下で指定し、末尾が「s」で終わる秒数。例: "3.5s"

staticDuration

string (Duration format)

交通状況を考慮しない区間での移動時間。

小数点以下 9 桁以下で指定し、末尾が「s」で終わる秒数。例: "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 の手順の概要情報。このフィールドは TRANSIT ルートでのみ入力されます。

ポリライン

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

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_type は次のいずれかになります。
encodedPolyline

string

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

geoJsonLinestring

object (Struct format)

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

ルート区間

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)

交通状況を考慮しない状態でこのステップを通過する期間。状況によっては、このフィールドに値が表示されない場合があります。

小数点以下 9 桁以下で指定し、末尾が「s」で終わる秒数。例: "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 左に左折します。
TURN_LEFT 左折します。
TURN_SLIGHT_RIGHT 少し右に曲がります。
TURN_SHARP_RIGHT 右左折します。
UTURN_RIGHT 右左折します。
TURN_RIGHT 左折します。
STRAIGHT まっすぐ進みましょう。
RAMP_LEFT 左側を進んでください。
RAMP_RIGHT 適切なスロープを使用します。
MERGE トラフィックに統合する。
FORK_LEFT 左のフォーク。
FORK_RIGHT 正しくフォークしましょう。
FERRY フェリーを利用します。
FERRY_TRAIN 列車でフェリーに乗ります。
ROUNDABOUT_LEFT 環状交差点を左に曲がります。
ROUNDABOUT_RIGHT 環状交差点で右に曲がります。
DEPART 初回操作。
NAME_CHANGE 町名の変更を示すために使用されます。

ルート区間の運行情報

レッグステップでトラフィック ゾーンの制限など、ユーザーに通知する必要がある追加情報が含まれています。

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

object (SpeedReadingInterval)

注: 現在、このフィールドには入力されていません。

RouteLegStepLocalizedValue

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

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)

現時点で同じ駅または停留所からの出発間隔を予想時刻として指定します。たとえば、運転時隔の秒数が 600 の場合、バスを逃すと 10 分待つことになると予想されます。

小数点以下 9 桁以下で指定し、末尾が「s」で終わる秒数。例: "3.5s"

transitLine

object (TransitLine)

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

stopCount

integer

出発地から到着地までの経由地数。このカウントには出発停車地は含まれますが、出発停車地は含まれません。たとえば、停車地 A から出発して、停車地 B と C を通過し、停車地 D に到着するルートの場合、stopCount は 3 を返します。

tripShortText

string

乗客への乗換案内を識別するために、時刻表や掲示板に表示されるテキスト。テキストでは、運行日の特定のルートを一意に識別する必要があります。たとえば「538」は、平日の 15:10 にカリフォルニア州サンノゼを出発する、カリフォルニア州サクラメント行きのアムトラックの 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"

交通機関の停止

交通機関に関する情報。

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)

書式付きテキスト表現での、対応するタイムゾーンでの時刻。

ローカライズされた時刻

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

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

object (LocalizedText)

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

timeZone

string

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

路線

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

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

object (TransitAgency)

この路線を運営する交通機関。

name

string

この交通機関の路線の正式名称。例: 「東京都港区六本木 6 丁目 1 号線」。

uri

string

交通機関によって提供される、この路線の URI。

color

string

線の案内で一般的に使用される色。16 進数で表されます。

iconUri

string

この行に関連付けられたアイコンの URI。

nameShort

string

この路線の略称。この名前は通常、「M7」や「355」などの行番号になります。

textColor

string

この路線のサイネージで一般的に使用される色。16 進数で表されます。

vehicle

object (TransitVehicle)

この路線を運行する車両の種類。

交通機関

路線を運営する交通機関。

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

string

この交通機関の名前。

phoneNumber

string

交通機関のロケール固有の形式の電話番号。

uri

string

交通機関の URI。

車両

交通機関の車両で使用されている車両に関する情報。

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

object (LocalizedText)

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

type

enum (TransitVehicleType)

使用された車両のタイプ。

iconUri

string

この車両タイプに関連付けられたアイコンの URI。

localIconUri

string

地域の交通標識に基づく、この車両タイプに関連付けられたアイコンの URI。

交通機関の車両タイプ

交通機関の車両の種類。

列挙型
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 トロリーバス。

ルート区間の移動に関するアドバイス

トラフィック ゾーンの制限など、レッグステップでユーザーに通知する必要がある追加情報が含まれています。

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)

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

手順の概要

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

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

object (MultiModalSegment)

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

マルチモーダル セグメント

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, "経度": -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)

運賃はテキスト形式で表記されます。

ジオコーディングの結果

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

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

object (GeocodedWaypoint)

ジオコーディングされた出発地点。

destination

object (GeocodedWaypoint)

ジオコーディングされた地点。

intermediates[]

object (GeocodedWaypoint)

中間ジオコーディングの地点のリスト。それぞれに地点が 0 から始まる位置に対応するインデックス フィールド(リクエストで指定された順序)が含まれます。

ジオコーディングされた地点

地点として使用する場所についての詳細住所の地点にのみ入力されます。住所がジオコーディングされた地域を特定するためのジオコーディング結果の詳細が含まれます。

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

object (Status)

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

type[]

string

結果の型(ゼロ以上のタイプタグの形式)。サポートされているタイプ: https://developers.google.com/maps/documentation/Geocoding/requests-Geocoding#Types

partialMatch

boolean

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

placeId

string

この結果のプレイス ID。

intermediateWaypointRequestIndex

integer

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