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 muestra el viaje nuevo.
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Obtén información sobre un solo viaje.
ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

Informa el uso facturable de los viajes.
SearchTrips

rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse)

Obtener todos los viajes de 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 vehículo nuevo asociado con un proveedor de transporte compartido o de entregas a pedido. Cada Vehicle debe tener un ID de vehículo único.

Los siguientes campos 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.
GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

Devuelve 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.
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 actualizados del vehículo en Fleet Engine.

Cuando se actualiza 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 proporcionados en la solicitud. Si quieres actualizar solo 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 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 se reemplazará todo el campo attributes 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 llena 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 cargándose, etcétera

Enumeraciones
UNKNOWN_BATTERY_STATUS Se desconoce 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 está cargando.
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 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 enumeran en esta enumeración.

ConsumableTrafficPolyline

Es la densidad del tráfico a lo largo de la ruta de un vehículo.

Campos
speed_reading_interval[]

SpeedReadingInterval

Es la velocidad del tráfico a lo largo de la ruta desde el punto de referencia anterior al actual.
encoded_path_to_waypoint

string

La ruta que sigue el conductor desde el punto de referencia anterior hasta el actual. Esta ruta contiene 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

Mensaje de solicitud CreateTrip.

Campos
header

RequestHeader

El encabezado de 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 cadena Unicode válida.
  • Tiene una longitud máxima de 64 caracteres.
  • Se normalizó de acuerdo con el formulario C de normalización 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 ignoran todos los demás campos 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 se admiten intermediate_destinations viajes en EXCLUSIVE.

Cuando se configura 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 estos puntos no será determinado.

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 se encuentre antes de los destinos intermedios y todos los destinos intermedios antecedan al punto de llegada. Los puntos de referencia de un viaje EXCLUSIVE no deben intercalarse con ningún otro viaje.

Se usarán los campos trip_id, waypoint_type y location, y se ignorarán todos los demás campos TripWaypoint de vehicle_waypoints.

CreateVehicleRequest

Mensaje de solicitud de CreateVehicle.

Campos
header

RequestHeader

El encabezado de 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. Es el ID único del vehículo. Sujeto a las siguientes restricciones:

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

Vehicle

Obligatorio. La entidad Vehículo que se creará. Cuando creas un vehículo, debes 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 usan si se proporcionan.

DeviceSettings

Información sobre las distintas opciones de configuración del dispositivo móvil.

Campos
location_power_save_mode

LocationPowerSaveMode

La manera en que 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 se encuentra en estado interactivo.
battery_info

BatteryInfo

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

GetTripRequest

Mensaje de solicitud de GetTrip.

Campos
header

RequestHeader

El encabezado de 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 debe 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 ruta no se modifican desde esta marca de tiempo, el campo de ruta no se establece en la respuesta. Si no se especifica un mínimo, los datos de la ruta se recuperan siempre.
remaining_waypoints_version

Timestamp

Indica la marca de tiempo mínima (exclusiva) para la que se recuperan los Trip.remaining_waypoints. Si no se modifican desde esta marca de tiempo, las 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 la 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 se modifican desde esta marca de tiempo, no se establece el campo current_route_segment_traffic en la respuesta. Si no se especifica un mínimo, los datos de tráfico siempre se recuperan. 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 de acceso siempre se recuperan.

GetVehicleRequest

Mensaje de solicitud de GetVehicle.

Campos
header

RequestHeader

El encabezado de 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 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 se modifican 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

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

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 la matrícula no contiene ningún valor numérico.

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

ListVehiclesRequest

Mensaje de solicitud de ListVehicles.

Campos
header

RequestHeader

El encabezado de 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 devolverán. Valor predeterminado: 100.
page_token

string

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 establece, 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 estacionarios que aún 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 los vehículos con una de las categorías de tipos especificadas. No se permite UNKNOWN.
required_attributes[]

string

Los emisores pueden realizar 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 crear 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 los vehículos con los atributos especificados. Este campo es una conjunción/operación AND. Se permite un máximo de 50 atributos_obligatorios. Esto coincide con 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 los vehículos con al menos uno de los atributos especificados en cada VehicleAttributeList. En cada lista, un vehículo debe coincidir con al menos uno de los atributos. Este campo es una operación OR de disyunción inclusiva en cada VehicleAttributeList y una operación AND en toda 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 permite una lista de listas y 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 en una VehicleAttributeList. En cada lista, un vehículo debe coincidir con todos los atributos. Este campo es una conjunción/operación AND en cada VehicleAttributeList y una operación de disyunción/OR 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 este estado.
on_trip_only

bool

Solo devuelve los vehículos con los viajes actuales.
filter

string

Opcional. Una búsqueda de filtro para aplicar cuando se publican vehículos. Consulta http://aip.dev/160 para ver ejemplos de la sintaxis del filtro.

Este campo se diseñó 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 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 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 consulta de filtro es de 50.

Además, todos los atributos se almacenan como cadenas, por lo que las únicas comparaciones admitidas para los atributos son las comparaciones de cadenas. Con el fin de compararlos con valores numéricos o booleanos, los valores se deben entrecomillar de forma explícita para que se los trate como strings (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 fue en el área rectangular definida por el viewport.

ListVehiclesResponse

Mensaje de respuesta ListVehicles.

Campos
vehicles[]

Vehicle

Vehículos que coinciden con los criterios de la solicitud El campo page_size de la solicitud determina la cantidad máxima de vehículos que se muestran.
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 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 el dispositivo cambia de "ahorro de batería" de que la función esté activada. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enumeraciones
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode no definido
LOCATION_MODE_NO_CHANGE El ahorro de batería no debería afectar a los proveedores de ubicación, o bien este está desactivado.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF El proveedor de ubicación basada 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 Cuando el ahorro de batería está activado y el dispositivo no es interactivo, deben inhabilitarse todos los proveedores de ubicación.
LOCATION_MODE_FOREGROUND_ONLY Todos los proveedores de ubicación se mantendrán disponibles, pero las correcciones de ubicación solo deben proporcionarse a las aplicaciones 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

El sensor o la metodología que se usó para determinar la ubicación.

Enumeraciones
UNKNOWN_SENSOR El sensor no se especifica o es desconocido.
GPS GPS o GPS asistido.
NETWORK GPS asistido, ID de torre 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 Una ubicación que el dispositivo móvil determina que es la posición más probable en la ruta.
CUSTOMER_SUPPLIED_LOCATION Una ubicación proporcionada por el cliente desde una fuente independiente. Por lo general, este valor se usa para una ubicación proporcionada de fuentes distintas del dispositivo móvil que ejecuta el SDK de Driver. Si la fuente original se describe por uno de los otros valores de enumeración, usa ese valor. Las ubicaciones marcadas con la marca CUSTOMER_SUPPLIED_LOCATION se proporcionan, por lo general, a través de un last_location.supplemental_location_sensor de un vehículo.
FLEET_ENGINE_LOCATION Una ubicación calculada por Fleet Engine en función de 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.

Enumeraciones
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 de Driver ingresó al modo GUIDED_NAV.
OFF_ROUTE El vehículo se desvió de la ruta sugerida.
ARRIVED_AT_DESTINATION El vehículo se encuentra a unos 50 m del destino.

PolylineFormatType

Es el tipo de formato de polilínea.

Enumeraciones
UNKNOWN_FORMAT_TYPE El formato no se especifica o es desconocido.
LAT_LNG_LIST_TYPE Una lista de google.type.LatLng.
ENCODED_POLYLINE_TYPE 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.

Enumeraciones
UNKNOWN_POWER_SOURCE La fuente de alimentación es 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 pertenece 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

Es la plataforma en la que se emitió la solicitud.
related_ids[]

string

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

SolutionType

Indica el tipo de solución de productos de GMP (por ejemplo, ON_DEMAND_RIDESHARING_AND_DELIVERIES) que se utiliza para el viaje informado.

SolutionType

Es el selector de diferentes tipos de soluciones de un viaje informado.

Enumeraciones
SOLUTION_TYPE_UNSPECIFIED Es el valor predeterminado. Para ofrecer 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 compartido y entregas a pedido.

RequestHeader

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

Campos
language_code

string

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 para el inglés (si existe tal nombre). Ejemplo de valor de campo: en-US.
region_code

string

Obligatorio. 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 de llamada, si corresponde. El formato de la versión es "major.minor.patch", ejemplo: 1.1.2.
os_version

string

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

string

Modelo del dispositivo en el que se ejecuta el SDK que realiza la llamada. Ejemplos de valores de campo: iPhone12,1, SM-G920F.
sdk_type

SdkType

El tipo de SDK que envía la solicitud.
maps_sdk_version

string

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

string

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

Platform

Plataforma del SDK que realiza la llamada.
manufacturer

string

Fabricante del dispositivo Android del SDK de llamada; solo se aplica a 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 a 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.

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

Tipos posibles de SDK.

Enumeraciones
SDK_TYPE_UNSPECIFIED Es el valor predeterminado. Este valor se usa si se omite sdk_type.
CONSUMER El SDK que realiza la llamada es el consumidor.
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 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

El vehículo asociado con los viajes en 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 la estableces como verdadera, la respuesta incluirá los Viajes que influyen en la ruta del conductor.
page_size

int32

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

string

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

Duration

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

SearchTripsResponse

Mensaje de respuesta de SearchTrips.

Campos
trips[]

Trip

La lista de viajes del vehículo solicitado.
next_page_token

string

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

SearchVehiclesRequest

Mensaje de solicitud de SearchVehicles.

Campos
header

RequestHeader

El encabezado de 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.
dropoff_point

TerminalLocation

El lugar de destino previsto 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 vehículos dentro del radio de búsqueda. El valor debe estar entre 400 y 10,000 metros (inclusive).
count

int32

Obligatorio. Especifica la cantidad máxima de vehículos que se devolverán. El valor debe ser de 1 a 50 (inclusive).
minimum_capacity

int32

Obligatorio. Especifica la cantidad de pasajeros que se consideran para un viaje. El valor debe ser mayor o igual que uno. No se considera al controlador en el valor de capacidad.
trip_types[]

TripType

Obligatorio. Representa el tipo de viaje propuesto. 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 aquellos vehículos que enviaron actualizaciones de ubicación a Fleet Engine dentro del período de duración especificado. Los vehículos estacionarios que aún 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 VehicleTypes con la categoría UNKNOWN.
required_attributes[]

VehicleAttribute

Los emisores pueden realizar 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 crear 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 a los vehículos con los atributos especificados. Este campo es una conjunción/operación AND. Se permite un máximo de 50 atributos_obligatorios. Esto coincide con la cantidad máxima de atributos permitidos en un vehículo.
required_one_of_attributes[]

VehicleAttributeList

Restringe la búsqueda únicamente a los vehículos con al menos uno de los atributos especificados en cada VehicleAttributeList. En cada lista, un vehículo debe coincidir con al menos uno de los atributos. Este campo es una operación OR de disyunción inclusiva en cada VehicleAttributeList y una operación AND en toda 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 permite una lista de listas y 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 a los vehículos con todos los atributos en un VehicleAttributeList. En cada lista, un vehículo debe coincidir con todos los atributos. Este campo es una conjunción/operación AND en cada VehicleAttributeList y una operación de disyunción/OR inclusiva en la colección de VehicleAttributeList.
order_by

VehicleMatchOrder

Obligatorio. Especifica el criterio de orden 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, los vehículos con viajes asignados se excluyen de los resultados de la búsqueda. Si no se especifica current_trips_present y el campo tiene el valor 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 establecer un valor distinto de CURRENT_TRIPS_PRESENT_UNSPECIFIED si trip_type incluye SHARED.
filter

string

Opcional. Una búsqueda de filtro para aplicar cuando se buscan vehículos. Consulta http://aip.dev/160 para ver ejemplos de la sintaxis del filtro.

Este campo se diseñó 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 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 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 consulta de filtro es de 50.

Además, todos los atributos se almacenan como cadenas, por lo que las únicas comparaciones admitidas para los atributos son las comparaciones de cadenas. Con el fin de compararlos con valores numéricos o booleanos, los valores se deben entrecomillar de forma explícita para que se los trate como strings (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 Los vehículos con un máximo de 5 viajes actuales y 10 puntos de referencia se incluyen en los resultados de la búsqueda. 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.

Enumeraciones
UNKNOWN_VEHICLE_MATCH_ORDER Es el valor predeterminado. Se usa para el orden 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 la 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 llegada. 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 en línea recta y la hora de llegada estimada. Las ponderaciones se establecen con los valores predeterminados y se pueden modificar por cliente. Comunícate con Atención al cliente de Google si necesitas modificar estas ponderaciones en tu proyecto.

SearchVehiclesResponse

Mensaje de respuesta SearchVehicles.

Campos
matches[]

VehicleMatch

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

SpeedReadingInterval

Indicador de densidad del tráfico en un tramo 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 utilizando 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 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 propagado.
speed

Speed

La velocidad del tráfico en este intervalo.

Velocidad

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

Enumeraciones
SPEED_UNSPECIFIED Valor predeterminado Este valor no se usa.
NORMAL Velocidad normal, no se detecta una 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 produjo una parada (recogida o destino).

Campos
point

LatLng

Obligatorio. Indica la ubicación real.
timestamp

Timestamp

Indica cuándo se produjo 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

Obligatorio. Indica la ubicación de un punto de referencia de viaje.
terminal_point_id
(deprecated)

TerminalPointId

Obsoleto: Especifica el campo point en su lugar.
access_point_id
(deprecated)

string

Obsoleto: Especifica el campo point en su lugar.
trip_id
(deprecated)

string

Obsoleta.
terminal_location_type
(deprecated)

WaypointType

Obsoleto: Vehicle.waypoint tendrá estos datos.

TerminalPointId

Obsoleto: Los TerminalPoints ya no son compatibles con 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 en la ruta prevista para el vehículo.

Campos
traffic_rendering

VisualTrafficReportPolylineRendering

Una renderización de polilíneas que indica qué tan rápido es el tráfico para todas las regiones a lo largo de un tramo de viaje de un cliente.

Viaje

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

Estado actual del viaje.
trip_type

TripType

El tipo de viaje.
pickup_point

TerminalLocation

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

StopLocation

Solo entrada. La ubicación real del momento y el lugar en el que se recogió al cliente. Este campo permite que el proveedor proporcione comentarios sobre la información real de retiro.
actual_pickup_arrival_point

StopLocation

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

Timestamp

Solo salida. Puede ser la hora estimada en el futuro a la que se recogerá a los pasajeros o la hora real en la que se buscaron.
intermediate_destinations[]

TerminalLocation

Paradas intermedias en función de las solicitudes del viaje (además de los puntos de partida y destino). En un principio, esto no será compatible con 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. 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 ignora este campo.
actual_intermediate_destination_arrival_points[]

StopLocation

Solo entrada. La hora y la ubicación reales de la 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 la ubicación reales en que y dónde se recogió al cliente desde un destino intermedio. Este campo permite 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 se bajará.
actual_dropoff_point

StopLocation

Solo entrada. La hora y la ubicación reales en que cuándo y dónde llegó al cliente. Este campo permite que el proveedor proporcione comentarios sobre la información real sobre el destino.
dropoff_time

Timestamp

Solo salida. Puede ser la hora estimada en el futuro a la que se bajarán los pasajeros en el destino final o la hora real en la que se bajarán.
remaining_waypoints[]

TripWaypoint

Solo salida. 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 ignora este campo. Por motivos de privacidad, solo el servidor propaga este campo en las llamadas UpdateTrip y CreateTrip, NO en las llamadas GetTrip.
route[]

LatLng

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

string

Solo salida. Una ruta codificada al siguiente punto de referencia.

Nota: Este campo está diseñado solo para que lo usen el SDK del controlador y el SDK para consumidores. 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á diseñado solo para que lo usen el SDK del controlador y el SDK para consumidores.
current_route_segment_traffic

ConsumableTrafficPolyline

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

Nota: Este campo está diseñado solo para que lo usen el SDK del controlador y el SDK para consumidores.
current_route_segment_traffic_version

Timestamp

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

Nota: Este campo está diseñado solo para que lo usen el SDK del controlador y el SDK para consumidores.
current_route_segment_end_point

TripWaypoint

Solo salida. El punto de referencia donde termina current_route_segment.
remaining_distance_meters

Int32Value

Solo salida. La distancia en automóvil restante en el campo current_route_segment. El valor no se especifica si el viaje no está asignado a un vehículo o si el viaje se completa o se cancela.
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 (completado o cancelado).
remaining_time_to_first_waypoint

Duration

Solo salida. Es la duración 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 (completado o cancelado).
remaining_waypoints_version

Timestamp

Solo salida. Indica la última vez que se modificó 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 y el tráfico de remaining_waypoints solo se muestren 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 una capacidad disponible para que se muestre en una respuesta de 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 last_location o current_route_segment no existen. Fleet Engine lo calcula. Se ignorarán las actualizaciones de los clientes.
view

TripView

Subconjunto de campos de Viaje que se completan y cómo deben interpretarse.

TripStatus

El estado de un viaje que indica su progreso.

Enumeraciones
UNKNOWN_TRIP_STATUS Es el valor predeterminado, que se usa para el estado del viaje no especificado o no reconocido.
NEW Viaje recién creado.
ENROUTE_TO_PICKUP El conductor se dirige 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 llegada).
ENROUTE_TO_DROPOFF El conductor recogió al pasajero y está de camino al siguiente destino.
COMPLETE Se dejó al pasajero y se completó el viaje.
CANCELED El viaje se canceló antes de que lo recogiera el conductor, el pasajero o el proveedor de transporte compartido.

TripType

Indica el tipo de viaje.

Enumeraciones
UNKNOWN_TRIP_TYPE Es el valor predeterminado, que se usa para 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

Es el selector de diferentes conjuntos de campos de viaje 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 ofrecer retrocompatibilidad, la API usará de forma predeterminada una vista de SDK. Para garantizar la estabilidad y la compatibilidad, se recomienda a los clientes seleccionar un TripView distinto de SDK.
SDK Incluye campos que tal vez no se puedan interpretar ni admitir mediante bibliotecas disponibles públicamente.
JOURNEY_SHARING_V1S Los campos de viaje se propagan para el caso de uso de Viajes compartidos. 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 del viaje de un vehículo.

Campos
location

TerminalLocation

Es la ubicación de este punto de referencia.
trip_id

string

El viaje asociado con este punto de referencia.
waypoint_type

WaypointType

El rol que desempeña este punto de referencia en este viaje, como el punto de partida o destino.
path_to_waypoint[]

LatLng

La ruta desde el punto de referencia anterior al actual. No definido 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 al punto de referencia actual.

Nota: Este campo está diseñado solo para que lo usen el SDK del controlador y el SDK para consumidores. 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 Rides and Deliveries de Google Maps Platform.
distance_meters

Int32Value

La distancia de la ruta desde el punto de referencia anterior al actual. No definido para el primer punto de referencia de una lista.
eta

Timestamp

La hora estimada de llegada a este punto de referencia. No definido 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 definido para el primer punto de referencia de una lista.

UpdateTripRequest

Mensaje de solicitud UpdateTrip.

Campos
header

RequestHeader

El encabezado de 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. 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 actualizas 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 será determinado.

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 se encuentre antes de los destinos intermedios y todos los destinos intermedios antecedan al punto de llegada. Los puntos de referencia de un viaje EXCLUSIVE no deben intercalarse con ningún otro viaje. Se usarán los campos trip_id, waypoint_type y location, y se ignorarán todos los demás campos TripWaypoint de vehicle_waypoints.

Si deseas 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 que se pase debe ser coherente con la versión de Fleet Engine. Si no es así, la solicitud falla.
update_mask

FieldMask

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

UpdateVehicleAttributesRequest

Mensaje de solicitud de UpdateVehicleAttributes.

Campos
header

RequestHeader

El encabezado de 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

Mensaje de respuesta UpdateVehicleAttributes.

Campos
attributes[]

VehicleAttribute

Obligatorio. La lista completa actualizada de los atributos del vehículo, incluidos los nuevos, los alterados y los que no se modificaron.

UpdateVehicleRequest

“Mensaje de solicitud UpdateVehicle.

Campos
header

RequestHeader

El encabezado de 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 pertenece la cuenta de servicio que realiza esta llamada.
vehicle

Vehicle

Obligatorio. Los valores de 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, se reemplazarán todos los atributos del vehículo por los proporcionados en la solicitud. Si quieres actualizar solo 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 encuentran actualmente en el vehículo y ningún otro.
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. El nombre único de este vehículo. El formato es providers/{provider}/vehicles/{vehicle}.
vehicle_state

VehicleState

El estado del vehículo.
supported_trip_types[]

TripType

Tipos de viaje admitidos en este vehículo.
current_trips[]

string

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

VehicleLocation

Última ubicación informada del vehículo.
maximum_capacity

int32

La cantidad total de pasajeros que puede transportar este vehículo. No se considera el controlador 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 como máximo 100 atributos, y cada uno de ellos debe tener una clave única.
vehicle_type

VehicleType

Obligatorio. El tipo de 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 y la ruta.
license_plate

LicensePlate

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 de conductor intenta tomar hasta el siguiente punto de referencia Esta lista también se muestra en Trip.current_route_segment para todos los viajes activos asignados al vehículo.

Nota: Este campo está diseñado únicamente para que lo use el SDK del controlador. Aún no se admite la decodificación.
current_route_segment_traffic

TrafficPolylineData

Solo entrada. Fleet Engine usa esta información para mejorar los recorridos compartidos. Nota: Este campo está diseñado únicamente para que lo use el SDK del controlador.
current_route_segment_version

Timestamp

Solo salida. Hora a la que se configuró el current_route_segment. El cliente puede almacenarla y pasarla en solicitudes GetVehicle futuras para evitar que se devuelvan rutas que no hayan cambiado.
current_route_segment_end_point

TripWaypoint

El punto de referencia donde termina current_route_segment. Los conductores pueden proporcionarlo en 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. Fleet Engine luego hará todo lo posible para interpolar un punto de referencia real si no está especificado 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 en automóvil 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 hora de llegada estimada a la primera entrada del campo waypoints. El valor no se especifica si el campo waypoints está vacío o si el campo Vehicle.current_route_segment está vacío.

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

Int32Value

Solo entrada. Tiempo de conducción restante: current_route_segment. El valor no se especifica si el campo waypoints está vacío o si el campo Vehicle.current_route_segment está vacío. Este valor debe coincidir con eta_to_first_waypoint y current_time si todos los grupos usan el mismo reloj.

Cuando actualizas 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 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

El estado de navegación del vehículo.
device_settings

DeviceSettings

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

VehicleType

El tipo de vehículo.

Campos
category

Category

Categoría del tipo de vehículo

Categoría

Categorías de tipos de vehículos

Enumeraciones
UNKNOWN Esta opción es predeterminada y 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 (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, ciclomotor y otro vehículo de dos ruedas
BICYCLE Transporte impulsado por personas.
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 función “key:value” la longitud de la cadena 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

Es el valor del atributo.
Campo de unión vehicle_attribute_value. El valor del atributo puede estar en cadena, en booleano o en tipo doble. Las direcciones (vehicle_attribute_value) solo pueden ser una de las siguientes opciones:
string_value

string

Valor del atributo de tipo de cadena.

Nota: Es idéntico al campo value, que eventualmente dejará de estar disponible. Para los métodos de creación o actualización, se puede usar cualquier campo, pero es muy recomendable usar string_value. Si se configuran string_value y value, deben ser idénticos; de lo contrario, se mostrará un error. Ambos campos se propagan en las respuestas.
bool_value

bool

Valor de atributo de tipo booleano.
number_value

double

Valor de atributo de doble tipo.

VehicleAttributeList

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

Campos
attributes[]

VehicleAttribute

Una lista de atributos en esta colección.

VehicleLocation

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

Campos
location

LatLng

La ubicación del vehículo. Cuando se envía a Fleet Engine, la ubicación del vehículo es una ubicación de GPS. Cuando la recibes en una respuesta, la ubicación del vehículo puede ser una ubicación de 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

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 el 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

Es la 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/segundo.
update_time

Timestamp

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

Timestamp

Solo salida. Indica 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 ajusta 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) desde que esta ubicación se envió por primera vez al servidor. En la primera actualización, este valor será cero. 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á inactiva.
raw_location

LatLng

Ubicación sin procesar del vehículo (sin procesar por pargos).
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

Ubicación complementaria proporcionada por la app integrada.
supplemental_location_time

Timestamp

Marca de tiempo asociada con la ubicación complementaria.
supplemental_location_sensor

LocationSensor

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 los cálculos relacionados para un vehículo que coinciden con los puntos de viajes activos del vehículo SearchVehiclesRequest.

Campos
vehicle

Vehicle

Obligatorio. Un vehículo que coincide con la solicitud.
vehicle_pickup_eta

Timestamp

La hora de llegada estimada del vehículo al punto de partida especificado en la solicitud Un valor vacío indica un error en el cálculo de 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 de partida o destino intermedios para los viajes existentes. Esta distancia comprende la distancia calculada en automóvil (ruta) más la distancia en línea recta entre el punto de destino de la navegación y el punto de partida solicitado. (Por lo general, la distancia entre el extremo de navegación y el punto de partida solicitado es pequeño). Un valor vacío indica un error en el cálculo de la distancia.
vehicle_pickup_straight_line_distance_meters

Int32Value

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

La hora de llegada estimada completa del vehículo al punto de llegada especificado en la solicitud. El ETA incluye paradas en cualquier punto de referencia antes del dropoff_point especificado en la solicitud. El valor solo se propagará cuando se especifique un punto de llegada en la solicitud. Un valor vacío indica un error al calcular la hora de llegada estimada.
vehicle_pickup_to_dropoff_distance_meters

Int32Value

La distancia en automóvil (en metros) del vehículo desde el punto de partida hasta el punto de llegada especificado en la solicitud. La distancia solo es entre los dos puntos y no incluye la ubicación del vehículo ni ningún otro punto que deba visitarse antes de que el vehículo 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 un error en el cálculo de 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 usó 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 para el vehículo y los puntos de partida proporcionados en la solicitud. Una lista vacía indica un error en el cálculo de la hora de llegada estimada del vehículo.
vehicle_match_type

VehicleMatchType

Tipo de coincidencia del vehículo.
requested_ordered_by

VehicleMatchOrder

El orden solicitado para clasificar coincidencias de vehículos.
ordered_by

VehicleMatchOrder

El pedido real que se usó para este vehículo. Normalmente, esto coincidirá con "order_by" de la solicitud. Sin embargo, en determinadas circunstancias, como un error interno del servidor, se puede usar un método diferente (como PICKUP_POINT_STRAIGHT_DISTANCE).

VehicleMatchType

Coincidencia con el tipo de vehículo.

Enumeraciones
UNKNOWN Tipo de coincidencia de vehículo desconocido
EXCLUSIVE Actualmente, el vehículo no tiene ningún viaje asignado y puede continuar al punto de partida.
BACK_TO_BACK Actualmente, el vehículo está asignado a un viaje, pero puede continuar al punto de partida después de completar el viaje en curso. Los cálculos de la hora de llegada 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 continuar al punto de partida. Los cálculos de la hora de llegada y la distancia tienen en cuenta el viaje existente.

VehicleState

Es el estado de un Vehicle.

Enumeraciones
UNKNOWN_VEHICLE_STATE Esta opción es predeterminada y se usa para estados de vehículo no especificados o no reconocidos.
OFFLINE El vehículo no acepta viajes nuevos. Nota: Es posible que el vehículo continúe funcionando en este estado mientras completa el 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. Tramos de ruta que deben representarse a lo largo de la polilínea Se garantiza que los estiramientos no se superpongan y no abarquen necesariamente toda la ruta.

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

RoadStretch

Un tramo de ruta que se debe renderizar.

Campos
style

Style

Obligatorio. Es el estilo que se aplicará.
offset_meters

int32

Obligatorio. El estilo debe aplicarse entre [offset_meters, offset_meters + length_meters).
length_meters

int32

Obligatorio. Es la longitud de la ruta en la que se aplicará el diseño.

Estilo

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

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

Punto de referencia

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

Es la ubicación de este punto de referencia.
eta

Timestamp

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

WaypointType

Es el tipo de punto de referencia.

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