feat: add API for shorter distance reference routes

Google APIs · copybara-github · commit 4deb95d3bd31 · 2024-11-26T10:35:01.000-08:00
PiperOrigin-RevId: 700387857
diff --git a/google/maps/routing/v2/fallback_info.proto b/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;
diff --git a/google/maps/routing/v2/geocoding_results.proto b/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;
diff --git a/google/maps/routing/v2/localized_time.proto b/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;
diff --git a/google/maps/routing/v2/location.proto b/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;
diff --git a/google/maps/routing/v2/maneuver.proto b/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;
diff --git a/google/maps/routing/v2/navigation_instruction.proto b/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;
diff --git a/google/maps/routing/v2/polyline.proto b/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;
diff --git a/google/maps/routing/v2/route.proto b/google/maps/routing/v2/route.proto
@@ -31,7 +31,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 +48,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,11 +119,13 @@ 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
@@ -204,9 +206,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 +387,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
diff --git a/google/maps/routing/v2/route_label.proto b/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;
 }
diff --git a/google/maps/routing/v2/route_modifiers.proto b/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;
diff --git a/google/maps/routing/v2/route_travel_mode.proto b/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;
diff --git a/google/maps/routing/v2/routes_service.proto b/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.
@@ -262,7 +276,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];
 
diff --git a/google/maps/routing/v2/routing_preference.proto b/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;
diff --git a/google/maps/routing/v2/speed_reading_interval.proto b/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;
diff --git a/google/maps/routing/v2/toll_passes.proto b/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;
diff --git a/google/maps/routing/v2/traffic_model.proto b/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;
diff --git a/google/maps/routing/v2/transit.proto b/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;
diff --git a/google/maps/routing/v2/transit_preferences.proto b/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;
diff --git a/google/maps/routing/v2/units.proto b/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;
diff --git a/google/maps/routing/v2/vehicle_emission_type.proto b/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;
diff --git a/google/maps/routing/v2/waypoint.proto b/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;
