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.

DeleteTrip

rpc DeleteTrip(DeleteTripRequest) returns (Empty)

Borra un solo viaje.

Devuelve FAILED_PRECONDITION si el viaje está activo y asignado a un vehículo.

GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Obtén 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 de un vehículo específico.

UpdateTrip

rpc UpdateTrip(UpdateTripRequest) returns (Trip)

Actualiza los datos del viaje.

VehicleService

Servicio de administración de vehículos.

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

Crea una instancia de un vehículo nuevo asociado a un proveedor de viajes compartidos 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 de 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 usan si se proporcionan.

DeleteVehicle

rpc DeleteVehicle(DeleteVehicleRequest) returns (Empty)

Borra un vehículo de Fleet Engine.

Devuelve FAILED_PRECONDITION si el vehículo tiene viajes activos asignados.

GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

Devuelve un vehículo de Fleet Engine.

ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

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

SearchVehicles

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

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

UpdateVehicle

rpc UpdateVehicle(UpdateVehicleRequest) returns (Vehicle)

Escribe los datos del vehículo actualizados en Fleet Engine.

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

  • currentTrips
  • availableCapacity
  • current_route_segment_version
  • waypoints_version

El vehículo name tampoco se puede actualizar.

Si se actualiza el campo attributes, todos los atributos del vehículo se reemplazan por los atributos proporcionados en la solicitud. Si deseas actualizar solo algunos atributos, consulta el método UpdateVehicleAttributes. Del mismo modo, se puede actualizar el campo waypoints, pero debe contener todos los puntos de ruta que se encuentran actualmente en el vehículo y ningún otro.

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, donde todo el campo attributes se reemplazará por el de UpdateVehicleRequest y se quitarán los atributos que no estén en la solicitud.

BatteryInfo

Es información sobre la batería del dispositivo.

Campos
battery_status

BatteryStatus

Estado de la batería, ya sea que esté completa o en carga, etc.

power_source

PowerSource

Es el estado de la fuente de alimentación de la batería.

battery_percentage

float

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

BatteryStatus

Estado de la batería, ya sea que esté completa o en carga, etc.

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

BillingPlatformIdentifier

Es un conjunto de valores que indican en qué plataforma se emitió la solicitud.

Enumeraciones
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED Predeterminado. Se usa para plataformas no especificadas.
SERVER La plataforma es un cliente-servidor.
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 incluyen 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

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

CreateTripRequest

Es el mensaje de solicitud de CreateTrip.

Campos
header

RequestHeader

Es el encabezado de solicitud estándar de Fleet Engine.

parent

string

Es 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 la cuenta de servicio que realiza esta llamada es miembro.

trip_id

string

Es obligatorio. Es el ID único del viaje. Sujeto a las siguientes restricciones:

  • Debe ser una cadena Unicode válida.
  • Se limita a una longitud máxima de 64 caracteres.
  • Se normaliza según la forma C de normalización de Unicode.
  • No puede contener ninguno de los siguientes caracteres ASCII: "/", ":", "?", "," o "#".
trip

Trip

Es obligatorio. Es la entidad de viaje que se creará.

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

  • trip_type
  • pickup_point

Se usan los siguientes campos si los proporcionas:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

Se ignoran todos los demás campos de Trip. 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 de EXCLUSIVE admiten intermediate_destinations.

Cuando se establece 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, el orden de los puntos de referencia no se determinará.

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 esté antes de los destinos intermedios y todos los destinos intermedios estén antes del punto de destino. Los puntos de referencia de un viaje EXCLUSIVE no deben intercalarse con los de ningún otro viaje.

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

CreateVehicleRequest

Mensaje de solicitud de CreateVehicle.

Campos
header

RequestHeader

Es el encabezado de solicitud estándar de Fleet Engine.

parent

string

Es 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 la cuenta de servicio que realiza esta llamada es miembro.

vehicle_id

string

Es obligatorio. Es el ID único del vehículo. Sujeto a las siguientes restricciones:

  • Debe ser una cadena Unicode válida.
  • Se limita a una longitud máxima de 64 caracteres.
  • Se normaliza según la forma C de normalización de Unicode.
  • No puede contener ninguno de los siguientes caracteres ASCII: "/", ":", "?", "," o "#".
vehicle

Vehicle

Es obligatorio. Es la entidad Vehicle que se creará. Cuando se crea un vehículo, se deben completar los siguientes campos:

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Cuando se crea 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 usan si se proporcionan.

DeleteTripRequest

Es el mensaje de solicitud de DeleteTrip.

Campos
header

RequestHeader

Opcional. Es el encabezado de solicitud estándar de Fleet Engine.

name

string

Es 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 la cuenta de servicio que realiza esta llamada es miembro.

DeleteVehicleRequest

Es el mensaje de solicitud de DeleteVehicle.

Campos
header

RequestHeader

Opcional. Es el encabezado de solicitud estándar de Fleet Engine.

name

string

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

DeviceSettings

Información sobre varios parámetros de configuración del dispositivo móvil

Campos
location_power_save_mode

LocationPowerSaveMode

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

is_power_save_mode

bool

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

is_interactive

bool

Indica si el dispositivo está en un estado interactivo.

battery_info

BatteryInfo

Es información sobre el estado de la batería.

GetTripRequest

Es el mensaje de solicitud de GetTrip.

Campos
header

RequestHeader

Es el encabezado de solicitud estándar de Fleet Engine.

name

string

Es 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 la cuenta de servicio que realiza esta llamada es miembro.

view

TripView

Es el subconjunto de campos de Trip que se deben devolver 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 cambiaron desde esta marca de tiempo, el campo de la 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
(deprecated)

Timestamp

Obsoleto: Los Trip.remaining_waypoints siempre se recuperan. Usa remaining_waypoints_route_version para controlar cuándo se recuperan los datos de Trip.remaining_waypoints.traffic_to_waypoint y Trip.remaining_waypoints.path_to_waypoint.

route_format_type

PolylineFormatType

Es 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 cambiaron desde esta marca de tiempo, el campo current_route_segment_traffic no se establece 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 cambiaron desde esta marca de tiempo, los campos anteriores no se configuran en la respuesta. Si no se especifica remaining_waypoints_route_version, siempre se recuperan el tráfico y la ruta.

GetVehicleRequest

Mensaje de solicitud de GetVehicle.

Campos
header

RequestHeader

Es el encabezado de solicitud estándar de Fleet Engine.

name

string

Es 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 la cuenta de servicio que realiza esta llamada es miembro.

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 cambió desde esta marca de tiempo, el campo current_route_segment no se establece en la respuesta. Si no se especifica un mínimo, siempre se recupera 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 cambiaron desde esta marca de tiempo, los datos de vehicle.waypoints no se establecen en la respuesta. Si no se especifica este campo, siempre se recupera vehicle.waypoints.

LicensePlate

Es 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

Es 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

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

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

ListVehiclesRequest

Mensaje de solicitud de ListVehicles.

Campos
header

RequestHeader

Es el encabezado de solicitud estándar de Fleet Engine.

parent

string

Es 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 la cuenta de servicio que realiza esta llamada es miembro.

page_size

int32

Es la cantidad máxima de vehículos que se devolverán. El valor predeterminado es 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 criterios de filtro de la llamada anterior a ListVehicles.

minimum_capacity

Int32Value

Especifica la capacidad mínima requerida del vehículo. Todos los vehículos que se devuelvan 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 del período especificado. Los vehículos detenidos que siguen transmitiendo su ubicación no se consideran obsoletos. Si está presente, debe ser una duración positiva válida.

vehicle_type_categories[]

Category

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

required_attributes[]

string

Las entidades que llaman 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 componer 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 los vehículos con los atributos especificados. Este campo es una operación de conjunción/AND. Se permite un máximo de 50 required_attributes. Esto coincide con la cantidad máxima de atributos permitidos en un vehículo. Cada cadena repetida debe tener el formato "clave:valor".

required_one_of_attributes[]

string

Restringe la respuesta a los vehículos que tienen 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 inclusiva/OR en cada VehicleAttributeList y una operación de conjunción/AND en la colección de VehicleAttributeList. Cada cadena repetida debe tener el formato "clave1:valor1|clave2:valor2|clave3:valor3".

required_one_of_attribute_sets[]

string

required_one_of_attribute_sets proporciona funcionalidad adicional.

Al igual que required_one_of_attributes, required_one_of_attribute_sets usa un mensaje que permite una lista de listas, lo que permite expresiones como esta:

(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 objeto VehicleAttributeList. Dentro de cada lista, un vehículo debe coincidir con todos los atributos. Este campo es una operación de conjunción/AND en cada VehicleAttributeList y una operación de disyunción inclusiva/OR en toda la colección de VehicleAttributeList. Cada cadena repetida debe tener el formato "clave1:valor1|clave2:valor2|clave3:valor3".

vehicle_state

VehicleState

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

on_trip_only

bool

Solo se muestran los vehículos con viajes en curso.

filter

string

Opcional. Es una consulta de filtro que se aplica cuando se enumeran 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 un valor no vacío aquí, los siguientes campos deben estar vacíos: 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 consultas admitidas son las que se realizan sobre atributos del vehículo (por ejemplo, attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>). La cantidad máxima de restricciones permitidas en una consulta 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 comparaciones de cadenas. Para comparar con valores numéricos o booleanos, los valores deben estar entre comillas de forma explícita para que se traten 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 la ventana gráfica.

ListVehiclesResponse

Mensaje de respuesta ListVehicles.

Campos
vehicles[]

Vehicle

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

next_page_token

string

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

total_size

int64

Es obligatorio. Es la cantidad total de vehículos que coinciden con los criterios de la solicitud en todas las páginas.

LocationPowerSaveMode

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

Enumeraciones
UNKNOWN_LOCATION_POWER_SAVE_MODE Undefined LocationPowerSaveMode
LOCATION_MODE_NO_CHANGE Los proveedores de ubicación no deben verse afectados por el Ahorro de batería, o bien el Ahorro de batería debe estar desactivado.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF El proveedor de ubicación basado en GPS debe inhabilitarse cuando el ahorro de batería está activado y el dispositivo no es interactivo.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Todos los proveedores de ubicación deben inhabilitarse cuando el ahorro de batería está activado y el dispositivo no es interactivo.
LOCATION_MODE_FOREGROUND_ONLY Todos los proveedores de ubicación seguirán disponibles, pero las correcciones de ubicación solo se deben proporcionar a las apps en primer plano.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF La ubicación no se desactivará, 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.

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

Es el estado de navegación del vehículo.

Enumeraciones
UNKNOWN_NAVIGATION_STATUS Estado de navegación sin especificar.
NO_GUIDANCE La navegación de la app de Conductor está en modo FREE_NAV.
ENROUTE_TO_DESTINATION La navegación paso a paso está disponible y la navegación de la app para socios conductores entró en el modo GUIDED_NAV.
OFF_ROUTE El vehículo se desvió de la ruta sugerida.
ARRIVED_AT_DESTINATION El vehículo se encuentra a aproximadamente 50 m del destino.

PolylineFormatType

Es el tipo de formato de polilínea.

Enumeraciones
UNKNOWN_FORMAT_TYPE El formato no se especificó o se desconoce.
LAT_LNG_LIST_TYPE Es una lista de google.type.LatLng.
ENCODED_POLYLINE_TYPE Es 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 usa para cargar la batería.

Enumeraciones
UNKNOWN_POWER_SOURCE Se desconoce la fuente de alimentación.
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

Es el mensaje de solicitud de ReportBillableTrip.

Campos
name

string

Es 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 la cuenta de servicio que realiza esta llamada es miembro.

country_code

string

Es obligatorio. Es el código de país de dos letras en el que se realiza el viaje. El precio se define según el código de país.

platform

BillingPlatformIdentifier

Es la plataforma en la que se emitió la solicitud.

related_ids[]

string

Son los identificadores directamente relacionados con el viaje del que se informa. Por lo general, son IDs (por ejemplo, IDs de sesión) de operaciones previas a la reserva que se realizan antes de que esté disponible el ID del 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 usó para el viaje informado.

SolutionType

Es un selector para los diferentes tipos de soluciones de un viaje informado.

Enumeraciones
SOLUTION_TYPE_UNSPECIFIED Es el valor predeterminado. Para garantizar la retrocompatibilidad, la API usará ON_DEMAND_RIDESHARING_AND_DELIVERIES de forma predeterminada, que es el primer tipo de solución admitido.
ON_DEMAND_RIDESHARING_AND_DELIVERIES La solución es un viaje de viajes compartidos y entregas 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 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 una preferencia por el inglés si existe tal nombre. Ejemplo de valor del campo: en-US.

region_code

string

Es obligatorio. Es el código de región de CLDR de la región en la que se origina la solicitud. Ejemplo de valor del campo: US.

sdk_version

string

Es la versión del SDK de llamada, si corresponde. El formato de la versión es “principal.secundaria.parche”, 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

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 Maps de la que depende el SDK de llamada, si corresponde. El formato de la versión es “principal.secundaria.parche”, por ejemplo, 5.2.1.

nav_sdk_version

string

Es la versión del NavSDK de la que depende el SDK de llamada, si corresponde. El formato de la versión es “principal.secundaria.parche”, por ejemplo, 2.1.0.

platform

Platform

Es la plataforma del SDK de llamada.

manufacturer

string

Fabricante del dispositivo Android desde el SDK de llamada, solo aplicable para los SDKs de Android. Ejemplo de valor del campo: Samsung.

android_api_level

int32

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

trace_id

string

Es un ID opcional que se puede proporcionar para fines de registro y para identificar la solicitud.

Plataforma

Es la plataforma del SDK que realiza la llamada.

Enumeraciones
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

Son los tipos posibles de SDK.

Enumeraciones
SDK_TYPE_UNSPECIFIED Es el valor predeterminado. Este valor se usa si se omite sdk_type.
CONSUMER El SDK de llamadas es Consumer.
DRIVER El SDK de llamada es Driver.
JAVASCRIPT El SDK de llamada es JavaScript.

SearchTripsRequest

Es el mensaje de solicitud de SearchTrips.

Campos
header

RequestHeader

Es el encabezado de solicitud estándar de Fleet Engine.

parent

string

Es 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 la cuenta de servicio que realiza esta llamada es miembro.

vehicle_id

string

Es el vehículo asociado a los viajes de la solicitud. Si no se especifica, los viajes devueltos no contienen lo siguiente:

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
active_trips_only

bool

Si se establece como verdadero, la respuesta incluye los 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 este parámetro en un valor que se haya mostrado anteriormente en SearchTripsResponse para continuar con los resultados anteriores.

minimum_staleness

Duration

Si se especifica, devuelve los viajes que no se actualizaron después de la hora (current - minimum_staleness).

SearchTripsResponse

Es el mensaje de respuesta de SearchTrips.

Campos
trips[]

Trip

Es la lista de viajes del vehículo solicitado.

next_page_token

string

Pasa este token en SearchTripsRequest para paginar los resultados de la lista. La API devuelve una lista de viajes en cada llamada y, cuando no quedan más resultados, la lista de viajes está vacía.

SearchVehiclesRequest

Mensaje de solicitud de SearchVehicles.

Campos
header

RequestHeader

Es el encabezado de solicitud estándar de Fleet Engine.

parent

string

Es 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 la cuenta de servicio que realiza esta llamada es miembro.

pickup_point

TerminalLocation

Es obligatorio. Es el punto de retiro cerca del cual se realizará la búsqueda.

dropoff_point

TerminalLocation

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

pickup_radius_meters

int32

Es obligatorio. Define el radio de búsqueda de vehículos alrededor del punto de partida. Solo se devolverán los vehículos que se encuentren dentro del radio de búsqueda. El valor debe estar entre 400 y 10,000 metros (inclusive).

count

int32

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

minimum_capacity

int32

Es obligatorio. Especifica la cantidad de pasajeros que se consideran para un viaje. El valor debe ser mayor o igual que uno. El conductor no se considera en el valor de capacidad.

trip_types[]

TripType

Es obligatorio. Representa el tipo de viaje propuesto. Debe incluir exactamente un tipo. No se permite UNKNOWN_TRIP_TYPE. Restringe la búsqueda solo a los vehículos que pueden admitir 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 del período especificado. Los vehículos detenidos que siguen transmitiendo su ubicación no se consideran obsoletos. Si no se establece este campo, el servidor usa cinco minutos como valor predeterminado.

vehicle_types[]

VehicleType

Es 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 VehicleTypes con una categoría de UNKNOWN.

required_attributes[]

VehicleAttribute

Las entidades que llaman 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 componer 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 required_attributes. Esto coincide con 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 que tienen 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 inclusiva/OR en cada VehicleAttributeList y una operación de conjunción/AND en la colección de VehicleAttributeList.

required_one_of_attribute_sets[]

VehicleAttributeList

required_one_of_attribute_sets proporciona funcionalidad adicional.

Al igual que required_one_of_attributes, required_one_of_attribute_sets usa un mensaje que permite una lista de listas, lo que permite expresiones como esta:

(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 que tienen todos los atributos en un VehicleAttributeList. Dentro de cada lista, un vehículo debe coincidir con todos los atributos. Este campo es una operación de conjunción/AND en cada VehicleAttributeList y una operación de disyunción inclusiva/OR en toda la colección de VehicleAttributeList.

order_by

VehicleMatchOrder

Es 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. Cuando no se especifica current_trips_present y este campo es false, los vehículos con viajes asignados se excluyen de los resultados de la búsqueda. 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. Debe establecerse en un valor que no sea CURRENT_TRIPS_PRESENT_UNSPECIFIED si trip_type incluye SHARED.

filter

string

Opcional. Es una consulta de filtro que se aplica cuando se buscan 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 un valor no vacío aquí, los siguientes campos deben estar vacíos: 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 consultas admitidas son las que se realizan sobre atributos del vehículo (por ejemplo, attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>). La cantidad máxima de restricciones permitidas en una consulta 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 comparaciones de cadenas. Para comparar con valores numéricos o booleanos, los valores deben estar entre comillas de forma explícita para que se traten como cadenas (por ejemplo, attributes.<key> = "10" o attributes.<key> = "true").

CurrentTripsPresent

Especifica los tipos de restricciones en los viajes actuales de un vehículo.

Enumeraciones
CURRENT_TRIPS_PRESENT_UNSPECIFIED La disponibilidad de vehículos con viajes presentes se rige 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 los vehículos con un máximo de 5 viajes actuales 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 de vehículos en la respuesta.

Enumeraciones
UNKNOWN_VEHICLE_MATCH_ORDER Es el valor predeterminado y se usa para el orden de coincidencias de vehículos no especificado o no reconocido.
PICKUP_POINT_ETA Orden ascendente según el tiempo de conducción del vehículo hasta el punto de partida.
PICKUP_POINT_DISTANCE Orden ascendente según la distancia de conducción del vehículo hasta el punto de partida.
DROPOFF_POINT_ETA Orden ascendente según el tiempo de conducción del vehículo hasta el punto de entrega. Este orden solo se puede usar si se especifica el punto de entrega en la solicitud.
PICKUP_POINT_STRAIGHT_DISTANCE Orden ascendente según la distancia en línea recta desde la última ubicación informada del vehículo hasta el punto de partida.
COST Orden ascendente según el costo de la coincidencia configurado. El costo de la coincidencia se define como un cálculo ponderado entre la distancia en línea recta y la ETA. Los pesos se establecen con valores predeterminados y se pueden modificar por cliente. Comunícate con el equipo de asistencia de Google si es necesario modificar estos pesos para tu proyecto.

SearchVehiclesResponse

Mensaje de respuesta SearchVehicles.

Campos
matches[]

VehicleMatch

Es una lista de vehículos que coinciden con los criterios de SearchVehiclesRequest, ordenada según el campo SearchVehiclesRequest.order_by.

SpeedReadingInterval

Es un indicador de la densidad del tráfico en un tramo contiguo de una ruta. Dado un camino con puntos P_0, P_1, …, P_N (índice basado en cero), el objeto SpeedReadingInterval define un intervalo y describe su tráfico con las siguientes categorías.

Campos
start_polyline_point_index

int32

Es 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

Í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 la polilínea según los datos de tráfico.

Enumeraciones
SPEED_UNSPECIFIED Valor predeterminado Este valor no se usa.
NORMAL Velocidad normal, sin demoras en el tráfico.
SLOW Se detectó una desaceleración y hay una cantidad moderada de tráfico.
TRAFFIC_JAM Demoras en el tráfico

StopLocation

Es la ubicación real en la que se produjo una parada (ascenso o descenso).

Campos
point

LatLng

Es obligatorio. Denota la ubicación real.

timestamp

Timestamp

Indica cuándo ocurrió la parada.

stop_time
(deprecated)

Timestamp

Solo entrada. Obsoleta. Usa el campo de marca de tiempo.

TerminalLocation

Describe la ubicación de un punto de referencia.

Campos
point

LatLng

Denota la LatLng exacta del punto de referencia. Se debe especificar point o place como entrada. Si se especifican ambos, se usará point para el enrutamiento y place para los metadatos. Si solo se especifica place como entrada, point se calculará a partir de place y se incluirá en el resultado.

place

string

Es el nombre del recurso del lugar que representa esta ubicación. El formato es places/{place_id}. Se debe especificar point o place como entrada. Si se especifican ambos, se usará point para el enrutamiento y place para los metadatos. place solo se incluye en el resultado si se incluyó en la entrada, lo que significa que no se realiza ninguna búsqueda de place desde LatLng.

Esta función se encuentra en fase experimental.

point_location_source

PointSource

Solo salida. Es la fuente del campo point.

terminal_point_id
(deprecated)

TerminalPointId

Obsoleto: Especifica el campo place en su lugar.

access_point_id
(deprecated)

string

Obsoleto: Especifica el campo place en su lugar.

trip_id
(deprecated)

string

Obsoleta.

terminal_location_type
(deprecated)

WaypointType

Obsoleto: Vehicle.waypoint tendrá estos datos.

PointSource

Indica la fuente de un LatLng.

Enumeraciones
POINT_SOURCE_UNSPECIFIED No se especificó la fuente puntual.
POINT_SOURCE_DEVELOPER_PROVIDED El desarrollador proporcionó explícitamente el LatLng.
POINT_SOURCE_CALCULATED_FROM_PLACE El valor de LatLng se calculó a partir del lugar proporcionado.

TerminalPointId

Obsoleto: Ya no se admiten los TerminalPoints en Fleet Engine. Usa TerminalLocation.point en su lugar.

Campos
value
(deprecated)

string

Obsoleta.

Campo de unión Id. Obsoleta. Las direcciones (Id) solo pueden ser una de las siguientes opciones:
place_id
(deprecated)

string

Obsoleta.

generated_id
(deprecated)

string

Obsoleta.

TrafficPolylineData

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

Campos
traffic_rendering

VisualTrafficReportPolylineRendering

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

Viaje

Son los metadatos del viaje.

Campos
name

string

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

vehicle_id

string

ID del vehículo que realiza este viaje.

trip_status

TripStatus

Es el estado actual del viaje.

trip_type

TripType

Es el tipo de viaje.

pickup_point

TerminalLocation

Ubicación en la que el cliente indica que lo recogerán.

actual_pickup_point

StopLocation

Solo entrada. La ubicación real en la que se recogió al cliente y el momento en que se hizo. Este campo es para que el proveedor proporcione comentarios sobre la información de retiro real.

actual_pickup_arrival_point

StopLocation

Solo entrada. Hora y ubicación reales de la llegada del conductor al punto de partida. Este campo es para que el proveedor proporcione comentarios sobre la información de llegada real al punto de partida.

pickup_time

Timestamp

Solo salida. Es la hora futura estimada en la que se recogerá al pasajero o la hora real en la que se lo recogió.

intermediate_destinations[]

TerminalLocation

Son las paradas intermedias en el orden en que se solicitan los viajes (además de la recogida y la llegada). Inicialmente, no se admitirá para los viajes compartidos.

intermediate_destinations_version

Timestamp

Indica la última vez que se modificó el objeto intermediate_destinations. Tu servidor debe almacenar en caché este valor y pasarlo en UpdateTripRequest cuando actualice intermediate_destination_index para garantizar que no se cambie intermediate_destinations.

intermediate_destination_index

int32

Cuando TripStatus es ENROUTE_TO_INTERMEDIATE_DESTINATION, un número entre [0..N-1] que indica 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, este campo se ignora.

actual_intermediate_destination_arrival_points[]

StopLocation

Solo entrada. Hora y ubicación reales de la llegada del conductor a un destino intermedio. Este campo es para que el proveedor proporcione comentarios sobre la información de llegada real a los destinos intermedios.

actual_intermediate_destinations[]

StopLocation

Solo entrada. Hora y ubicación reales en las que se recogió al cliente en un destino intermedio. Este campo es para que el proveedor proporcione comentarios sobre la información de retiro real en los destinos intermedios.

dropoff_point

TerminalLocation

Ubicación en la que el cliente indica que se bajará.

actual_dropoff_point

StopLocation

Solo entrada. Hora y ubicación reales en las que se dejó al cliente. Este campo es para que el proveedor proporcione comentarios sobre la información real de la parada.

dropoff_time

Timestamp

Solo salida. Es la hora futura estimada en la que se dejará a los pasajeros en el destino final o la hora real en la que se los dejó.

remaining_waypoints[]

TripWaypoint

Solo salida. Es la ruta completa desde la ubicación actual hasta el punto de destino, incluidos ambos. Esta ruta podría incluir puntos de referencia de otros viajes.

vehicle_waypoints[]

TripWaypoint

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

route[]

LatLng

Solo salida. Es la ruta prevista para este viaje hasta la primera entrada de remaining_waypoints. Ten en cuenta que el primer punto de ruta puede pertenecer a un viaje diferente.

current_route_segment

string

Solo salida. Es una ruta codificada hacia el siguiente punto de referencia.

Nota: Este campo solo está diseñado para que lo usen el SDK de Driver y el SDK de Consumer. 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 solo está diseñado para que lo usen el SDK de Driver y el SDK de Consumer.

current_route_segment_traffic

ConsumableTrafficPolyline

Solo salida. Indica las condiciones de tráfico a lo largo de la ruta current_route_segment cuando están disponibles.

Nota: Este campo solo está diseñado para que lo usen el SDK de Driver y el SDK de Consumer.

current_route_segment_traffic_version

Timestamp

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

Nota: Este campo solo está diseñado para que lo usen el SDK de Driver y el SDK de Consumer.

current_route_segment_end_point

TripWaypoint

Solo salida. Es la parada en la que termina current_route_segment.

remaining_distance_meters

Int32Value

Solo salida. La distancia de conducción restante en el campo current_route_segment El valor no se especifica si el viaje no se asigna a un vehículo o si se completa o cancela.

eta_to_first_waypoint

Timestamp

Solo salida. Es la ETA al próximo punto de ruta (la primera entrada en el campo remaining_waypoints). El valor no se especifica si el viaje no se asigna a un vehículo o si el viaje está inactivo (completado o cancelado).

remaining_time_to_first_waypoint

Duration

Solo salida. Es la duración desde el momento en que se devuelven los datos del viaje hasta el momento en Trip.eta_to_first_waypoint. El valor no se especifica si el viaje no se asigna a un vehículo o si el viaje está inactivo (completado o cancelado).

remaining_waypoints_version

Timestamp

Solo salida. Indica la última vez que se cambió remaining_waypoints (se agregó, quitó o 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 y el tráfico de remaining_waypoints solo se devuelvan si se actualizan.

number_of_passengers

int32

Inmutable. Indica la cantidad de pasajeros en 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 a lo largo de la ruta.

last_location_snappable

bool

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

view

TripView

Es el subconjunto de campos de Trip que se completan y cómo se deben interpretar.

attributes[]

TripAttribute

Es una lista de atributos de viaje personalizados. Cada atributo debe tener una clave única.

TripAttribute

Describe un atributo de viaje como un par clave-valor. La longitud de la cadena "clave:valor" no puede superar los 256 caracteres.

Campos
key

string

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

Campo de unión trip_attribute_value. Es el valor del atributo y puede ser de tipo string, bool o double. Las direcciones (trip_attribute_value) solo pueden ser una de las siguientes opciones:
string_value

string

Es el valor del atributo escrito como cadena.

bool_value

bool

Es el valor del atributo escrito booleano.

number_value

double

Es el valor del atributo escrito como doble.

TripStatus

Es el estado de un viaje que indica su progreso.

Enumeraciones
UNKNOWN_TRIP_STATUS Es el valor predeterminado y se usa para el estado del viaje no especificado o no reconocido.
NEW Es un viaje creado recientemente.
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 está en camino a un destino intermedio (no al punto de entrega).
ENROUTE_TO_DROPOFF El conductor recogió al pasajero y está en camino al próximo destino.
COMPLETE El pasajero se bajó y el viaje se completó.
CANCELED El viaje se canceló antes de la partida por el conductor, el pasajero o el proveedor de viajes compartidos.

TripType

Es el tipo de viaje.

Enumeraciones
UNKNOWN_TRIP_TYPE Es el valor predeterminado y se usa para los tipos de viajes 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

Es un selector para diferentes conjuntos de campos de Trip en una respuesta de GetTrip. Consulta AIP-157 para obtener contexto. Es probable que se agreguen vistas adicionales.

Enumeraciones
TRIP_VIEW_UNSPECIFIED Es el valor predeterminado. Para garantizar la retrocompatibilidad, la API usará una vista del SDK de forma predeterminada. Para garantizar la estabilidad y la asistencia, se recomienda a los clientes que seleccionen un TripView que no sea SDK.
SDK Incluye campos que pueden no ser interpretables o compatibles con bibliotecas disponibles públicamente.
JOURNEY_SHARING_V1S Los campos de viaje se completan para el caso de uso de Compartir viaje. 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 un punto final en el viaje de un vehículo.

Campos
location

TerminalLocation

Es la ubicación de este punto de ruta.

trip_id

string

Es el viaje asociado a este punto de ruta.

waypoint_type

WaypointType

Es el rol que desempeña este punto de referencia en el viaje, como la partida o el destino.

path_to_waypoint[]

LatLng

Es la ruta desde el punto de referencia anterior hasta el punto de referencia actual. Si este es el primer punto de ruta, la ruta es desde la ubicación actual del vehículo hasta el punto de ruta. Este campo solo se propaga cuando se solicita.

encoded_path_to_waypoint

string

Es la ruta codificada desde el punto de ruta anterior hasta el punto de ruta actual.

Nota: Este campo solo está diseñado para que lo usen el SDK de Driver y el SDK de Consumer. Aún no se admite la decodificación.

traffic_to_waypoint

ConsumableTrafficPolyline

Las condiciones de 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 de viajes y entregas de Google Maps Platform.

distance_meters

Int32Value

Es la distancia de la ruta desde la parada anterior hasta la parada actual. Si este es el primer punto de ruta, la distancia de la ruta es desde la ubicación actual del vehículo hasta el punto de ruta.

eta

Timestamp

Es la hora estimada de llegada a este punto de ruta.

duration

Duration

Es el tiempo de viaje desde la parada anterior hasta esta parada. Si este es el primer punto de referencia, el tiempo de viaje se calcula desde la ubicación actual del vehículo hasta el punto de referencia.

UpdateTripRequest

Es el mensaje de solicitud de UpdateTrip.

Campos
header

RequestHeader

Es el encabezado de solicitud estándar de Fleet Engine.

name

string

Es 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 la cuenta de servicio que realiza esta llamada es miembro.

trip

Trip

Es obligatorio. Es el viaje asociado con la actualización.

Fleet Engine mantiene los siguientes campos. No los 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, debes proporcionar la lista de Trip.vehicle_waypoints para especificar el orden de los puntos de referencia restantes. De lo contrario, el orden no se determinará.

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 esté antes de los destinos intermedios y todos los destinos intermedios estén antes del punto de destino. Los puntos de referencia de un viaje EXCLUSIVE no deben intercalarse con los de ningún otro viaje. Se usan los campos trip_id, waypoint_type y location, y se ignoran todos los demás campos TripWaypoint en vehicle_waypoints.

Para evitar una condición de carrera en los 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 que se pasa debe ser coherente con la versión de Fleet Engine. Si no es así, la solicitud fallará.

update_mask

FieldMask

Es obligatorio. Es la máscara de campo que indica qué campos del viaje se deben actualizar. El objeto update_mask debe contener al menos un campo.

UpdateVehicleAttributesRequest

Mensaje de solicitud de UpdateVehicleAttributes.

Campos
header

RequestHeader

Es el encabezado de solicitud estándar de Fleet Engine.

name

string

Es 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 la cuenta de servicio que realiza esta llamada es miembro.

attributes[]

VehicleAttribute

Es obligatorio. Son los atributos del vehículo que se actualizarán. Los atributos no mencionados no se alteran ni se quitan.

UpdateVehicleAttributesResponse

Mensaje de respuesta UpdateVehicleAttributes.

Campos
attributes[]

VehicleAttribute

Es obligatorio. Es la lista completa actualizada de atributos del vehículo, incluidos los atributos nuevos, modificados y sin cambios.

UpdateVehicleRequest

Mensaje de solicitud de `UpdateVehicle`.

Campos
header

RequestHeader

Es el encabezado de solicitud estándar de Fleet Engine.

name

string

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

vehicle

Vehicle

Es obligatorio. Son los valores de la entidad Vehicle que se aplicarán. Cuando se actualiza un Vehicle, es posible que los siguientes campos no se actualicen, ya que los administra el servidor.

  • available_capacity
  • current_route_segment_version
  • current_trips
  • name
  • waypoints_version

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

Del mismo modo, se puede actualizar el campo waypoints, pero debe contener todos los puntos de ruta que se encuentran actualmente en el vehículo y ningún otro.

update_mask

FieldMask

Es obligatorio. Es una máscara de campo que indica qué campos del Vehicle se deben actualizar. Se debe proporcionar al menos un nombre de campo.

Vehículo

Son los 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

Son los tipos de viajes que admite este vehículo.

current_trips[]

string

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

last_location

VehicleLocation

Es la última ubicación informada del vehículo.

past_locations[]

VehicleLocation

Solo entrada. Son las ubicaciones en las que estuvo este vehículo en el pasado y que aún no se informaron a Fleet Engine. Se usa en UpdateVehicleRequest para registrar las ubicaciones que no se pudieron enviar al servidor anteriormente. Por lo general, esto sucede cuando el vehículo no tiene conectividad a Internet.

maximum_capacity

int32

Es la cantidad total de pasajeros que puede transportar este vehículo. El conductor no se tiene en cuenta en este valor. Este valor debe ser mayor o igual que uno.

attributes[]

VehicleAttribute

Es la lista de atributos del vehículo. Un vehículo puede tener hasta 100 atributos, y cada atributo debe tener una clave única.

vehicle_type

VehicleType

Es 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 ETA y la ruta.

license_plate

LicensePlate

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

route[]
(deprecated)

TerminalLocation

Obsoleto: Usa Vehicle.waypoints en su lugar.

current_route_segment

string

Es la polilínea que especifica la ruta que la app para conductores pretende tomar hasta el próximo punto de ruta. Esta lista también se muestra en Trip.current_route_segment para todos los viajes activos asignados al vehículo.

Nota: Este campo solo está diseñado para que lo use 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 el uso compartido del viaje. Nota: Este campo solo está diseñado para que lo use el SDK de Driver.

current_route_segment_version

Timestamp

Solo salida. Fecha y hora en que se estableció current_route_segment. El cliente puede almacenarlo y pasarlo en futuras solicitudes de GetVehicle para evitar que se devuelvan rutas que no cambiaron.

current_route_segment_end_point

TripWaypoint

Es la parada en la que termina current_route_segment. Los conductores pueden proporcionar este valor en las llamadas a UpdateVehicle como un punto de referencia de viaje completo, un punto de referencia LatLng o como el último LatLng de la current_route_segment. Luego, Fleet Engine hará todo lo posible para interpolar a un punto de ruta real si no se especifica por completo. Este campo se ignora en las llamadas a UpdateVehicle, a menos que también se especifique current_route_segment.

remaining_distance_meters

Int32Value

Es la distancia de conducción restante para el 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

Es la ETA para la primera entrada en el campo waypoints. El valor no se especifica si el campo waypoints o el campo Vehicle.current_route_segment están vacíos.

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. Es el tiempo de conducción restante para el current_route_segment. El valor no se especifica si el campo waypoints o el campo Vehicle.current_route_segment están vacíos. 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

Son los puntos de referencia restantes asignados a este vehículo.

waypoints_version

Timestamp

Solo salida. Es la ú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 consecutivos. Si es true, SearchVehicles puede incluir el vehículo incluso si está asignado a un viaje. El valor predeterminado es false.

navigation_status

NavigationStatus

Es el estado de navegación del vehículo.

device_settings

DeviceSettings

Solo entrada. Es 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 de tipo de vehículo

Categoría

Categorías de tipos de vehículos

Enumeraciones
UNKNOWN Es el valor predeterminado y se usa para las categorías de vehículos no especificadas o no reconocidas.
AUTO Un automóvil
TAXI Cualquier vehículo que funcione como taxi (por lo general, con licencia o regulado)
TRUCK Por lo general, es un vehículo con una gran capacidad de almacenamiento.
TWO_WHEELER Una motocicleta, un ciclomotor o cualquier otro vehículo de dos ruedas
BICYCLE Transporte a tracción humana
PEDESTRIAN Un transportador humano, que suele caminar o correr, y que se desplaza por senderos peatonales.

VehicleAttribute

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

Campos
key

string

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

value

string

Es el valor del atributo.

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

string

Es el valor del atributo escrito como cadena.

Nota: Este campo es idéntico al campo value, que quedará obsoleto en el futuro. 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 las respuestas.

bool_value

bool

Es el valor del atributo escrito booleano.

number_value

double

Es el valor del atributo escrito como doble.

VehicleAttributeList

Es un tipo de datos de lista de listas para los atributos del vehículo.

Campos
attributes[]

VehicleAttribute

Es una lista de atributos de esta colección.

VehicleLocation

Ubicación, velocidad y dirección 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 una ubicación GPS. Cuando la recibes en una respuesta, la ubicación del vehículo puede ser una ubicación GPS, una ubicación complementaria o alguna otra ubicación estimada. 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

Es la dirección en la que se mueve el vehículo, expresada en grados. El 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 por segundo

speed_accuracy

DoubleValue

Precisión de speed en metros por segundo.

update_time

Timestamp

Es la fecha y hora en que el sensor informó el valor de location según su reloj.

server_time

Timestamp

Solo salida. Fecha y hora en que el servidor recibió la información de ubicación.

location_sensor

LocationSensor

Es el 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 de GPS está habilitado en el dispositivo móvil.

time_since_update

Int32Value

Solo entrada. Es el tiempo (en segundos) transcurrido desde que se envió esta ubicación al servidor por primera vez. Este valor será cero para la primera actualización. Si se desconoce la hora (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á desactualizada.

raw_location

LatLng

Ubicación sin procesar del vehículo (sin procesar por el ajuste a la ruta).

raw_location_time

Timestamp

Es la marca de tiempo asociada a la ubicación sin procesar.

raw_location_sensor

LocationSensor

Es la 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.

flp_location

LatLng

Es la ubicación del proveedor de ubicación combinada de Android.

flp_update_time

Timestamp

Marca de tiempo de actualización de flp_location

flp_latlng_accuracy_meters

DoubleValue

Precisión de flp_location en metros como radio.

flp_heading_degrees

Int32Value

Es la dirección en la que se mueve el vehículo en grados, según lo determina el FusedLocationProvider. El 0 representa el norte. El rango válido es [0,360).

supplemental_location

LatLng

Es la ubicación complementaria que proporciona la app de integración.

supplemental_location_time

Timestamp

Es la marca de tiempo asociada a la ubicación complementaria.

supplemental_location_sensor

LocationSensor

Es 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 los viajes activos del vehículo SearchVehiclesRequest.

Campos
vehicle

Vehicle

Es obligatorio. Un vehículo que coincide con la solicitud.

vehicle_pickup_eta

Timestamp

Es la ETA de conducción del vehículo hasta el punto de partida especificado en la solicitud. Un valor vacío indica que no se pudo calcular la ETA 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 de partida o destino intermedios para los viajes existentes. Esta distancia comprende la distancia de conducción (ruta) calculada, más la distancia en línea recta entre el punto final de navegación y el punto de partida solicitado. (La distancia entre el punto de destino de la 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

Es obligatorio. Es la distancia en línea recta entre el vehículo y el punto de partida especificado en la solicitud.

vehicle_dropoff_eta

Timestamp

Es la hora estimada de llegada del vehículo completo al punto de entrega especificado en la solicitud. La ETA incluye las paradas en los puntos de referencia antes del dropoff_point especificado en la solicitud. El valor solo se propagará cuando se especifique un punto de entrega en la solicitud. Un valor vacío indica un error en el cálculo de la ETA.

vehicle_pickup_to_dropoff_distance_meters

Int32Value

Es la distancia de conducción del vehículo (en metros) desde el punto de partida hasta el punto de destino especificado en la solicitud. La distancia solo se calcula 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 el vehículo llegue al punto de partida o al punto 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 destino especificado en la solicitud.

trip_type

TripType

Es obligatorio. Es el tipo de viaje de la solicitud que se usó para calcular la ETA al punto de partida.

vehicle_trips_waypoints[]

Waypoint

Es la lista ordenada de puntos de referencia que se usa para calcular la ETA. La lista incluye la ubicación del vehículo, los puntos de retiro de los viajes activos del vehículo y los puntos de retiro proporcionados en la solicitud. Una lista vacía indica que no se pudo calcular la ETA del vehículo.

vehicle_match_type

VehicleMatchType

Es el tipo de coincidencia del vehículo.

requested_ordered_by

VehicleMatchOrder

Es el orden solicitado para ordenar las coincidencias de vehículos. Equivale a ordered_by.

ordered_by

VehicleMatchOrder

Es el orden solicitado para ordenar las coincidencias de vehículos. Equivale a requested_ordered_by.

VehicleMatchType

Es el tipo de coincidencia del vehículo.

Enumeraciones
UNKNOWN Tipo de coincidencia 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 dirigirse al punto de partida después de completar el viaje en curso. Los cálculos de la ETA y la distancia tienen en cuenta el viaje existente.
CARPOOL El vehículo tiene capacidad suficiente para un viaje compartido.
CARPOOL_BACK_TO_BACK El vehículo finalizará el viaje activo actual antes de dirigirse al punto de partida. Los cálculos de la ETA y la distancia tienen en cuenta el viaje existente.

VehicleState

Es el estado de un Vehicle.

Enumeraciones
UNKNOWN_VEHICLE_STATE Es el valor predeterminado y 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 que se le asignó.
ONLINE El vehículo acepta viajes nuevos.

VisualTrafficReportPolylineRendering

Describe cómo los clientes deben colorear una parte de la polilínea a lo largo de la ruta.

Campos
road_stretch[]

RoadStretch

Opcional. Son tramos de ruta que se deben renderizar a lo largo de la polilínea. Se garantiza que los tramos no se superponen y no necesariamente abarcan toda la ruta.

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

RoadStretch

Es un tramo de ruta que se debe renderizar.

Campos
style

Style

Es obligatorio. Es el estilo que se aplicará.

offset_meters

int32

Es obligatorio. El estilo se debe aplicar entre [offset_meters, offset_meters + length_meters).

length_meters

int32

Es obligatorio. Es la longitud de la ruta en la que se aplicará el estilo.

Estilo

Es el estilo de tráfico, que indica la velocidad del tráfico.

Enumeraciones
STYLE_UNSPECIFIED No se seleccionó ningún diseño.
SLOWER_TRAFFIC El tráfico se está ralentizando.
TRAFFIC_JAM Hay un embotellamiento.

Punto de referencia

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

Campos
lat_lng

LatLng

Es la ubicación de este punto de ruta.

eta

Timestamp

Es la hora estimada en la que el vehículo llegará a este punto de ruta.

WaypointType

Es el tipo de punto de ruta.

Enumeraciones
UNKNOWN_WAYPOINT_TYPE Tipo de punto de referencia desconocido o no especificado.
PICKUP_WAYPOINT_TYPE Son los puntos de ruta para recoger pasajeros o artículos.
DROP_OFF_WAYPOINT_TYPE Son los puntos de referencia para dejar pasajeros o artículos.
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE Son los puntos de referencia para los destinos intermedios en un viaje con varios destinos.