Encapsulates a set of optional conditions to satisfy when calculating the routes.
JSON representation |
---|
{ "avoidTolls": boolean, "avoidHighways": boolean, "avoidFerries": boolean, "avoidIndoor": boolean, "vehicleInfo": { object ( |
Fields | |
---|---|
avoidTolls |
When set to true, avoids toll roads where reasonable, giving preference to routes not containing toll roads. Applies only to the |
avoidHighways |
When set to true, avoids highways where reasonable, giving preference to routes not containing highways. Applies only to the |
avoidFerries |
When set to true, avoids ferries where reasonable, giving preference to routes not containing ferries. Applies only to the |
avoidIndoor |
When set to true, avoids navigating indoors where reasonable, giving preference to routes not containing indoor navigation. Applies only to the |
vehicleInfo |
Specifies the vehicle information. |
tollPasses[] |
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 |
avoidTunnels |
When set to true, avoids tunnels where reasonable, giving preference to routes not containing tunnels. Applies only to the |
avoidVignettes[] |
When set to true, avoids roads with vignettes in certain countries where reasonable, giving preference to routes not containing travel on roads with vignettes in countries listed as supporting this feature. Applies only to the |
hovPreference |
Specifies whether to change routing based on the presence of HOV-eligible roads. This field is not supported in v2.computeRouteMatrix. |
VehicleInfo
Contains the vehicle information, such as the vehicle emission type.
JSON representation |
---|
{ "emissionType": enum ( |
Fields | |
---|---|
emissionType |
Describes the vehicle's emission type. Applies only to the |
totalAxleCount |
Total number of axles. Must be >= 2 if set. Must be set for trucking to trigger, but is optional for trailering. This field is not supported in v2.computeRouteMatrix when |
totalHeightMm |
Height of the vehicle, including heights of any attached trailers. Must be set for trucking or trailering to trigger. This field is not supported in v2.computeRouteMatrix when |
totalLengthMm |
Length of the vehicle, including lengths of any attached trailers. Must be set for trucking or trailering to trigger. This field is not supported in v2.computeRouteMatrix when |
totalWidthMm |
Width of the vehicle, including widths of any attached trailers. Must be set for trucking or trailering to trigger. This field is not supported in v2.computeRouteMatrix when |
totalWeightKg |
Weight of the vehicle, including weights of any attached trailers. Weight in this context refers to actual weight, not weight rating. Must be set for trucking or trailering to trigger. This field is not supported in v2.computeRouteMatrix when |
trailerInfo[] |
Contains one entry for each trailer. If trailer info is provided, |
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. |
TrailerInfo
Information about individual trailers attached to the vehicle. Lengths of any trailers must be supplied for trucking. Other attributes are optional. Total attributes must encompass the attributes of any trailers. For example, totalHeightMm
must always be greater than or equal to trailerInfo.height_mm
.
JSON representation |
---|
{ "heightMm": string, "lengthMm": string, "widthMm": string, "weightKg": string } |
Fields | |
---|---|
heightMm |
Height of the trailer. |
lengthMm |
Length of the trailer. |
widthMm |
Width of the trailer. |
weightKg |
Weight of the trailer. Weight in this context refers to actual weight, not weight rating. |
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. |
HOVPreference
Specifies whether to change routing based on the presence of HOV (high occupancy vehicle) roads or lanes.
JSON representation |
---|
{ "allowHov": boolean } |
Fields | |
---|---|
allowHov |
Specifies whether to allow routing on HOV-only roads in addition to road segments that share HOV lanes. By default, preference will be given to routes not containing HOV-only roads. |