@googlemaps/routeoptimization 0.5.1 → 0.6.0

package/README.md

@@ -79,6 +79,8 @@ Samples are in the [`samples/`][homepage_samples] directory. Each sample's `READ
 | --------------------------- | --------------------------------- |
 | batch optimize tours | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-routeoptimization/samples/generated/v1/route_optimization.batch_optimize_tours.js) |
 | optimize tours | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-routeoptimization/samples/generated/v1/route_optimization.optimize_tours.js) |
+| optimize tours long running | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-routeoptimization/samples/generated/v1/route_optimization.optimize_tours_long_running.js) |
+| optimize tours uri | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-routeoptimization/samples/generated/v1/route_optimization.optimize_tours_uri.js) |
 | maps | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-routeoptimization/samples/generated/v1/snippet_metadata_google.maps.routeoptimization.v1.json) |
 
 

package/build/protos/google/maps/routeoptimization/v1/route_optimization_service.proto

@@ -117,8 +117,138 @@ service RouteOptimization {
       metadata_type: "BatchOptimizeToursMetadata"
     };
   }
+
+  // This is a variant of the
+  // [OptimizeTours][google.maps.routeoptimization.v1.RouteOptimization.OptimizeTours]
+  // method designed for
+  // optimizations with large timeout values. It should be preferred over the
+  // `OptimizeTours` method for optimizations that take longer than
+  // a few minutes.
+  //
+  // The returned [long-running operation][google.longrunning.Operation] (LRO)
+  // will have a name of the format
+  // `<parent>/operations/<operation_id>` and can be used to track
+  // progress of the computation. The
+  // [metadata][google.longrunning.Operation.metadata] field type is
+  // [OptimizeToursLongRunningMetadata][google.maps.routeoptimization.v1.OptimizeToursLongRunningMetadata].
+  // The [response][google.longrunning.Operation.response] field type is
+  // [OptimizeToursResponse][google.maps.routeoptimization.v1.OptimizeToursResponse],
+  // if successful.
+  //
+  // Experimental: See
+  // https://developers.google.com/maps/tt/route-optimization/experimental/otlr/make-request
+  // for more details.
+  //
+  rpc OptimizeToursLongRunning(OptimizeToursRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1/{parent=projects/*/locations/*}:optimizeToursLongRunning"
+      body: "*"
+      additional_bindings {
+        post: "/v1/{parent=projects/*}:optimizeToursLongRunning"
+        body: "*"
+      }
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "OptimizeToursResponse"
+      metadata_type: "OptimizeToursLongRunningMetadata"
+    };
+  }
+
+  // This is a variant of the
+  // [OptimizeToursLongRunning][google.maps.routeoptimization.v1.RouteOptimization.OptimizeToursLongRunning]
+  // method designed for optimizations with large timeout values and large
+  // input/output sizes.
+  //
+  // The client specifies the URI of the `OptimizeToursRequest` stored
+  // in Google Cloud Storage and the server writes the `OptimizeToursResponse`
+  // to a client-specified Google Cloud Storage URI.
+  //
+  // This method should be preferred over the `OptimizeTours` method for
+  // optimizations that take longer than a few minutes and input/output sizes
+  // that are larger than 8MB, though it can be used for shorter and smaller
+  // optimizations as well.
+  //
+  // The returned [long-running operation][google.longrunning.Operation] (LRO)
+  // will have a name of the format
+  // `<parent>/operations/<operation_id>` and can be used to track
+  // progress of the computation. The
+  // [metadata][google.longrunning.Operation.metadata] field type is
+  // [OptimizeToursLongRunningMetadata][google.maps.routeoptimization.v1.OptimizeToursUriMetadata].
+  // The [response][google.longrunning.Operation.response] field type is
+  // [OptimizeToursUriResponse][google.maps.routeoptimization.v1.OptimizeToursUriResponse],
+  // if successful.
+  //
+  // Experimental: See
+  // https://developers.google.com/maps/tt/route-optimization/experimental/otlr/make-request
+  // for more details.
+  rpc OptimizeToursUri(OptimizeToursUriRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1/{parent=projects/*/locations/*}:OptimizeToursUri"
+      body: "*"
+      additional_bindings {
+        post: "/v1/{parent=projects/*}:OptimizeToursUri"
+        body: "*"
+      }
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "OptimizeToursUriResponse"
+      metadata_type: "OptimizeToursUriMetadata"
+    };
+  }
+}
+
+// A Universal Resource Identifier that points to a resource that can be read
+// and written by the Route Optimization API.
+message Uri {
+  // The URI of the resource. The resource may not yet exist.
+  //
+  // The contents of the resource are encoded as either JSON
+  // or textproto. Only Google Cloud Storage resources are supported. If the
+  // resource is encoded as JSON, the resource name must be suffixed with
+  // `.json`. If the resource is encoded as textproto, the resource name must
+  // be suffixed with `.txtpb`. For example, a Google Cloud Storage URI to
+  // a JSON encoded file might look like: `gs://bucket/path/input/object.json`.
+  string uri = 1;
 }
 
+// A request used by the `OptimizeToursUri` method.
+message OptimizeToursUriRequest {
+  // Required. Target project or location to make a call.
+  //
+  // Format:
+  // * `projects/{project-id}`
+  // * `projects/{project-id}/locations/{location-id}`
+  //
+  // If no location is specified, a region will be chosen automatically.
+  string parent = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The URI of the Cloud Storage object containing the
+  // `OptimizeToursRequest`.
+  Uri input = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The URI of the Cloud Storage object that will contain the
+  // `OptimizeToursResponse`.
+  Uri output = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// A response returned by the `OptimizeToursUri` method.
+message OptimizeToursUriResponse {
+  // Optional. The URI of the Cloud Storage object containing the
+  // `OptimizeToursResponse` encoded as either JSON or textproto. If the object
+  // was encoded as JSON, the extension of the object name will be
+  // `.json`. If the object was encoded as textproto, the extension of the
+  // object name will be `.txtpb`.
+  //
+  // The `crc32_checksum` of the resource can be used to verify the contents of
+  // the resource have not been modified.
+  Uri output = 1 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Operation metadata for `OptimizeToursUri` calls.
+message OptimizeToursUriMetadata {}
+
 // Request to batch optimize tours as an asynchronous operation.
 // Each input file should contain one `OptimizeToursRequest`, and each output
 // file will contain one `OptimizeToursResponse`. The request contains
@@ -160,6 +290,9 @@ message BatchOptimizeToursResponse {}
 // Operation metadata for `BatchOptimizeToursRequest` calls.
 message BatchOptimizeToursMetadata {}
 
+// Operation metadata for `OptimizeToursLongRunning` calls.
+message OptimizeToursLongRunningMetadata {}
+
 // Request to be given to a tour optimization solver which defines the
 // shipment model to solve as well as optimization parameters.
 message OptimizeToursRequest {
@@ -194,6 +327,17 @@ message OptimizeToursRequest {
     // *IMPORTANT*: not all infeasible shipments are returned here, but only the
     // ones that are detected as infeasible during preprocessing.
     DETECT_SOME_INFEASIBLE_SHIPMENTS = 2;
+
+    // This mode only works if `ShipmentModel.objectives` is not empty. The
+    // request is not solved. It is only validated and filled with costs
+    // corresponding to the given objectives. Also see the documentation of
+    // `ShipmentModel.objectives`. The resulting request is returned as
+    // `OptimizeToursResponse.processed_request`.
+    //
+    // Experimental: See
+    // https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request
+    // for more details.
+    TRANSFORM_AND_RETURN_REQUEST = 3;
   }
 
   // Mode defining the behavior of the search, trading off latency versus
@@ -473,6 +617,15 @@ message OptimizeToursResponse {
   // `solving_mode` is `DEFAULT_SOLVE`.
   repeated OptimizeToursValidationError validation_errors = 5;
 
+  // In some cases we modify the incoming request before solving it, i.e. adding
+  // costs. If solving_mode == TRANSFORM_AND_RETURN_REQUEST, the
+  // modified request is returned here.
+  //
+  // Experimental: See
+  // https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request
+  // for more details.
+  OptimizeToursRequest processed_request = 21;
+
   // Duration, distance and usage metrics for this solution.
   Metrics metrics = 6;
 }
@@ -485,6 +638,45 @@ message OptimizeToursResponse {
 // * the unperformed shipment penalties.
 // * the cost of the global duration of the shipments
 message ShipmentModel {
+  // Objectives replace the cost model completely, and are therefore
+  // incompatible with pre-existing costs. Each objective maps to a number of
+  // pre-defined costs for, e.g., vehicles, shipments or transition attributes.
+  //
+  // Experimental: See
+  // https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request
+  // for more details.
+  message Objective {
+    // The objective type that will be mapped to a set of costs.
+    enum Type {
+      // A default set of costs will be used, to ensure a reasonable solution.
+      // Note: this objective can be used on its own, but will also always be
+      // added with weight 1.0, as a baseline, to the objectives specified by
+      // the user, if it's not already present.
+      DEFAULT = 0;
+
+      // "MIN" objectives.
+      // Minimize the total distance traveled.
+      MIN_DISTANCE = 10;
+
+      // Minimize the total working time, summed over all vehicles.
+      MIN_WORKING_TIME = 11;
+
+      // Same as above but focusing on travel time only.
+      MIN_TRAVEL_TIME = 12;
+
+      // Minimize the number of vehicles used.
+      MIN_NUM_VEHICLES = 13;
+    }
+
+    // The type of the objective.
+    optional Type type = 1;
+
+    // How much this objective should count relatively to the others. This can
+    // be any non-negative number, weights do not have to sum to 1. Weights
+    // default to 1.0.
+    optional double weight = 2;
+  }
+
   // Specifies a duration and distance matrix from visit and vehicle start
   // locations to visit and vehicle end locations.
   message DurationDistanceMatrix {
@@ -550,6 +742,17 @@ message ShipmentModel {
   // Set of vehicles which can be used to perform visits.
   repeated Vehicle vehicles = 2;
 
+  // The set of objectives for this model, that we will transform into costs.
+  // If not empty, the input model has to be costless.
+  // To obtain the modified request, please use `solving_mode` =
+  // TRANSFORM_AND_RETURN_REQUEST. Note that the request will not
+  // be solved in this case. See corresponding documentation.
+  //
+  // Experimental: See
+  // https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request
+  // for more details.
+  repeated Objective objectives = 17;
+
   // Constrains the maximum number of active vehicles. A vehicle is active if
   // its route performs at least one shipment. This can be used to limit the
   // number of routes in the case where there are fewer drivers than
@@ -617,7 +820,6 @@ message ShipmentModel {
   // }
   // ```
   //
-  //
   // * There are three locations: locA, locB and locC.
   // * 1 vehicle starting its route at locA and ending it at locB, using
   //   matrix "fast".
@@ -716,6 +918,10 @@ message ShipmentModel {
   repeated ShipmentTypeRequirement shipment_type_requirements = 13;
 
   // Set of precedence rules which must be enforced in the model.
+  //
+  // *IMPORTANT*: Use of precedence rules limits the size of problem that can be
+  // optimized. Requests using precedence rules that include many shipments may
+  // be rejected.
   repeated PrecedenceRule precedence_rules = 14;
 }
 
@@ -804,6 +1010,16 @@ message Shipment {
     // response as `visit_label` in the corresponding
     // [ShipmentRoute.Visit][google.maps.routeoptimization.v1.ShipmentRoute.Visit].
     string label = 11;
+
+    // Specifies whether U-turns should be avoided in driving routes at this
+    // location.
+    // U-turn avoidance is best effort and complete avoidance is not guaranteed.
+    // This is an experimental feature and behavior is subject to change.
+    //
+    // Experimental: See
+    // https://developers.google.com/maps/tt/route-optimization/experimental/u-turn-avoidance/make-request
+    // for more details.
+    optional bool avoid_u_turns = 13;
   }
 
   // When performing a visit, a predefined amount may be added to the vehicle
@@ -958,14 +1174,12 @@ message ShipmentTypeIncompatibility {
     // same vehicle.
     NOT_PERFORMED_BY_SAME_VEHICLE = 1;
 
-    // For two shipments with incompatible types with the
-    // `NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY` incompatibility mode:
-    //
-    // * If both are pickups only (no deliveries) or deliveries only (no
-    //   pickups), they cannot share the same vehicle at all.
-    // * If one of the shipments has a delivery and the other a pickup, the two
-    //   shipments can share the same vehicle iff the former shipment is
-    //   delivered before the latter is picked up.
+    // In this mode, two shipments with incompatible types can never be on the
+    // same vehicle at the same time:
+    // * They can share the same vehicle only if one is delivered before the
+    //   other is picked up.
+    // * When both shipments are pickups-only (no deliveries) or deliveries-only
+    //   (no pickups), they can't share the same vehicle at all.
     NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY = 2;
   }
 
@@ -1054,9 +1268,13 @@ message RouteModifiers {
 message Vehicle {
   // Travel modes which can be used by vehicles.
   //
-  // These should be a subset of the Google Maps Platform Routes Preferred API
-  // travel modes, see:
-  // https://developers.google.com/maps/documentation/routes_preferred/reference/rest/Shared.Types/RouteTravelMode.
+  // These should be a subset of the Google Maps Platform Routes API travel
+  // modes, see:
+  // https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteTravelMode
+  //
+  // Note: `WALKING` routes are in beta and might sometimes be missing clear
+  // sidewalks or pedestrian paths. You must display this warning to the user
+  // for all walking routes that you display in your app.
   enum TravelMode {
     // Unspecified travel mode, equivalent to `DRIVING`.
     TRAVEL_MODE_UNSPECIFIED = 0;
@@ -1107,6 +1325,97 @@ message Vehicle {
       optional int64 max = 2;
     }
 
+    // Cost of moving one unit of load during a `Transition`.
+    // For a given load, the cost is the sum of two parts:
+    //
+    // - min(load, `load_threshold`) * `cost_per_unit_below_threshold`
+    // - max(0, load - `load_threshold`) * `cost_per_unit_above_threshold`
+    //
+    // With this cost, solutions prefer to deliver high demands first,
+    // or equivalently pickup high demands last.
+    // For example, if a vehicle has
+    //
+    //     load_limit {
+    //       key: "weight"
+    //       value {
+    //         cost_per_kilometer {
+    //           load_threshold: 15
+    //           cost_per_unit_below_threshold: 2.0
+    //           cost_per_unit_above_threshold: 10.0
+    //         }
+    //       }
+    //     }
+    //
+    // and its route is start,pickup,pickup,delivery,delivery,end with
+    // transitions:
+    //
+    //     transition { vehicle_load['weight'] { amount: 0 }
+    //                  travel_distance_meters: 1000.0 }
+    //     transition { vehicle_load['weight'] { amount: 10 }
+    //                  travel_distance_meters: 1000.0 }
+    //     transition { vehicle_load['weight'] { amount: 20 }
+    //                  travel_distance_meters: 1000.0 }
+    //     transition { vehicle_load['weight'] { amount: 10 }
+    //                  travel_distance_meters: 1000.0 }
+    //     transition { vehicle_load['weight'] { amount: 0 }
+    //                  travel_distance_meters: 1000.0 }
+    //
+    // then the cost incurred by this `LoadCost` is
+    // (cost_below * load_below * kilometers + cost_above * load_above * kms)
+    //
+    // - transition 0: 0.0
+    // - transition 1: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
+    // - transition 2: 2.0 * 15 * 1.0 + 10.0 * (20 - 15) * 1.0 = 80.0
+    // - transition 3: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
+    // - transition 4: 0.0
+    //
+    // So the `LoadCost` over the route is 120.0.
+    //
+    // However, if the route is start,pickup,delivery,pickup,delivery,end
+    // with transitions:
+    //
+    //     transition { vehicle_load['weight'] { amount: 0 }
+    //                  travel_distance_meters: 1000.0 }
+    //     transition { vehicle_load['weight'] { amount: 10 }
+    //                  travel_distance_meters: 1000.0 }
+    //     transition { vehicle_load['weight'] { amount: 0 }
+    //                  travel_distance_meters: 1000.0 }
+    //     transition { vehicle_load['weight'] { amount: 10 }
+    //                  travel_distance_meters: 1000.0 }
+    //     transition { vehicle_load['weight'] { amount: 0 }
+    //                  travel_distance_meters: 1000.0 }
+    //
+    // then the cost incurred by this `LoadCost` is
+    //
+    // - transition 0: 0.0
+    // - transition 1: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
+    // - transition 2: 0.0
+    // - transition 3: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
+    // - transition 4: 0.0
+    //
+    // Here the `LoadCost` over the route is 40.0.
+    //
+    // `LoadCost` makes solutions with heavy-loaded transitions more expensive.
+    //
+    // Experimental: See
+    // https://developers.google.com/maps/tt/route-optimization/experimental/load-cost/make-request
+    // for more details.
+    message LoadCost {
+      // Amount of load above which the cost of moving a unit of load changes
+      // from cost_per_unit_below_threshold to cost_per_unit_above_threshold.
+      // Must be >= 0.
+      optional int64 load_threshold = 1;
+
+      // Cost of moving a unit of load, for each unit between 0 and threshold.
+      // Must be a finite value, and >= 0.
+      optional double cost_per_unit_below_threshold = 2;
+
+      // Cost of moving a unit of load, for each unit above threshold.
+      // In the special case threshold = 0, this is a fixed cost per unit.
+      // Must be a finite value, and >= 0.
+      optional double cost_per_unit_above_threshold = 3;
+    }
+
     // The maximum acceptable amount of load.
     optional int64 max_load = 1;
 
@@ -1122,6 +1431,8 @@ message Vehicle {
     // * [cost_per_unit_above_soft_max][google.maps.routeoptimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max]. All costs
     // add up and must be in the same unit as
     // [Shipment.penalty_cost][google.maps.routeoptimization.v1.Shipment.penalty_cost].
+    // Soft limits may only be defined on types that apply to either pickups
+    // only or deliveries only throughout the model.
     double cost_per_unit_above_soft_max = 3;
 
     // The acceptable load interval of the vehicle at the start of the route.
@@ -1129,6 +1440,22 @@ message Vehicle {
 
     // The acceptable load interval of the vehicle at the end of the route.
     Interval end_load_interval = 5;
+
+    // Cost of moving one unit of load over one kilometer for this vehicle.
+    // This can be used as a proxy for fuel consumption: if the load is a weight
+    // (in Newtons), then load*kilometer has the dimension of an energy.
+    //
+    // Experimental: See
+    // https://developers.google.com/maps/tt/route-optimization/experimental/load-cost/make-request
+    // for more details.
+    optional LoadCost cost_per_kilometer = 6;
+
+    // Cost of traveling with a unit of load during one hour for this vehicle.
+    //
+    // Experimental: See
+    // https://developers.google.com/maps/tt/route-optimization/experimental/load-cost/make-request
+    // for more details.
+    optional LoadCost cost_per_traveled_hour = 7;
   }
 
   // A limit defining a maximum duration of the route of a vehicle. It can be
@@ -1544,7 +1871,13 @@ message Waypoint {
     // heading.
     Location location = 1;
 
-    // The POI Place ID associated with the waypoint.
+    // The POI place ID associated with the waypoint.
+    //
+    // When using a place ID to specify arrival or departure location of a
+    // VisitRequest, use a place ID that is specific enough to determine a
+    // LatLng location for navigation to the place.
+    // For example, a place ID representing a building is suitable, but a place
+    // ID representing a road is discouraged.
     string place_id = 2;
   }
 
@@ -1555,6 +1888,13 @@ message Waypoint {
   // from the center of the road. This option doesn't work for the 'WALKING'
   // travel mode.
   bool side_of_road = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Indicates that the waypoint is meant for vehicles to stop at, where the
+  // intention is to either pick up or drop off. This option works only for the
+  // 'DRIVING' travel mode, and when the 'location_type' is 'location'.
+  //
+  // Experimental: This field's behavior or existence may change in future.
+  bool vehicle_stopover = 4;
 }
 
 // Encapsulates a location (a geographic point, and an optional heading).
@@ -1790,6 +2130,20 @@ message ShipmentRoute {
     // [VisitRequest.label][google.maps.routeoptimization.v1.Shipment.VisitRequest.label],
     // if specified in the `VisitRequest`.
     string visit_label = 8;
+
+    // An opaque token representing information about a visit location.
+    //
+    // This field may be populated in the result routes' visits when
+    // [VisitRequest.avoid_u_turns][google.maps.routeoptimization.v1.Shipment.VisitRequest.avoid_u_turns]
+    // was set to true for this visit or if
+    // [ShipmentModel.avoid_u_turns][google.maps.routeoptimization.v1.ShipmentModel.avoid_u_turns]
+    // was set to true in the request
+    // [OptimizeToursRequest][google.maps.routeoptimization.v1.OptimizeToursRequest].
+    //
+    // Experimental: See
+    // https://developers.google.com/maps/tt/route-optimization/experimental/u-turn-avoidance/make-request
+    // for more details.
+    optional int32 injected_solution_location_token = 13;
   }
 
   // Transition between two events on the route. See the description of
@@ -1963,6 +2317,16 @@ message ShipmentRoute {
   // depending on the context.
   AggregatedMetrics metrics = 12;
 
+  // [VehicleFullness][google.maps.routeoptimization.v1.VehicleFullness] field
+  // for computing how close the capped metrics are to their respective vehicle
+  // limits. Its fields are ratios between a capped metric field (e.g.
+  // [AggregatedMetrics.travel_distance_meters][google.maps.routeoptimization.v1.AggregatedMetrics.travel_distance_meters])
+  // and the related vehicle limit (e.g.
+  // [Vehicle.route_distance_limit][google.maps.routeoptimization.v1.Vehicle.route_distance_limit]).
+  //
+  // Experimental: This field's behavior or existence may change in future.
+  VehicleFullness vehicle_fullness = 20;
+
   // Cost of the route, broken down by cost-related request fields.
   // The keys are proto paths, relative to the input OptimizeToursRequest, e.g.
   // "model.shipments.pickups.cost", and the values are the total cost
@@ -2051,6 +2415,34 @@ message SkippedShipment {
       // The `allowed_vehicle_indices` field of the shipment is not empty and
       // this vehicle does not belong to it.
       VEHICLE_NOT_ALLOWED = 7;
+
+      // The vehicle's `ignore` field is true.
+      //
+      // Experimental: This field's behavior or existence may change in future.
+      VEHICLE_IGNORED = 8;
+
+      // The shipment's `ignore` field is true.
+      //
+      // Experimental: This field's behavior or existence may change in future.
+      SHIPMENT_IGNORED = 9;
+
+      // The shipment is skipped in the `injected_solution_constraint`.
+      //
+      // Experimental: This field's behavior or existence may change in future.
+      SKIPPED_IN_INJECTED_SOLUTION_CONSTRAINT = 10;
+
+      // The vehicle route relaxation specified in the
+      // `injected_solution_constraint` doesn't permit any visit to be inserted.
+      //
+      // Experimental: This field's behavior or existence may change in future.
+      VEHICLE_ROUTE_IS_FULLY_SEQUENCE_CONSTRAINED = 11;
+
+      // The shipment has a zero penalty cost. While this can be useful as an
+      // advanced modelling choice, it may also explain after the fact why a
+      // shipment was skipped.
+      //
+      // Experimental: This field's behavior or existence may change in future.
+      ZERO_PENALTY_COST = 13;
     }
 
     // Refer to the comments of Code.
@@ -2060,6 +2452,15 @@ message SkippedShipment {
     // field provides the index of one relevant vehicle.
     optional int32 example_vehicle_index = 2;
 
+    // Same as
+    // [example_vehicle_index][google.maps.routeoptimization.v1.SkippedShipment.Reason.example_vehicle_index]
+    // except that we provide the list of multiple identified vehicles. This
+    // list is not necessarily exhaustive. This is only filled if
+    // [fill_example_vehicle_indices_in_skipped_reasons][] is true.
+    //
+    // Experimental: This field's behavior or existence may change in future.
+    repeated int32 example_vehicle_indices = 5;
+
     // If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one
     // capacity type that is exceeded.
     string example_exceeded_capacity_type = 3;
@@ -2074,6 +2475,20 @@ message SkippedShipment {
   // specified in the `Shipment`.
   string label = 2;
 
+  // This is a copy of the
+  // [Shipment.penalty_cost][google.maps.routeoptimization.v1.Shipment.penalty_cost],
+  // included here to make it easier to see the severity of a skipped shipment.
+  //
+  // Experimental: This field's behavior or existence may change in future.
+  optional double penalty_cost = 6;
+
+  // Estimated ratio of vehicles that cannot perform this shipment for at least
+  // one of the reasons below.
+  // Note: this is only filled when reasons involve a vehicle.
+  //
+  // Experimental: This field's behavior or existence may change in future.
+  optional double estimated_incompatible_vehicle_ratio = 5;
+
   // A list of reasons that explain why the shipment was skipped. See comment
   // above `Reason`. If we are unable to understand why a shipment was skipped,
   // reasons will not be set.
@@ -2093,6 +2508,18 @@ message AggregatedMetrics {
   // counts once.
   int32 performed_shipment_count = 1;
 
+  // Number of mandatory shipments performed.
+  //
+  // Experimental: This field's behavior or existence may change in future.
+  optional int32 performed_mandatory_shipment_count = 12;
+
+  // The sum of the
+  // [Shipment.penalty_cost][google.maps.routeoptimization.v1.Shipment.penalty_cost]
+  // of the performed shipments.
+  //
+  // Experimental: This field's behavior or existence may change in future.
+  optional double performed_shipment_penalty_cost_sum = 13;
+
   // Total travel duration for a route or a solution.
   google.protobuf.Duration travel_duration = 2;
 
@@ -2129,6 +2556,63 @@ message AggregatedMetrics {
   map<string, ShipmentRoute.VehicleLoad> max_loads = 9;
 }
 
+// [VehicleFullness][google.maps.routeoptimization.v1.VehicleFullness] is a
+// metric which computes how full a vehicle is. Each
+// [VehicleFullness][google.maps.routeoptimization.v1.VehicleFullness] field is
+// between 0 and 1, computed as the ratio between a capped metric field (e.g.
+// [AggregatedMetrics.travel_distance_meters][google.maps.routeoptimization.v1.AggregatedMetrics.travel_distance_meters])
+// and its related vehicle limit (e.g.
+// [Vehicle.route_distance_limit][google.maps.routeoptimization.v1.Vehicle.route_distance_limit]),
+// if it exists. Otherwise the fullness ratio stays unset. If the limit is 0,
+// the field is set to 1. Note: when a route is subject to traffic
+// infeasibilities, some raw fullness ratios might exceed 1.0, e.g. the vehicle
+// might exceed its distance limit. In these cases, we cap the fullness values
+// at 1.0.
+message VehicleFullness {
+  // Maximum of all other fields in this message.
+  optional double max_fullness = 1;
+
+  // The ratio between
+  // [AggregatedMetrics.travel_distance_meters][google.maps.routeoptimization.v1.AggregatedMetrics.travel_distance_meters]
+  // and
+  // [Vehicle.route_distance_limit][google.maps.routeoptimization.v1.Vehicle.route_distance_limit].
+  // If
+  // [Vehicle.route_distance_limit][google.maps.routeoptimization.v1.Vehicle.route_distance_limit]
+  // is unset, this field will be unset.
+  optional double distance = 2;
+
+  // The ratio between [AggregatedMetrics.travel_duration_seconds][] and
+  // [Vehicle.travel_duration_limit][google.maps.routeoptimization.v1.Vehicle.travel_duration_limit].
+  // If
+  // [Vehicle.travel_duration_limit][google.maps.routeoptimization.v1.Vehicle.travel_duration_limit]
+  // is unset, this field will be unset.
+  optional double travel_duration = 3;
+
+  // The ratio between [AggregatedMetrics.total_duration_seconds][] and
+  // [Vehicle.route_duration_limit][google.maps.routeoptimization.v1.Vehicle.route_duration_limit].
+  // If
+  // [Vehicle.route_duration_limit][google.maps.routeoptimization.v1.Vehicle.route_duration_limit]
+  // is unset, this field will be unset.
+  optional double active_duration = 4;
+
+  // The maximum ratio among all types of [AggregatedMetrics.max_load][] and
+  // their respective
+  // [Vehicle.load_limits][google.maps.routeoptimization.v1.Vehicle.load_limits].
+  // If all
+  // [Vehicle.load_limits][google.maps.routeoptimization.v1.Vehicle.load_limits]
+  // fields are unset, this field will be unset.
+  optional double max_load = 5;
+
+  // The ratio (vehicle_end_time - vehicle_start_time) /
+  // (latest_vehicle_end_time - earliest_vehicle_start_time) for a given
+  // vehicle. If the denominator is not present, it uses
+  // ([ShipmentModel.global_end_time][google.maps.routeoptimization.v1.ShipmentModel.global_end_time]
+  // -
+  // [ShipmentModel.global_start_time][google.maps.routeoptimization.v1.ShipmentModel.global_start_time])
+  // instead.
+  optional double active_span = 6;
+}
+
 // Solution injected in the request including information about which visits
 // must be constrained and how they must be constrained.
 message InjectedSolutionConstraint {