@googlemaps/routing 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.4.0](https://github.com/googleapis/google-cloud-node/compare/routing-v1.3.0...routing-v1.4.0) (2024-12-18)
+
+
+### Features
+
+* [routing] add API for experimental flyover and narrow road polyline details ([#5865](https://github.com/googleapis/google-cloud-node/issues/5865)) ([24d7341](https://github.com/googleapis/google-cloud-node/commit/24d7341b387fc8f6d286ff945bc9aed54ddcc7df))
+* [routing] add API for shorter distance reference routes ([#5842](https://github.com/googleapis/google-cloud-node/issues/5842)) ([99b489f](https://github.com/googleapis/google-cloud-node/commit/99b489f1170ceb45d3ce6cb8d56c8c7aa671ad03))
+
 ## [1.3.0](https://github.com/googleapis/google-cloud-node/compare/routing-v1.2.0...routing-v1.3.0) (2024-05-21)
 
 

package/README.md

@@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 1.  [Select or create a Cloud Platform project][projects].
 1.  [Enable billing for your project][billing].
 1.  [Enable the Google Maps Routing API][enable_api].
-1.  [Set up authentication with a service account][auth] so you can access the
+1.  [Set up authentication][auth] so you can access the
     API from your local workstation.
 
 ### Installing the client library
@@ -233,4 +233,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
 [projects]: https://console.cloud.google.com/project
 [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
 [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=routes.googleapis.com
-[auth]: https://cloud.google.com/docs/authentication/getting-started
+[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local

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

@@ -16,7 +16,6 @@ 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;

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

@@ -18,7 +18,6 @@ package google.maps.routing.v2;
 
 import "google/rpc/status.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;

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

@@ -18,7 +18,6 @@ package google.maps.routing.v2;
 
 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;

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

@@ -19,7 +19,6 @@ package google.maps.routing.v2;
 import "google/protobuf/wrappers.proto";
 import "google/type/latlng.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;

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

@@ -16,7 +16,6 @@ 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;

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

@@ -18,7 +18,6 @@ package google.maps.routing.v2;
 
 import "google/maps/routing/v2/maneuver.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;

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

@@ -18,7 +18,6 @@ package google.maps.routing.v2;
 
 import "google/protobuf/struct.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;

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

@@ -0,0 +1,84 @@
+// Copyright 2024 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/api/field_behavior.proto";
+
+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 = "PolylineDetailsProto";
+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";
+
+// Details corresponding to a given index or contiguous segment of a polyline.
+// Given a polyline with points P_0, P_1, ... , P_N (zero-based index), the
+// `PolylineDetails` defines an interval and associated metadata.
+message PolylineDetails {
+  // Encapsulates the start and end indexes for a polyline detail.
+  // For instances where the data corresponds to a single point, `start_index`
+  // and `end_index` will be equal.
+  message PolylinePointIndex {
+    // The start index of this detail in the polyline.
+    optional int32 start_index = 1;
+
+    // The end index of this detail in the polyline.
+    optional int32 end_index = 2;
+  }
+
+  // Encapsulates the states of road features along a stretch of polyline.
+  enum RoadFeatureState {
+    // The road feature's state was not computed (default value).
+    ROAD_FEATURE_STATE_UNSPECIFIED = 0;
+
+    // The road feature exists.
+    EXISTS = 1;
+
+    // The road feature does not exist.
+    DOES_NOT_EXIST = 2;
+  }
+
+  // Encapsulates information about flyovers along the polyline.
+  message FlyoverInfo {
+    // Output only. Denotes whether a flyover exists for a given stretch of the
+    // polyline.
+    RoadFeatureState flyover_presence = 1
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // The location of flyover related information along the polyline.
+    PolylinePointIndex polyline_point_index = 2;
+  }
+
+  // Encapsulates information about narrow roads along the polyline.
+  message NarrowRoadInfo {
+    // Output only. Denotes whether a narrow road exists for a given stretch of
+    // the polyline.
+    RoadFeatureState narrow_road_presence = 1
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // The location of narrow road related information along the polyline.
+    PolylinePointIndex polyline_point_index = 2;
+  }
+
+  // Flyover details along the polyline.
+  repeated FlyoverInfo flyover_info = 12;
+
+  // Narrow road details along the polyline.
+  repeated NarrowRoadInfo narrow_road_info = 13;
+}

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

@@ -21,6 +21,7 @@ import "google/maps/routing/v2/localized_time.proto";
 import "google/maps/routing/v2/location.proto";
 import "google/maps/routing/v2/navigation_instruction.proto";
 import "google/maps/routing/v2/polyline.proto";
+import "google/maps/routing/v2/polyline_details.proto";
 import "google/maps/routing/v2/route_label.proto";
 import "google/maps/routing/v2/route_travel_mode.proto";
 import "google/maps/routing/v2/speed_reading_interval.proto";
@@ -31,7 +32,6 @@ import "google/protobuf/timestamp.proto";
 import "google/type/localized_text.proto";
 import "google/type/money.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;
@@ -49,9 +49,10 @@ message Route {
     // Travel distance represented in text form.
     google.type.LocalizedText distance = 1;
 
-    // Duration taking traffic conditions into consideration, represented in
-    // text form. Note: If you did not request traffic information, this value
-    // will be the same value as `static_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`.
     google.type.LocalizedText duration = 2;
 
     // Duration without taking traffic conditions into consideration,
@@ -119,16 +120,21 @@ message Route {
   // Text representations of properties of the `Route`.
   RouteLocalizedValues localized_values = 11;
 
-  // A web-safe, base64-encoded route token that can be passed to the Navigation
-  // SDK, that allows the Navigation SDK to reconstruct the route during
-  // navigation, and, in the event of rerouting, honor the original intention
-  // when you created the route by calling ComputeRoutes. Customers should treat
-  // this token as an opaque blob. It is not meant for reading or mutating.
+  // An opaque token that can be passed to [Navigation
+  // SDK](https://developers.google.com/maps/documentation/navigation) 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: `Route.route_token` is only available for requests that have set
   // `ComputeRoutesRequest.routing_preference` to `TRAFFIC_AWARE` or
   // `TRAFFIC_AWARE_OPTIMAL`. `Route.route_token` is not supported for requests
   // that have Via waypoints.
   string route_token = 12;
+
+  // Contains information about details along the polyline.
+  PolylineDetails polyline_details = 14;
 }
 
 // Contains the additional information that the user should be informed
@@ -204,9 +210,10 @@ message RouteLeg {
     // Travel distance represented in text form.
     google.type.LocalizedText distance = 1;
 
-    // Duration taking traffic conditions into consideration represented in text
-    // form. Note: If you did not request traffic information, this value will
-    // be the same value as static_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.
     google.type.LocalizedText duration = 2;
 
     // Duration without taking traffic conditions into
@@ -384,7 +391,7 @@ message RouteLegStepTransitDetails {
   // 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, stop_count will return 3.
+  // stop D, <code>stop_count</code> returns 3.
   int32 stop_count = 6;
 
   // The text that appears in schedules and sign boards to identify a transit

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

@@ -16,7 +16,6 @@ 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;
@@ -44,4 +43,7 @@ enum RouteLabel {
   // Fuel efficient route. Routes labeled with this value are determined to be
   // optimized for Eco parameters such as fuel consumption.
   FUEL_EFFICIENT = 3;
+
+  // Shorter travel distance route. This is an experimental feature.
+  SHORTER_DISTANCE = 4;
 }

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

@@ -19,7 +19,6 @@ package google.maps.routing.v2;
 import "google/maps/routing/v2/toll_passes.proto";
 import "google/maps/routing/v2/vehicle_info.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;

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

@@ -16,7 +16,6 @@ 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;

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

@@ -35,7 +35,6 @@ 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";
 option go_package = "cloud.google.com/go/maps/routing/apiv2/routingpb;routingpb";
 option java_multiple_files = true;
@@ -142,9 +141,24 @@ message ComputeRoutesRequest {
     // Not used. Requests containing this value fail.
     REFERENCE_ROUTE_UNSPECIFIED = 0;
 
-    // Fuel efficient route. Routes labeled with this value are determined to be
-    // optimized for parameters such as fuel consumption.
+    // Fuel efficient route.
     FUEL_EFFICIENT = 1;
+
+    // Route with shorter travel distance. This is an experimental feature.
+    //
+    // For `DRIVE` requests, this feature prioritizes shorter distance over
+    // driving comfort. For example, it may prefer local roads instead of
+    // highways, take dirt roads, cut through parking lots, etc. This feature
+    // does not return any maneuvers that Google Maps knows to be illegal.
+    //
+    // For `BICYCLE` and `TWO_WHEELER` requests, this feature returns routes
+    // similar to those returned when you don't specify
+    // `requested_reference_routes`.
+    //
+    // This feature is not compatible with any other travel modes, via
+    // intermediate waypoints, or `optimize_waypoint_order`; such requests will
+    // fail. However, you can use it with any `routing_preference`.
+    SHORTER_DISTANCE = 2;
   }
 
   // Extra computations to perform while completing the request.
@@ -166,6 +180,20 @@ message ComputeRoutesRequest {
     // is meant to be read as-is. This content is for display only.
     // Do not programmatically parse it.
     HTML_FORMATTED_NAVIGATION_INSTRUCTIONS = 4;
+
+    // Flyover information for the route(s). The
+    // `routes.polyline_details.flyover_info` fieldmask must be specified to
+    // return this information. This data will only currently be populated for
+    // certain metros in India. This feature is experimental, and the
+    // SKU/charge is subject to change.
+    FLYOVER_INFO_ON_POLYLINE = 7;
+
+    // Narrow road information for the route(s). The
+    // `routes.polyline_details.narrow_road_info` fieldmask must be specified
+    // to return this information. This data will only currently be populated
+    // for certain metros in India. This feature is experimental, and the
+    // SKU/charge is subject to change.
+    NARROW_ROAD_INFO_ON_POLYLINE = 8;
   }
 
   // Required. Origin waypoint.
@@ -262,7 +290,10 @@ message ComputeRoutesRequest {
   // 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 `FUEL_EFFICIENT` reference route calculation takes into account various
-  // parameters that would generate an optimal fuel efficient route.
+  // parameters that would generate an optimal fuel efficient route. When using
+  // this feature, look for
+  // [`route_labels`][google.maps.routing.v2.Route.route_labels] on the
+  // resulting routes.
   repeated ReferenceRoute requested_reference_routes = 14
       [(google.api.field_behavior) = OPTIONAL];
 

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

@@ -16,7 +16,6 @@ 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;

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

@@ -16,7 +16,6 @@ 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;

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

@@ -16,7 +16,6 @@ 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;

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

@@ -16,7 +16,6 @@ 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;

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

@@ -19,7 +19,6 @@ 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;

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

@@ -16,7 +16,6 @@ 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;

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

@@ -16,7 +16,6 @@ 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;

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

@@ -16,7 +16,6 @@ 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;

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

@@ -18,7 +18,6 @@ package google.maps.routing.v2;
 
 import "google/maps/routing/v2/location.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;