Package maps.fleetengine.delivery.v1

Índice

DeliveryService

El servicio de entrega de último kilómetro.

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

Crea y muestra un lote de objetos Task nuevos.
CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

Crea y muestra un DeliveryVehicle nuevo.
CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

Crea y muestra un objeto Task nuevo.
GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

Muestra la instancia DeliveryVehicle especificada.
GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Obtiene información sobre un Task.
GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

Muestra la instancia TaskTrackingInfo especificada.
ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

Obtiene todos los DeliveryVehicle que cumplen con los criterios de filtrado especificados.
ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

Obtiene todos los Task que cumplen con los criterios de filtrado especificados.
UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Escribe datos de DeliveryVehicle actualizados en Fleet Engine y asigna Tasks al DeliveryVehicle. No puedes actualizar el nombre de DeliveryVehicle. Puedes actualizar remaining_vehicle_journey_segments, pero debe contener todos los VehicleJourneySegment para que se conserven en DeliveryVehicle. Los elementos task_id se recuperan de remaining_vehicle_journey_segments, y sus Tasks correspondientes se asignan al DeliveryVehicle si aún no se asignaron.
UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Actualiza los datos de Task.

BatchCreateTasksRequest

El mensaje de solicitud BatchCreateTask

Campos
header

DeliveryRequestHeader

Opcional. El encabezado de la solicitud a la API de entrega estándar. Nota: Si configuras este campo, el campo del encabezado en los mensajes de CreateTaskRequest debe estar vacío o debe coincidir con este campo.
parent

string

Obligatorio. El recurso superior compartido por todas las tareas. Este valor debe tener el formato providers/{provider}. El provider debe ser el ID del proyecto de Google Cloud. Por ejemplo, sample-cloud-project. El campo superior de los mensajes CreateTaskRequest debe estar vacío o debe coincidir con este campo.
requests[]

CreateTaskRequest

Obligatorio. Es el mensaje de solicitud que especifica los recursos que se crearán. Nota: Puedes crear un máximo de 500 tareas por lote.

BatchCreateTasksResponse

El mensaje de respuesta BatchCreateTask

Campos
tasks[]

Task

Las tareas creadas.

CreateDeliveryVehicleRequest

El mensaje de solicitud CreateDeliveryVehicle

Campos
header

DeliveryRequestHeader

Opcional. El encabezado de la solicitud a la API de entrega estándar.
parent

string

Obligatorio. Debe tener el formato providers/{provider}. El proveedor debe ser el ID del proyecto de Google Cloud. Por ejemplo, sample-cloud-project
delivery_vehicle_id

string

Obligatorio. El ID del vehículo de entrega debe ser único y estar 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 “'#'”.
delivery_vehicle

DeliveryVehicle

Obligatorio. La entidad DeliveryVehicle que se creará. Cuando creas un nuevo vehículo de entrega, puedes configurar los siguientes campos opcionales:

  • last_location
  • attributes

Nota: Se ignora el campo name de DeliveryVehicle. No se deben configurar todos los demás campos DeliveryVehicle; de lo contrario, se mostrará un error.

CreateTaskRequest

El mensaje de solicitud CreateTask

Campos
header

DeliveryRequestHeader

Opcional. El encabezado de la solicitud a la API de entrega estándar.
parent

string

Obligatorio. Debe tener el formato providers/{provider}. El provider debe ser el ID del proyecto de Google Cloud. Por ejemplo, sample-cloud-project.
task_id

string

Obligatorio. El ID de tarea debe ser único, pero no debe ser un ID de seguimiento del envío. Para almacenar un ID de seguimiento del envío, usa el campo tracking_id. Ten en cuenta que varias tareas pueden tener el mismo tracking_id. Los IDs de tareas están sujetos 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 “'#'”.
task

Task

Obligatorio. La entidad Task que se creará. Cuando creas una tarea, se requieren los siguientes campos:

  • type
  • state (se debe establecer en OPEN)
  • tracking_id (no se debe establecer para tareas UNAVAILABLE ni SCHEDULED_STOP, pero es obligatorio para todos los demás tipos de tareas)
  • planned_location (opcional para UNAVAILABLE tareas)
  • task_duration

Nota: Se ignora el campo name de la tarea. No se deben configurar todos los demás campos Task; de lo contrario, se mostrará un error.

DeliveryRequestHeader

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

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.

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

SdkType

Tipos posibles de SDK.

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

DeliveryVehicle

El mensaje DeliveryVehicle Un vehículo de reparto transporta los envíos de un depósito a una ubicación de entrega y de un lugar de retiro al depósito. En algunos casos, los vehículos de entrega también transportan los envíos directamente desde la ubicación de recogida a la de entrega.

Nota: gRPC y las APIs de REST usan convenciones de nomenclatura de campo diferentes. Por ejemplo, el campo DeliveryVehicle.current_route_segment en la API de gRPC y el campo DeliveryVehicle.currentRouteSegment en la API de REST hacen referencia al mismo campo.

Campos
name

string

El nombre único de este vehículo de entrega. El formato es providers/{provider}/deliveryVehicles/{vehicle}.
last_location

DeliveryVehicleLocation

La última ubicación informada del vehículo de entrega.
navigation_status

DeliveryVehicleNavigationStatus

El estado de navegación del vehículo de entrega
current_route_segment

bytes

La polilínea codificada que especifica la ruta que la navegación recomienda tomar al siguiente punto de referencia. Tu app para conductores la actualiza cuando se alcanza o pasa una parada, y cuando se redirige la navegación. Estos LatLng se muestran en Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) para todas las tareas activas asignadas al vehículo.

Hay algunos casos en los que este campo podría no usarse para propagar Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

  • El extremo de current_route_segment no coincide con DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) o DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • La app del controlador no actualizó su ubicación recientemente, por lo que el valor de la última actualización de este campo podría estar inactivo.

  • La app del conductor actualizó su ubicación recientemente, pero la current_route_segment está inactiva y apunta a una parada anterior del vehículo.

En estos casos, Fleet Engine completa este campo con una ruta desde la VehicleStop que pasó más recientemente hasta la VehicleStop que pasó para garantizar que el consumidor de este campo tenga la mejor información disponible sobre la ruta actual del vehículo de entrega.
current_route_segment_end_point

LatLng

La ubicación donde termina el objeto current_route_segment. Actualmente, la app del controlador no propaga esta información, pero puedes proporcionarla en las llamadas de UpdateDeliveryVehicle. Es el LatLng de la próxima parada del vehículo o el último LatLng del current_route_segment. Fleet Engine hará todo lo posible para interpolar a un VehicleStop real.

Este campo se ignora en las llamadas a UpdateDeliveryVehicle si el campo current_route_segment está vacío.
remaining_distance_meters

Int32Value

La distancia en automóvil restante para el current_route_segment. La aplicación del controlador generalmente proporciona este campo, pero hay algunas circunstancias en las que Fleet Engine anulará el valor que envía la aplicación. Para obtener más información, consulta DeliveryVehicle.current_route_segment. Este campo se muestra en Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) o Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) para todos los Task activos asignados al vehículo de entrega.

Fleet Engine ignora este campo en UpdateDeliveryVehicleRequest si el campo current_route_segment está vacío.
remaining_duration

Duration

Tiempo de conducción restante: current_route_segment. La aplicación del controlador generalmente proporciona este campo, pero hay algunas circunstancias en las que Fleet Engine anulará el valor que envía la aplicación. Para obtener más información, consulta DeliveryVehicle.current_route_segment. Este campo se muestra en Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) o Task.remainingVehicleJourneySegments[0].drivingDuration (REST) para todas las tareas activas asignadas al vehículo de entrega.

Fleet Engine ignora este campo en UpdateDeliveryVehicleRequest si el campo current_route_segment está vacío.
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Los segmentos de recorrido asignados a este vehículo de entrega, a partir de la ubicación informada más reciente del vehículo. Este campo no se propagará en la respuesta de ListDeliveryVehicles.
attributes[]

DeliveryVehicleAttribute

Una lista de atributos personalizados de vehículos de entrega. Un vehículo de entrega puede tener 100 atributos como máximo, y cada atributo debe tener una clave única.
type

DeliveryVehicleType

El tipo de este vehículo de entrega. Si no la estableces, la configuración predeterminada será AUTO.

DeliveryVehicleType

El tipo de vehículo de entrega.

Enumeradores
DELIVERY_VEHICLE_TYPE_UNSPECIFIED El valor no está en uso.
AUTO Un automóvil
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.

DeliveryVehicleAttribute

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

Campos
key

string

La clave del atributo.
value

string

Es el valor del atributo.
Campo de unión delivery_vehicle_attribute_value. El valor del atributo puede estar en cadena, en booleano o en tipo doble. Las direcciones (delivery_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.

DeliveryVehicleLocation

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

DeliveryVehicleLocationSensor

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

DeliveryVehicleLocationSensor

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

DeliveryVehicleLocationSensor

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.

DeliveryVehicleLocationSensor

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

Enumeradores
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 como CUSTOMER_SUPPLIED_LOCATION se proporcionan, por lo general, a través de un last_location.supplemental_location_sensor de DeliveryVehicle.
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 El proveedor de ubicación en los sistemas operativos de Apple.

DeliveryVehicleNavigationStatus

El estado de navegación del vehículo.

Enumeradores
UNKNOWN_NAVIGATION_STATUS Estado de navegación no especificado.
NO_GUIDANCE La navegación de la app de Driver está en modo FREE_NAV.
ENROUTE_TO_DESTINATION La navegación paso a paso está disponible y la navegación de la app 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.

GetDeliveryVehicleRequest

El mensaje de solicitud GetDeliveryVehicle

Campos
header

DeliveryRequestHeader

Opcional. El encabezado de la solicitud a la API de entrega estándar.
name

string

Obligatorio. Debe tener el formato providers/{provider}/deliveryVehicles/{delivery_vehicle}. El provider debe ser el ID del proyecto de Google Cloud. Por ejemplo, sample-cloud-project.

GetTaskRequest

El mensaje de solicitud GetTask

Campos
header

DeliveryRequestHeader

Opcional. El encabezado de la solicitud a la API de entrega estándar.
name

string

Obligatorio. Debe tener el formato providers/{provider}/tasks/{task}. El provider debe ser el ID del proyecto de Google Cloud. Por ejemplo, sample-cloud-project.

GetTaskTrackingInfoRequest

El mensaje de solicitud GetTaskTrackingInfoRequest

Campos
header

DeliveryRequestHeader

Opcional. El encabezado de la solicitud a la API de entrega estándar.
name

string

Obligatorio. Debe tener el formato providers/{provider}/taskTrackingInfo/{tracking_id}. El provider debe ser el ID del proyecto de Google Cloud y el tracking_id debe ser el ID de seguimiento asociado con la tarea. Un nombre de ejemplo puede ser providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id.

ListDeliveryVehiclesRequest

El mensaje de solicitud ListDeliveryVehicles

Campos
header

DeliveryRequestHeader

Opcional. El encabezado de la solicitud a la API de entrega estándar.
parent

string

Obligatorio. Debe tener el formato providers/{provider}. El provider debe ser el ID del proyecto de Google Cloud. Por ejemplo, sample-cloud-project.
page_size

int32

Opcional. La cantidad máxima de vehículos que se devolverán. El servicio puede devolver menos que este número. Si no especificas este número, el servidor determinará el número de resultados que se mostrarán.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListDeliveryVehicles anterior. Debes proporcionarla para poder recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListDeliveryVehicles deben coincidir con la llamada que proporcionó el token de la página.
filter

string

Opcional. Una búsqueda de filtro para aplicar cuando se muestran vehículos de entrega. Consulta http://aip.dev/160 para ver ejemplos de la sintaxis del filtro. Si no especificas un valor o si especificas una cadena vacía para el filtro, se mostrarán todos los vehículos de entrega.

Ten en cuenta que las únicas consultas admitidas para ListDeliveryVehicles son sobre atributos de vehículos (por ejemplo, attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Además, todos los atributos se almacenan como cadenas, por lo que las únicas comparaciones admitidas para los atributos son las comparaciones de cadenas. Para comparar 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").

La cantidad máxima de restricciones permitida en una consulta de filtro es de 50. Una restricción es parte de la consulta con el formato attribute.<KEY> <COMPARATOR> <VALUE>, por ejemplo, attributes.foo = bar es 1 restricción.
viewport

Viewport

Opcional. 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.

ListDeliveryVehiclesResponse

El mensaje de respuesta ListDeliveryVehicles

Campos
delivery_vehicles[]

DeliveryVehicle

Es el conjunto de vehículos de entrega que cumplen con los criterios de filtrado solicitados. Si no se especifica ningún filtro, la solicitud muestra todos los vehículos de entrega. Una respuesta correcta también puede estar vacía. Si la respuesta está vacía, indica que no se encontraron vehículos de entrega que cumplieran con los criterios de filtro solicitados.
next_page_token

string

Puedes pasar este token en ListDeliveryVehiclesRequest para continuar con la lista de resultados. Cuando se muestren todos los resultados, este campo no aparecerá en la respuesta o será una cadena vacía.
total_size

int64

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

ListTasksRequest

El mensaje de solicitud ListTasks

Campos
header

DeliveryRequestHeader

Opcional. El encabezado de la solicitud a la API de entrega estándar.
parent

string

Obligatorio. Debe tener el formato providers/{provider}. El provider debe ser el ID del proyecto de Google Cloud. Por ejemplo, sample-cloud-project.
page_size

int32

Opcional. La cantidad máxima de Tasks que se mostrarán. El servicio puede mostrar menos que este valor. Si no especificas este valor, el servidor determinará la cantidad de resultados que se mostrarán.
page_token

string

Opcional. Un token de página recibido de una llamada ListTasks anterior. Puedes proporcionar esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListTasks deben coincidir con la llamada que proporcionó el token de la página.
filter

string

Opcional. Una consulta de filtro para aplicar cuando se muestra la lista de Tasks. Consulta http://aip.dev/160 para ver ejemplos de sintaxis de filtros. Si no especificas un valor o si filtras una cadena vacía, se mostrarán todas las Tasks. Para obtener información sobre las propiedades de Tasks que puedes filtrar, consulta Enumera tareas.

ListTasksResponse

La respuesta ListTasks que contiene el conjunto de tareas que cumplen con los criterios de filtro de ListTasksRequest.

Campos
tasks[]

Task

El conjunto de tareas que cumplen con los criterios de filtrado solicitados. Cuando no se especifica ningún filtro, la solicitud muestra todas las tareas. Una respuesta correcta también puede estar vacía. Una respuesta vacía indica que no se encontraron tareas que cumplan con los criterios de filtro solicitados.
next_page_token

string

Pasa este token en ListTasksRequest para continuar con la lista de resultados. Si se mostraron todos los resultados, este campo es una cadena vacía o no aparece en la respuesta.
total_size

int64

La cantidad total de tareas que coinciden con los criterios de la solicitud en todas las páginas.

LocationInfo

Una ubicación con cualquier identificador adicional.

Campos
point

LatLng

Las coordenadas de la ubicación.

Tarea

En la API de Delivery, una tarea representa una sola acción para realizar un seguimiento. En general, hay una distinción entre las tareas relacionadas con el envío y las tareas de división. Un envío puede tener varias Tasks asociadas a él. Por ejemplo, podría haber una Task para la partida y otra para la bajada o el transbordo. Además, distintos vehículos pueden manejar diferentes Tasks para un envío determinado. Por ejemplo, un vehículo podría encargarse de la recogida, conducir el envío al centro, mientras que otro vehículo realiza el mismo envío desde el concentrador hasta la ubicación de destino.

Nota: gRPC y las APIs de REST usan convenciones de nomenclatura de campo diferentes. Por ejemplo, el campo Task.journey_sharing_info en la API de gRPC y el campo Task.journeySharingInfo en la API de REST hacen referencia al mismo campo.

Campos
name

string

Debe tener el formato providers/{provider}/tasks/{task}.
type

Type

Obligatorio. Inmutable. Define el tipo de la Task. Por ejemplo, una pausa o un envío.
state

State

Obligatorio. Es el estado de ejecución actual de la tarea.
task_outcome

TaskOutcome

El resultado de la Tarea
task_outcome_time

Timestamp

Es la marca de tiempo que indica cuando el proveedor estableció el resultado de Task.
task_outcome_location

LocationInfo

Es la ubicación en la que se estableció el resultado de Task. Este valor se actualiza como parte de UpdateTask. Si el proveedor no actualiza de manera explícita este valor, Fleet Engine lo propaga de forma predeterminada con la última ubicación conocida del vehículo (la ubicación sin procesar).
task_outcome_location_source

TaskOutcomeLocationSource

Indica de dónde provino el valor de task_outcome_location.
tracking_id

string

Inmutable. Este campo facilita el almacenamiento de un ID para que puedas evitar el uso de una asignación complicada. No puedes configurar tracking_id para tareas de tipo UNAVAILABLE y SCHEDULED_STOP. Estos IDs están sujetos 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 “'#'”.
delivery_vehicle_id

string

Solo salida. El ID del vehículo que ejecuta esta tarea. Los IDs de vehículos de entrega están sujetos 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 “'#'”.
planned_location

LocationInfo

Inmutable. La ubicación donde se completará la Tarea. Opcional para las tareas de UNAVAILABLE, pero obligatorio para todas las demás tareas.
task_duration

Duration

Obligatorio. Inmutable. El tiempo necesario para ejecutar una tarea en esta ubicación.
target_time_window

TimeWindow

El período durante el cual se debe completar la tarea.
journey_sharing_info

JourneySharingInfo

Solo salida. Campos específicos para el uso compartido de la experiencia. No se propaga cuando el estado es CLOSED.
task_tracking_view_config

TaskTrackingViewConfig

Es la configuración del seguimiento de tareas que especifica qué elementos de datos son visibles para los usuarios finales en qué circunstancias.
attributes[]

TaskAttribute

Una lista de atributos de tareas personalizadas. Cada atributo debe tener una clave única.

JourneySharingInfo

Recorrido en el que se comparten campos específicos.

Campos
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Información de seguimiento de las paradas que realizará el vehículo asignado antes de completar esta tarea. Ten en cuenta que esta lista puede contener paradas de otras tareas.

El primer segmento, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), contiene información de ruta desde la última ubicación conocida del controlador hasta la próxima VehicleStop. Por lo general, la información actual de la ruta proviene de la app del conductor, excepto en algunos casos indicados en la documentación de DeliveryVehicle.current_route_segment. Fleet Engine propaga los otros segmentos en Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments (REST). Proporcionan información de ruta entre las VehicleStops restantes.
last_location

DeliveryVehicleLocation

Indica la última ubicación informada del vehículo del vehículo asignado.
last_location_snappable

bool

Indica si la lastLocation del vehículo se puede ajustar al current_route_segment. Este valor es falso si no existen last_location o current_route_segment. Fleet Engine calcula este valor. Se ignoran las actualizaciones de los clientes.

Estado

El estado de un elemento Task. Esto indica el progreso de las tareas.

Enumeradores
STATE_UNSPECIFIED Predeterminado. Se usa para un estado de tarea no especificado o no reconocido.
OPEN La tarea aún no se asignó a un vehículo de entrega, o bien el vehículo de entrega aún no pasó la parada de vehículo asignada a Task.
CLOSED Cuando el vehículo pasa la parada del vehículo para esta tarea.

TaskOutcome

El resultado de intentar ejecutar una Task. Cuando se cierra TaskState, TaskOutcome indica si se completó correctamente.

Enumeradores
TASK_OUTCOME_UNSPECIFIED El resultado de la Task antes de que se establezca su valor.
SUCCEEDED La tarea se completó correctamente.
FAILED La tarea no se pudo completar o se canceló.

TaskOutcomeLocationSource

La identidad de la fuente que propagó el task_outcome_location.

Enumeradores
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED El resultado de la tarea antes de que se establezca.
PROVIDER El proveedor especificó task_outcome_location.
LAST_VEHICLE_LOCATION El proveedor no especificó el task_outcome_location, por lo que Fleet Engine usó la ubicación más reciente del vehículo conocida.

Tipo

El tipo de Task.

Enumeradores
TYPE_UNSPECIFIED Configuración predeterminada, el tipo de tarea es desconocido.
PICKUP Una tarea de retiro es la acción que se realiza para retirar un envío de un cliente. Los retiros de vehículos de depósito o alimentador deben utilizar el tipo SCHEDULED_STOP.
DELIVERY Una Tarea de entrega es la acción que se realiza para entregar un envío a un cliente final. Para llegar a los vehículos del depósito o alimentador, se debe utilizar el tipo SCHEDULED_STOP.
SCHEDULED_STOP Se utiliza una tarea de detención programada para fines de planificación. Por ejemplo, podría representar el retiro o la entrega de envíos de los vehículos de alimentación o los depósitos. No se debe usar para los envíos que un cliente final los recoge o lleva.
UNAVAILABLE Una tarea que significa que el vehículo no está disponible para el servicio. Por ejemplo, esto puede ocurrir cuando el conductor se toma un descanso o cuando el vehículo está recargando combustible.

TaskAttribute

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

Campos
key

string

La clave del atributo. Las claves no pueden contener el carácter de dos puntos (:).
Campo de unión task_attribute_value. El valor del atributo puede estar en cadena, en booleano o en tipo doble. Si no se establece ninguno, el string_value de TaskAttribute se almacenará como la cadena vacía "". task_attribute_value solo puede ser una de las siguientes opciones:
string_value

string

Valor del atributo de tipo de cadena.
bool_value

bool

Valor de atributo de tipo booleano.
number_value

double

Valor de atributo de doble tipo.

TaskTrackingInfo

El mensaje TaskTrackingInfo El mensaje contiene información de seguimiento de tareas que se usará para mostrarlas. Si un ID de seguimiento está asociado con varias tareas, Fleet Engine utiliza una heurística para decidir qué TaskTrackingInfo de Task seleccionar.

Campos
name

string

Debe tener el formato providers/{provider}/taskTrackingInfo/{tracking}, en el que tracking representa el ID de seguimiento.
tracking_id

string

Inmutable. El ID de seguimiento de una tarea. * Debe ser una cadena Unicode válida. * Límite de longitud máximo de 64 caracteres. * Normalizado de acuerdo con el formulario C de normalización de Unicode. * No puede contener ninguno de los siguientes caracteres ASCII: “/”, “:”, “?”, “,” o “'#'”.
vehicle_location

DeliveryVehicleLocation

La última ubicación del vehículo.
route_polyline_points[]

LatLng

Una lista de puntos que, cuando se conectan, forman una polilínea de la ruta prevista del vehículo hacia la ubicación de esta tarea.
remaining_stop_count

Int32Value

Indica la cantidad de paradas que le quedan al vehículo hasta llegar a la parada de tarea, incluida la parada. Por ejemplo, si la próxima parada del vehículo es la parada de tarea, el valor será 1.
remaining_driving_distance_meters

Int32Value

La distancia total restante en metros con el VehicleStop de interés.
estimated_arrival_time

Timestamp

La marca de tiempo que indica la hora de llegada estimada a la ubicación de la parada.
estimated_task_completion_time

Timestamp

La marca de tiempo que indica el tiempo estimado de finalización de una tarea.
state

State

Es el estado de ejecución actual de la tarea.
task_outcome

TaskOutcome

El resultado de intentar ejecutar una Task.
task_outcome_time

Timestamp

Es la marca de tiempo que indica cuando el proveedor estableció el resultado de la tarea.
planned_location

LocationInfo

Inmutable. La ubicación donde se completará la Tarea.
target_time_window

TimeWindow

El período durante el cual se debe completar la tarea.
attributes[]

TaskAttribute

Los atributos personalizados configurados en la tarea.

TaskTrackingViewConfig

Es el mensaje de configuración que define cuándo debe ser visible para los usuarios finales un elemento de datos de una tarea.

Campos
route_polyline_points_visibility

VisibilityOption

Es el campo que especifica cuándo se pueden ver los puntos de polilínea de la ruta. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel del proyecto para estos datos.
estimated_arrival_time_visibility

VisibilityOption

El campo que especifica cuándo puede ser visible la hora de llegada estimada. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel del proyecto para estos datos.
estimated_task_completion_time_visibility

VisibilityOption

El campo que especifica cuándo puede ser visible el tiempo estimado de finalización de la tarea. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel del proyecto para estos datos.
remaining_driving_distance_visibility

VisibilityOption

El campo que especifica cuándo se puede ver la distancia de conducción restante. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel del proyecto para estos datos.
remaining_stop_count_visibility

VisibilityOption

Es el campo que especifica cuándo se puede ver el recuento de paradas restantes. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel del proyecto para estos datos.
vehicle_location_visibility

VisibilityOption

Es el campo que especifica cuándo puede ser visible la ubicación del vehículo. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel del proyecto para estos datos.

VisibilityOption

Es el mensaje de opción que define cuándo un elemento de datos debe ser visible para los usuarios finales.

Campos
Campo de unión visibility_option. La opción de visibilidad específica elegida. Las direcciones (visibility_option) solo pueden ser una de las siguientes opciones:
remaining_stop_count_threshold

int32

Los usuarios finales podrán ver este elemento de datos si el recuento de paradas restante es igual o igual que <= restante_stop_count_threshold.
duration_until_estimated_arrival_time_threshold

Duration

Este elemento de datos es visible para los usuarios finales si la hora de llegada estimada a la parada es <= duration_until_estimated_arrival_time_threshold.
remaining_driving_distance_meters_threshold

int32

Este elemento de datos es visible para los usuarios finales si la distancia de conducción restante en metros es igual a <= restante_distance_meters_threshold.
always

bool

Si se configura como verdadero, este elemento de datos siempre estará visible para los usuarios finales sin umbrales. Este campo no se puede establecer como falso.
never

bool

Si se configura como verdadero, este elemento de datos siempre está oculto para los usuarios finales sin umbrales. Este campo no se puede establecer como falso.

TimeWindow

Es un intervalo de tiempo.

Campos
start_time

Timestamp

Obligatorio. Es la hora de inicio del período (inclusive).
end_time

Timestamp

Obligatorio. Es la hora de finalización del período (inclusive).

UpdateDeliveryVehicleRequest

El mensaje de solicitud UpdateDeliveryVehicle

Campos
header

DeliveryRequestHeader

Opcional. El encabezado de la solicitud a la API de entrega estándar.
delivery_vehicle

DeliveryVehicle

Obligatorio. La actualización de entidad DeliveryVehicle que se aplicará. Nota: No puedes actualizar el nombre de DeliveryVehicle.
update_mask

FieldMask

Obligatorio. Una máscara de campo que indica qué campos de DeliveryVehicle se deben actualizar. Ten en cuenta que update_mask debe contener al menos un campo.

Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "remaining_vehicle_journey_segments".

UpdateTaskRequest

El mensaje de solicitud UpdateTask

Campos
header

DeliveryRequestHeader

Opcional. El encabezado de la solicitud a la API de entrega estándar.
task

Task

Obligatorio. La tarea asociada con la actualización. Fleet Engine mantiene los siguientes campos. No las actualices con Task.update.

  • last_location.
  • last_location_snappable.
  • name.
  • remaining_vehicle_journey_segments.
  • task_outcome_location_source.

Nota: No puedes cambiar el valor de task_outcome una vez que lo estableces.

Si la tarea se asignó a un vehículo de entrega, no establezcas el estado de la tarea en CLOSED con Task.update. En su lugar, quita la VehicleStop que contiene la tarea del vehículo de entrega, lo que establecerá automáticamente el estado de la tarea en CERRADA.
update_mask

FieldMask

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

Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "task_outcome,task_outcome_time,task_outcome_location".

VehicleJourneySegment

Representa el tramo de recorrido de un vehículo, desde su parada anterior hasta la parada actual. Si es la primera parada activa, es desde la ubicación actual del Vehículo hasta esa parada.

Campos
stop

VehicleStop

Especifica la ubicación de la parada, junto con los Task asociados a ella. Es posible que algunos campos de VehicleStop no estén presentes si este segmento de viaje forma parte de JourneySharingInfo.
driving_distance_meters

Int32Value

Solo salida. La distancia de viaje desde la parada anterior hasta esta parada. Si la parada actual es la primera parada de la lista de tramos de viaje, el punto de partida es la ubicación del vehículo registrada en el momento en que esta parada se agregó a la lista. Es posible que este campo no esté presente si este segmento de recorrido forma parte de JourneySharingInfo.
driving_duration

Duration

Solo salida. La duración del viaje desde la parada anterior hasta esta parada. Si la parada actual es la primera parada de la lista de tramos de viaje, el punto de partida es la ubicación del vehículo registrada en el momento en que esta parada se agregó a la lista.

Si este campo está definido en la ruta Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) o Task.remainingVehicleJourneySegments[0].drivingDuration (REST), se puede propagar con el valor de DeliveryVehicle.remaining_duration (gRPC) o DeliveryVehicle.remainingDuration (REST). Esto proporciona la duración restante en automóvil desde la ubicación conocida más reciente de la app para conductores, en lugar de la duración del viaje desde la parada anterior.
path[]

LatLng

Solo salida. Indica la ruta desde la parada anterior hasta esta parada. Si la parada actual es la primera parada de la lista de tramos de viaje, esta es la ruta desde la ubicación actual del vehículo hasta la parada en el momento en que esta se agregó a la lista. Es posible que este campo no esté presente si este segmento de recorrido forma parte de JourneySharingInfo.

Si este campo está definido en la ruta Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST), puede propagarse con los LatLng decodificados de DeliveryVehicle.current_route_segment (gRPC) o DeliveryVehicle.currentRouteSegment (REST). Esto proporciona la ruta de conducción desde la ubicación conocida más reciente de la app de conductor, en lugar de la ruta desde la parada anterior.

VehicleStop

Describe un punto en el que un vehículo se detiene para realizar una o más Task.

Campos
planned_location

LocationInfo

Obligatorio. Es la ubicación de la parada. Ten en cuenta que las ubicaciones de las Task podrían no coincidir exactamente con esta ubicación, pero estarán muy cerca de ella. Este campo no se propagará en la respuesta de una llamada a GetTask.
tasks[]

TaskInfo

Lista de Task que se realizarán en esta parada. Este campo no se propagará en la respuesta de una llamada a GetTask.
state

State

El estado de VehicleStop Este campo no se propagará en la respuesta de una llamada a GetTask.

Estado

Es el estado actual de un objeto VehicleStop.

Enumeradores
STATE_UNSPECIFIED Desconocido.
NEW Se creó, pero no se enrutaba de forma activa.
ENROUTE Enrutamiento asignado y activo
ARRIVED Llegaste a la parada. Supone que, cuando el Vehículo dirige a la siguiente parada, se completaron todas las paradas anteriores.

TaskInfo

Información adicional sobre la tarea realizada en esta parada.

Campos
task_id

string

El ID de la tarea. Este campo no se propagará en la respuesta de una llamada a GetTask. Los IDs de tareas están sujetos 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 “'#'”.
task_duration

Duration

Solo salida. Tiempo requerido para realizar la tarea.
target_time_window

TimeWindow

Solo salida. El período durante el cual se debe completar la tarea. Esto solo se establece en la respuesta a GetDeliveryVehicle.