@googlemaps/fleetengine 0.1.0

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

@@ -0,0 +1,331 @@
+// 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.v1;
+
+import "google/api/field_behavior.proto";
+import "google/maps/fleetengine/v1/traffic.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "google/type/latlng.proto";
+
+option csharp_namespace = "Google.Maps.FleetEngine.V1";
+option go_package = "cloud.google.com/go/maps/fleetengine/apiv1/fleetenginepb;fleetenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "FleetEngine";
+option java_package = "google.maps.fleetengine.v1";
+option objc_class_prefix = "CFE";
+
+// Identifies a terminal point.
+message TerminalPointId {
+  // Deprecated.
+  oneof Id {
+    // Deprecated.
+    string place_id = 2 [deprecated = true];
+
+    // Deprecated.
+    string generated_id = 3 [deprecated = true];
+  }
+
+  // Unique ID of the terminal point.
+  string value = 4;
+}
+
+// Describes the location of a waypoint.
+message TerminalLocation {
+  // Required. Denotes the location of a trip waypoint.
+  google.type.LatLng point = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // ID of the terminal point.
+  TerminalPointId terminal_point_id = 2;
+
+  // Deprecated.
+  string access_point_id = 3 [deprecated = true];
+
+  // Deprecated.
+  string trip_id = 4 [deprecated = true];
+
+  // Deprecated: `Vehicle.waypoint` will have this data.
+  WaypointType terminal_location_type = 5 [deprecated = true];
+}
+
+// Describes a stopping point on a vehicle's route or an ending point on a
+// vehicle's trip.
+message TripWaypoint {
+  // The location of this waypoint.
+  TerminalLocation location = 1;
+
+  // The trip associated with this waypoint.
+  string trip_id = 2;
+
+  // The role this waypoint plays in this trip, such as pickup or dropoff.
+  WaypointType waypoint_type = 3;
+
+  // The path from the previous waypoint to the current waypoint.  Undefined for
+  // the first waypoint in a list. This field is only populated when requested.
+  repeated google.type.LatLng path_to_waypoint = 4;
+
+  // The encoded path from the previous waypoint to the current waypoint.
+  //
+  // <p>Note: This field is intended only for use by the Driver SDK and Consumer
+  // SDK. Decoding is not yet supported.
+  string encoded_path_to_waypoint = 5;
+
+  // The traffic conditions along the path to this waypoint.  Note that traffic
+  // is only available for Google Map Platform Rides and Deliveries Solution
+  // customers.
+  ConsumableTrafficPolyline traffic_to_waypoint = 10;
+
+  // The path distance from the previous waypoint to the current waypoint.
+  // Undefined for the first waypoint in a list.
+  google.protobuf.Int32Value distance_meters = 6;
+
+  // The estimated time of arrival at this waypoint. Undefined for the first
+  // waypoint in a list.
+  google.protobuf.Timestamp eta = 7;
+
+  // The travel time from previous waypoint to this point. Undefined for the
+  // first waypoint in a list.
+  google.protobuf.Duration duration = 8;
+}
+
+// The type of a trip.
+enum TripType {
+  // Default, used for unspecified or unrecognized trip types.
+  UNKNOWN_TRIP_TYPE = 0;
+
+  // The trip may share a vehicle with other trips.
+  SHARED = 1;
+
+  // The trip is exclusive to a vehicle.
+  EXCLUSIVE = 2;
+}
+
+// The type of waypoint.
+enum WaypointType {
+  // Unknown or unspecified waypoint type.
+  UNKNOWN_WAYPOINT_TYPE = 0;
+
+  // Waypoints for picking up riders or items.
+  PICKUP_WAYPOINT_TYPE = 1;
+
+  // Waypoints for dropping off riders or items.
+  DROP_OFF_WAYPOINT_TYPE = 2;
+
+  // Waypoints for intermediate destinations in a multi-destination trip.
+  INTERMEDIATE_DESTINATION_WAYPOINT_TYPE = 3;
+}
+
+// The type of polyline format.
+enum PolylineFormatType {
+  // The format is unspecified or unknown.
+  UNKNOWN_FORMAT_TYPE = 0;
+
+  // A list of `google.type.LatLng`.
+  LAT_LNG_LIST_TYPE = 1;
+
+  // A polyline encoded with a polyline compression algorithm. Decoding is not
+  // yet supported.
+  ENCODED_POLYLINE_TYPE = 2;
+}
+
+// The vehicle's navigation status.
+enum NavigationStatus {
+  // Unspecified navigation status.
+  UNKNOWN_NAVIGATION_STATUS = 0;
+
+  // The Driver app's navigation is in `FREE_NAV` mode.
+  NO_GUIDANCE = 1;
+
+  // Turn-by-turn navigation is available and the Driver app navigation has
+  // entered `GUIDED_NAV` mode.
+  ENROUTE_TO_DESTINATION = 2;
+
+  // The vehicle has gone off the suggested route.
+  OFF_ROUTE = 3;
+
+  // The vehicle is within approximately 50m of the destination.
+  ARRIVED_AT_DESTINATION = 4;
+}
+
+// Describes a vehicle attribute as a key-value pair. The "key:value" string
+// length cannot exceed 256 characters.
+message VehicleAttribute {
+  // The attribute's key. Keys may not contain the colon character (:).
+  string key = 1;
+
+  // The attribute's value.
+  string value = 2;
+
+  // The attribute's value, can be in string, bool, or double type.
+  oneof vehicle_attribute_value {
+    // String typed attribute value.
+    //
+    // Note: This is identical to the `value` field which will eventually be
+    // deprecated. For create or update methods, either field can be used, but
+    // it's strongly recommended to use `string_value`. If both `string_value`
+    // and `value` are set, they must be identical or an error will be thrown.
+    // Both fields are populated in responses.
+    string string_value = 3;
+
+    // Boolean typed attribute value.
+    bool bool_value = 4;
+
+    // Double typed attribute value.
+    double number_value = 5;
+  }
+}
+
+// The location, speed, and heading of a vehicle at a point in time.
+message VehicleLocation {
+  // The location of the vehicle.
+  // When it is sent to Fleet Engine, the vehicle's location is a GPS location.
+  // When you receive it in a response, the vehicle's location can be either a
+  // GPS location, a supplemental location, or some other estimated location.
+  // The source is specified in `location_sensor`.
+  google.type.LatLng location = 1;
+
+  // Deprecated: Use `latlng_accuracy` instead.
+  google.protobuf.DoubleValue horizontal_accuracy = 8 [deprecated = true];
+
+  // Accuracy of `location` in meters as a radius.
+  google.protobuf.DoubleValue latlng_accuracy = 22;
+
+  // Direction the vehicle is moving in degrees.  0 represents North.
+  // The valid range is [0,360).
+  google.protobuf.Int32Value heading = 2;
+
+  // Deprecated: Use `heading_accuracy` instead.
+  google.protobuf.DoubleValue bearing_accuracy = 10 [deprecated = true];
+
+  // Accuracy of `heading` in degrees.
+  google.protobuf.DoubleValue heading_accuracy = 23;
+
+  // Altitude in meters above WGS84.
+  google.protobuf.DoubleValue altitude = 5;
+
+  // Deprecated: Use `altitude_accuracy` instead.
+  google.protobuf.DoubleValue vertical_accuracy = 9 [deprecated = true];
+
+  // Accuracy of `altitude` in meters.
+  google.protobuf.DoubleValue altitude_accuracy = 24;
+
+  // Speed of the vehicle in kilometers per hour.
+  // Deprecated: Use `speed` instead.
+  google.protobuf.Int32Value speed_kmph = 3 [deprecated = true];
+
+  // Speed of the vehicle in meters/second
+  google.protobuf.DoubleValue speed = 6;
+
+  // Accuracy of `speed` in meters/second.
+  google.protobuf.DoubleValue speed_accuracy = 7;
+
+  // The time when `location` was reported by the sensor according to the
+  // sensor's clock.
+  google.protobuf.Timestamp update_time = 4;
+
+  // Output only. The time when the server received the location information.
+  google.protobuf.Timestamp server_time = 13
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Provider of location data (for example, `GPS`).
+  LocationSensor location_sensor = 11;
+
+  // Whether `location` is snapped to a road.
+  google.protobuf.BoolValue is_road_snapped = 27;
+
+  // Input only. Indicates whether the GPS sensor is enabled on the mobile
+  // device.
+  google.protobuf.BoolValue is_gps_sensor_enabled = 12
+      [(google.api.field_behavior) = INPUT_ONLY];
+
+  // Input only. Time (in seconds) since this location was first sent to the
+  // server. This will be zero for the first update. If the time is unknown (for
+  // example, when the app restarts), this value resets to zero.
+  google.protobuf.Int32Value time_since_update = 14
+      [(google.api.field_behavior) = INPUT_ONLY];
+
+  // Input only. Deprecated: Other signals are now used to determine if a
+  // location is stale.
+  google.protobuf.Int32Value num_stale_updates = 15
+      [deprecated = true, (google.api.field_behavior) = INPUT_ONLY];
+
+  // Raw vehicle location (unprocessed by road-snapper).
+  google.type.LatLng raw_location = 16;
+
+  // Timestamp associated with the raw location.
+  google.protobuf.Timestamp raw_location_time = 17;
+
+  // Source of the raw location. Defaults to `GPS`.
+  LocationSensor raw_location_sensor = 28;
+
+  // Accuracy of `raw_location` as a radius, in meters.
+  google.protobuf.DoubleValue raw_location_accuracy = 25;
+
+  // Supplemental location provided by the integrating app.
+  google.type.LatLng supplemental_location = 18;
+
+  // Timestamp associated with the supplemental location.
+  google.protobuf.Timestamp supplemental_location_time = 19;
+
+  // Source of the supplemental location. Defaults to
+  // `CUSTOMER_SUPPLIED_LOCATION`.
+  LocationSensor supplemental_location_sensor = 20;
+
+  // Accuracy of `supplemental_location` as a radius, in meters.
+  google.protobuf.DoubleValue supplemental_location_accuracy = 21;
+
+  // Deprecated: Use `is_road_snapped` instead.
+  bool road_snapped = 26 [deprecated = true];
+}
+
+// The sensor or methodology used to determine the location.
+enum LocationSensor {
+  // The sensor is unspecified or unknown.
+  UNKNOWN_SENSOR = 0;
+
+  // GPS or Assisted GPS.
+  GPS = 1;
+
+  // Assisted GPS, cell tower ID, or WiFi access point.
+  NETWORK = 2;
+
+  // Cell tower ID or WiFi access point.
+  PASSIVE = 3;
+
+  // A location determined by the mobile device to be the most likely
+  // road position.
+  ROAD_SNAPPED_LOCATION_PROVIDER = 4;
+
+  // A customer-supplied location from an independent source.  Typically, this
+  // value is used for a location provided from sources other than the mobile
+  // device running Driver SDK.  If the original source is described by one of
+  // the other enum values, use that value. Locations marked
+  // CUSTOMER_SUPPLIED_LOCATION are typically provided via a Vehicle's
+  // `last_location.supplemental_location_sensor`.
+  CUSTOMER_SUPPLIED_LOCATION = 5;
+
+  // A location calculated by Fleet Engine based on the signals available to it.
+  // Output only. This value will be rejected if it is received in a request.
+  FLEET_ENGINE_LOCATION = 6;
+
+  // Android's Fused Location Provider.
+  FUSED_LOCATION_PROVIDER = 100;
+
+  // The location provider on Apple operating systems.
+  CORE_LOCATION = 200;
+}

package/build/protos/google/maps/fleetengine/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.v1;
+
+import "google/api/field_behavior.proto";
+
+option csharp_namespace = "Google.Maps.FleetEngine.V1";
+option go_package = "cloud.google.com/go/maps/fleetengine/apiv1/fleetenginepb;fleetenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "Headers";
+option java_package = "google.maps.fleetengine.v1";
+option objc_class_prefix = "CFE";
+
+// A RequestHeader contains fields common to all Fleet Engine RPC requests.
+message RequestHeader {
+  // 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/v1/traffic.proto

@@ -0,0 +1,68 @@
+// 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.v1;
+
+option csharp_namespace = "Google.Maps.FleetEngine.V1";
+option go_package = "cloud.google.com/go/maps/fleetengine/apiv1/fleetenginepb;fleetenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "TrafficProto";
+option java_package = "google.maps.fleetengine.v1";
+option objc_class_prefix = "CFE";
+
+// Traffic density indicator on a contiguous segment of a path. Given a path
+// with points P_0, P_1, ... , P_N (zero-based index), the SpeedReadingInterval
+// defines an interval and describes its traffic using the following categories.
+message SpeedReadingInterval {
+  // The classification of polyline speed based on traffic data.
+  enum Speed {
+    // Default value. This value is unused.
+    SPEED_UNSPECIFIED = 0;
+
+    // Normal speed, no slowdown is detected.
+    NORMAL = 1;
+
+    // Slowdown detected, but no traffic jam formed.
+    SLOW = 2;
+
+    // Traffic jam detected.
+    TRAFFIC_JAM = 3;
+  }
+
+  // The starting index of this interval in the path.
+  // In JSON, when the index is 0, the field will appear to be unpopulated.
+  int32 start_polyline_point_index = 1;
+
+  // The ending index of this interval in the path.
+  // In JSON, when the index is 0, the field will appear to be unpopulated.
+  int32 end_polyline_point_index = 2;
+
+  // Traffic speed in this interval.
+  Speed speed = 3;
+}
+
+// Traffic density along a Vehicle's path.
+message ConsumableTrafficPolyline {
+  // Traffic speed along the path from the previous waypoint to the current
+  // waypoint.
+  repeated SpeedReadingInterval speed_reading_interval = 1;
+
+  // The path the driver is taking from the previous waypoint to the current
+  // waypoint. This path has landmarks in it so clients can show traffic markers
+  // along the path (see `speed_reading_interval`).  Decoding is not yet
+  // supported.
+  string encoded_path_to_waypoint = 2;
+}