Package maps.fleetengine.delivery.v1

Índice

DeliveryService

El servicio de entrega de Last Mile.

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.

SearchTasks

rpc SearchTasks(SearchTasksRequest) returns (SearchTasksResponse)

Obsoleto: usa GetTaskTrackingInfo en su lugar.

UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Escribe datos actualizados de DeliveryVehicle en Fleet Engine y asigna Tasks a DeliveryVehicle. No se puede actualizar el nombre de DeliveryVehicle. Sin embargo, puedes actualizar remaining_vehicle_journey_segments, pero debe contener todos los VehicleJourneySegment que se encuentran actualmente en DeliveryVehicle. Los task_id se recuperan de remaining_vehicle_journey_segments, y sus Tasks correspondientes se asignan a 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 Delivery estándar. Nota: Si estableces este campo, el campo de encabezado de los mensajes CreateTaskRequest debe estar vacío o coincidir con este campo.

parent

string

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

requests[]

CreateTaskRequest

Obligatorio. 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 Delivery 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 string Unicode válida.
  • Tiene una longitud máxima de 64 caracteres.
  • Se normalizó según el Formulario de normalización C de Unicode.
  • No puede contener ninguno de los siguientes caracteres ASCII: “/”, “:”, “?”, “,” o '#'.
delivery_vehicle

DeliveryVehicle

Obligatorio. La entidad DeliveryVehicle que se creará. Cuando crees 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 de DeliveryVehicle; de lo contrario, se muestra un error.

CreateTaskRequest

El mensaje de solicitud CreateTask.

Campos
header

DeliveryRequestHeader

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

parent

string

Obligatorio. Debe tener el formato providers/{provider}. 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 de envío. Para almacenar un ID de seguimiento de envío, usa el campo tracking_id. Ten en cuenta que varias tareas pueden tener el mismo tracking_id. Los IDs de tarea están sujetos a las siguientes restricciones:

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

Task

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

  • type
  • state (se debe establecer en OPEN)
  • tracking_id (no se debe configurar para tareas de 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. Todos los demás campos de Task no se deben configurar; de lo contrario, se muestra un error.

DeliveryRequestHeader

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

Campos
language_code

string

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

region_code

string

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

sdk_version

string

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

os_version

string

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

device_model

string

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

sdk_type

SdkType

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

maps_sdk_version

string

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

nav_sdk_version

string

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

platform

Platform

Plataforma del SDK que realiza la llamada.

manufacturer

string

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

android_api_level

int32

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

trace_id

string

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

Plataforma

Es la plataforma del SDK que realiza la llamada.

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

SdkType

Posibles tipos de SDK.

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

DeliveryVehicle

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

Nota: Las APIs de REST y gRPC usan diferentes convenciones de nombres de campos. 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

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

last_location

DeliveryVehicleLocation

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

navigation_status

DeliveryVehicleNavigationStatus

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. La app del conductor actualiza esta información cuando se llega a una parada o pasa por ella, 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 es posible que este campo no se use para propagar Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

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

  • La app del controlador no actualizó su ubicación recientemente, por lo que el último valor de este campo puede estar inactivo.

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

En estos casos, Fleet Engine propaga este campo con una ruta desde la última opción VehicleStop que se pasó a VehicleStop 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

Es la ubicación donde termina el current_route_segment. Por el momento, la app del controlador no propaga este campo, pero puedes proporcionarlo en las llamadas a UpdateDeliveryVehicle. Es el LatLng de la próxima parada del vehículo o el último LatLng de current_route_segment. Luego, Fleet Engine hará todo lo posible para interpolar a un VehicleStop real.

Se ignora este campo en las llamadas UpdateDeliveryVehicle si el campo current_route_segment está vacío

remaining_distance_meters

Int32Value

La distancia restante en automóvil para current_route_segment. Por lo general, la app de Driver proporciona este campo, pero hay algunas circunstancias en las que Fleet Engine anulará el valor que envía la app. 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 ignorará este campo en UpdateDeliveryVehicleRequest si el campo current_route_segment está vacío.

remaining_duration

Duration

El tiempo de conducción restante para el current_route_segment. Por lo general, la app de Driver proporciona este campo, pero hay algunas circunstancias en las que Fleet Engine anulará el valor que envía la app. 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 ignorará este campo en UpdateDeliveryVehicleRequest si el campo current_route_segment está vacío.

remaining_vehicle_journey_segments[]

VehicleJourneySegment

Son los tramos de viaje asignados a este vehículo de entregas, comenzando por la ubicación del vehículo que se informó más recientemente. Este campo no se propagará en la respuesta de ListDeliveryVehicles.

attributes[]

DeliveryVehicleAttribute

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

type

DeliveryVehicleType

El tipo de este vehículo de entrega. Si no la estableces, el valor predeterminado 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, un ciclomotor u otro vehículo de dos ruedas
BICYCLE Transporte impulsado por seres humanos.
PEDESTRIAN Un transportador humano, generalmente caminando o corriendo, que viaja por senderos peatonales.

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

El valor del atributo.

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

string

Valor del atributo con tipo de cadena.

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

bool_value

bool

Valor del atributo de tipo booleano.

number_value

double

Valor del atributo de tipo doble.

DeliveryVehicleLocation

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

Campos
location

LatLng

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

horizontal_accuracy
(deprecated)

DoubleValue

Obsoleto: usa latlng_accuracy en su lugar.

latlng_accuracy

DoubleValue

Precisión de location en metros como radio.

heading

Int32Value

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

bearing_accuracy
(deprecated)

DoubleValue

Obsoleto: usa heading_accuracy en su lugar.

heading_accuracy

DoubleValue

Precisión de heading en grados.

altitude

DoubleValue

Altitud en metros sobre WGS84.

vertical_accuracy
(deprecated)

DoubleValue

Obsoleto: usa altitude_accuracy en su lugar.

altitude_accuracy

DoubleValue

Precisión de altitude en metros

speed_kmph
(deprecated)

Int32Value

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

speed

DoubleValue

Velocidad del vehículo en metros/segundo

speed_accuracy

DoubleValue

Precisión de speed en metros por segundo.

update_time

Timestamp

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

server_time

Timestamp

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

location_sensor

DeliveryVehicleLocationSensor

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

is_road_snapped

BoolValue

Indica si location se ajustó a una ruta.

is_gps_sensor_enabled

BoolValue

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

time_since_update

Int32Value

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

num_stale_updates
(deprecated)

Int32Value

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

raw_location

LatLng

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

raw_location_time

Timestamp

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

raw_location_sensor

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

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

supplemental_location_time

Timestamp

Marca de tiempo asociada con la ubicación complementaria.

supplemental_location_sensor

DeliveryVehicleLocationSensor

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

supplemental_location_accuracy

DoubleValue

Precisión de supplemental_location como radio, en metros.

road_snapped
(deprecated)

bool

Obsoleto: usa is_road_snapped en su lugar.

DeliveryVehicleLocationSensor

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

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

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 para conductores ingresó al modo GUIDED_NAV.
OFF_ROUTE El vehículo se desvió de la ruta sugerida.
ARRIVED_AT_DESTINATION El vehículo está a una distancia aproximada de 50 m del destino.

GetDeliveryVehicleRequest

El mensaje de solicitud GetDeliveryVehicle.

Campos
header

DeliveryRequestHeader

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

name

string

Obligatorio. Debe tener el formato providers/{provider}/deliveryVehicles/{delivery_vehicle}. 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 Delivery estándar.

name

string

Obligatorio. Debe tener el formato providers/{provider}/tasks/{task}. 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 Delivery estándar.

name

string

Obligatorio. Debe tener el formato providers/{provider}/taskTrackingInfo/{tracking_id}. provider debe ser el ID del proyecto de Google Cloud y 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 Delivery estándar.

parent

string

Obligatorio. Debe tener el formato providers/{provider}. 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 mostrará. Es posible que el servicio devuelva menos que este número. Si no especificas este número, el servidor determina la cantidad de resultados que se mostrarán.

page_token

string

Opcional. Un token de página, recibido desde una llamada ListDeliveryVehicles anterior. Debes proporcionarla para 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 consulta de filtro que se aplicará cuando se muestre una lista de 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 búsquedas 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 con los atributos son las de cadenas. Para compararlos con valores numéricos o booleanos, los valores deben estar entre comillas de forma explícita para que se los trate como cadenas (por ejemplo, attributes.<key> = "10" o attributes.<key> = "true").

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

viewport

Viewport

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

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. Cuando 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, significa que no se encontraron vehículos de entrega que cumplan 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 string vacía.

total_size

int64

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 Delivery estándar.

parent

string

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

page_size

int32

Opcional. La cantidad máxima de tareas que se mostrarán. Es posible que el servicio devuelva menos que este valor. Si no se especifica este valor, el servidor determina la cantidad de resultados que se mostrarán.

page_token

string

Opcional. Un token de página recibido de una llamada anterior a ListTasks. Puedes proporcionarla 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 enumere Tasks. Consulta http://aip.dev/160 para ver ejemplos de sintaxis de filtros. Si no especificas un valor o si filtras con una string vacía, se mostrarán todas las tareas. Para obtener información sobre las propiedades de Task que puedes filtrar, consulta Lista de tareas.

ListTasksResponse

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

Campos
tasks[]

Task

Es 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, significa que este campo es una string 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 identificadores adicionales.

Campos
point

LatLng

Coordenadas de la ubicación

SearchTasksRequest

Obsoleto: Se emite GetTaskTrackingInfoRequest a GetTaskTrackingInfo en su lugar.

Campos
header

DeliveryRequestHeader

Opcional. El encabezado de la solicitud a la API de Delivery 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

tracking_id

string

Obligatorio. Es el identificador del conjunto de tareas relacionadas que se solicitan. Los IDs de seguimiento están sujetos a las siguientes restricciones:

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

int32

Opcional. La cantidad máxima de tareas que se mostrarán. Es posible que el servicio devuelva menos que este valor. Si no se especifica este valor, el servidor determina la cantidad de resultados que se mostrarán.

page_token

string

Opcional. Un token de página, recibido desde una llamada SearchTasks anterior. Debes proporcionar este valor para recuperar la página siguiente.

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

SearchTasksResponse

La respuesta SearchTasks Contiene el conjunto de tareas que cumplen con los criterios de búsqueda en SearchTasksRequest.

Campos
tasks[]

Task

Es el conjunto de tareas para el tracking_id solicitado. Una respuesta correcta también puede estar vacía. Una respuesta vacía indica que no hay tareas asociadas con el tracking_id proporcionado.

next_page_token

string

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

Tarea

En la API de Delivery, una tarea representa una sola acción a la que le puedes hacer un seguimiento. En general, hay una distinción entre las tareas relacionadas con el envío y las tareas de desglose. Un envío puede tener varias tareas asociadas. Por ejemplo, podría haber una tarea para el punto de partida y otra para el destino o el transbordo. Además, vehículos diferentes pueden manejar las distintas Tasks para un envío determinado. Por ejemplo, un vehículo podría encargarse del retiro y conducir el envío al centro, mientras que otro vehículo realiza el mismo envío desde el centro hasta la ubicación de llegada.

Nota: Las APIs de REST y gRPC usan diferentes convenciones de nombres de campos. 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 Task. Por ejemplo, una pausa o un envío.

state

State

Obligatorio. El estado actual de la ejecución de la Task.

task_outcome

TaskOutcome

El resultado de la Task.

task_outcome_time

Timestamp

Es la marca de tiempo que indica cuándo el proveedor configuró el resultado de Task.

task_outcome_location

LocationInfo

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 forma explícita este valor, Fleet Engine lo propaga de forma predeterminada con la ubicación más reciente del vehículo (la ubicación sin).

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 no tengas que usar 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 string Unicode válida.
  • Tiene una longitud máxima de 64 caracteres.
  • Se normalizó según el Formulario de normalización C de Unicode.
  • No puede contener ninguno de los siguientes caracteres ASCII: “/”, “:”, “?”, “,” o '#'.
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 string Unicode válida.
  • Tiene una longitud máxima de 64 caracteres.
  • Se normalizó según el Formulario de normalización C de Unicode.
  • No puede contener ninguno de los siguientes caracteres ASCII: “/”, “:”, “?”, “,” o '#'.
planned_location

LocationInfo

Inmutable. Es la ubicación en la que se completará la tarea. Opcional para las tareas de UNAVAILABLE, pero es obligatorio para todas las demás tareas.

task_duration

Duration

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

target_time_window

TimeWindow

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

journey_sharing_info

JourneySharingInfo

Solo salida. Campos específicos del recorrido compartido. 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 y en qué circunstancias.

attributes[]

TaskAttribute

Una lista de atributos personalizados de Tasks. Cada atributo debe tener una clave única.

JourneySharingInfo

Recorrido que comparte campos específicos

Campos
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Información de seguimiento para 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 conductor hasta el próximo VehicleStop. Por lo general, la información de ruta actual proviene de la app del conductor, excepto en algunos casos que se indican 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 los VehicleStops restantes.

last_location

DeliveryVehicleLocation

Indica la ubicación más reciente que se informó del vehículo asignado.

last_location_snappable

bool

Indica si la última ubicación del vehículo se puede ajustar a current_route_segment. Este valor es Falso si last_location o current_route_segment no existen. Fleet Engine calcula este valor. Se ignoran las actualizaciones de los clientes.

Estado

Es el estado de una tarea. Indica el progreso de las tareas.

Enumeradores
STATE_UNSPECIFIED Predeterminado. Se usa para un estado de tarea no especificado o no reconocido.
OPEN Es posible que la tarea aún no se asigne a un vehículo de entrega o que este vehículo aún no haya pasado por la parada asignada por el Task.
CLOSED Cuando el vehículo pase por la parada del vehículo para realizar 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 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ó el 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.

Tipo

Es el tipo de Task.

Enumeradores
TYPE_UNSPECIFIED De forma predeterminada, se desconoce el tipo de tarea.
PICKUP Una tarea de retiro es la acción que se realiza para recoger un envío de un cliente. Las recogidas de vehículos desde plataformas o alimentadores deben usar 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. Los destinos de vehículos todoterreno o depósito deben usar el tipo SCHEDULED_STOP.
SCHEDULED_STOP Una Task de parada programada se utiliza con fines de planificación. Por ejemplo, podría representar la recogida o devolución de envíos de vehículos o depósitos de alimentación. No debe usarse para envíos que recoge o deja un cliente final.
UNAVAILABLE Una Tarea que significa que el Vehículo no está disponible para su mantenimiento. Por ejemplo, esto puede ocurrir cuando el conductor se toma un descanso o cuando se está recargando el combustible del vehículo.

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 ser de tipo string, bool o doble. Si no se establece ninguno, el valor string_value de TaskAttribute se almacenará como la string vacía "". task_attribute_value solo puede ser una de las siguientes opciones:
string_value

string

Valor del atributo con tipo de cadena.

bool_value

bool

Valor del atributo de tipo booleano.

number_value

double

Valor del atributo de tipo doble.

TaskTrackingInfo

El mensaje TaskTrackingInfo El mensaje contiene información de seguimiento de tareas que se utilizará para mostrarlo. Si un ID de seguimiento está asociado con varias tareas, Fleet Engine utiliza una heurística para decidir qué campo TaskTrackingInfo de la tarea 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 Task. * Debe ser una string Unicode válida. * Limitado a una longitud máxima de 64 caracteres. * Normalizada según el Formulario C de normalización de Unicode. * No puede contener ninguno de los siguientes caracteres ASCII: “/”, “:”, “?”, “,” o '#'.

vehicle_location

DeliveryVehicleLocation

Indica 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 esperada del vehículo hacia la ubicación de esta tarea.

remaining_stop_count

Int32Value

Indica la cantidad de paradas que quedan en el vehículo hasta llegar a la parada de tareas, incluida la parada de tareas. Por ejemplo, si la siguiente parada del vehículo es la parada de tareas, el valor será 1.

remaining_driving_distance_meters

Int32Value

La distancia total restante en metros al VehicleStop de interés.

estimated_arrival_time

Timestamp

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

estimated_task_completion_time

Timestamp

La marca de tiempo que indica la hora estimada de finalización de una tarea.

state

State

El estado actual de la ejecución de la Task.

task_outcome

TaskOutcome

El resultado de intentar ejecutar una Task.

task_outcome_time

Timestamp

La marca de tiempo que indica cuándo el proveedor estableció el resultado de la tarea.

planned_location

LocationInfo

Inmutable. Es la ubicación en la que se completará la tarea.

target_time_window

TimeWindow

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

attributes[]

TaskAttribute

Los atributos personalizados establecidos en la tarea.

TaskTrackingViewConfig

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

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 de proyecto para estos datos.

estimated_arrival_time_visibility

VisibilityOption

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

estimated_task_completion_time_visibility

VisibilityOption

Campo que especifica cuándo se puede visualizar 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 de proyecto para estos datos.

remaining_driving_distance_visibility

VisibilityOption

Puede verse el campo que especifica el momento en que se puede recorrer el área restante en automóvil. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel de proyecto para estos datos.

remaining_stop_count_visibility

VisibilityOption

El campo que especifica cuándo puede estar visible el recuento de paradas restante. Si no se especifica este campo, se usará la configuración de visibilidad predeterminada a nivel de 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 de 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

Este elemento de datos es visible para los usuarios finales si el recuento de paradas restante es inferior o igual a remanente_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 <= 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 restante en metros es inferior o igual a la cantidad restante_driving_distance_meters_threshold.

always

bool

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

never

bool

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

TimeWindow

Un intervalo de tiempo.

Campos
start_time

Timestamp

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

end_time

Timestamp

Obligatorio. Indica 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 Delivery 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.

Se trata de una lista separada por comas de los nombres de campos completamente 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 Delivery 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 configuras.

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

update_mask

FieldMask

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

Se trata de una lista separada por comas de los nombres de campos completamente calificados. Ejemplo: "task_outcome,task_outcome_time,task_outcome_location".

VehicleJourneySegment

Representa el tramo de viaje 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 esta 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 aparezcan si este tramo 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 de la lista de tramos de viaje, el punto de partida es la ubicación del vehículo registrada cuando se agregó esta parada 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. Indica la duración de viaje desde la parada anterior hasta esta parada. Si la parada actual es la primera de la lista de tramos de viaje, el punto de partida es la ubicación del vehículo registrada cuando se agregó esta parada a la lista.

Si este campo se define en la ruta de acceso 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 del viaje desde la ubicación conocida más reciente de la app del conductor en lugar de la duración del viaje en la parada anterior.

path[]

LatLng

Solo salida. El recorrido desde la parada anterior hasta esta parada. Si la parada actual es la primera de la lista de tramos de viaje, esta es la ruta desde la ubicación actual del vehículo hasta esta parada en el momento en que la parada 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 se define en la ruta de acceso Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST), se puede propagar 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 del conductor en lugar de la ruta desde la parada anterior.

VehicleStop

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

Campos
planned_location

LocationInfo

Obligatorio. Es la ubicación de la parada. Ten en cuenta que las ubicaciones en los objetos Task podrían no coincidir exactamente con esta ubicación, pero estarán a una distancia corta de ella. Este campo no se completará en la respuesta de una llamada a GetTask ni a SearchTasks.

tasks[]

TaskInfo

Es la lista de Task que se realizarán en esta parada. Este campo no se completará en la respuesta de una llamada a GetTask o SearchTasks.

state

State

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

Estado

El estado actual de un VehicleStop.

Enumeradores
STATE_UNSPECIFIED Desconocido.
NEW Se creó, pero no se enrutó de forma activa.
ENROUTE Asignado y enrutando activamente.
ARRIVED Llegaste a la parada. Supone que, cuando el vehículo va 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 tarea. Este campo no se completará en la respuesta de una llamada a GetTask ni a SearchTasks. Los IDs de tarea están sujetos a las siguientes restricciones:

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

Duration

Solo salida. El tiempo necesario para realizar la tarea.

target_time_window

TimeWindow

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