Package maps.fleetengine.v1

Índice

TripService

Servicio de administración de viajes.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Crea un viaje en Fleet Engine y devuelve el viaje nuevo.

GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Obtener información sobre un solo viaje

ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

Informa el uso de viajes facturables.

SearchTrips

rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse)

Obtén todos los viajes para un vehículo específico.

UpdateTrip

rpc UpdateTrip(UpdateTripRequest) returns (Trip)

Actualiza los datos de viajes.

VehicleService

Servicio de administración de vehículos.

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

Crea una instancia de un nuevo vehículo asociado con un proveedor de transporte compartido o entregas a pedido. Cada Vehicle debe tener un ID de vehículo único.

Los siguientes campos de Vehicle son obligatorios cuando se crea un Vehicle:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Los siguientes campos Vehicle se ignoran cuando se crea un Vehicle:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

Todos los demás campos son opcionales y se usarán si se proporcionan.

GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

Muestra un vehículo de Fleet Engine.

ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

Muestra una lista paginada de vehículos asociados con un proveedor que coinciden con las opciones de solicitud.

SearchFuzzedVehicles

rpc SearchFuzzedVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

Obsoleto: usa SearchVehicles en su lugar.

SearchVehicles

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

Muestra una lista de vehículos que coinciden con las opciones de solicitud.

UpdateVehicle

rpc UpdateVehicle(UpdateVehicleRequest) returns (Vehicle)

Escribe datos de vehículos actualizados en Fleet Engine.

Cuando actualizas un Vehicle, los siguientes campos no se pueden actualizar, ya que los administra el servidor:

  • currentTrips
  • availableCapacity
  • current_route_segment_version
  • waypoints_version

Tampoco se puede actualizar el vehículo name.

Si se actualiza el campo attributes, se reemplazarán todos los atributos del vehículo por los atributos proporcionados en la solicitud. Si solo quieres actualizar algunos atributos, consulta el método UpdateVehicleAttributes. Del mismo modo, el campo waypoints se puede actualizar, pero debe contener todos los puntos de referencia que se encuentren actualmente en el vehículo y no otros.

UpdateVehicleAttributes

rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse)

Actualiza parcialmente los atributos de un vehículo. Solo se actualizarán los atributos mencionados en la solicitud. Los demás atributos NO se modificarán. Nota: Esto es diferente en UpdateVehicle, ya que todo el campo attributes se reemplazará por el de UpdateVehicleRequest y se quitarán los atributos que no estén en la solicitud.

BatteryInfo

Información sobre la batería del dispositivo.

Campos
battery_status

BatteryStatus

Estado de la batería, ya sea completa o cargando, etc.

power_source

PowerSource

Estado de la fuente de alimentación de la batería

battery_percentage

float

Porcentaje actual de batería [0-100].

BatteryStatus

Estado de la batería, ya sea completa o cargando, etc.

Enumeradores
UNKNOWN_BATTERY_STATUS Se desconoce el estado de la batería.
BATTERY_STATUS_CHARGING Se está cargando la batería.
BATTERY_STATUS_DISCHARGING Se está descargando la batería.
BATTERY_STATUS_FULL La batería está completa.
BATTERY_STATUS_NOT_CHARGING La batería no se está cargando.
BATTERY_STATUS_POWER_LOW La batería tiene poca carga.

BillingPlatformIdentifier

Un conjunto de valores que indican desde qué plataforma se emitió la solicitud.

Enumeradores
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED Predeterminado. Se usa en plataformas no especificadas.
SERVER La plataforma es un servidor cliente.
WEB La plataforma es un navegador web.
ANDROID La plataforma es un dispositivo móvil Android.
IOS La plataforma es un dispositivo móvil iOS.
OTHERS Otras plataformas que no se mencionan en esta enumeración.

ConsumableTrafficPolyline

Densidad de tráfico a lo largo de la ruta de un vehículo.

Campos
speed_reading_interval[]

SpeedReadingInterval

Velocidad del tráfico a lo largo de la ruta desde el punto de referencia anterior hasta el punto de referencia actual.

encoded_path_to_waypoint

string

La ruta que toma el conductor desde el punto de referencia anterior hasta el punto de referencia actual. Esta ruta incluye puntos de referencia para que los clientes puedan mostrar marcadores de tráfico a lo largo de ella (consulta speed_reading_interval). Aún no se admite la decodificación.

CreateTripRequest

mensaje de solicitud CreateTrip.

Campos
header

RequestHeader

El encabezado de la solicitud estándar de Fleet Engine.

parent

string

Obligatorio. Debe tener el formato providers/{provider}. El proveedor debe ser el ID del proyecto (por ejemplo, sample-cloud-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

trip_id

string

Obligatorio. ID de viaje único. Sujeto a las siguientes restricciones:

  • Debe ser una string Unicode válida.
  • Tiene una longitud máxima de 64 caracteres.
  • Se normalizó según el Formulario de normalización C de Unicode.
  • No puede contener ninguno de los siguientes caracteres ASCII: “/”, “:”, “?”, “,” o '#'.
trip

Trip

Obligatorio. Entidad de viaje que se creará.

Cuando se crea un viaje, se deben completar los siguientes campos:

  • trip_type
  • pickup_point

Se usarán los siguientes campos si los proporcionas:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

Se ignorarán todos los demás campos de Viaje. Por ejemplo, todos los viajes comienzan con un trip_status de NEW, incluso si pasas un trip_status de CANCELED en la solicitud de creación.

Solo los viajes a EXCLUSIVE admiten intermediate_destinations.

Cuando estableces vehicle_id para un viaje compartido, debes proporcionar la lista de Trip.vehicle_waypoints para especificar el orden de los puntos de referencia restantes para el vehículo. De lo contrario, no se determinará el orden de los puntos de referencia.

Cuando especificas Trip.vehicle_waypoints, la lista debe contener todos los puntos de referencia restantes de los viajes del vehículo, sin puntos de referencia adicionales. Debes ordenar estos puntos de referencia de modo que, para un viaje determinado, el punto de partida sea anterior a los destinos intermedios y todos los destinos intermedios aparezcan antes del punto de llegada. Los puntos de referencia de un viaje EXCLUSIVE no deben intercalarse con ningún otro viaje.

Se utilizan los campos trip_id, waypoint_type y location, y se ignoran todos los demás campos de TripWaypoint en vehicle_waypoints.

CreateVehicleRequest

Mensaje de solicitud de CreateVehicle.

Campos
header

RequestHeader

El encabezado de la solicitud estándar de Fleet Engine.

parent

string

Obligatorio. Debe tener el formato providers/{provider}. El proveedor debe ser el ID del proyecto (por ejemplo, sample-cloud-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

vehicle_id

string

Obligatorio. ID de vehículo único. Sujeto a las siguientes restricciones:

  • Debe ser una string Unicode válida.
  • Tiene una longitud máxima de 64 caracteres.
  • Se normalizó según el Formulario de normalización C de Unicode.
  • No puede contener ninguno de los siguientes caracteres ASCII: “/”, “:”, “?”, “,” o '#'.
vehicle

Vehicle

Obligatorio. La entidad vehículo que se creará. Cuando se crea un vehículo, se deben completar los siguientes campos:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Cuando creas un vehículo, se ignoran los siguientes campos:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

Todos los demás campos son opcionales y se usarán si se proporcionan.

DeviceSettings

Información sobre los distintos parámetros de configuración del dispositivo móvil.

Campos
location_power_save_mode

LocationPowerSaveMode

Cómo están configuradas las funciones de ubicación para que se comporten en el dispositivo cuando el ahorro de batería está activado.

is_power_save_mode

bool

Indica si el dispositivo está actualmente en el modo de ahorro de energía.

is_interactive

bool

Indica si el dispositivo está en estado interactivo.

battery_info

BatteryInfo

Información sobre el estado de la batería.

GetTripRequest

mensaje de solicitud GetTrip.

Campos
header

RequestHeader

El encabezado de la solicitud estándar de Fleet Engine.

name

string

Obligatorio. Debe tener el formato providers/{provider}/trips/{trip}. El proveedor debe ser el ID del proyecto (por ejemplo, sample-cloud-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

view

TripView

El subconjunto de campos de viaje que se deben mostrar y su interpretación.

current_route_segment_version

Timestamp

Indica la marca de tiempo mínima (exclusiva) para la que se recuperan los datos de Trip.route o Trip.current_route_segment. Si los datos de la ruta no cambian desde esta marca de tiempo, el campo de ruta no se establece en la respuesta. Si no se especifica un mínimo, siempre se recuperan los datos de la ruta.

remaining_waypoints_version

Timestamp

Indica la marca de tiempo mínima (exclusiva) para la que se recuperan Trip.remaining_waypoints. Si no cambian desde esta marca de tiempo, los remaining_waypoints no se establecen en la respuesta. Si no se especifica este campo, siempre se recupera remaining_waypoints.

route_format_type

PolylineFormatType

El formato de ruta actual que se muestra, LAT_LNG_LIST_TYPE (en Trip.route) o ENCODED_POLYLINE_TYPE (en Trip.current_route_segment). El valor predeterminado es LAT_LNG_LIST_TYPE.

current_route_segment_traffic_version

Timestamp

Indica la marca de tiempo mínima (exclusiva) para la que se recupera Trip.current_route_segment_traffic. Si los datos de tráfico no cambian desde esta marca de tiempo, el campo current_route_segment_traffic no se establecerá en la respuesta. Si no se especifica un mínimo, siempre se recuperan los datos de tráfico. Ten en cuenta que el tráfico solo está disponible para los clientes de la solución On-Demand Rides & Deliveries.

remaining_waypoints_route_version

Timestamp

Indica la marca de tiempo mínima (exclusiva) para la que se recuperan los datos de Trip.remaining_waypoints.traffic_to_waypoint y Trip.remaining_waypoints.path_to_waypoint. Si los datos no se modifican desde esta marca de tiempo, los campos anteriores no se establecen en la respuesta. Si no se especifica remaining_waypoints_route_version, el tráfico y la ruta siempre se recuperan.

GetVehicleRequest

Mensaje de solicitud de GetVehicle.

Campos
header

RequestHeader

El encabezado de la solicitud estándar de Fleet Engine.

name

string

Obligatorio. Debe tener el formato providers/{provider}/vehicles/{vehicle}. El proveedor debe ser el ID del proyecto (por ejemplo, sample-cloud-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

current_route_segment_version

Timestamp

Indica la marca de tiempo mínima (exclusiva) para la que se recupera Vehicle.current_route_segment. Si la ruta no cambia desde esta marca de tiempo, el campo current_route_segment no se establecerá en la respuesta. Si no se especifica un mínimo, siempre se recupera el current_route_segment.

waypoints_version

Timestamp

Indica la marca de tiempo mínima (exclusiva) para la que se recuperan los datos de Vehicle.waypoints. Si los puntos de referencia no cambian desde esta marca de tiempo, no se establecerán los datos de vehicle.waypoints en la respuesta. Si no se especifica este campo, siempre se recupera vehicle.waypoints.

LicensePlate

La información de la matrícula del vehículo Para evitar almacenar información de identificación personal, solo se almacena la información mínima sobre la matrícula como parte de la entidad.

Campos
country_code

string

Obligatorio. Es el código de país o región de CLDR. Por ejemplo, US para Estados Unidos o IN para India.

last_character

string

El último dígito de la matrícula, o "-1", para indicar que no hay ningún valor numérico en ella.

  • "ABC 1234" -> "4"
  • "AB 123 CD" -> "3"
  • “ABCDEF” -> “-1”

ListVehiclesRequest

Mensaje de solicitud de ListVehicles.

Campos
header

RequestHeader

El encabezado de la solicitud estándar de Fleet Engine.

parent

string

Obligatorio. Debe tener el formato providers/{provider}. El proveedor debe ser el ID del proyecto (por ejemplo, sample-cloud-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

page_size

int32

La cantidad máxima de vehículos que se mostrará. Valor predeterminado: 100.

page_token

string

Es el valor de next_page_token proporcionado por una llamada anterior a ListVehicles para que puedas paginar grupos de vehículos. El valor no está definido si los criterios de filtro de la solicitud no son los mismos que los de la llamada anterior a ListVehicles.

minimum_capacity

Int32Value

Especifica la capacidad mínima requerida del vehículo. Todos los vehículos que se muestren tendrán un maximum_capacity mayor o igual que este valor. Si se configura, debe ser mayor o igual que 0.

trip_types[]

TripType

Restringe la respuesta a los vehículos que admiten, al menos, uno de los tipos de viaje especificados.

maximum_staleness

Duration

Restringe la respuesta a los vehículos que enviaron actualizaciones de ubicación a Fleet Engine dentro de la duración especificada. Los vehículos fijos que transmiten sus ubicaciones no se consideran inactivos. Si está presente, debe ser una duración positiva válida.

vehicle_type_categories[]

Category

Obligatorio. Restringe la respuesta a vehículos con una de las categorías de tipo especificadas. No se permite UNKNOWN.

required_attributes[]

string

Los llamadores pueden formar operaciones lógicas complejas con cualquier combinación de los campos required_attributes, required_one_of_attributes y required_one_of_attribute_sets.

required_attributes es una lista; required_one_of_attributes usa un mensaje que permite una lista de listas. En combinación, los dos campos permiten la composición de esta expresión:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Restringe la respuesta a vehículos con los atributos especificados. Este campo es una operación de conjunción/AND. Se permite un máximo de 50 atributos_obligatorio. Corresponde a la cantidad máxima de atributos permitidos en un vehículo. Cada cadena repetida debe tener el formato "key:value".

required_one_of_attributes[]

string

Restringe la respuesta a vehículos con al menos uno de los atributos especificados en cada VehicleAttributeList. Dentro de cada lista, un vehículo debe coincidir con al menos uno de los atributos. Este campo es una operación de disyunción/O inclusiva en cada VehicleAttributeList y una operación de conjunción/Y en la colección de VehicleAttributeList. Cada cadena repetida debe tener el formato "key1:value1|key2:value2|key3:value3".

required_one_of_attribute_sets[]

string

required_one_of_attribute_sets proporciona funciones adicionales.

Al igual que required_one_of_attributes, required_one_of_attribute_sets usa un mensaje que habilita una lista de listas y permite expresiones como la siguiente:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Restringe la respuesta a los vehículos que coinciden con todos los atributos de un VehicleAttributeList. Dentro de cada lista, un vehículo debe coincidir con todos los atributos. Este campo es una operación de conjunción/Y en cada VehicleAttributeList y una operación de disyunción/O inclusiva en la colección de VehicleAttributeList. Cada cadena repetida debe tener el formato "key1:value1|key2:value2|key3:value3".

vehicle_state

VehicleState

Restringe la respuesta a los vehículos que tienen ese estado.

on_trip_only

bool

Solo devuelve los vehículos con los viajes actuales.

filter

string

Opcional. Una consulta de filtro que se aplicará cuando se muestre una lista de vehículos. Consulta http://aip.dev/160 para ver ejemplos de la sintaxis del filtro.

Este campo está diseñado para reemplazar los campos required_attributes, required_one_of_attributes y required_one_of_attributes_sets. Si se especifica aquí un valor que no está vacío, los siguientes campos deben quedar en blanco: required_attributes, required_one_of_attributes y required_one_of_attributes_sets.

Este filtro funciona como una cláusula AND con otras restricciones, como vehicle_state o on_trip_only.

Ten en cuenta que las únicas búsquedas admitidas son sobre atributos de vehículos (por ejemplo, attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>). La cantidad máxima de restricciones permitida en una búsqueda de filtro es de 50.

Además, todos los atributos se almacenan como cadenas, por lo que las únicas comparaciones admitidas con los atributos son las de cadenas. Para compararlos con valores numéricos o booleanos, los valores deben estar entre comillas de forma explícita para que se los trate como cadenas (por ejemplo, attributes.<key> = "10" o attributes.<key> = "true").

viewport

Viewport

Opcional. Es un filtro que limita los vehículos que se muestran a aquellos cuya última ubicación conocida se encontraba en el área rectangular definida por el viewport.

ListVehiclesResponse

ListVehicles mensaje de respuesta.

Campos
vehicles[]

Vehicle

Vehículos que coinciden con los criterios de la solicitud. La cantidad máxima de vehículos que se muestran se determina mediante el campo page_size de la solicitud.

next_page_token

string

Token para recuperar la página siguiente de vehículos o vaciar si no hay más vehículos que cumplan con los criterios de la solicitud.

total_size

int64

Obligatorio. Cantidad total de vehículos que coinciden con los criterios de la solicitud en todas las páginas.

LocationPowerSaveMode

Cómo están configuradas las funciones de ubicación para que se comporten en el dispositivo móvil cuando la función de "ahorro de batería" de los dispositivos está activada. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enumeradores
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode no definido
LOCATION_MODE_NO_CHANGE El ahorro de batería no debe afectar a los proveedores de ubicación, o bien este último está desactivado.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF El proveedor de ubicación basado en GPS debe estar inhabilitado cuando el ahorro de batería está activado y el dispositivo no es interactivo.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Se deben inhabilitar todos los proveedores de ubicación cuando el ahorro de batería está activado y el dispositivo no es interactivo.
LOCATION_MODE_FOREGROUND_ONLY Todos los proveedores de ubicación permanecerán disponibles, pero las correcciones de ubicación solo deben proporcionarse a las aplicaciones en primer plano.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF No se desactivará la ubicación, pero LocationManager limitará todas las solicitudes a los proveedores cuando el dispositivo no sea interactivo.

LocationSensor

Es el sensor o la metodología que se usa para determinar la ubicación.

Enumeradores
UNKNOWN_SENSOR No se especificó el sensor o se desconoce.
GPS GPS o GPS asistido.
NETWORK GPS asistido, ID de torres de telefonía celular o punto de acceso Wi-Fi.
PASSIVE ID de torre de telefonía celular o punto de acceso Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Es una ubicación determinada por el dispositivo móvil como la posición más probable en la ruta.
CUSTOMER_SUPPLIED_LOCATION Una ubicación de una fuente independiente proporcionada por el cliente. Por lo general, este valor se usa para una ubicación proporcionada desde fuentes distintas del dispositivo móvil que ejecuta el SDK de Driver. Si uno de los otros valores de enumeración describe la fuente original, usa ese valor. Las ubicaciones marcadas como CUSTOMER_SUPPLIED_LOCATION suelen proporcionarse desde el last_location.supplemental_location_sensor del vehículo.
FLEET_ENGINE_LOCATION Una ubicación calculada por Fleet Engine según los indicadores disponibles para ella. Solo salida. Este valor se rechazará si se recibe en una solicitud.
FUSED_LOCATION_PROVIDER Proveedor de ubicación combinada de Android
CORE_LOCATION Es el proveedor de ubicación en los sistemas operativos de Apple.

El estado de navegación del vehículo.

Enumeradores
UNKNOWN_NAVIGATION_STATUS Estado de navegación no especificado.
NO_GUIDANCE La navegación de la app de Driver está en modo FREE_NAV.
ENROUTE_TO_DESTINATION La navegación paso a paso está disponible, y la navegación de la app para conductores ingresó al modo GUIDED_NAV.
OFF_ROUTE El vehículo se desvió de la ruta sugerida.
ARRIVED_AT_DESTINATION El vehículo está a una distancia aproximada de 50 m del destino.

PolylineFormatType

Es el tipo de formato de polilínea.

Enumeradores
UNKNOWN_FORMAT_TYPE El formato no está especificado o es desconocido.
LAT_LNG_LIST_TYPE Una lista de google.type.LatLng.
ENCODED_POLYLINE_TYPE Una polilínea codificada con un algoritmo de compresión de polilíneas. Aún no se admite la decodificación.

PowerSource

Tipo de cargador que se utiliza para cargar la batería.

Enumeradores
UNKNOWN_POWER_SOURCE Fuente de alimentación desconocida.
POWER_SOURCE_AC La fuente de alimentación es un cargador de CA.
POWER_SOURCE_USB La fuente de alimentación es un puerto USB.
POWER_SOURCE_WIRELESS La fuente de alimentación es inalámbrica.
POWER_SOURCE_UNPLUGGED La batería está desconectada.

ReportBillableTripRequest

Mensaje de solicitud ReportBillableTrip.

Campos
name

string

Obligatorio. Debe tener el formato providers/{provider}/billableTrips/{billable_trip}. El proveedor debe ser el ID del proyecto (por ejemplo, sample-cloud-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

country_code

string

Obligatorio. Es el código de país de dos letras del país donde se realiza el viaje. El precio se define según el código de país.

platform

BillingPlatformIdentifier

La plataforma por la cual se emitió la solicitud.

related_ids[]

string

Son los identificadores que están directamente relacionados con el viaje que se informa. Por lo general, son IDs (por ejemplo, IDs de sesión) de operaciones de reserva previa que se realizan antes de que esté disponible el ID de viaje. La cantidad de related_ids está limitada a 50.

solution_type

SolutionType

Es el tipo de solución de producto de GMP (por ejemplo, ON_DEMAND_RIDESHARING_AND_DELIVERIES) que se usa para el viaje informado.

SolutionType

Selector para los diferentes tipos de soluciones de un viaje informado.

Enumeradores
SOLUTION_TYPE_UNSPECIFIED Es el valor predeterminado. Para la retrocompatibilidad, la API usará ON_DEMAND_RIDESHARING_AND_DELIVERIES de forma predeterminada, que es el primer tipo de solución compatible.
ON_DEMAND_RIDESHARING_AND_DELIVERIES La solución es un viaje de transporte y entregas a pedido a pedido.

RequestHeader

Un RequestHeader contiene campos comunes a todas las solicitudes de RPC de Fleet Engine.

Campos
language_code

string

Es el código de idioma según la norma BCP-47, como en-US o sr-Latn. Para obtener más información, consulta http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Si no se especifica ninguno, la respuesta puede estar en cualquier idioma, con preferencia en inglés si ese nombre existe. Ejemplo de valor de campo: en-US.

region_code

string

Obligatorio. Es el código regional de CLDR de la región donde se origina la solicitud. Ejemplo de valor de campo: US.

sdk_version

string

Es la versión del SDK que realiza la llamada, si corresponde. El formato de la versión es "major.minor.patch", por ejemplo: 1.1.2.

os_version

string

Es la versión del sistema operativo en el que se ejecuta el SDK de llamada. Ejemplos de valores de campo: 4.4.1, 12.1.

device_model

string

Es el modelo del dispositivo en el que se ejecuta el SDK de llamada. Ejemplos de valores de campo: iPhone12,1, SM-G920F.

sdk_type

SdkType

Es el tipo de SDK que envía la solicitud.

maps_sdk_version

string

Es la versión del SDK de Map del que depende el SDK de llamada, si corresponde. El formato de la versión es "major.minor.patch", por ejemplo: 5.2.1.

nav_sdk_version

string

Es la versión del NavSDK del que depende el SDK de llamada, si corresponde. El formato de la versión es "major.minor.patch", por ejemplo: 2.1.0.

platform

Platform

Plataforma del SDK que realiza la llamada.

manufacturer

string

Fabricante del dispositivo Android del SDK que realiza la llamada, solo aplicable para los SDK de Android. Ejemplo de valor de campo: Samsung.

android_api_level

int32

Nivel de API de Android del SDK de llamada, solo aplicable para los SDK de Android. Ejemplo de valor de campo: 23.

trace_id

string

ID opcional que se puede proporcionar con fines de registro para identificar la solicitud.

Plataforma

Es la plataforma del SDK que realiza la llamada.

Enumeradores
PLATFORM_UNSPECIFIED Es el valor predeterminado. Este valor se usa si se omite la plataforma.
ANDROID La solicitud proviene de Android.
IOS La solicitud proviene de iOS.
WEB La solicitud proviene de la Web.

SdkType

Posibles tipos de SDK.

Enumeradores
SDK_TYPE_UNSPECIFIED Es el valor predeterminado. Este valor se usa si se omite sdk_type.
CONSUMER El SDK que realiza la llamada es Consumer.
DRIVER El SDK que realiza la llamada es el controlador.
JAVASCRIPT El SDK que realiza la llamada es JavaScript.

SearchTripsRequest

Mensaje de solicitud de SearchTrips.

Campos
header

RequestHeader

El encabezado de la solicitud estándar de Fleet Engine.

parent

string

Obligatorio. Debe tener el formato providers/{provider}. El proveedor debe ser el ID del proyecto (por ejemplo, sample-cloud-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

vehicle_id

string

Indica el vehículo asociado con los viajes de la solicitud. Si no se especifica, los viajes devueltos no contendrán lo siguiente:

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
active_trips_only

bool

Si se establece como verdadera, la respuesta incluirá Viajes que influyen en la ruta de un conductor.

page_size

int32

Si no se configura, el servidor decide la cantidad de resultados que se mostrarán.

page_token

string

Establece esto en un valor que se mostró antes en SearchTripsResponse para continuar desde los resultados anteriores.

minimum_staleness

Duration

Si se especifica, muestra los viajes que no se actualizaron después del tiempo (current - minimum_staleness).

SearchTripsResponse

Mensaje de respuesta de SearchTrips.

Campos
trips[]

Trip

Es la lista de viajes para el vehículo solicitado.

next_page_token

string

Pasa este token en SearchTripsRequest a la página de los resultados de la lista. La API muestra una lista de viajes en cada llamada y, cuando no queden más resultados, la lista estará vacía.

SearchVehiclesRequest

Mensaje de solicitud de SearchVehicles.

Campos
header

RequestHeader

El encabezado de la solicitud estándar de Fleet Engine.

parent

string

Obligatorio. Debe tener el formato providers/{provider}. El proveedor debe ser el ID del proyecto (por ejemplo, sample-cloud-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

pickup_point

TerminalLocation

Obligatorio. El punto de partida para buscar cerca.

dropoff_point

TerminalLocation

La ubicación de destino prevista del cliente. El campo es obligatorio si trip_types contiene TripType.SHARED.

pickup_radius_meters

int32

Obligatorio. Define el radio de búsqueda del vehículo alrededor del punto de partida. Solo se mostrarán los vehículos que estén dentro del radio de búsqueda. El valor debe ser de entre 400 y 10,000 metros (inclusive).

count

int32

Obligatorio. Especifica la cantidad máxima de vehículos que se devolverá. El valor debe estar entre 1 y 50 (inclusive).

minimum_capacity

int32

Obligatorio. Especifica la cantidad de pasajeros que se tienen en cuenta para un viaje. El valor debe ser mayor o igual que uno. El controlador no se considera en el valor de capacidad.

trip_types[]

TripType

Obligatorio. Representa el tipo de viaje propuesto. Se debe incluir exactamente un tipo. No se permite UNKNOWN_TRIP_TYPE. Restringe la búsqueda a los vehículos que admiten ese tipo de viaje.

maximum_staleness

Duration

Restringe la búsqueda solo a los vehículos que enviaron actualizaciones de ubicación a Fleet Engine dentro de la duración especificada. Los vehículos fijos que transmiten sus ubicaciones no se consideran inactivos. Si no se establece este campo, el servidor usa cinco minutos como valor predeterminado.

vehicle_types[]

VehicleType

Obligatorio. Restringe la búsqueda a vehículos con uno de los tipos especificados. Se debe especificar al menos un tipo de vehículo. No se permiten los tipos de vehículos con la categoría UNKNOWN.

required_attributes[]

VehicleAttribute

Los llamadores pueden formar operaciones lógicas complejas con cualquier combinación de los campos required_attributes, required_one_of_attributes y required_one_of_attribute_sets.

required_attributes es una lista; required_one_of_attributes usa un mensaje que permite una lista de listas. En combinación, los dos campos permiten la composición de esta expresión:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

Restringe la búsqueda solo a los vehículos con los atributos especificados. Este campo es una operación de conjunción/AND. Se permite un máximo de 50 atributos_obligatorio. Corresponde a la cantidad máxima de atributos permitidos en un vehículo.

required_one_of_attributes[]

VehicleAttributeList

Restringe la búsqueda solo a los vehículos con al menos uno de los atributos especificados en cada VehicleAttributeList. Dentro de cada lista, un vehículo debe coincidir con al menos uno de los atributos. Este campo es una operación de disyunción/O inclusiva en cada VehicleAttributeList y una operación de conjunción/Y en la colección de VehicleAttributeList.

required_one_of_attribute_sets[]

VehicleAttributeList

required_one_of_attribute_sets proporciona funciones adicionales.

Al igual que required_one_of_attributes, required_one_of_attribute_sets usa un mensaje que habilita una lista de listas y permite expresiones como la siguiente:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

Restringe la búsqueda solo a los vehículos con todos los atributos en una VehicleAttributeList. Dentro de cada lista, un vehículo debe coincidir con todos los atributos. Este campo es una operación de conjunción/Y en cada VehicleAttributeList y una operación de disyunción/O inclusiva en la colección de VehicleAttributeList.

order_by

VehicleMatchOrder

Obligatorio. Especifica el criterio de ordenamiento deseado para los resultados.

include_back_to_back

bool

Indica si los vehículos con un solo viaje activo son aptos para esta búsqueda. Este campo solo se usa cuando no se especifica current_trips_present. Si no se especifica current_trips_present y este campo es false, se excluirán de los resultados de la búsqueda los vehículos con viajes asignados. Cuando no se especifica current_trips_present y este campo es true, los resultados de la búsqueda pueden incluir vehículos con un viaje activo que tenga el estado ENROUTE_TO_DROPOFF. Cuando se especifica current_trips_present, este campo no se puede establecer como verdadero.

El valor predeterminado es false.

trip_id

string

Indica el viaje asociado con este SearchVehicleRequest.

current_trips_present

CurrentTripsPresent

Indica si los vehículos con viajes activos son aptos para esta búsqueda. Se debe configurar en un valor distinto de CURRENT_TRIPS_PRESENT_UNSPECIFIED si trip_type incluye SHARED.

filter

string

Opcional. Una consulta de filtro que se aplicará cuando se busquen vehículos. Consulta http://aip.dev/160 para ver ejemplos de la sintaxis del filtro.

Este campo está diseñado para reemplazar los campos required_attributes, required_one_of_attributes y required_one_of_attributes_sets. Si se especifica aquí un valor que no está vacío, los siguientes campos deben quedar en blanco: required_attributes, required_one_of_attributes y required_one_of_attributes_sets.

Este filtro funciona como una cláusula AND con otras restricciones, como minimum_capacity o vehicle_types.

Ten en cuenta que las únicas búsquedas admitidas son sobre atributos de vehículos (por ejemplo, attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>). La cantidad máxima de restricciones permitida en una búsqueda de filtro es de 50.

Además, todos los atributos se almacenan como cadenas, por lo que las únicas comparaciones admitidas con los atributos son las de cadenas. Para compararlos con valores numéricos o booleanos, los valores deben estar entre comillas de forma explícita para que se los trate como cadenas (por ejemplo, attributes.<key> = "10" o attributes.<key> = "true").

CurrentTripsPresent

Especifica los tipos de restricciones que se aplican a los viajes actuales de un vehículo.

Enumeradores
CURRENT_TRIPS_PRESENT_UNSPECIFIED La disponibilidad de vehículos con viajes está regida por el campo include_back_to_back.
NONE Los vehículos sin viajes pueden aparecer en los resultados de la búsqueda. Cuando se usa este valor, include_back_to_back no puede ser true.
ANY En los resultados de la búsqueda, se incluyen vehículos con un máximo de 5 viajes y 10 puntos de referencia. Cuando se usa este valor, include_back_to_back no puede ser true.

VehicleMatchOrder

Especifica el orden de las coincidencias del vehículo en la respuesta.

Enumeradores
UNKNOWN_VEHICLE_MATCH_ORDER Predeterminado: se usa para el pedido de coincidencias de vehículos no especificado o no reconocido.
PICKUP_POINT_ETA Orden ascendente por tiempo de conducción del vehículo hasta el punto de partida.
PICKUP_POINT_DISTANCE Orden ascendente por distancia en automóvil del vehículo hasta el punto de partida.
DROPOFF_POINT_ETA Orden ascendente por tiempo de conducción del vehículo hasta el punto de destino. Este pedido solo se puede usar si se especifica el punto de destino en la solicitud.
PICKUP_POINT_STRAIGHT_DISTANCE Orden ascendente por distancia en línea recta desde la última ubicación informada del vehículo hasta el punto de partida.
COST Orden ascendente por el costo de coincidencia configurado. El costo de coincidencia se define como un cálculo ponderado entre la distancia lineal y el ETA. Las ponderaciones se establecen con valores predeterminados y se pueden modificar por cliente. Comunícate con Atención al cliente de Google si es necesario modificar estas ponderaciones para tu proyecto.

SearchVehiclesResponse

SearchVehicles mensaje de respuesta.

Campos
matches[]

VehicleMatch

Lista de vehículos que coinciden con los criterios de SearchVehiclesRequest, ordenados según el campo SearchVehiclesRequest.order_by.

SpeedReadingInterval

Indicador de densidad de tráfico en un segmento contiguo de una ruta. Dada una ruta con puntos P_0, P_1, ... , P_N (índice basado en cero), SpeedReadingInterval define un intervalo y describe su tráfico mediante las siguientes categorías.

Campos
start_polyline_point_index

int32

El índice inicial de este intervalo en la ruta. En JSON, cuando el índice es 0, el campo parecerá no estar propagado.

end_polyline_point_index

int32

El índice final de este intervalo en la ruta. En JSON, cuando el índice es 0, el campo parecerá no estar propagado.

speed

Speed

Velocidad del tráfico en este intervalo.

Velocidad

Es la clasificación de la velocidad de las polilíneas según los datos de tráfico.

Enumeradores
SPEED_UNSPECIFIED Valor predeterminado Este valor no se usa.
NORMAL Velocidad normal; no se detecta ninguna demora.
SLOW Se detectó una demora, pero no se formó un embotellamiento.
TRAFFIC_JAM Se detectó un embotellamiento.

StopLocation

Es la ubicación real en la que se detuvo una parada (partida o destino).

Campos
point

LatLng

Obligatorio. Denota la ubicación real.

timestamp

Timestamp

Indica cuándo se detuvo.

stop_time
(deprecated)

Timestamp

Solo entrada. Ya no está disponible. Usa el campo de marca de tiempo.

TerminalLocation

Describe la ubicación de un punto de referencia.

Campos
point

LatLng

Obligatorio. Indica la ubicación de un punto de referencia de viaje.

terminal_point_id

TerminalPointId

ID del punto de terminal.

access_point_id
(deprecated)

string

Ya no está disponible.

trip_id
(deprecated)

string

Ya no está disponible.

terminal_location_type
(deprecated)

WaypointType

Obsoleto: Vehicle.waypoint tendrá estos datos.

TerminalPointId

Identifica un punto de terminal.

Campos
value

string

Es el ID único del punto de terminal.

Campo de unión Id. Ya no está disponible. Las direcciones (Id) solo pueden ser una de las siguientes opciones:
place_id
(deprecated)

string

Ya no está disponible.

generated_id
(deprecated)

string

Ya no está disponible.

TrafficPolylineData

Condiciones de tráfico a lo largo de la ruta esperada para el vehículo.

Campos
traffic_rendering

VisualTrafficReportPolylineRendering

Renderización de polilínea de la velocidad del tráfico en todas las regiones a lo largo de un tramo del viaje de un cliente.

Viaje

Metadatos de viajes.

Campos
name

string

Solo salida. Debe tener el formato "providers/{provider}/trips/{trip}"

vehicle_id

string

Es el ID del vehículo que realiza este viaje.

trip_status

TripStatus

Estado actual del viaje.

trip_type

TripType

Es el tipo de viaje.

pickup_point

TerminalLocation

Es la ubicación en la que el cliente indica que lo retirarán.

actual_pickup_point

StopLocation

Solo entrada. La ubicación real en la que y donde se recogió al cliente. Este campo permite que el proveedor brinde comentarios sobre la información real de retiro.

actual_pickup_arrival_point

StopLocation

Solo entrada. La hora y la ubicación reales del conductor cuando llega al punto de partida Este campo permite que el proveedor brinde comentarios sobre la información real de llegada al punto de partida.

pickup_time

Timestamp

Solo salida. Ya sea la hora estimada en la que se recogerá a los pasajeros o la hora real en la que se recogió a los pasajeros.

intermediate_destinations[]

TerminalLocation

Paradas intermedias para que el viaje solicite el servicio (además del punto de partida y el destino) En un principio, esto no será compatible con los viajes compartidos.

intermediate_destinations_version

Timestamp

Indica la última vez que se modificó el intermediate_destinations. Tu servidor debe almacenar en caché este valor y pasarlo en UpdateTripRequest cuando se actualiza intermediate_destination_index para asegurarse de que no se modifique intermediate_destinations.

intermediate_destination_index

int32

Cuando TripStatus es ENROUTE_TO_INTERMEDIATE_DESTINATION, un número entre [0..N-1] que indica con qué destino intermedio cruzará el vehículo a continuación. Cuando TripStatus es ARRIVED_AT_INTERMEDIATE_DESTINATION, un número entre [0..N-1] que indica en qué destino intermedio se encuentra el vehículo. El proveedor establece este valor. Si no hay intermediate_destinations, se ignorará este campo.

actual_intermediate_destination_arrival_points[]

StopLocation

Solo entrada. La hora y el lugar reales de llegada del conductor a un destino intermedio Este campo permite que el proveedor proporcione comentarios sobre la información real de llegada a destinos intermedios.

actual_intermediate_destinations[]

StopLocation

Solo entrada. Indica la hora y ubicación reales en el momento y el lugar en que se recogió al cliente de un destino intermedio. Este campo sirve para que el proveedor proporcione comentarios sobre la información real de retiro en destinos intermedios.

dropoff_point

TerminalLocation

Ubicación en la que el cliente indica que bajarán del vehículo.

actual_dropoff_point

StopLocation

Solo entrada. La hora y la ubicación reales en el momento y el lugar en que se dejó al cliente. Este campo es para que el proveedor proporcione comentarios sobre la información real de destino.

dropoff_time

Timestamp

Solo salida. Corresponde a la hora futura estimada en la que los pasajeros se bajarán en el destino final o la hora real en la que se bajaron.

remaining_waypoints[]

TripWaypoint

Solo salida. Es la ruta completa desde la ubicación actual hasta el punto de destino, inclusive. Esta ruta puede incluir puntos de referencia de otros viajes.

vehicle_waypoints[]

TripWaypoint

Este campo admite el ordenamiento manual de los puntos de referencia para el viaje. Contiene todos los puntos de referencia restantes para el vehículo asignado, así como los puntos de referencia de partida y llegada para este viaje. Si el viaje no se asignó a un vehículo, Fleet Engine ignorará este campo. Por motivos de privacidad, el servidor solo propaga este campo en las llamadas UpdateTrip y CreateTrip, NO en las llamadas GetTrip.

route[]

LatLng

Solo salida. Ruta anticipada para este viaje a la primera entrada en remanente_waypoints. Ten en cuenta que el primer punto de referencia puede pertenecer a un viaje diferente.

current_route_segment

string

Solo salida. Una ruta de acceso codificada para el próximo punto de referencia.

Nota: Este campo está destinado solo para uso con el SDK de Driver y el SDK de consumidor. Aún no se admite la decodificación.

current_route_segment_version

Timestamp

Solo salida. Indica la última vez que se modificó la ruta.

Nota: Este campo está destinado solo para uso con el SDK de Driver y el SDK de consumidor.

current_route_segment_traffic

ConsumableTrafficPolyline

Solo salida. Indica las condiciones de tráfico en la current_route_segment cuando están disponibles.

Nota: Este campo está destinado solo para uso con el SDK de Driver y el SDK de consumidor.

current_route_segment_traffic_version

Timestamp

Solo salida. Indica la última vez que se modificó el current_route_segment_traffic.

Nota: Este campo está destinado solo para uso con el SDK de Driver y el SDK de consumidor.

current_route_segment_end_point

TripWaypoint

Solo salida. El punto de referencia donde finaliza current_route_segment.

remaining_distance_meters

Int32Value

Solo salida. La distancia restante en automóvil en el campo current_route_segment El valor no se especifica si el viaje no se asignó a un vehículo o si el viaje se completó o se canceló.

eta_to_first_waypoint

Timestamp

Solo salida. La hora de llegada estimada al siguiente punto de referencia (la primera entrada en el campo remaining_waypoints). El valor no se especifica si el viaje no está asignado a un vehículo o si el viaje está inactivo (se completó o se canceló).

remaining_time_to_first_waypoint

Duration

Solo salida. Es la duración que transcurre desde que se muestran los datos del viaje hasta la hora en Trip.eta_to_first_waypoint. El valor no se especifica si el viaje no está asignado a un vehículo o si el viaje está inactivo (se completó o se canceló).

remaining_waypoints_version

Timestamp

Solo salida. Indica la última vez que se cambió remaining_waypoints (se agregó, se quitó o se cambió un punto de referencia).

remaining_waypoints_route_version

Timestamp

Solo salida. Indica la última vez que se modificaron remaining_waypoints.path_to_waypoint y remaining_waypoints.traffic_to_waypoint. Tu app cliente debe almacenar en caché este valor y pasarlo en GetTripRequest para garantizar que las rutas de acceso y el tráfico de remaining_waypoints solo se muestren si se actualizan.

number_of_passengers

int32

Inmutable. Indica la cantidad de pasajeros de este viaje y no incluye al conductor. Un vehículo debe tener capacidad disponible para devolverse en una respuesta SearchVehicles.

last_location

VehicleLocation

Solo salida. Indica la última ubicación informada del vehículo en la ruta.

last_location_snappable

bool

Solo salida. Indica si el last_location del vehículo se puede ajustar al segmento current_route_segment. Falso si last_location o current_route_segment no existen. Fleet Engine lo calcula. Se ignorará cualquier actualización de los clientes.

view

TripView

Es el subconjunto de campos de viaje que se propagan y cómo deben interpretarse.

TripStatus

Es el estado de un viaje que indica su progreso.

Enumeradores
UNKNOWN_TRIP_STATUS Predeterminado: se usa para el estado de viaje no especificado o no reconocido.
NEW Viaje recién creado.
ENROUTE_TO_PICKUP El conductor está en camino al punto de partida.
ARRIVED_AT_PICKUP El conductor llegó al punto de partida.
ARRIVED_AT_INTERMEDIATE_DESTINATION El conductor llegó a un destino intermedio y está esperando al pasajero.
ENROUTE_TO_INTERMEDIATE_DESTINATION El conductor se dirige a un destino intermedio (no al punto de destino).
ENROUTE_TO_DROPOFF El conductor recogió al pasajero y está en camino al siguiente destino.
COMPLETE El pasajero se baja y el viaje se completó.
CANCELED El viaje se canceló antes de que el conductor, el pasajero o el proveedor de transporte compartido lo recogieran.

TripType

Es el tipo de viaje.

Enumeradores
UNKNOWN_TRIP_TYPE Predeterminado: se usa para los tipos de viaje no especificados o no reconocidos.
SHARED Es posible que el viaje comparta un vehículo con otros viajes.
EXCLUSIVE El viaje es exclusivo para un vehículo.

TripView

Selector para diferentes conjuntos de campos de viaje en una respuesta de GetTrip. Consulta AIP-157 para obtener más contexto. Es probable que se agreguen vistas adicionales.

Enumeradores
TRIP_VIEW_UNSPECIFIED Es el valor predeterminado. Para ofrecer retrocompatibilidad, la API usará, de forma predeterminada, una vista de SDK. Para garantizar la estabilidad y asistencia, se recomienda a los clientes que seleccionen un TripView que no sea SDK.
SDK Incluye campos que tal vez no se puedan interpretar ni admitir mediante el uso de bibliotecas disponibles de forma pública.
JOURNEY_SHARING_V1S Los campos de viaje se propagan para el caso de uso de viaje compartido. Esta vista está diseñada para las comunicaciones de servidor a servidor.

TripWaypoint

Describe un punto de parada en la ruta de un vehículo o el punto de llegada durante el viaje de un vehículo.

Campos
location

TerminalLocation

La ubicación de este punto de referencia.

trip_id

string

El viaje asociado con este punto de referencia.

waypoint_type

WaypointType

La función que desempeña este punto de referencia en este viaje, como el punto de partida o el destino.

path_to_waypoint[]

LatLng

La ruta desde el punto de referencia anterior al punto de referencia actual. No se define para el primer punto de referencia de una lista. Este campo solo se completa cuando se solicita.

encoded_path_to_waypoint

string

La ruta codificada desde el punto de referencia anterior hasta el punto de referencia actual.

Nota: Este campo está destinado solo para uso con el SDK de Driver y el SDK de consumidor. Aún no se admite la decodificación.

traffic_to_waypoint

ConsumableTrafficPolyline

Las condiciones del tráfico a lo largo de la ruta hacia este punto de referencia. Ten en cuenta que el tráfico solo está disponible para los clientes de la solución Viajes y entregas de Google Maps Platform.

distance_meters

Int32Value

La distancia de la ruta desde el punto de referencia anterior hasta el punto de referencia actual. No se define para el primer punto de referencia de una lista.

eta

Timestamp

La hora estimada de llegada a este punto de referencia. No se define para el primer punto de referencia de una lista.

duration

Duration

La duración del viaje desde el punto de referencia anterior hasta este punto. No se define para el primer punto de referencia de una lista.

UpdateTripRequest

Mensaje de solicitud de UpdateTrip.

Campos
header

RequestHeader

El encabezado de la solicitud estándar de Fleet Engine.

name

string

Obligatorio. Debe tener el formato providers/{provider}/trips/{trip}. El proveedor debe ser el ID del proyecto (por ejemplo, sample-consumer-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

trip

Trip

Obligatorio. Indica el viaje asociado con la actualización.

Fleet Engine mantiene los siguientes campos. No las actualices con Trip.update.

  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_traffic
  • current_route_segment_traffic_version
  • current_route_segment_version
  • dropoff_time
  • eta_to_next_waypoint
  • intermediate_destinations_version
  • last_location
  • name
  • number_of_passengers
  • pickup_time
  • remaining_distance_meters
  • remaining_time_to_first_waypoint
  • remaining_waypoints
  • remaining_waypoints_version
  • route

Cuando actualices el Trip.vehicle_id de un viaje compartido, deberás proporcionar la lista de Trip.vehicle_waypoints para especificar el orden de los puntos de referencia restantes; de lo contrario, el orden será indeterminado.

Cuando especificas Trip.vehicle_waypoints, la lista debe contener todos los puntos de referencia restantes de los viajes del vehículo, sin puntos de referencia adicionales. Debes ordenar estos puntos de referencia de modo que, para un viaje determinado, el punto de partida sea anterior a los destinos intermedios y todos los destinos intermedios aparezcan antes del punto de llegada. Los puntos de referencia de un viaje EXCLUSIVE no deben intercalarse con ningún otro viaje. Se utilizan los campos trip_id, waypoint_type y location, y se ignoran todos los demás campos de TripWaypoint en vehicle_waypoints.

Para evitar una condición de carrera para viajes con varios destinos, debes proporcionar Trip.intermediate_destinations_version cuando actualices el estado del viaje a ENROUTE_TO_INTERMEDIATE_DESTINATION. El Trip.intermediate_destinations_version pasado debe ser coherente con la versión de Fleet Engine. Si no es así, la solicitud falla.

update_mask

FieldMask

Obligatorio. La máscara de campo que indica qué campos de Viaje se deben actualizar. El elemento update_mask debe contener al menos un campo.

UpdateVehicleAttributesRequest

Mensaje de solicitud de UpdateVehicleAttributes.

Campos
header

RequestHeader

El encabezado de la solicitud estándar de Fleet Engine.

name

string

Obligatorio. Debe tener el formato providers/{provider}/vehicles/{vehicle}. El proveedor debe ser el ID del proyecto (por ejemplo, sample-cloud-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

attributes[]

VehicleAttribute

Obligatorio. Los atributos del vehículo que se actualizarán. Los atributos no mencionados no se modifican ni se quitan.

UpdateVehicleAttributesResponse

UpdateVehicleAttributes mensaje de respuesta.

Campos
attributes[]

VehicleAttribute

Obligatorio. La lista completa actualizada de atributos del vehículo, incluidos los nuevos, modificados y intactos.

UpdateVehicleRequest

`Mensaje de solicitud UpdateVehicle.

Campos
header

RequestHeader

El encabezado de la solicitud estándar de Fleet Engine.

name

string

Obligatorio. Debe tener el formato providers/{provider}/vehicles/{vehicle}. El {provider} debe ser el ID del proyecto (por ejemplo, sample-cloud-project) del proyecto de Google Cloud del que forma parte la cuenta de servicio que realiza esta llamada.

vehicle

Vehicle

Obligatorio. Los valores de entidad Vehicle que se aplicarán. Cuando actualizas un Vehicle, es posible que los siguientes campos no se actualicen, ya que el servidor los administra.

  • available_capacity
  • current_route_segment_version
  • current_trips
  • name
  • waypoints_version

Si se actualiza el campo attributes, se reemplazarán todos los atributos del vehículo por los atributos proporcionados en la solicitud. Si solo quieres actualizar algunos atributos, consulta el método UpdateVehicleAttributes.

Del mismo modo, el campo waypoints se puede actualizar, pero debe contener todos los puntos de referencia que se encuentren actualmente en el vehículo y no otros.

update_mask

FieldMask

Obligatorio. Una máscara de campo que indica qué campos de Vehicle se deben actualizar. Se debe proporcionar al menos un nombre de campo.

Vehículo

Metadatos del vehículo.

Campos
name

string

Solo salida. Es el nombre único de este vehículo. El formato es providers/{provider}/vehicles/{vehicle}.

vehicle_state

VehicleState

Es el estado del vehículo.

supported_trip_types[]

TripType

Tipos de viaje admitidos por este vehículo.

current_trips[]

string

Solo salida. Lista de viajes de trip_id asignados actualmente a este vehículo.

last_location

VehicleLocation

Ubicación del vehículo que se informó por última vez.

maximum_capacity

int32

La cantidad total de pasajeros que puede transportar este vehículo. El controlador no se considera en este valor. Este valor debe ser mayor o igual que uno.

attributes[]

VehicleAttribute

Lista de atributos del vehículo. Un vehículo puede tener 100 atributos como máximo, y cada uno de ellos debe tener una clave única.

vehicle_type

VehicleType

Obligatorio. Es el tipo de este vehículo. Se puede usar para filtrar vehículos en los resultados de SearchVehicles. También influye en los cálculos de la hora de llegada estimada y la ruta.

license_plate

LicensePlate

La información de la matrícula del vehículo.

route[]
(deprecated)

TerminalLocation

Obsoleto: usa Vehicle.waypoints en su lugar.

current_route_segment

string

La polilínea que especifica la ruta que la app del conductor pretende tomar al siguiente punto de referencia. Esta lista también se devuelve en Trip.current_route_segment para todos los viajes activos asignados al vehículo.

Nota: Este campo está destinado únicamente para el uso con el SDK de Driver. Aún no se admite la decodificación.

current_route_segment_traffic

TrafficPolylineData

Solo entrada. Fleet Engine usa esta información para mejorar los viajes compartidos. Nota: Este campo está destinado únicamente para el uso con el SDK de Driver.

current_route_segment_version

Timestamp

Solo salida. Hora en la que se estableció current_route_segment. El cliente puede almacenarlo y pasarlo en solicitudes GetVehicle futuras para evitar que se muestren rutas sin cambios.

current_route_segment_end_point

TripWaypoint

El punto de referencia donde finaliza current_route_segment. Los conductores en llamadas a UpdateVehicle pueden proporcionarlo como un punto de referencia de viaje completo, un punto de referencia LatLng o como el último LatLng de current_route_segment. Fleet Engine hará lo posible para interpolar un punto de referencia real si no se especifica por completo. Este campo se ignora en las llamadas UpdateVehicle, a menos que también se especifique current_route_segment.

remaining_distance_meters

Int32Value

La distancia restante en automóvil para current_route_segment. Este valor también se muestra en Trip.remaining_distance_meters para todos los viajes activos asignados al vehículo. El valor no se especifica si el campo current_route_segment está vacío.

eta_to_first_waypoint

Timestamp

La hora de llegada estimada a la primera entrada en el campo waypoints. El valor no se especifica si el campo waypoints está vacío o el campo Vehicle.current_route_segment está vacío.

Cuando se actualiza un vehículo, remaining_time_seconds tiene prioridad sobre eta_to_first_waypoint en la misma solicitud.

remaining_time_seconds

Int32Value

Solo entrada. El tiempo de conducción restante para el current_route_segment. El valor no se especifica si el campo waypoints está vacío o el campo Vehicle.current_route_segment está vacío. Este valor debe coincidir con eta_to_first_waypoint - current_time si todas las partes usan el mismo reloj.

Cuando se actualiza un vehículo, remaining_time_seconds tiene prioridad sobre eta_to_first_waypoint en la misma solicitud.

waypoints[]

TripWaypoint

Los puntos de referencia restantes asignados a este vehículo.

waypoints_version

Timestamp

Solo salida. Última vez que se actualizó el campo waypoints. Los clientes deben almacenar en caché este valor y pasarlo en GetVehicleRequest para garantizar que el campo waypoints solo se muestre si se actualiza.

back_to_back_enabled

bool

Indica si el conductor acepta viajes seguidos. Si es true, SearchVehicles puede incluir el vehículo, incluso si está asignado a un viaje. El valor predeterminado es false.

navigation_status

NavigationStatus

El estado de navegación del vehículo.

device_settings

DeviceSettings

Solo entrada. Información sobre la configuración del dispositivo móvil que usa el conductor

VehicleType

Es el tipo de vehículo.

Campos
category

Category

Categoría del tipo de vehículo

Categoría

Categorías de tipos de vehículos

Enumeradores
UNKNOWN Predeterminado: se usa para categorías de vehículos no especificadas o no reconocidas.
AUTO Un automóvil.
TAXI Cualquier vehículo que funcione como taxi (normalmente regulado o con licencia)
TRUCK Por lo general, es un vehículo con una gran capacidad de almacenamiento.
TWO_WHEELER Una motocicleta, un ciclomotor u otro vehículo de dos ruedas
BICYCLE Transporte impulsado por seres humanos.
PEDESTRIAN Un transportador humano, generalmente caminando o corriendo, que viaja por senderos peatonales.

VehicleAttribute

Describe un atributo de vehículo como un par clave-valor. La longitud de la cadena "key:value" no puede superar los 256 caracteres.

Campos
key

string

La clave del atributo. Las claves no pueden contener el carácter de dos puntos (:).

value

string

El valor del atributo.

Campo de unión vehicle_attribute_value. El valor del atributo puede ser de tipo string, bool o doble. Las direcciones (vehicle_attribute_value) solo pueden ser una de las siguientes opciones:
string_value

string

Valor del atributo con tipo de cadena.

Nota: Esto es idéntico al campo value que, con el tiempo, dejará de estar disponible. Para los métodos de creación o actualización, se puede usar cualquiera de los campos, pero se recomienda usar string_value. Si se configuran string_value y value, deben ser idénticos o se arrojará un error. Ambos campos se propagan en respuestas.

bool_value

bool

Valor del atributo de tipo booleano.

number_value

double

Valor del atributo de tipo doble.

VehicleAttributeList

Una lista de tipos de datos para los atributos del vehículo.

Campos
attributes[]

VehicleAttribute

Una lista de atributos de esta colección.

VehicleLocation

Es la ubicación, velocidad y rumbo de un vehículo en un momento determinado.

Campos
location

LatLng

Es la ubicación del vehículo. Cuando se envía a Fleet Engine, la ubicación del vehículo es GPS. Cuando la recibes en una respuesta, la ubicación del vehículo puede ser una ubicación GPS, complementaria o alguna otra ubicación aproximada. La fuente se especifica en location_sensor.

horizontal_accuracy
(deprecated)

DoubleValue

Obsoleto: usa latlng_accuracy en su lugar.

latlng_accuracy

DoubleValue

Precisión de location en metros como radio.

heading

Int32Value

Dirección en la que se mueve el vehículo en grados. 0 representa el norte. El rango válido es [0,360).

bearing_accuracy
(deprecated)

DoubleValue

Obsoleto: usa heading_accuracy en su lugar.

heading_accuracy

DoubleValue

Precisión de heading en grados.

altitude

DoubleValue

Altitud en metros sobre WGS84.

vertical_accuracy
(deprecated)

DoubleValue

Obsoleto: usa altitude_accuracy en su lugar.

altitude_accuracy

DoubleValue

Precisión de altitude en metros

speed_kmph
(deprecated)

Int32Value

Velocidad del vehículo en kilómetros por hora. Obsoleto: usa speed en su lugar.

speed

DoubleValue

Velocidad del vehículo en metros/segundo

speed_accuracy

DoubleValue

Precisión de speed en metros por segundo.

update_time

Timestamp

La hora a la que el sensor informó location según el reloj del sensor.

server_time

Timestamp

Solo salida. Es la hora a la que el servidor recibió la información de ubicación.

location_sensor

LocationSensor

Proveedor de datos de ubicación (por ejemplo, GPS)

is_road_snapped

BoolValue

Indica si location se ajustó a una ruta.

is_gps_sensor_enabled

BoolValue

Solo entrada. Indica si el sensor GPS está habilitado en el dispositivo móvil.

time_since_update

Int32Value

Solo entrada. Tiempo (en segundos) transcurridos desde que esta ubicación se envió al servidor por primera vez. Este valor será cero para la primera actualización. Si la hora es desconocida (por ejemplo, cuando se reinicia la app), este valor se restablece a cero.

num_stale_updates
(deprecated)

Int32Value

Solo entrada. Obsoleto: Ahora se usan otros indicadores para determinar si una ubicación está inactiva.

raw_location

LatLng

Ubicación del vehículo sin procesar (no procesada por el pargo).

raw_location_time

Timestamp

Marca de tiempo asociada con la ubicación sin procesar.

raw_location_sensor

LocationSensor

Fuente de la ubicación sin procesar. La configuración predeterminada es GPS.

raw_location_accuracy

DoubleValue

Precisión de raw_location como radio, en metros.

supplemental_location

LatLng

Es la ubicación complementaria que proporciona la app integrada.

supplemental_location_time

Timestamp

Marca de tiempo asociada con la ubicación complementaria.

supplemental_location_sensor

LocationSensor

La fuente de la ubicación complementaria. La configuración predeterminada es CUSTOMER_SUPPLIED_LOCATION.

supplemental_location_accuracy

DoubleValue

Precisión de supplemental_location como radio, en metros.

road_snapped
(deprecated)

bool

Obsoleto: usa is_road_snapped en su lugar.

VehicleMatch

Contiene el vehículo y las estimaciones relacionadas para un vehículo que coinciden con los puntos de viajes activos del vehículo SearchVehiclesRequest.

Campos
vehicle

Vehicle

Obligatorio. Un vehículo que coincida con la solicitud

vehicle_pickup_eta

Timestamp

Es la hora de llegada estimada del vehículo hasta el punto de partida especificado en la solicitud. Un valor vacío indica que no se pudo calcular la hora de llegada estimada del vehículo. Si SearchVehiclesRequest.include_back_to_back era true y este vehículo tiene un viaje activo, vehicle_pickup_eta incluye el tiempo necesario para completar el viaje activo actual.

vehicle_pickup_distance_meters

Int32Value

Es la distancia desde la ubicación actual del vehículo hasta el punto de partida especificado en la solicitud, incluidos los puntos intermedios de partida o llegada para los viajes existentes. Esta distancia incluye la distancia calculada de conducción (ruta), más la distancia en línea recta entre el punto de destino de la navegación y el punto de partida solicitado. (La distancia entre el extremo de navegación y el punto de partida solicitado suele ser pequeña). Un valor vacío indica un error en el cálculo de la distancia.

vehicle_pickup_straight_line_distance_meters

Int32Value

Obligatorio. La distancia lineal entre el vehículo y el punto de partida especificado en la solicitud.

vehicle_dropoff_eta

Timestamp

Es la hora de llegada estimada del vehículo completo hasta el punto de llegada especificado en la solicitud. La hora de llegada estimada incluye la parada en cualquier punto de referencia antes del dropoff_point especificado en la solicitud. El valor solo se completará cuando se especifique un punto de destino en la solicitud. Un valor vacío indica que se produjo un error al calcular la hora de llegada estimada.

vehicle_pickup_to_dropoff_distance_meters

Int32Value

La distancia en automóvil del vehículo (en metros) desde el punto de partida hasta el punto de llegada especificado en la solicitud. La distancia solo se establece entre los dos puntos y no incluye la ubicación del vehículo ni ningún otro punto que se deba visitar antes de que este visite el punto de partida o de destino. El valor solo se propagará cuando se especifique un dropoff_point en la solicitud. Un valor vacío indica que no se pudo calcular la distancia desde el punto de partida hasta el punto de llegada especificado en la solicitud.

trip_type

TripType

Obligatorio. Es el tipo de viaje de la solicitud que se utilizó para calcular la hora de llegada estimada al punto de partida.

vehicle_trips_waypoints[]

Waypoint

La lista ordenada de puntos de referencia utilizados para calcular la hora de llegada estimada. La lista incluye la ubicación del vehículo, los puntos de retiro de los viajes activos y los puntos de retiro proporcionados en la solicitud. Si la lista está vacía, significa que no se pudo calcular la hora de llegada estimada del vehículo.

vehicle_match_type

VehicleMatchType

Tipo de coincidencia de vehículo.

requested_ordered_by

VehicleMatchOrder

El pedido solicitado para ordenar las coincidencias de vehículos.

ordered_by

VehicleMatchOrder

Es el pedido real que se usó para este vehículo. Por lo general, este coincidirá con el campo “order_by” de la solicitud. Sin embargo, en ciertas circunstancias, como un error interno del servidor, se puede usar un método diferente (como PICKUP_POINT_STRAIGHT_DISTANCE).

VehicleMatchType

Tipo de coincidencia de vehículo.

Enumeradores
UNKNOWN Tipo de concordancia de vehículo desconocido
EXCLUSIVE Actualmente, el vehículo no tiene ningún viaje asignado y puede dirigirse al punto de partida.
BACK_TO_BACK Actualmente, el vehículo está asignado a un viaje, pero puede continuar hasta el punto de partida después de completar el viaje en curso. Los cálculos de la hora de llegada estimada y la distancia tienen en cuenta el viaje existente.
CARPOOL El vehículo tiene capacidad suficiente para realizar un viaje compartido.
CARPOOL_BACK_TO_BACK El vehículo finalizará su viaje actual y activo antes de dirigirse al punto de partida. Los cálculos de la hora de llegada estimada y la distancia tienen en cuenta el viaje existente.

VehicleState

Es el estado de un Vehicle.

Enumeradores
UNKNOWN_VEHICLE_STATE Predeterminado: se usa para los estados del vehículo no especificados o no reconocidos.
OFFLINE El vehículo no acepta viajes nuevos. Nota: El vehículo puede seguir funcionando en este estado mientras completa un viaje asignado.
ONLINE El vehículo está aceptando viajes nuevos.

VisualTrafficReportPolylineRendering

Describe el modo en que los clientes deberían colorear una parte de la polilínea a lo largo de la ruta.

Campos
road_stretch[]

RoadStretch

Opcional. Tramos de ruta que se deben representar a lo largo de la polilínea. Se garantiza que los estiramientos no se superpondrán y no abarcan necesariamente todo el recorrido.

Ante la ausencia de un tramo de ruta para el diseño, el cliente debe aplicar el valor predeterminado para la ruta.

RoadStretch

Un tramo de ruta que se debería renderizar.

Campos
style

Style

Obligatorio. El estilo que se aplicará.

offset_meters

int32

Obligatorio. El diseño debe aplicarse entre [offset_meters, offset_meters + length_meters).

length_meters

int32

Obligatorio. La longitud de la ruta donde se aplicará el estilo.

Estilo

El estilo del tráfico, que indica la velocidad del tráfico.

Enumeradores
STYLE_UNSPECIFIED No se seleccionó ningún estilo.
SLOWER_TRAFFIC El tráfico se está ralentizando.
TRAFFIC_JAM Hay un embotellamiento.

Waypoint

Describe los puntos intermedios de una ruta para un VehicleMatch en un SearchVehiclesResponse. Este concepto se representa como una TripWaypoint en todos los demás extremos.

Campos
lat_lng

LatLng

La ubicación de este punto de referencia.

eta

Timestamp

La hora estimada a la que el vehículo llegará a este punto de referencia.

WaypointType

El tipo de punto de referencia.

Enumeradores
UNKNOWN_WAYPOINT_TYPE Tipo de punto de referencia desconocido o no especificado.
PICKUP_WAYPOINT_TYPE Puntos de referencia para recoger pasajeros o artículos.
DROP_OFF_WAYPOINT_TYPE Puntos de referencia para dejar pasajeros o artículos.
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE Puntos de referencia para destinos intermedios en un viaje con varios destinos.