@googlemaps/fleetengine-delivery 0.1.0

package/build/protos/google/maps/fleetengine/delivery/v1/delivery_vehicles.proto

@@ -0,0 +1,269 @@
+// 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 maps.fleetengine.delivery.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/maps/fleetengine/delivery/v1/common.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/wrappers.proto";
+import "google/type/latlng.proto";
+
+option csharp_namespace = "Google.Maps.FleetEngine.Delivery.V1";
+option go_package = "cloud.google.com/go/maps/fleetengine/delivery/apiv1/deliverypb;deliverypb";
+option java_multiple_files = true;
+option java_outer_classname = "DeliveryVehicles";
+option java_package = "google.maps.fleetengine.delivery.v1";
+option objc_class_prefix = "CFED";
+
+// The `DeliveryVehicle` message. A delivery vehicle transports shipments from a
+// depot to a delivery location, and from a pickup location to the depot. In
+// some cases, delivery vehicles also transport shipments directly from the
+// pickup location to the delivery location.
+//
+// Note: gRPC and REST APIs use different field naming conventions. For example,
+// the `DeliveryVehicle.current_route_segment` field in the gRPC API and the
+// `DeliveryVehicle.currentRouteSegment` field in the REST API refer to the same
+// field.
+message DeliveryVehicle {
+  option (google.api.resource) = {
+    type: "fleetengine.googleapis.com/DeliveryVehicle"
+    pattern: "providers/{provider}/deliveryVehicles/{vehicle}"
+  };
+
+  // The type of delivery vehicle.
+  enum DeliveryVehicleType {
+    // The value is unused.
+    DELIVERY_VEHICLE_TYPE_UNSPECIFIED = 0;
+
+    // An automobile.
+    AUTO = 1;
+
+    // A motorcycle, moped, or other two-wheeled vehicle
+    TWO_WHEELER = 2;
+
+    // Human-powered transport.
+    BICYCLE = 3;
+
+    // A human transporter, typically walking or running, traveling along
+    // pedestrian pathways.
+    PEDESTRIAN = 4;
+  }
+
+  // The unique name of this Delivery Vehicle.
+  // The format is `providers/{provider}/deliveryVehicles/{vehicle}`.
+  string name = 1;
+
+  // The last reported location of the Delivery Vehicle.
+  DeliveryVehicleLocation last_location = 2;
+
+  // The Delivery Vehicle's navigation status.
+  DeliveryVehicleNavigationStatus navigation_status = 3;
+
+  // The encoded polyline specifying the route that the navigation recommends
+  // taking to the next waypoint. Your driver app updates this when a
+  // stop is reached or passed, and when the navigation reroutes. These
+  // `LatLng`s are returned in
+  // `Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path`
+  // (gRPC) or `Task.journeySharingInfo.remainingVehicleJourneySegments[0].path`
+  // (REST) for all active Tasks assigned to the Vehicle.
+  //
+  // There are a few cases where this field might not be used to populate
+  // `Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path`
+  // (gRPC) or `Task.journeySharingInfo.remainingVehicleJourneySegments[0].path`
+  // (REST):
+  //
+  // * The endpoint of the `current_route_segment` does not match
+  // `DeliveryVehicle.remaining_vehicle_journey_segments[0].stop` (gRPC) or
+  // `DeliveryVehicle.remainingVehicleJourneySegments[0].stop` (REST).
+  //
+  // * The driver app has not updated its location recently, so the last
+  // updated value for this field might be stale.
+  //
+  // * The driver app has recently updated its location, but the
+  // `current_route_segment` is stale, and points to a previous vehicle stop.
+  //
+  // In these cases, Fleet Engine populates this field with a route from the
+  // most recently passed VehicleStop to the upcoming VehicleStop to ensure that
+  // the consumer of this field has the best available information on the
+  // current path of the Delivery Vehicle.
+  bytes current_route_segment = 4;
+
+  // The location where the `current_route_segment` ends. This is not currently
+  // populated by the driver app, but you can supply it on
+  // `UpdateDeliveryVehicle` calls. It is either the `LatLng` from the upcoming
+  // vehicle stop, or the last `LatLng` of the `current_route_segment`. Fleet
+  // Engine will then do its best to interpolate to an actual `VehicleStop`.
+  //
+  // This field is ignored in `UpdateDeliveryVehicle` calls if the
+  // `current_route_segment` field is empty.
+  google.type.LatLng current_route_segment_end_point = 5;
+
+  // The remaining driving distance for the `current_route_segment`.
+  // The Driver app typically provides this field, but there are some
+  // circumstances in which Fleet Engine will override the value sent by the
+  // app. For more information, see
+  // [DeliveryVehicle.current_route_segment][maps.fleetengine.delivery.v1.DeliveryVehicle.current_route_segment].
+  // This field is returned in
+  // `Task.remaining_vehicle_journey_segments[0].driving_distance_meters` (gRPC)
+  // or `Task.remainingVehicleJourneySegments[0].drivingDistanceMeters` (REST)
+  // for all active `Task`s assigned to the Delivery Vehicle.
+  //
+  // Fleet Engine ignores this field in `UpdateDeliveryVehicleRequest` if the
+  // `current_route_segment` field is empty.
+  google.protobuf.Int32Value remaining_distance_meters = 6;
+
+  // The remaining driving time for the `current_route_segment`.
+  // The Driver app typically provides this field, but there are some
+  // circumstances in which Fleet Engine will override the value sent by the
+  // app.  For more information, see
+  // [DeliveryVehicle.current_route_segment][maps.fleetengine.delivery.v1.DeliveryVehicle.current_route_segment].
+  // This field is returned in
+  // `Task.remaining_vehicle_journey_segments[0].driving_duration` (gRPC) or
+  // `Task.remainingVehicleJourneySegments[0].drivingDuration` (REST) for all
+  // active tasks assigned to the Delivery Vehicle.
+  //
+  // Fleet Engine ignores this field in `UpdateDeliveryVehicleRequest` if the
+  // `current_route_segment` field is empty.
+  google.protobuf.Duration remaining_duration = 7;
+
+  // The journey segments assigned to this Delivery Vehicle, starting from the
+  // Vehicle's most recently reported location. This field won't be populated
+  // in the response of `ListDeliveryVehicles`.
+  repeated VehicleJourneySegment remaining_vehicle_journey_segments = 8;
+
+  // A list of custom Delivery Vehicle attributes. A Delivery Vehicle can have
+  // at most 100 attributes, and each attribute must have a unique key.
+  repeated DeliveryVehicleAttribute attributes = 9;
+
+  // The type of this delivery vehicle. If unset, this will default to `AUTO`.
+  DeliveryVehicleType type = 10;
+}
+
+// A location with any additional identifiers.
+message LocationInfo {
+  // The location's coordinates.
+  google.type.LatLng point = 1;
+}
+
+// Represents a Vehicle’s travel segment - from its previous stop to the
+// current stop. If it is the first active stop, then it is from the
+// Vehicle’s current location to this stop.
+message VehicleJourneySegment {
+  // Specifies the stop location, along with the `Task`s associated with
+  // the stop. Some fields of the VehicleStop might not be present if this
+  // journey segment is part of `JourneySharingInfo`.
+  VehicleStop stop = 1;
+
+  // Output only. The travel distance from the previous stop to this stop.
+  // If the current stop is the first stop in the list of journey
+  // segments, then the starting point is the vehicle's location recorded
+  // at the time that this stop was added to the list. This field might not be
+  // present if this journey segment is part of `JourneySharingInfo`.
+  google.protobuf.Int32Value driving_distance_meters = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The travel time from the previous stop to this stop.
+  // If the current stop is the first stop in the list of journey
+  // segments, then the starting point is the Vehicle's location recorded
+  // at the time that this stop was added to the list.
+  //
+  // If this field is defined in the path
+  // `Task.remaining_vehicle_journey_segments[0].driving_duration` (gRPC) or
+  // `Task.remainingVehicleJourneySegments[0].drivingDuration` (REST),
+  // then it may be populated with the value from
+  // `DeliveryVehicle.remaining_duration` (gRPC) or
+  // `DeliveryVehicle.remainingDuration` (REST).
+  // This provides the remaining driving duration from the driver app's latest
+  // known location rather than the driving time from the previous stop.
+  google.protobuf.Duration driving_duration = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The path from the previous stop to this stop. If the current
+  // stop is the first stop in the list of journey segments, then this is the
+  // path from the vehicle's current location to this stop at the time that the
+  // stop was added to the list. This field might not be present if this journey
+  // segment is part of `JourneySharingInfo`.
+  //
+  // If this field is defined in the path
+  // `Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path`
+  // (gRPC) or `Task.journeySharingInfo.remainingVehicleJourneySegments[0].path`
+  // (REST), then it may be populated with the `LatLng`s decoded from
+  // `DeliveryVehicle.current_route_segment` (gRPC) or
+  // `DeliveryVehicle.currentRouteSegment` (REST). This provides the driving
+  // path from the driver app's latest known location rather than the path from
+  // the previous stop.
+  repeated google.type.LatLng path = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Describes a point where a Vehicle stops to perform one or more `Task`s.
+message VehicleStop {
+  // Additional information about the Task performed at this stop.
+  message TaskInfo {
+    // The Task ID. This field won't be populated in the response of either a
+    // `GetTask`, or a `SearchTasks` call. Task IDs are subject to the following
+    // restrictions:
+    //
+    // * Must be a valid Unicode string.
+    // * Limited to a maximum length of 64 characters.
+    // * Normalized according to [Unicode Normalization Form C]
+    // (http://www.unicode.org/reports/tr15/).
+    // * May not contain any of the following ASCII characters: '/', ':', '?',
+    // ',', or '#'.
+    string task_id = 1;
+
+    // Output only. The time required to perform the Task.
+    google.protobuf.Duration task_duration = 2
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The time window during which the task should be completed.
+    // This is only set in the response to `GetDeliveryVehicle`.
+    TimeWindow target_time_window = 3
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // The current state of a `VehicleStop`.
+  enum State {
+    // Unknown.
+    STATE_UNSPECIFIED = 0;
+
+    // Created, but not actively routing.
+    NEW = 1;
+
+    // Assigned and actively routing.
+    ENROUTE = 2;
+
+    // Arrived at stop. Assumes that when the Vehicle is routing to the next
+    // stop, that all previous stops have been completed.
+    ARRIVED = 3;
+  }
+
+  // Required. The location of the stop. Note that the locations in the `Task`s
+  // might not exactly match this location, but will be within a short distance
+  // of it. This field won't be populated in the response of either a `GetTask`,
+  // or a `SearchTasks` call.
+  LocationInfo planned_location = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // The list of `Task`s to be performed at this stop. This field won't be
+  // populated in the response of either a `GetTask` or `SearchTasks` call.
+  repeated TaskInfo tasks = 2;
+
+  // The state of the `VehicleStop`. This field won't be populated in the
+  // response of either a `GetTask`, or a `SearchTasks` call.
+  State state = 3;
+}

package/build/protos/google/maps/fleetengine/delivery/v1/header.proto

@@ -0,0 +1,108 @@
+// 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 maps.fleetengine.delivery.v1;
+
+import "google/api/field_behavior.proto";
+
+option csharp_namespace = "Google.Maps.FleetEngine.Delivery.V1";
+option go_package = "cloud.google.com/go/maps/fleetengine/delivery/apiv1/deliverypb;deliverypb";
+option java_multiple_files = true;
+option java_outer_classname = "Headers";
+option java_package = "google.maps.fleetengine.delivery.v1";
+option objc_class_prefix = "CFED";
+
+// A RequestHeader contains fields common to all Delivery RPC requests.
+message DeliveryRequestHeader {
+  // Possible types of SDK.
+  enum SdkType {
+    // The default value. This value is used if the `sdk_type` is omitted.
+    SDK_TYPE_UNSPECIFIED = 0;
+
+    // The calling SDK is Consumer.
+    CONSUMER = 1;
+
+    // The calling SDK is Driver.
+    DRIVER = 2;
+
+    // The calling SDK is JavaScript.
+    JAVASCRIPT = 3;
+  }
+
+  // The platform of the calling SDK.
+  enum Platform {
+    // The default value. This value is used if the platform is omitted.
+    PLATFORM_UNSPECIFIED = 0;
+
+    // The request is coming from Android.
+    ANDROID = 1;
+
+    // The request is coming from iOS.
+    IOS = 2;
+
+    // The request is coming from the web.
+    WEB = 3;
+  }
+
+  // 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. If none
+  // is specified, the response may be in any language, with a preference for
+  // English if such a name exists. Field value example: `en-US`.
+  string language_code = 1;
+
+  // Required. CLDR region code of the region where the request originates.
+  // Field value example: `US`.
+  string region_code = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Version of the calling SDK, if applicable.
+  // The version format is "major.minor.patch", example: `1.1.2`.
+  string sdk_version = 3;
+
+  // Version of the operating system on which the calling SDK is running.
+  // Field value examples: `4.4.1`, `12.1`.
+  string os_version = 4;
+
+  // Model of the device on which the calling SDK is running.
+  // Field value examples: `iPhone12,1`, `SM-G920F`.
+  string device_model = 5;
+
+  // The type of SDK sending the request.
+  SdkType sdk_type = 6;
+
+  // Version of the MapSDK which the calling SDK depends on, if applicable.
+  // The version format is "major.minor.patch", example: `5.2.1`.
+  string maps_sdk_version = 7;
+
+  // Version of the NavSDK which the calling SDK depends on, if applicable.
+  // The version format is "major.minor.patch", example: `2.1.0`.
+  string nav_sdk_version = 8;
+
+  // Platform of the calling SDK.
+  Platform platform = 9;
+
+  // Manufacturer of the Android device from the calling SDK, only applicable
+  // for the Android SDKs.
+  // Field value example: `Samsung`.
+  string manufacturer = 10;
+
+  // Android API level of the calling SDK, only applicable for the Android SDKs.
+  // Field value example: `23`.
+  int32 android_api_level = 11;
+
+  // Optional ID that can be provided for logging purposes in order to identify
+  // the request.
+  string trace_id = 12;
+}

package/build/protos/google/maps/fleetengine/delivery/v1/task_tracking_info.proto

@@ -0,0 +1,98 @@
+// 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 maps.fleetengine.delivery.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/maps/fleetengine/delivery/v1/common.proto";
+import "google/maps/fleetengine/delivery/v1/delivery_vehicles.proto";
+import "google/maps/fleetengine/delivery/v1/tasks.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "google/type/latlng.proto";
+
+option csharp_namespace = "Google.Maps.FleetEngine.Delivery.V1";
+option go_package = "cloud.google.com/go/maps/fleetengine/delivery/apiv1/deliverypb;deliverypb";
+option java_multiple_files = true;
+option java_outer_classname = "TaskTrackingInfoProto";
+option java_package = "google.maps.fleetengine.delivery.v1";
+option objc_class_prefix = "CFED";
+
+// The `TaskTrackingInfo` message. The message contains task tracking
+// information which will be used for display. If a tracking ID is associated
+// with multiple Tasks, Fleet Engine uses a heuristic to decide which Task's
+// TaskTrackingInfo to select.
+message TaskTrackingInfo {
+  option (google.api.resource) = {
+    type: "fleetengine.googleapis.com/TaskTrackingInfo"
+    pattern: "providers/{provider}/taskTrackingInfo/{tracking}"
+  };
+
+  // Must be in the format `providers/{provider}/taskTrackingInfo/{tracking}`,
+  // where `tracking` represents the tracking ID.
+  string name = 1;
+
+  // Immutable. The tracking ID of a Task.
+  // * Must be a valid Unicode string.
+  // * Limited to a maximum length of 64 characters.
+  // * Normalized according to [Unicode Normalization Form C]
+  // (http://www.unicode.org/reports/tr15/).
+  // * May not contain any of the following ASCII characters: '/', ':', '?',
+  // ',', or '#'.
+  string tracking_id = 2 [(google.api.field_behavior) = IMMUTABLE];
+
+  // The vehicle's last location.
+  DeliveryVehicleLocation vehicle_location = 3;
+
+  // A list of points which when connected forms a polyline of the vehicle's
+  // expected route to the location of this task.
+  repeated google.type.LatLng route_polyline_points = 4;
+
+  // Indicates the number of stops the vehicle remaining until the task stop is
+  // reached, including the task stop. For example, if the vehicle's next stop
+  // is the task stop, the value will be 1.
+  google.protobuf.Int32Value remaining_stop_count = 5;
+
+  // The total remaining distance in meters to the `VehicleStop` of interest.
+  google.protobuf.Int32Value remaining_driving_distance_meters = 6;
+
+  // The timestamp that indicates the estimated arrival time to the stop
+  // location.
+  google.protobuf.Timestamp estimated_arrival_time = 7;
+
+  // The timestamp that indicates the estimated completion time of a Task.
+  google.protobuf.Timestamp estimated_task_completion_time = 8;
+
+  // The current execution state of the Task.
+  Task.State state = 11;
+
+  // The outcome of attempting to execute a Task.
+  Task.TaskOutcome task_outcome = 9;
+
+  // The timestamp that indicates when the Task's outcome was set by the
+  // provider.
+  google.protobuf.Timestamp task_outcome_time = 12;
+
+  // Immutable. The location where the Task will be completed.
+  LocationInfo planned_location = 10 [(google.api.field_behavior) = IMMUTABLE];
+
+  // The time window during which the task should be completed.
+  TimeWindow target_time_window = 13;
+
+  // The custom attributes set on the task.
+  repeated TaskAttribute attributes = 14;
+}