Index
Routes
(interface)ComputeRouteMatrixRequest
(message)ComputeRouteMatrixRequest.ExtraComputation
(enum)ComputeRoutesRequest
(message)ComputeRoutesRequest.ExtraComputation
(enum)ComputeRoutesRequest.ReferenceRoute
(enum)ComputeRoutesResponse
(message)FallbackInfo
(message)FallbackReason
(enum)FallbackRoutingMode
(enum)GeocodedWaypoint
(message)GeocodingResults
(message)LocalizedTime
(message)Location
(message)Maneuver
(enum)NavigationInstruction
(message)Polyline
(message)PolylineEncoding
(enum)PolylineQuality
(enum)Route
(message)Route.RouteLocalizedValues
(message)RouteLabel
(enum)RouteLeg
(message)RouteLeg.RouteLegLocalizedValues
(message)RouteLeg.StepsOverview
(message)RouteLeg.StepsOverview.MultiModalSegment
(message)RouteLegStep
(message)RouteLegStep.RouteLegStepLocalizedValues
(message)RouteLegStepTransitDetails
(message)RouteLegStepTransitDetails.TransitDetailsLocalizedValues
(message)RouteLegStepTransitDetails.TransitStopDetails
(message)RouteLegStepTravelAdvisory
(message)RouteLegTravelAdvisory
(message)RouteMatrixDestination
(message)RouteMatrixElement
(message)RouteMatrixElement.LocalizedValues
(message)RouteMatrixElementCondition
(enum)RouteMatrixOrigin
(message)RouteModifiers
(message)RouteTravelAdvisory
(message)RouteTravelMode
(enum)RoutingPreference
(enum)SpeedReadingInterval
(message)SpeedReadingInterval.Speed
(enum)TollInfo
(message)TollPass
(enum)TrafficModel
(enum)TransitAgency
(message)TransitLine
(message)TransitPreferences
(message)TransitPreferences.TransitRoutingPreference
(enum)TransitPreferences.TransitTravelMode
(enum)TransitStop
(message)TransitVehicle
(message)TransitVehicle.TransitVehicleType
(enum)Units
(enum)VehicleEmissionType
(enum)VehicleInfo
(message)Waypoint
(message)
Routes
The Routes API.
ComputeRouteMatrix |
---|
Takes in a list of origins and destinations and returns a stream containing route information for each combination of origin and destination. NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using the URL parameter For example, in this method:
It is critical that you include
|
ComputeRoutes |
---|
Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints. NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using URL parameter For example, in this method:
Google discourage the use of the wildcard (
|
ComputeRouteMatrixRequest
ComputeRouteMatrix request message
Fields | |
---|---|
origins[] |
Required. Array of origins, which determines the rows of the response matrix. Several size restrictions apply to the cardinality of origins and destinations:
|
destinations[] |
Required. Array of destinations, which determines the columns of the response matrix. |
travel_ |
Optional. Specifies the mode of transportation. |
routing_ |
Optional. Specifies how to compute the route. The server attempts to use the selected routing preference to compute the route. If the routing preference results in an error or an extra long latency, an error is returned. You can specify this option only when the |
departure_ |
Optional. The departure time. If you don't set this value, then this value defaults to the time that you made the request. NOTE: You can only specify a |
arrival_ |
Optional. The arrival time. NOTE: Can only be set when |
language_ |
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Unicode Locale Identifier. See Language Support for the list of supported languages. When you don't provide this value, the display language is inferred from the location of the first origin. |
region_ |
Optional. The region code, specified as a ccTLD ("top-level domain") two-character value. For more information see Country code top-level domains. |
units |
Optional. Specifies the units of measure for the display fields. |
extra_ |
Optional. A list of extra computations which may be used to complete the request. Note: These extra computations may return extra fields on the response. These extra fields must also be specified in the field mask to be returned in the response. |
traffic_ |
Optional. Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the |
transit_ |
Optional. Specifies preferences that influence the route returned for |
ExtraComputation
Extra computations to perform while completing the request.
Enums | |
---|---|
EXTRA_COMPUTATION_UNSPECIFIED |
Not used. Requests containing this value will fail. |
TOLLS |
Toll information for the matrix element(s). |
ComputeRoutesRequest
ComputeRoutes request message.
Fields | |
---|---|
origin |
Required. Origin waypoint. |
destination |
Required. Destination waypoint. |
intermediates[] |
Optional. A set of waypoints along the route (excluding terminal points), for either stopping at or passing by. Up to 25 intermediate waypoints are supported. |
travel_ |
Optional. Specifies the mode of transportation. |
routing_ |
Optional. Specifies how to compute the route. The server attempts to use the selected routing preference to compute the route. If the routing preference results in an error or an extra long latency, then an error is returned. You can specify this option only when the |
polyline_ |
Optional. Specifies your preference for the quality of the polyline. |
polyline_ |
Optional. Specifies the preferred encoding for the polyline. |
departure_ |
Optional. The departure time. If you don't set this value, then this value defaults to the time that you made the request. NOTE: You can only specify a |
arrival_ |
Optional. The arrival time. NOTE: Can only be set when |
compute_ |
Optional. Specifies whether to calculate alternate routes in addition to the route. No alternative routes are returned for requests that have intermediate waypoints. |
route_ |
Optional. A set of conditions to satisfy that affect the way routes are calculated. |
language_ |
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Unicode Locale Identifier. See Language Support for the list of supported languages. When you don't provide this value, the display language is inferred from the location of the route request. |
region_ |
Optional. The region code, specified as a ccTLD ("top-level domain") two-character value. For more information see Country code top-level domains. |
units |
Optional. Specifies the units of measure for the display fields. These fields include the |
optimize_ |
Optional. If set to true, the service attempts to minimize the overall cost of the route by re-ordering the specified intermediate waypoints. The request fails if any of the intermediate waypoints is a |
requested_ |
Optional. Specifies what reference routes to calculate as part of the request in addition to the default route. A reference route is a route with a different route calculation objective than the default route. For example a |
extra_ |
Optional. A list of extra computations which may be used to complete the request. Note: These extra computations may return extra fields on the response. These extra fields must also be specified in the field mask to be returned in the response. |
traffic_ |
Optional. Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the |
transit_ |
Optional. Specifies preferences that influence the route returned for |
ExtraComputation
Extra computations to perform while completing the request.
Enums | |
---|---|
EXTRA_COMPUTATION_UNSPECIFIED |
Not used. Requests containing this value will fail. |
TOLLS |
Toll information for the route(s). |
FUEL_CONSUMPTION |
Estimated fuel consumption for the route(s). |
TRAFFIC_ON_POLYLINE |
Traffic aware polylines for the route(s). |
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS |
NavigationInstructions presented as a formatted HTML text string. This content is meant to be read as-is. This content is for display only. Do not programmatically parse it. |
ReferenceRoute
A supported reference route on the ComputeRoutesRequest.
Enums | |
---|---|
REFERENCE_ROUTE_UNSPECIFIED |
Not used. Requests containing this value fail. |
FUEL_EFFICIENT |
Fuel efficient route. |
SHORTER_DISTANCE |
Route with shorter travel distance. This is an experimental feature. For For This feature is not compatible with any other travel modes, via intermediate waypoints, or |
ComputeRoutesResponse
ComputeRoutes the response message.
Fields | |
---|---|
routes[] |
Contains an array of computed routes (up to three) when you specify |
fallback_ |
In some cases when the server is not able to compute the route results with all of the input preferences, it may fallback to using a different way of computation. When fallback mode is used, this field contains detailed info about the fallback response. Otherwise this field is unset. |
geocoding_ |
Contains geocoding response info for waypoints specified as addresses. |
FallbackInfo
Information related to how and why a fallback result was used. If this field is set, then it means the server used a different routing mode from your preferred mode as fallback.
Fields | |
---|---|
routing_ |
Routing mode used for the response. If fallback was triggered, the mode may be different from routing preference set in the original client request. |
reason |
The reason why fallback response was used instead of the original response. This field is only populated when the fallback mode is triggered and the fallback response is returned. |
FallbackReason
Reasons for using fallback response.
Enums | |
---|---|
FALLBACK_REASON_UNSPECIFIED |
No fallback reason specified. |
SERVER_ERROR |
A server error happened while calculating routes with your preferred routing mode, but we were able to return a result calculated by an alternative mode. |
LATENCY_EXCEEDED |
We were not able to finish the calculation with your preferred routing mode on time, but we were able to return a result calculated by an alternative mode. |
FallbackRoutingMode
Actual routing mode used for returned fallback response.
Enums | |
---|---|
FALLBACK_ROUTING_MODE_UNSPECIFIED |
Not used. |
FALLBACK_TRAFFIC_UNAWARE |
Indicates the TRAFFIC_UNAWARE was used to compute the response. |
FALLBACK_TRAFFIC_AWARE |
Indicates the TRAFFIC_AWARE was used to compute the response. |
GeocodedWaypoint
Details about the locations used as waypoints. Only populated for address waypoints. Includes details about the geocoding results for the purposes of determining what the address was geocoded to.
Fields | |
---|---|
geocoder_ |
Indicates the status code resulting from the geocoding operation. |
type[] |
The type(s) of the result, in the form of zero or more type tags. Supported types: Address types and address component types. |
partial_ |
Indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address. You may wish to examine the original request for misspellings and/or an incomplete address. |
place_ |
The place ID for this result. |
intermediate_ |
The index of the corresponding intermediate waypoint in the request. Only populated if the corresponding waypoint is an intermediate waypoint. |
GeocodingResults
Contains
for origin, destination and intermediate waypoints. Only populated for address waypoints.GeocodedWaypoints
Fields | |
---|---|
origin |
Origin geocoded waypoint. |
destination |
Destination geocoded waypoint. |
intermediates[] |
A list of intermediate geocoded waypoints each containing an index field that corresponds to the zero-based position of the waypoint in the order they were specified in the request. |
LocalizedTime
Localized description of time.
Fields | |
---|---|
time |
The time specified as a string in a given time zone. |
time_ |
Contains the time zone. The value is the name of the time zone as defined in the IANA Time Zone Database, e.g. "America/New_York". |
Location
Encapsulates a location (a geographic point, and an optional heading).
Fields | |
---|---|
lat_ |
The waypoint's geographic coordinates. |
heading |
The compass heading associated with the direction of the flow of traffic. This value specifies the side of the road for pickup and drop-off. Heading values can be from 0 to 360, where 0 specifies a heading of due North, 90 specifies a heading of due East, and so on. You can use this field only for |
Maneuver
A set of values that specify the navigation action to take for the current step (for example, turn left, merge, or straight).
Enums | |
---|---|
MANEUVER_UNSPECIFIED |
Not used. |
TURN_SLIGHT_LEFT |
Turn slightly to the left. |
TURN_SHARP_LEFT |
Turn sharply to the left. |
UTURN_LEFT |
Make a left u-turn. |
TURN_LEFT |
Turn left. |
TURN_SLIGHT_RIGHT |
Turn slightly to the right. |
TURN_SHARP_RIGHT |
Turn sharply to the right. |
UTURN_RIGHT |
Make a right u-turn. |
TURN_RIGHT |
Turn right. |
STRAIGHT |
Go straight. |
RAMP_LEFT |
Take the left ramp. |
RAMP_RIGHT |
Take the right ramp. |
MERGE |
Merge into traffic. |
FORK_LEFT |
Take the left fork. |
FORK_RIGHT |
Take the right fork. |
FERRY |
Take the ferry. |
FERRY_TRAIN |
Take the train leading onto the ferry. |
ROUNDABOUT_LEFT |
Turn left at the roundabout. |
ROUNDABOUT_RIGHT |
Turn right at the roundabout. |
DEPART |
Initial maneuver. |
NAME_CHANGE |
Used to indicate a street name change. |
Polyline
Encapsulates an encoded polyline.
Fields | |
---|---|
Union field polyline_type . Encapsulates the type of polyline. Defaults to encoded_polyline. polyline_type can be only one of the following: |
|
encoded_ |
The string encoding of the polyline using the polyline encoding algorithm |
geo_ |
Specifies a polyline using the GeoJSON LineString format. |
PolylineEncoding
Specifies the preferred type of polyline to be returned.
Enums | |
---|---|
POLYLINE_ENCODING_UNSPECIFIED |
No polyline type preference specified. Defaults to ENCODED_POLYLINE . |
ENCODED_POLYLINE |
Specifies a polyline encoded using the polyline encoding algorithm. |
GEO_JSON_LINESTRING |
Specifies a polyline using the GeoJSON LineString format |
PolylineQuality
A set of values that specify the quality of the polyline.
Enums | |
---|---|
POLYLINE_QUALITY_UNSPECIFIED |
No polyline quality preference specified. Defaults to OVERVIEW . |
HIGH_QUALITY |
Specifies a high-quality polyline - which is composed using more points than OVERVIEW , at the cost of increased response size. Use this value when you need more precision. |
OVERVIEW |
Specifies an overview polyline - which is composed using a small number of points. Use this value when displaying an overview of the route. Using this option has a lower request latency compared to using the HIGH_QUALITY option. |
Route
Contains a route, which consists of a series of connected road segments that join beginning, ending, and intermediate waypoints.
Fields | |
---|---|
route_ |
Labels for the |
legs[] |
A collection of legs (path segments between waypoints) that make up the route. Each leg corresponds to the trip between two non- |
distance_ |
The travel distance of the route, in meters. |
duration |
The length of time needed to navigate the route. If you set the |
static_ |
The duration of travel through the route without taking traffic conditions into consideration. |
polyline |
The overall route polyline. This polyline is the combined polyline of all |
description |
A description of the route. |
warnings[] |
An array of warnings to show when displaying the route. |
viewport |
The viewport bounding box of the polyline. |
travel_ |
Additional information about the route. |
optimized_ |
If you set |
localized_ |
Text representations of properties of the |
route_ |
An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route. NOTE: |
RouteLocalizedValues
Text representations of certain properties.
Fields | |
---|---|
distance |
Travel distance represented in text form. |
duration |
Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as |
static_ |
Duration without taking traffic conditions into consideration, represented in text form. |
transit_ |
Transit fare represented in text form. |
RouteLabel
Labels for the
that are useful to identify specific properties of the route to compare against others.Route
Enums | |
---|---|
ROUTE_LABEL_UNSPECIFIED |
Default - not used. |
DEFAULT_ROUTE |
The default "best" route returned for the route computation. |
DEFAULT_ROUTE_ALTERNATE |
An alternative to the default "best" route. Routes like this will be returned when is specified. |
FUEL_EFFICIENT |
Fuel efficient route. Routes labeled with this value are determined to be optimized for Eco parameters such as fuel consumption. |
SHORTER_DISTANCE |
Shorter travel distance route. This is an experimental feature. |
RouteLeg
Contains a segment between non-via
waypoints.
Fields | |
---|---|
distance_ |
The travel distance of the route leg, in meters. |
duration |
The length of time needed to navigate the leg. If the |
static_ |
The duration of travel through the leg, calculated without taking traffic conditions into consideration. |
polyline |
The overall polyline for this leg that includes each |
start_ |
The start location of this leg. This location might be different from the provided |
end_ |
The end location of this leg. This location might be different from the provided |
steps[] |
An array of steps denoting segments within this leg. Each step represents one navigation instruction. |
travel_ |
Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a route leg. |
localized_ |
Text representations of properties of the |
steps_ |
Overview information about the steps in this |
RouteLegLocalizedValues
Text representations of certain properties.
Fields | |
---|---|
distance |
Travel distance represented in text form. |
duration |
Duration, represented in text form and localized to the region of the query. Takes traffic conditions into consideration. Note: If you did not request traffic information, this value is the same value as static_duration. |
static_ |
Duration without taking traffic conditions into consideration, represented in text form. |
StepsOverview
Provides overview information about a list of RouteLegStep
s.
Fields | |
---|---|
multi_ |
Summarized information about different multi-modal segments of the |
MultiModalSegment
Provides summarized information about different multi-modal segments of the RouteLeg.steps
. A multi-modal segment is defined as one or more contiguous RouteLegStep
that have the same RouteTravelMode
. This field is not populated if the RouteLeg
does not contain any multi-modal segments in the steps.
Fields | |
---|---|
navigation_ |
NavigationInstruction for the multi-modal segment. |
travel_ |
The travel mode of the multi-modal segment. |
step_ |
The corresponding |
step_ |
The corresponding |
RouteLegStep
Contains a segment of a
. A step corresponds to a single navigation instruction. Route legs are made up of steps.RouteLeg
Fields | |
---|---|
distance_ |
The travel distance of this step, in meters. In some circumstances, this field might not have a value. |
static_ |
The duration of travel through this step without taking traffic conditions into consideration. In some circumstances, this field might not have a value. |
polyline |
The polyline associated with this step. |
start_ |
The start location of this step. |
end_ |
The end location of this step. |
navigation_ |
Navigation instructions. |
travel_ |
Contains the additional information that the user should be informed about, such as possible traffic zone restrictions, on a leg step. |
localized_ |
Text representations of properties of the |
transit_ |
Details pertaining to this step if the travel mode is |
travel_ |
The travel mode used for this step. |
RouteLegStepLocalizedValues
Text representations of certain properties.
Fields | |
---|---|
distance |
Travel distance represented in text form. |
static_ |
Duration without taking traffic conditions into consideration, represented in text form. |
RouteLegStepTransitDetails
Additional information for the RouteLegStep
related to TRANSIT
routes.
Fields | |
---|---|
stop_ |
Information about the arrival and departure stops for the step. |
localized_ |
Text representations of properties of the |
headsign |
Specifies the direction in which to travel on this line as marked on the vehicle or at the departure stop. The direction is often the terminus station. |
headway |
Specifies the expected time as a duration between departures from the same stop at this time. For example, with a headway seconds value of 600, you would expect a ten minute wait if you should miss your bus. |
transit_ |
Information about the transit line used in this step. |
stop_ |
The number of stops from the departure to the arrival stop. This count includes the arrival stop, but excludes the departure stop. For example, if your route leaves from Stop A, passes through stops B and C, and arrives at stop D,
returns 3. |
trip_ |
The text that appears in schedules and sign boards to identify a transit trip to passengers. The text should uniquely identify a trip within a service day. For example, "538" is the |
TransitDetailsLocalizedValues
Localized descriptions of values for RouteTransitDetails
.
Fields | |
---|---|
arrival_ |
Time in its formatted text representation with a corresponding time zone. |
departure_ |
Time in its formatted text representation with a corresponding time zone. |
TransitStopDetails
Details about the transit stops for the RouteLegStep
.
Fields | |
---|---|
arrival_ |
Information about the arrival stop for the step. |
arrival_ |
The estimated time of arrival for the step. |
departure_ |
Information about the departure stop for the step. |
departure_ |
The estimated time of departure for the step. |
RouteLegStepTravelAdvisory
Contains the additional information that the user should be informed about, such as possible traffic zone restrictions on a leg step.
Fields | |
---|---|
speed_ |
NOTE: This field is not currently populated. |
RouteLegTravelAdvisory
Contains the additional information that the user should be informed about on a leg step, such as possible traffic zone restrictions.
Fields | |
---|---|
toll_ |
Contains information about tolls on the specific |
speed_ |
Speed reading intervals detailing traffic density. Applicable in case of Example:
|
RouteMatrixDestination
A single destination for ComputeRouteMatrixRequest
Fields | |
---|---|
waypoint |
Required. Destination waypoint |
RouteMatrixElement
Contains route information computed for an origin/destination pair in the ComputeRouteMatrix API. This proto can be streamed to the client.
Fields | |
---|---|
status |
Error status code for this element. |
condition |
Indicates whether the route was found or not. Independent of status. |
distance_ |
The travel distance of the route, in meters. |
duration |
The length of time needed to navigate the route. If you set the |
static_ |
The duration of traveling through the route without taking traffic conditions into consideration. |
travel_ |
Additional information about the route. For example: restriction information and toll information |
fallback_ |
In some cases when the server is not able to compute the route with the given preferences for this particular origin/destination pair, it may fall back to using a different mode of computation. When fallback mode is used, this field contains detailed information about the fallback response. Otherwise this field is unset. |
localized_ |
Text representations of properties of the |
origin_ |
Zero-based index of the origin in the request. |
destination_ |
Zero-based index of the destination in the request. |
LocalizedValues
Text representations of certain properties.
Fields | |
---|---|
distance |
Travel distance represented in text form. |
duration |
Duration represented in text form taking traffic conditions into consideration. Note: If traffic information was not requested, this value is the same value as static_duration. |
static_ |
Duration represented in text form without taking traffic conditions into consideration. |
transit_ |
Transit fare represented in text form. |
RouteMatrixElementCondition
The condition of the route being returned.
Enums | |
---|---|
ROUTE_MATRIX_ELEMENT_CONDITION_UNSPECIFIED |
Only used when the status of the element is not OK. |
ROUTE_EXISTS |
A route was found, and the corresponding information was filled out for the element. |
ROUTE_NOT_FOUND |
No route could be found. Fields containing route information, such as distance_meters or duration , will not be filled out in the element. |
RouteMatrixOrigin
A single origin for ComputeRouteMatrixRequest
Fields | |
---|---|
waypoint |
Required. Origin waypoint |
route_ |
Optional. Modifiers for every route that takes this as the origin |
RouteModifiers
Encapsulates a set of optional conditions to satisfy when calculating the routes.
Fields | |
---|---|
avoid_ |
When set to true, avoids toll roads where reasonable, giving preference to routes not containing toll roads. Applies only to the |
avoid_ |
When set to true, avoids highways where reasonable, giving preference to routes not containing highways. Applies only to the |
avoid_ |
When set to true, avoids ferries where reasonable, giving preference to routes not containing ferries. Applies only to the |
avoid_ |
When set to true, avoids navigating indoors where reasonable, giving preference to routes not containing indoor navigation. Applies only to the |
vehicle_ |
Specifies the vehicle information. |
toll_ |
Encapsulates information about toll passes. If toll passes are provided, the API tries to return the pass price. If toll passes are not provided, the API treats the toll pass as unknown and tries to return the cash price. Applies only to the |
RouteTravelAdvisory
Contains the additional information that the user should be informed about, such as possible traffic zone restrictions.
Fields | |
---|---|
toll_ |
Contains information about tolls on the route. This field is only populated if tolls are expected on the route. If this field is set, but the |
speed_ |
Speed reading intervals detailing traffic density. Applicable in case of Example:
|
fuel_ |
The predicted fuel consumption in microliters. |
route_ |
Returned route may have restrictions that are not suitable for requested travel mode or route modifiers. |
transit_ |
If present, contains the total fare or ticket costs on this route This property is only returned for |
RouteTravelMode
A set of values used to specify the mode of travel. NOTE: WALK
, BICYCLE
, and TWO_WHEELER
routes are in beta and might sometimes be missing clear sidewalks, pedestrian paths, or bicycling paths. You must display this warning to the user for all walking, bicycling, and two-wheel routes that you display in your app.
Enums | |
---|---|
TRAVEL_MODE_UNSPECIFIED |
No travel mode specified. Defaults to DRIVE . |
DRIVE |
Travel by passenger car. |
BICYCLE |
Travel by bicycle. |
WALK |
Travel by walking. |
TWO_WHEELER |
Two-wheeled, motorized vehicle. For example, motorcycle. Note that this differs from the BICYCLE travel mode which covers human-powered mode. |
TRANSIT |
Travel by public transit routes, where available. |
RoutingPreference
A set of values that specify factors to take into consideration when calculating the route.
Enums | |
---|---|
ROUTING_PREFERENCE_UNSPECIFIED |
No routing preference specified. Default to TRAFFIC_UNAWARE . |
TRAFFIC_UNAWARE |
Computes routes without taking live traffic conditions into consideration. Suitable when traffic conditions don't matter or are not applicable. Using this value produces the lowest latency. Note: For DRIVE and TWO_WHEELER , the route and duration chosen are based on road network and average time-independent traffic conditions, not current road conditions. Consequently, routes may include roads that are temporarily closed. Results for a given request may vary over time due to changes in the road network, updated average traffic conditions, and the distributed nature of the service. Results may also vary between nearly-equivalent routes at any time or frequency. |
TRAFFIC_AWARE |
Calculates routes taking live traffic conditions into consideration. In contrast to TRAFFIC_AWARE_OPTIMAL , some optimizations are applied to significantly reduce latency. |
TRAFFIC_AWARE_OPTIMAL |
Calculates the routes taking live traffic conditions into consideration, without applying most performance optimizations. Using this value produces the highest latency. |
SpeedReadingInterval
Traffic density indicator on a contiguous segment of a polyline or path. Given a path with points P_0, P_1, ... , P_N (zero-based index), the SpeedReadingInterval
defines an interval and describes its traffic using the following categories.
Fields | |
---|---|
start_ |
The starting index of this interval in the polyline. |
end_ |
The ending index of this interval in the polyline. |
Union field
|
|
speed |
Traffic speed in this interval. |
Speed
The classification of polyline speed based on traffic data.
Enums | |
---|---|
SPEED_UNSPECIFIED |
Default value. This value is unused. |
NORMAL |
Normal speed, no slowdown is detected. |
SLOW |
Slowdown detected, but no traffic jam formed. |
TRAFFIC_JAM |
Traffic jam detected. |
TollInfo
Fields | |
---|---|
estimated_ |
The monetary amount of tolls for the corresponding |
TollPass
List of toll passes around the world that we support.
Enums | |
---|---|
TOLL_PASS_UNSPECIFIED |
Not used. If this value is used, then the request fails. |
AU_ETOLL_TAG |
Sydney toll pass. See additional details at https://www.myetoll.com.au. |
AU_EWAY_TAG |
Sydney toll pass. See additional details at https://www.tollpay.com.au. |
AU_LINKT |
Australia-wide toll pass. See additional details at https://www.linkt.com.au/. |
AR_TELEPASE |
Argentina toll pass. See additional details at https://telepase.com.ar |
BR_AUTO_EXPRESO |
Brazil toll pass. See additional details at https://www.autoexpreso.com |
BR_CONECTCAR |
Brazil toll pass. See additional details at https://conectcar.com. |
BR_MOVE_MAIS |
Brazil toll pass. See additional details at https://movemais.com. |
BR_PASSA_RAPIDO |
Brazil toll pass. See additional details at https://pasorapido.gob.do/ |
BR_SEM_PARAR |
Brazil toll pass. See additional details at https://www.semparar.com.br. |
BR_TAGGY |
Brazil toll pass. See additional details at https://taggy.com.br. |
BR_VELOE |
Brazil toll pass. See additional details at https://veloe.com.br/site/onde-usar. |
CA_US_AKWASASNE_SEAWAY_CORPORATE_CARD |
Canada to United States border crossing. |
CA_US_AKWASASNE_SEAWAY_TRANSIT_CARD |
Canada to United States border crossing. |
CA_US_BLUE_WATER_EDGE_PASS |
Ontario, Canada to Michigan, United States border crossing. |
CA_US_CONNEXION |
Ontario, Canada to Michigan, United States border crossing. |
CA_US_NEXUS_CARD |
Canada to United States border crossing. |
ID_E_TOLL |
Indonesia. E-card provided by multiple banks used to pay for tolls. All e-cards via banks are charged the same so only one enum value is needed. E.g. - Bank Mandiri https://www.bankmandiri.co.id/e-money - BCA https://www.bca.co.id/flazz - BNI https://www.bni.co.id/id-id/ebanking/tapcash |
IN_FASTAG |
India. |
IN_LOCAL_HP_PLATE_EXEMPT |
India, HP state plate exemption. |
JP_ETC |
Japan ETC. Electronic wireless system to collect tolls. https://www.go-etc.jp/ |
JP_ETC2 |
Japan ETC2.0. New version of ETC with further discount and bidirectional communication between devices on vehicles and antennas on the road. https://www.go-etc.jp/etc2/index.html |
MX_IAVE |
Mexico toll pass. https://iave.capufe.gob.mx/#/ |
MX_PASE |
Mexico https://www.pase.com.mx |
MX_QUICKPASS |
Mexico https://operadoravial.com/quick-pass/ |
MX_SISTEMA_TELEPEAJE_CHIHUAHUA |
http://appsh.chihuahua.gob.mx/transparencia/?doc=/ingresos/TelepeajeFormato4.pdf |
MX_TAG_IAVE |
Mexico |
MX_TAG_TELEVIA |
Mexico toll pass company. One of many operating in Mexico City. See additional details at https://www.televia.com.mx. |
MX_TELEVIA |
Mexico toll pass company. One of many operating in Mexico City. https://www.televia.com.mx |
MX_VIAPASS |
Mexico toll pass. See additional details at https://www.viapass.com.mx/viapass/web_home.aspx. |
US_AL_FREEDOM_PASS |
AL, USA. |
US_AK_ANTON_ANDERSON_TUNNEL_BOOK_OF_10_TICKETS |
AK, USA. |
US_CA_FASTRAK |
CA, USA. |
US_CA_FASTRAK_CAV_STICKER |
Indicates driver has any FasTrak pass in addition to the DMV issued Clean Air Vehicle (CAV) sticker. https://www.bayareafastrak.org/en/guide/doINeedFlex.shtml |
US_CO_EXPRESSTOLL |
CO, USA. |
US_CO_GO_PASS |
CO, USA. |
US_DE_EZPASSDE |
DE, USA. |
US_FL_BOB_SIKES_TOLL_BRIDGE_PASS |
FL, USA. |
US_FL_DUNES_COMMUNITY_DEVELOPMENT_DISTRICT_EXPRESSCARD |
FL, USA. |
US_FL_EPASS |
FL, USA. |
US_FL_GIBA_TOLL_PASS |
FL, USA. |
US_FL_LEEWAY |
FL, USA. |
US_FL_SUNPASS |
FL, USA. |
US_FL_SUNPASS_PRO |
FL, USA. |
US_IL_EZPASSIL |
IL, USA. |
US_IL_IPASS |
IL, USA. |
US_IN_EZPASSIN |
IN, USA. |
US_KS_BESTPASS_HORIZON |
KS, USA. |
US_KS_KTAG |
KS, USA. |
US_KS_NATIONALPASS |
KS, USA. |
US_KS_PREPASS_ELITEPASS |
KS, USA. |
US_KY_RIVERLINK |
KY, USA. |
US_LA_GEAUXPASS |
LA, USA. |
US_LA_TOLL_TAG |
LA, USA. |
US_MA_EZPASSMA |
MA, USA. |
US_MD_EZPASSMD |
MD, USA. |
US_ME_EZPASSME |
ME, USA. |
US_MI_AMBASSADOR_BRIDGE_PREMIER_COMMUTER_CARD |
MI, USA. |
US_MI_BCPASS |
MI, USA. |
US_MI_GROSSE_ILE_TOLL_BRIDGE_PASS_TAG |
MI, USA. |
US_MI_IQ_PROX_CARD |
MI, USA. Deprecated as this pass type no longer exists. |
US_MI_IQ_TAG |
MI, USA. |
US_MI_MACKINAC_BRIDGE_MAC_PASS |
MI, USA. |
US_MI_NEXPRESS_TOLL |
MI, USA. |
US_MN_EZPASSMN |
MN, USA. |
US_NC_EZPASSNC |
NC, USA. |
US_NC_PEACH_PASS |
NC, USA. |
US_NC_QUICK_PASS |
NC, USA. |
US_NH_EZPASSNH |
NH, USA. |
US_NJ_DOWNBEACH_EXPRESS_PASS |
NJ, USA. |
US_NJ_EZPASSNJ |
NJ, USA. |
US_NY_EXPRESSPASS |
NY, USA. |
US_NY_EZPASSNY |
NY, USA. |
US_OH_EZPASSOH |
OH, USA. |
US_PA_EZPASSPA |
PA, USA. |
US_RI_EZPASSRI |
RI, USA. |
US_SC_PALPASS |
SC, USA. |
US_TX_AVI_TAG |
TX, USA. |
US_TX_BANCPASS |
TX, USA. |
US_TX_DEL_RIO_PASS |
TX, USA. |
US_TX_EFAST_PASS |
TX, USA. |
US_TX_EAGLE_PASS_EXPRESS_CARD |
TX, USA. |
US_TX_EPTOLL |
TX, USA. |
US_TX_EZ_CROSS |
TX, USA. |
US_TX_EZTAG |
TX, USA. |
US_TX_FUEGO_TAG |
TX, USA. |
US_TX_LAREDO_TRADE_TAG |
TX, USA. |
US_TX_PLUSPASS |
TX, USA. |
US_TX_TOLLTAG |
TX, USA. |
US_TX_TXTAG |
TX, USA. |
US_TX_XPRESS_CARD |
TX, USA. |
US_UT_ADAMS_AVE_PARKWAY_EXPRESSCARD |
UT, USA. |
US_VA_EZPASSVA |
VA, USA. |
US_WA_BREEZEBY |
WA, USA. |
US_WA_GOOD_TO_GO |
WA, USA. |
US_WV_EZPASSWV |
WV, USA. |
US_WV_MEMORIAL_BRIDGE_TICKETS |
WV, USA. |
US_WV_MOV_PASS |
WV, USA |
US_WV_NEWELL_TOLL_BRIDGE_TICKET |
WV, USA. |
TrafficModel
Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration
field in the response, which contains the predicted time in traffic based on historical averages.
Enums | |
---|---|
TRAFFIC_MODEL_UNSPECIFIED |
Unused. If specified, will default to BEST_GUESS . |
BEST_GUESS |
Indicates that the returned duration should be the best estimate of travel time given what is known about both historical traffic conditions and live traffic. Live traffic becomes more important the closer the departure_time is to now. |
PESSIMISTIC |
Indicates that the returned duration should be longer than the actual travel time on most days, though occasional days with particularly bad traffic conditions may exceed this value. |
OPTIMISTIC |
Indicates that the returned duration should be shorter than the actual travel time on most days, though occasional days with particularly good traffic conditions may be faster than this value. |
TransitAgency
A transit agency that operates a transit line.
Fields | |
---|---|
name |
The name of this transit agency. |
phone_ |
The transit agency's locale-specific formatted phone number. |
uri |
The transit agency's URI. |
TransitLine
Contains information about the transit line used in this step.
Fields | |
---|---|
agencies[] |
The transit agency (or agencies) that operates this transit line. |
name |
The full name of this transit line, For example, "8 Avenue Local". |
uri |
the URI for this transit line as provided by the transit agency. |
color |
The color commonly used in signage for this line. Represented in hexadecimal. |
icon_ |
The URI for the icon associated with this line. |
name_ |
The short name of this transit line. This name will normally be a line number, such as "M7" or "355". |
text_ |
The color commonly used in text on signage for this line. Represented in hexadecimal. |
vehicle |
The type of vehicle that operates on this transit line. |
TransitPreferences
Preferences for TRANSIT
based routes that influence the route that is returned.
Fields | |
---|---|
allowed_ |
A set of travel modes to use when getting a |
routing_ |
A routing preference that, when specified, influences the |
TransitRoutingPreference
Specifies routing preferences for transit routes.
Enums | |
---|---|
TRANSIT_ROUTING_PREFERENCE_UNSPECIFIED |
No preference specified. |
LESS_WALKING |
Indicates that the calculated route should prefer limited amounts of walking. |
FEWER_TRANSFERS |
Indicates that the calculated route should prefer a limited number of transfers. |
TransitTravelMode
A set of values used to specify the mode of transit.
Enums | |
---|---|
TRANSIT_TRAVEL_MODE_UNSPECIFIED |
No transit travel mode specified. |
BUS |
Travel by bus. |
SUBWAY |
Travel by subway. |
TRAIN |
Travel by train. |
LIGHT_RAIL |
Travel by light rail or tram. |
RAIL |
Travel by rail. This is equivalent to a combination of SUBWAY , TRAIN , and LIGHT_RAIL . |
TransitStop
Information about a transit stop.
Fields | |
---|---|
name |
The name of the transit stop. |
location |
The location of the stop expressed in latitude/longitude coordinates. |
TransitVehicle
Information about a vehicle used in transit routes.
Fields | |
---|---|
name |
The name of this vehicle, capitalized. |
type |
The type of vehicle used. |
icon_ |
The URI for an icon associated with this vehicle type. |
local_ |
The URI for the icon associated with this vehicle type, based on the local transport signage. |
TransitVehicleType
The type of vehicles for transit routes.
Enums | |
---|---|
TRANSIT_VEHICLE_TYPE_UNSPECIFIED |
Unused. |
BUS |
Bus. |
CABLE_CAR |
A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT . |
COMMUTER_TRAIN |
Commuter rail. |
FERRY |
Ferry. |
FUNICULAR |
A vehicle that is pulled up a steep incline by a cable. A Funicular typically consists of two cars, with each car acting as a counterweight for the other. |
GONDOLA_LIFT |
An aerial cable car. |
HEAVY_RAIL |
Heavy rail. |
HIGH_SPEED_TRAIN |
High speed train. |
INTERCITY_BUS |
Intercity bus. |
LONG_DISTANCE_TRAIN |
Long distance train. |
METRO_RAIL |
Light rail transit. |
MONORAIL |
Monorail. |
OTHER |
All other vehicles. |
RAIL |
Rail. |
SHARE_TAXI |
Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route. |
SUBWAY |
Underground light rail. |
TRAM |
Above ground light rail. |
TROLLEYBUS |
Trolleybus. |
Units
A set of values that specify the unit of measure used in the display.
Enums | |
---|---|
UNITS_UNSPECIFIED |
Units of measure not specified. Defaults to the unit of measure inferred from the request. |
METRIC |
Metric units of measure. |
IMPERIAL |
Imperial (English) units of measure. |
VehicleEmissionType
A set of values describing the vehicle's emission type. Applies only to the DRIVE
.RouteTravelMode
Enums | |
---|---|
VEHICLE_EMISSION_TYPE_UNSPECIFIED |
No emission type specified. Default to GASOLINE . |
GASOLINE |
Gasoline/petrol fueled vehicle. |
ELECTRIC |
Electricity powered vehicle. |
HYBRID |
Hybrid fuel (such as gasoline + electric) vehicle. |
DIESEL |
Diesel fueled vehicle. |
VehicleInfo
Contains the vehicle information, such as the vehicle emission type.
Fields | |
---|---|
emission_ |
Describes the vehicle's emission type. Applies only to the |
Waypoint
Encapsulates a waypoint. Waypoints mark both the beginning and end of a route, and include intermediate stops along the route.
Fields | |
---|---|
via |
Marks this waypoint as a milestone rather a stopping point. For each non-via waypoint in the request, the response appends an entry to the |
vehicle_ |
Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pickup or drop-off. When you set this value, the calculated route won't include non- |
side_ |
Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option works only for |
Union field location_type . Different ways to represent a location. location_type can be only one of the following: |
|
location |
A point specified using geographic coordinates, including an optional heading. |
place_ |
The POI Place ID associated with the waypoint. |
address |
Human readable address or a plus code. See https://plus.codes for details. |