@googlemaps/routing 0.5.1 → 1.0.0

package/build/protos/google/maps/routing/v2/routes_service.proto

@@ -26,11 +26,14 @@ import "google/maps/routing/v2/route.proto";
 import "google/maps/routing/v2/route_modifiers.proto";
 import "google/maps/routing/v2/route_travel_mode.proto";
 import "google/maps/routing/v2/routing_preference.proto";
+import "google/maps/routing/v2/traffic_model.proto";
+import "google/maps/routing/v2/transit_preferences.proto";
 import "google/maps/routing/v2/units.proto";
 import "google/maps/routing/v2/waypoint.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
 import "google/rpc/status.proto";
+import "google/type/localized_text.proto";
 
 option cc_enable_arenas = true;
 option csharp_namespace = "Google.Maps.Routing.V2";
@@ -157,6 +160,13 @@ message ComputeRoutesRequest {
 
     // Traffic aware polylines for the route(s).
     TRAFFIC_ON_POLYLINE = 3;
+
+    // [Navigation
+    // Instructions][google.maps.routing.v2.NavigationInstructions.instructions]
+    // 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.
+    HTML_FORMATTED_NAVIGATION_INSTRUCTIONS = 4;
   }
 
   // Required. Origin waypoint.
@@ -189,11 +199,21 @@ message ComputeRoutesRequest {
       [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. The departure time. If you don't set this value, then this value
-  // defaults to the time that you made the request. If you set this value to a
-  // time that has already occurred, then the request fails.
+  // defaults to the time that you made the request.
+  // NOTE: You can only specify a `departure_time` in the past when
+  // [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
+  // `TRANSIT`.
   google.protobuf.Timestamp departure_time = 7
       [(google.api.field_behavior) = OPTIONAL];
 
+  // Optional. The arrival time.
+  // NOTE: Can only be set when
+  // [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
+  // `TRANSIT`. You can specify either departure_time or arrival_time, but not
+  // both.
+  google.protobuf.Timestamp arrival_time = 19
+      [(google.api.field_behavior) = OPTIONAL];
+
   // Optional. Specifies whether to calculate alternate routes in addition to
   // the route. No alternative routes are returned for requests that have
   // intermediate waypoints.
@@ -216,14 +236,26 @@ message ComputeRoutesRequest {
   // https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains
   string region_code = 16 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. Specifies the units of measure for the display fields. This
-  // includes the `instruction` field in
+  // Optional. Specifies the units of measure for the display fields. These
+  // fields include the `instruction` field in
   // [NavigationInstruction][google.maps.routing.v2.NavigationInstruction]. The
   // units of measure used for the route, leg, step distance, and duration are
   // not affected by this value. If you don't provide this value, then the
-  // display units are inferred from the location of the request.
+  // display units are inferred from the location of the first origin.
   Units units = 11 [(google.api.field_behavior) = OPTIONAL];
 
+  // 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 `via` waypoint. Use
+  // `ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index` to
+  // find the new ordering.
+  // If `ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index` is
+  // not requested in the `X-Goog-FieldMask` header, the request fails.
+  // If `optimize_waypoint_order` is set to false,
+  // `ComputeRoutesResponse.optimized_intermediate_waypoint_index` will be
+  // empty.
+  bool optimize_waypoint_order = 13 [(google.api.field_behavior) = OPTIONAL];
+
   // 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
@@ -238,6 +270,26 @@ message ComputeRoutesRequest {
   // returned in the response.
   repeated ExtraComputation extra_computations = 15
       [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Specifies the assumptions to use when calculating time in
+  // traffic. This setting affects the value returned in the duration field in
+  // the [Route][google.maps.routing.v2.Route] and
+  // [RouteLeg][google.maps.routing.v2.RouteLeg] which contains the predicted
+  // time in traffic based on historical averages.
+  // `TrafficModel` is only available for requests that have set
+  // [RoutingPreference][google.maps.routing.v2.RoutingPreference] to
+  // `TRAFFIC_AWARE_OPTIMAL` and
+  // [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] to `DRIVE`.
+  // Defaults to `BEST_GUESS` if traffic is requested and `TrafficModel` is not
+  // specified.
+  TrafficModel traffic_model = 18 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Specifies preferences that influence the route returned for
+  // `TRANSIT` routes. NOTE: You can only specify a `transit_preferences` when
+  // [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
+  // `TRANSIT`.
+  TransitPreferences transit_preferences = 20
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // ComputeRoutes the response message.
@@ -299,12 +351,22 @@ message ComputeRouteMatrixRequest {
   RoutingPreference routing_preference = 4
       [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. The departure time. If you don't set this value, this defaults to
-  // the time that you made the request. If you set this value to a time that
-  // has already occurred, the request fails.
+  // 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 `departure_time` in the past when
+  // [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
+  // `TRANSIT`.
   google.protobuf.Timestamp departure_time = 5
       [(google.api.field_behavior) = OPTIONAL];
 
+  // Optional. The arrival time.
+  // NOTE: Can only be set when
+  // [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
+  // `TRANSIT`. You can specify either departure_time or arrival_time, but not
+  // both.
+  google.protobuf.Timestamp arrival_time = 11
+      [(google.api.field_behavior) = OPTIONAL];
+
   // Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
   // information, see
   // http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. See
@@ -324,6 +386,24 @@ message ComputeRouteMatrixRequest {
   // returned in the response.
   repeated ExtraComputation extra_computations = 8
       [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Specifies the assumptions to use when calculating time in
+  // traffic. This setting affects the value returned in the duration field in
+  // the [RouteMatrixElement][google.maps.routing.v2.RouteMatrixElement] which
+  // contains the predicted time in traffic based on historical averages.
+  // [RoutingPreference][google.maps.routing.v2.RoutingPreference] to
+  // `TRAFFIC_AWARE_OPTIMAL` and
+  // [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] to `DRIVE`.
+  // Defaults to `BEST_GUESS` if traffic is requested and `TrafficModel` is not
+  // specified.
+  TrafficModel traffic_model = 10 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Specifies preferences that influence the route returned for
+  // `TRANSIT` routes. NOTE: You can only specify a `transit_preferences` when
+  // [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
+  // `TRANSIT`.
+  TransitPreferences transit_preferences = 12
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // A single origin for ComputeRouteMatrixRequest
@@ -341,9 +421,27 @@ message RouteMatrixDestination {
   Waypoint waypoint = 1 [(google.api.field_behavior) = REQUIRED];
 }
 
-// Encapsulates route information computed for an origin/destination pair in the
+// Contains route information computed for an origin/destination pair in the
 // ComputeRouteMatrix API. This proto can be streamed to the client.
 message RouteMatrixElement {
+  // Text representations of certain properties.
+  message LocalizedValues {
+    // Travel distance represented in text form.
+    google.type.LocalizedText distance = 1;
+
+    // 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.
+    google.type.LocalizedText duration = 2;
+
+    // Duration represented in text form without taking traffic conditions into
+    // consideration.
+    google.type.LocalizedText static_duration = 3;
+
+    // Transit fare represented in text form.
+    google.type.LocalizedText transit_fare = 4;
+  }
+
   // Zero-based index of the origin in the request.
   optional int32 origin_index = 1;
 
@@ -381,6 +479,9 @@ message RouteMatrixElement {
   // used, this field contains detailed information about the fallback response.
   // Otherwise this field is unset.
   FallbackInfo fallback_info = 8;
+
+  // Text representations of properties of the `RouteMatrixElement`.
+  LocalizedValues localized_values = 10;
 }
 
 // The condition of the route being returned.

package/build/protos/google/maps/routing/v2/toll_passes.proto

@@ -218,7 +218,11 @@ enum TollPass {
   US_MI_GROSSE_ILE_TOLL_BRIDGE_PASS_TAG = 37;
 
   // MI, USA.
-  US_MI_IQ_PROX_CARD = 38;
+  // Deprecated as this pass type no longer exists.
+  US_MI_IQ_PROX_CARD = 38 [deprecated = true];
+
+  // MI, USA.
+  US_MI_IQ_TAG = 95;
 
   // MI, USA.
   US_MI_MACKINAC_BRIDGE_MAC_PASS = 39;
@@ -265,6 +269,9 @@ enum TollPass {
   // SC, USA.
   US_SC_PALPASS = 47;
 
+  // TX, USA.
+  US_TX_AVI_TAG = 97;
+
   // TX, USA.
   US_TX_BANCPASS = 48;
 
@@ -286,6 +293,9 @@ enum TollPass {
   // TX, USA.
   US_TX_EZTAG = 54;
 
+  // TX, USA.
+  US_TX_FUEGO_TAG = 96;
+
   // TX, USA.
   US_TX_LAREDO_TRADE_TAG = 55;
 

package/build/protos/google/maps/routing/v2/traffic_model.proto

@@ -0,0 +1,52 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.maps.routing.v2;
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Maps.Routing.V2";
+option go_package = "cloud.google.com/go/maps/routing/apiv2/routingpb;routingpb";
+option java_multiple_files = true;
+option java_outer_classname = "TrafficModelProto";
+option java_package = "com.google.maps.routing.v2";
+option objc_class_prefix = "GMRV2";
+option php_namespace = "Google\\Maps\\Routing\\V2";
+option ruby_package = "Google::Maps::Routing::V2";
+
+// 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.
+enum TrafficModel {
+  // Unused. If specified, will default to `BEST_GUESS`.
+  TRAFFIC_MODEL_UNSPECIFIED = 0;
+
+  // 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.
+  BEST_GUESS = 1;
+
+  // 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.
+  PESSIMISTIC = 2;
+
+  // 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.
+  OPTIMISTIC = 3;
+}

package/build/protos/google/maps/routing/v2/transit.proto

@@ -0,0 +1,161 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.maps.routing.v2;
+
+import "google/maps/routing/v2/location.proto";
+import "google/type/localized_text.proto";
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Maps.Routing.V2";
+option go_package = "cloud.google.com/go/maps/routing/apiv2/routingpb;routingpb";
+option java_multiple_files = true;
+option java_outer_classname = "TransitProto";
+option java_package = "com.google.maps.routing.v2";
+option objc_class_prefix = "GMRV2";
+option php_namespace = "Google\\Maps\\Routing\\V2";
+option ruby_package = "Google::Maps::Routing::V2";
+
+// A transit agency that operates a transit line.
+message TransitAgency {
+  // The name of this transit agency.
+  string name = 1;
+
+  // The transit agency's locale-specific formatted phone number.
+  string phone_number = 2;
+
+  // The transit agency's URI.
+  string uri = 3;
+}
+
+// Contains information about the transit line used in this step.
+message TransitLine {
+  // The transit agency (or agencies) that operates this transit line.
+  repeated TransitAgency agencies = 1;
+
+  // The full name of this transit line, For example, "8 Avenue Local".
+  string name = 2;
+
+  // the URI for this transit line as provided by the transit agency.
+  string uri = 3;
+
+  // The color commonly used in signage for this line. Represented in
+  // hexadecimal.
+  string color = 4;
+
+  // The URI for the icon associated with this line.
+  string icon_uri = 5;
+
+  // The short name of this transit line. This name will normally be a line
+  // number, such as "M7" or "355".
+  string name_short = 6;
+
+  // The color commonly used in text on signage for this line. Represented in
+  // hexadecimal.
+  string text_color = 7;
+
+  // The type of vehicle that operates on this transit line.
+  TransitVehicle vehicle = 8;
+}
+
+// Information about a transit stop.
+message TransitStop {
+  // The name of the transit stop.
+  string name = 1;
+
+  // The location of the stop expressed in latitude/longitude coordinates.
+  Location location = 2;
+}
+
+// Information about a vehicle used in transit routes.
+message TransitVehicle {
+  // The type of vehicles for transit routes.
+  enum TransitVehicleType {
+    // Unused.
+    TRANSIT_VEHICLE_TYPE_UNSPECIFIED = 0;
+
+    // Bus.
+    BUS = 1;
+
+    // A vehicle that operates on a cable, usually on the ground. Aerial cable
+    // cars may be of the type `GONDOLA_LIFT`.
+    CABLE_CAR = 2;
+
+    // Commuter rail.
+    COMMUTER_TRAIN = 3;
+
+    // Ferry.
+    FERRY = 4;
+
+    // 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.
+    FUNICULAR = 5;
+
+    // An aerial cable car.
+    GONDOLA_LIFT = 6;
+
+    // Heavy rail.
+    HEAVY_RAIL = 7;
+
+    // High speed train.
+    HIGH_SPEED_TRAIN = 8;
+
+    // Intercity bus.
+    INTERCITY_BUS = 9;
+
+    // Long distance train.
+    LONG_DISTANCE_TRAIN = 10;
+
+    // Light rail transit.
+    METRO_RAIL = 11;
+
+    // Monorail.
+    MONORAIL = 12;
+
+    // All other vehicles.
+    OTHER = 13;
+
+    // Rail.
+    RAIL = 14;
+
+    // Share taxi is a kind of bus with the ability to drop off and pick up
+    // passengers anywhere on its route.
+    SHARE_TAXI = 15;
+
+    // Underground light rail.
+    SUBWAY = 16;
+
+    // Above ground light rail.
+    TRAM = 17;
+
+    // Trolleybus.
+    TROLLEYBUS = 18;
+  }
+
+  // The name of this vehicle, capitalized.
+  google.type.LocalizedText name = 1;
+
+  // The type of vehicle used.
+  TransitVehicleType type = 2;
+
+  // The URI for an icon associated with this vehicle type.
+  string icon_uri = 3;
+
+  // The URI for the icon associated with this vehicle type, based on the local
+  // transport signage.
+  string local_icon_uri = 4;
+}

package/build/protos/google/maps/routing/v2/transit_preferences.proto

@@ -0,0 +1,75 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.maps.routing.v2;
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Maps.Routing.V2";
+option go_package = "cloud.google.com/go/maps/routing/apiv2/routingpb;routingpb";
+option java_multiple_files = true;
+option java_outer_classname = "TransitPreferencesProto";
+option java_package = "com.google.maps.routing.v2";
+option objc_class_prefix = "GMRV2";
+option php_namespace = "Google\\Maps\\Routing\\V2";
+option ruby_package = "Google::Maps::Routing::V2";
+
+// Preferences for `TRANSIT` based routes that influence the route that is
+// returned.
+message TransitPreferences {
+  // A set of values used to specify the mode of transit.
+  enum TransitTravelMode {
+    // No transit travel mode specified.
+    TRANSIT_TRAVEL_MODE_UNSPECIFIED = 0;
+
+    // Travel by bus.
+    BUS = 1;
+
+    // Travel by subway.
+    SUBWAY = 2;
+
+    // Travel by train.
+    TRAIN = 3;
+
+    // Travel by light rail or tram.
+    LIGHT_RAIL = 4;
+
+    // Travel by rail. This is equivalent to a combination of `SUBWAY`, `TRAIN`,
+    // and `LIGHT_RAIL`.
+    RAIL = 5;
+  }
+
+  // Specifies routing preferences for transit routes.
+  enum TransitRoutingPreference {
+    // No preference specified.
+    TRANSIT_ROUTING_PREFERENCE_UNSPECIFIED = 0;
+
+    // Indicates that the calculated route should prefer limited amounts of
+    // walking.
+    LESS_WALKING = 1;
+
+    // Indicates that the calculated route should prefer a limited number of
+    // transfers.
+    FEWER_TRANSFERS = 2;
+  }
+
+  // A set of travel modes to use when getting a `TRANSIT` route. Defaults to
+  // all supported modes of travel.
+  repeated TransitTravelMode allowed_travel_modes = 1;
+
+  // A routing preference that, when specified, influences the `TRANSIT` route
+  // returned.
+  TransitRoutingPreference routing_preference = 2;
+}

package/build/protos/google/maps/routing/v2/vehicle_info.proto

@@ -28,10 +28,10 @@ option objc_class_prefix = "GMRV2";
 option php_namespace = "Google\\Maps\\Routing\\V2";
 option ruby_package = "Google::Maps::Routing::V2";
 
-// Encapsulates the vehicle information, such as the license plate last
-// character.
+// Contains the vehicle information, such as the vehicle emission type.
 message VehicleInfo {
   // Describes the vehicle's emission type.
-  // Applies only to the `DRIVE` travel mode.
+  // Applies only to the `DRIVE`
+  // [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
   VehicleEmissionType emission_type = 2;
 }