Package maps.fleetengine.delivery.v1

Indice

DeliveryService

Il servizio Last Mile Delivery.

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

Crea e restituisce un batch di nuovi oggetti Task.
CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

Crea e restituisce un nuovo DeliveryVehicle.
CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

Crea e restituisce un nuovo oggetto Task.
GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

Restituisce l'istanza DeliveryVehicle specificata.
GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Recupera informazioni su un Task.
GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

Restituisce l'istanza TaskTrackingInfo specificata.
ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

Restituisce tutti i valori DeliveryVehicle che soddisfano i criteri di filtro specificati.
ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

Restituisce tutti i valori Task che soddisfano i criteri di filtro specificati.
UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Scrive i dati DeliveryVehicle aggiornati su Fleet Engine e assegna Tasks a DeliveryVehicle. Non puoi aggiornare il nome di DeliveryVehicle. Puoi aggiornare remaining_vehicle_journey_segments, ma deve contenere tutti i VehicleJourneySegment per essere mantenuto su DeliveryVehicle. Gli task_id vengono recuperati da remaining_vehicle_journey_segments e i relativi Tasks vengono assegnati all'elemento DeliveryVehicle, se non sono ancora stati assegnati.
UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Consente di aggiornare i dati relativi a Task.

BatchCreateTasksRequest

Il messaggio di richiesta di BatchCreateTask.

Campi
header

DeliveryRequestHeader

(Facoltativo) L'intestazione della richiesta API Delivery standard. Nota: se imposti questo campo, il campo di intestazione nei messaggi CreateTaskRequest deve essere vuoto o deve corrispondere a questo campo.
parent

string

Obbligatorio. La risorsa padre condivisa da tutte le attività. Questo valore deve essere nel formato providers/{provider}. provider deve essere l'ID del progetto Google Cloud. Ad esempio: sample-cloud-project. Il campo principale nei messaggi CreateTaskRequest deve essere vuoto o deve corrispondere a questo campo.
requests[]

CreateTaskRequest

Obbligatorio. Il messaggio di richiesta che specifica le risorse da creare. Nota: puoi creare un massimo di 500 attività per gruppo.

BatchCreateTasksResponse

Il messaggio di risposta di BatchCreateTask.

Campi
tasks[]

Task

Le attività create.

CreateDeliveryVehicleRequest

Il messaggio di richiesta di CreateDeliveryVehicle.

Campi
header

DeliveryRequestHeader

(Facoltativo) L'intestazione della richiesta API Delivery standard.
parent

string

Obbligatorio. Deve essere nel formato providers/{provider}. Il provider deve essere l'ID progetto Google Cloud. Ad esempio, sample-cloud-project.
delivery_vehicle_id

string

Obbligatorio. L'ID veicolo per la consegna deve essere univoco e soggetto alle seguenti limitazioni:

  • Deve essere una stringa Unicode valida.
  • Lunghezza massima di 64 caratteri.
  • Normalizzato secondo lo Unicode Normalization Form C.
  • Non può contenere nessuno dei seguenti caratteri ASCII: "/", ":", "?", "," o "#".
delivery_vehicle

DeliveryVehicle

Obbligatorio. L'entità DeliveryVehicle da creare. Quando crei un nuovo veicolo per la consegna, puoi impostare i seguenti campi facoltativi:

  • tipo
  • last_location
  • attributi

Nota: il campo name di Delivery Vehicle viene ignorato. Tutti gli altri campi DeliveryVeicoli non devono essere impostati. altrimenti viene restituito un errore.

CreateTaskRequest

Il messaggio di richiesta di CreateTask.

Campi
header

DeliveryRequestHeader

(Facoltativo) L'intestazione della richiesta API Delivery standard.
parent

string

Obbligatorio. Deve essere nel formato providers/{provider}. provider deve essere l'ID del progetto Google Cloud. Ad esempio: sample-cloud-project.
task_id

string

Obbligatorio. L'ID attività deve essere univoco, ma non un ID di monitoraggio della spedizione. Per memorizzare un ID monitoraggio della spedizione, utilizza il campo tracking_id. Tieni presente che più attività possono avere lo stesso tracking_id. Gli ID attività sono soggetti alle seguenti restrizioni:

  • Deve essere una stringa Unicode valida.
  • Lunghezza massima di 64 caratteri.
  • Normalizzato secondo lo Unicode Normalization Form C.
  • Non può contenere nessuno dei seguenti caratteri ASCII: "/", ":", "?", "," o "#".
task

Task

Obbligatorio. L'entità Tasks da creare. Quando crei un'attività, i seguenti campi sono obbligatori:

  • type
  • state (deve essere impostato su OPEN)
  • tracking_id (non deve essere impostato per le attività UNAVAILABLE o SCHEDULED_STOP, ma è obbligatorio per tutti gli altri tipi di attività)
  • planned_location (facoltativo per UNAVAILABLE attività)
  • task_duration

Nota: il campo name dell'attività viene ignorato. Tutti gli altri campi Attività non devono essere impostati. altrimenti viene restituito un errore.

DeliveryRequestHeader

Una RequestHeader contiene campi comuni a tutte le richieste RPC di consegna.

Campi
language_code

string

Il codice lingua BCP-47, ad esempio en-US o sr-Latn. Per ulteriori informazioni, visita la pagina http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Se non viene specificato nulla, la risposta potrebbe essere in qualsiasi lingua, con una preferenza per l'inglese, se questo nome esiste. Esempio di valore del campo: en-US.
region_code

string

Obbligatorio. Codice regione CLDR della regione in cui ha origine la richiesta. Esempio di valore del campo: US.
sdk_version

string

Versione dell'SDK che chiama, se applicabile. Il formato della versione è "major.minor.patch", ad esempio: 1.1.2.
os_version

string

Versione del sistema operativo su cui è in esecuzione l'SDK per la chiamata. Esempi di valori di campi: 4.4.1, 12.1.
device_model

string

Modello del dispositivo su cui è in esecuzione l'SDK per la chiamata. Esempi di valori di campi: iPhone12,1, SM-G920F.
sdk_type

SdkType

Il tipo di SDK che invia la richiesta.
maps_sdk_version

string

Versione del MapSDK da cui dipende l'SDK che chiama, se applicabile. Il formato della versione è "major.minor.patch", ad esempio: 5.2.1.
nav_sdk_version

string

Versione del NavSDK da cui dipende l'SDK che chiama, se applicabile. Il formato della versione è "major.minor.patch", ad esempio: 2.1.0.
platform

Platform

Piattaforma dell'SDK che chiama.
manufacturer

string

Produttore del dispositivo Android dall'SDK di chiamata, applicabile solo per gli SDK Android. Esempio di valore del campo: Samsung.
android_api_level

int32

Livello API Android dell'SDK di chiamata, applicabile solo per gli SDK Android. Esempio di valore del campo: 23.
trace_id

string

ID facoltativo che può essere fornito a scopo di logging al fine di identificare la richiesta.

Piattaforma

La piattaforma dell'SDK di chiamata.

Enum
PLATFORM_UNSPECIFIED Il valore predefinito. Questo valore viene utilizzato se la piattaforma viene omessa.
ANDROID La richiesta proviene da Android.
IOS La richiesta proviene da iOS.
WEB La richiesta proviene dal web.

SdkType

Possibili tipi di SDK.

Enum
SDK_TYPE_UNSPECIFIED Il valore predefinito. Questo valore viene utilizzato se l'attributo sdk_type viene omesso.
CONSUMER L'SDK che chiama è consumer.
DRIVER L'SDK che chiama è il driver.
JAVASCRIPT L'SDK di chiamata è JavaScript.

DeliveryVehicle

Il messaggio DeliveryVehicle. Un veicolo per la consegna trasporta le spedizioni da un deposito a un punto di consegna e da un punto di prelievo al deposito. In alcuni casi, i mezzi di consegna trasportano anche le spedizioni direttamente dal punto di prelievo a quello di consegna.

Nota: le API gRPC e REST utilizzano convenzioni di denominazione dei campi diverse. Ad esempio, il campo DeliveryVehicle.current_route_segment nell'API gRPC e il campo DeliveryVehicle.currentRouteSegment nell'API REST fanno riferimento allo stesso campo.

Campi
name

string

Il nome univoco di questo veicolo per la consegna. Il formato è providers/{provider}/deliveryVehicles/{vehicle}.
last_location

DeliveryVehicleLocation

L'ultima posizione segnalata del veicolo per la consegna.
navigation_status

DeliveryVehicleNavigationStatus

Lo stato di navigazione del veicolo per la consegna.
current_route_segment

bytes

La polilinea codificata che specifica il percorso che la navigazione consiglia di seguire per la tappa successiva. L'app del conducente aggiorna questo dato quando viene raggiunta o superata una fermata e quando la navigazione cambia percorso. Questi LatLng vengono restituiti in Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) per tutte le attività attive assegnate al veicolo.

In alcuni casi, questo campo potrebbe non essere utilizzato per compilare Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

  • L'endpoint di current_route_segment non corrisponde a DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) o DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • L'app del conducente non ha aggiornato la sua posizione di recente, pertanto l'ultimo valore aggiornato per questo campo potrebbe essere inattivo.

  • L'app del conducente ha aggiornato di recente la sua posizione, ma il current_route_segment è inattivo e rimanda a una fermata del veicolo precedente.

In questi casi, Fleet Engine compila questo campo con un percorso dal VehicleStop passato più di recente al prossimo VehicleStop per garantire che l'utente di questo campo abbia le migliori informazioni disponibili sul percorso attuale del Veicolo di consegna.
current_route_segment_end_point

LatLng

La posizione in cui termina l'evento current_route_segment. Al momento non è compilato dall'app del conducente, ma puoi fornirlo nelle chiamate UpdateDeliveryVehicle. Si tratta della LatLng della prossima fermata del veicolo o dell'ultimo LatLng dei current_route_segment. Fleet Engine farà del proprio meglio per interpolare in modo da ottenere un valore VehicleStop effettivo.

Questo campo viene ignorato nelle chiamate UpdateDeliveryVehicle se il campo current_route_segment è vuoto.
remaining_distance_meters

Int32Value

La distanza in auto rimanente per il current_route_segment. In genere l'app Driver fornisce questo campo, ma in alcuni casi Fleet Engine sostituirà il valore inviato dall'app. Per ulteriori informazioni, vedi DeliveryVehicle.current_route_segment. Questo campo viene restituito in Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) o Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) per tutti i Task attivi assegnati al veicolo di consegna.

Fleet Engine ignora questo campo in UpdateDeliveryVehicleRequest se il campo current_route_segment è vuoto.
remaining_duration

Duration

Il tempo di guida rimanente per il current_route_segment. In genere l'app Driver fornisce questo campo, ma in alcuni casi Fleet Engine sostituirà il valore inviato dall'app. Per ulteriori informazioni, vedi DeliveryVehicle.current_route_segment. Questo campo viene restituito in Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) o Task.remainingVehicleJourneySegments[0].drivingDuration (REST) per tutte le attività attive assegnate al veicolo di consegna.

Fleet Engine ignora questo campo in UpdateDeliveryVehicleRequest se il campo current_route_segment è vuoto.
remaining_vehicle_journey_segments[]

VehicleJourneySegment

I segmenti di viaggio assegnati a questo Veicolo per le consegne, a partire dalla posizione del veicolo segnalata più di recente. Questo campo non verrà compilato nella risposta di ListDeliveryVehicles.
attributes[]

DeliveryVehicleAttribute

Un elenco di attributi personalizzati del veicolo per la consegna. Un veicolo per la consegna può avere al massimo 100 attributi, ognuno dei quali deve avere una chiave univoca.
type

DeliveryVehicleType

Il tipo di questo veicolo per la consegna. Se non viene configurato, il valore predefinito è AUTO.

DeliveryVehicleType

Il tipo di veicolo per la consegna.

Enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Il valore non è utilizzato.
AUTO Un'automobile.
TWO_WHEELER Una motocicletta, un ciclomotore o un altro veicolo a due ruote
BICYCLE Trasporto a energia umana.
PEDESTRIAN Un trasportatore, di solito cammina o corre, che percorre percorsi pedonali.

DeliveryVehicleAttribute

Descrive un attributo del veicolo come coppia chiave-valore. La colonna "key:value" la lunghezza della stringa non può superare i 256 caratteri.

Campi
key

string

La chiave dell'attributo.
value

string

Il valore dell'attributo.
Campo unione delivery_vehicle_attribute_value. Il valore dell'attributo può essere di tipo stringa, bool o doppio. delivery_vehicle_attribute_value può essere solo uno dei seguenti:
string_value

string

Valore dell'attributo tipo di stringa.

Nota: è identico al campo value che verrà ritirato. Per i metodi di creazione o aggiornamento, entrambi i campi possono essere utilizzati, ma consigliamo vivamente di utilizzare string_value. Se string_value e value sono impostati, devono essere identici, altrimenti verrà visualizzato un errore. Entrambi i campi vengono compilati in risposte.
bool_value

bool

Valore di attributo digitato con valore booleano.
number_value

double

Valore attributo doppio tipo.

DeliveryVehicleLocation

La posizione, la velocità e la direzione di un veicolo in un determinato momento.

Campi
location

LatLng

La posizione del veicolo. Quando viene inviato a Fleet Engine, la posizione del veicolo è una posizione GPS. Quando la ricevi in una risposta, la posizione del veicolo può essere una posizione GPS, una posizione supplementare o un'altra posizione stimata. L'origine è specificata in location_sensor.
horizontal_accuracy
(deprecated)

DoubleValue

Deprecato: usa invece latlng_accuracy.
latlng_accuracy

DoubleValue

Precisione di location in metri come raggio.
heading

Int32Value

La direzione di spostamento del veicolo in gradi. 0 rappresenta il nord. L'intervallo valido è [0,360).
bearing_accuracy
(deprecated)

DoubleValue

Deprecato: usa invece heading_accuracy.
heading_accuracy

DoubleValue

Precisione di heading in gradi.
altitude

DoubleValue

Altitudine in metri sopra WGS84.
vertical_accuracy
(deprecated)

DoubleValue

Deprecato: usa invece altitude_accuracy.
altitude_accuracy

DoubleValue

Precisione di altitude in metri.
speed_kmph
(deprecated)

Int32Value

Velocità del veicolo in chilometri orari. Deprecato: usa invece speed.
speed

DoubleValue

Velocità del veicolo in metri/secondo
speed_accuracy

DoubleValue

Precisione di speed in metri al secondo.
update_time

Timestamp

L'ora in cui il sensore ha segnalato location in base all'orologio del sensore.
server_time

Timestamp

Solo output. L'ora in cui il server ha ricevuto le informazioni sulla posizione.
location_sensor

DeliveryVehicleLocationSensor

Fornitore di dati sulla posizione (ad esempio, GPS).
is_road_snapped

BoolValue

Indica se location è agganciato a una strada.
is_gps_sensor_enabled

BoolValue

Solo input. Indica se il sensore GPS è abilitato sul dispositivo mobile.
time_since_update

Int32Value

Solo input. Tempo (in secondi) dall'invio della posizione al server per la prima volta. Il valore sarà zero per il primo aggiornamento. Se l'ora non è nota (ad esempio, al riavvio dell'app), questo valore viene reimpostato su zero.
num_stale_updates
(deprecated)

Int32Value

Solo input. Obsoleta: ora vengono utilizzati altri indicatori per determinare se una località è obsoleta.
raw_location

LatLng

Posizione del veicolo grezzo (non elaborata da un esperto di autovelox).
raw_location_time

Timestamp

Timestamp associato alla località non elaborata.
raw_location_sensor

DeliveryVehicleLocationSensor

Origine della località non elaborata. Il valore predefinito è GPS.
raw_location_accuracy

DoubleValue

Precisione di raw_location come raggio, in metri.
supplemental_location

LatLng

Posizione supplementare fornita dall'app di integrazione.
supplemental_location_time

Timestamp

Timestamp associato alla località supplementare.
supplemental_location_sensor

DeliveryVehicleLocationSensor

Origine della località supplementare. Il valore predefinito è CUSTOMER_SUPPLIED_LOCATION.
supplemental_location_accuracy

DoubleValue

Precisione di supplemental_location come raggio, in metri.
road_snapped
(deprecated)

bool

Deprecato: usa invece is_road_snapped.

DeliveryVehicleLocationSensor

Il sensore o la metodologia utilizzati per determinare la posizione.

Enum
UNKNOWN_SENSOR Il sensore non è specificato o è sconosciuto.
GPS GPS o GPS assistito.
NETWORK GPS assistito, ID ripetitore cellulare o punto di accesso Wi-Fi.
PASSIVE ID del ripetitore di telefonia mobile o punto di accesso Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Una posizione determinata dal dispositivo mobile come la posizione più probabile sulla strada.
CUSTOMER_SUPPLIED_LOCATION Una località fornita dal cliente da una fonte indipendente. In genere, questo valore viene utilizzato per una posizione fornita da fonti diverse dal dispositivo mobile su cui è in esecuzione l'SDK Driver. Se la fonte originale è descritta da uno degli altri valori enum, utilizza quel valore. Le località contrassegnate come CUSTOMER_SUPPLIED_LOCATION vengono in genere fornite tramite l'attributo last_location.supplemental_location_sensor di un veicolo per la consegna.
FLEET_ENGINE_LOCATION Una località calcolata da Fleet Engine in base agli indicatori a sua disposizione. Solo output. Questo valore verrà rifiutato se viene ricevuto in una richiesta.
FUSED_LOCATION_PROVIDER Fused Location Provider di Android.
CORE_LOCATION Il fornitore di posizione sui sistemi operativi Apple.

DeliveryVehicleNavigationStatus

Lo stato di navigazione del veicolo.

Enum
UNKNOWN_NAVIGATION_STATUS Stato di navigazione non specificato.
NO_GUIDANCE La navigazione dell'app Driver è in modalità FREE_NAV.
ENROUTE_TO_DESTINATION La navigazione passo passo è disponibile e la navigazione nell'app Driver è attivata in modalità GUIDED_NAV.
OFF_ROUTE Il veicolo ha abbandonato il percorso suggerito.
ARRIVED_AT_DESTINATION Il veicolo si trova a una distanza di circa 50 m dalla destinazione.

GetDeliveryVehicleRequest

Il messaggio di richiesta di GetDeliveryVehicle.

Campi
header

DeliveryRequestHeader

(Facoltativo) L'intestazione della richiesta API Delivery standard.
name

string

Obbligatorio. Deve essere nel formato providers/{provider}/deliveryVehicles/{delivery_vehicle}. provider deve essere l'ID del progetto Google Cloud. Ad esempio: sample-cloud-project.

GetTaskRequest

Il messaggio di richiesta di GetTask.

Campi
header

DeliveryRequestHeader

(Facoltativo) L'intestazione della richiesta API Delivery standard.
name

string

Obbligatorio. Deve essere nel formato providers/{provider}/tasks/{task}. provider deve essere l'ID del progetto Google Cloud. Ad esempio: sample-cloud-project.

GetTaskTrackingInfoRequest

Il messaggio di richiesta di GetTaskTrackingInfoRequest.

Campi
header

DeliveryRequestHeader

(Facoltativo) L'intestazione della richiesta API Delivery standard.
name

string

Obbligatorio. Deve essere nel formato providers/{provider}/taskTrackingInfo/{tracking_id}. provider deve essere l'ID del progetto Google Cloud e tracking_id deve essere l'ID monitoraggio associato all'attività. Un nome di esempio può essere providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id.

ListDeliveryVehiclesRequest

Il messaggio di richiesta di ListDeliveryVehicles.

Campi
header

DeliveryRequestHeader

(Facoltativo) L'intestazione della richiesta API Delivery standard.
parent

string

Obbligatorio. Deve essere nel formato providers/{provider}. provider deve essere l'ID del progetto Google Cloud. Ad esempio: sample-cloud-project.
page_size

int32

(Facoltativo) Il numero massimo di veicoli da restituire. Il servizio potrebbe restituire un numero inferiore a questo. Se non specifichi questo numero, il server determina il numero di risultati da restituire.
page_token

string

(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata a ListDeliveryVehicles. Devi fornirlo per poter recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti a ListDeliveryVehicles devono corrispondere alla chiamata che ha fornito il token della pagina.
filter

string

(Facoltativo) Una query di filtro da applicare quando vengono elencati i veicoli per la consegna. Vedi http://aip.dev/160 per esempi di sintassi dei filtri. Se non specifichi un valore o specifichi una stringa vuota per il filtro, verranno restituiti tutti i veicoli per la consegna.

Tieni presente che le uniche query supportate per ListDeliveryVehicles riguardano gli attributi del veicolo (ad es. attributes.<key> = <value> o attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Inoltre, tutti gli attributi vengono memorizzati come stringhe, pertanto gli unici confronti supportati con gli attributi sono quelli di stringhe. Per eseguire il confronto con valori numerici o booleani, i valori devono essere tra virgolette in modo esplicito per essere trattati come stringhe (ad esempio, attributes.<key> = "10" o attributes.<key> = "true").

Il numero massimo di restrizioni consentite in una query di filtro è 50. Una restrizione fa parte della query nel formato attribute.<KEY> <COMPARATOR> <VALUE>, ad esempio attributes.foo = bar è 1 restrizione.
viewport

Viewport

(Facoltativo) Un filtro che limita i veicoli restituiti a quelli la cui ultima posizione nota era nell'area rettangolare definita dall'area visibile.

ListDeliveryVehiclesResponse

Il messaggio di risposta di ListDeliveryVehicles.

Campi
delivery_vehicles[]

DeliveryVehicle

L'insieme di veicoli per la consegna che soddisfano i criteri di filtro richiesti. Se non viene specificato alcun filtro, la richiesta restituisce tutti i veicoli per la consegna. Una risposta corretta può anche essere vuota. Una risposta vuota indica che non sono stati trovati veicoli per la consegna che soddisfano i criteri di filtro richiesti.
next_page_token

string

Puoi passare questo token in ListDeliveryVehiclesRequest per continuare a elencare i risultati. Quando vengono restituiti tutti i risultati, questo campo non sarà presente nella risposta o sarà una stringa vuota.
total_size

int64

Il numero totale di veicoli per la consegna che corrispondono ai criteri della richiesta, in tutte le pagine.

ListTasksRequest

Il messaggio di richiesta di ListTasks.

Campi
header

DeliveryRequestHeader

(Facoltativo) L'intestazione della richiesta API Delivery standard.
parent

string

Obbligatorio. Deve essere nel formato providers/{provider}. provider deve essere l'ID del progetto Google Cloud. Ad esempio: sample-cloud-project.
page_size

int32

(Facoltativo) Il numero massimo di attività da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore. Se non specifichi questo valore, il server determina il numero di risultati da restituire.
page_token

string

(Facoltativo) Un token di pagina ricevuto da una precedente chiamata a ListTasks. Puoi fornirlo per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti a ListTasks devono corrispondere alla chiamata che ha fornito il token della pagina.
filter

string

(Facoltativo) Una query di filtro da applicare quando vengono elencate le attività. Vedi http://aip.dev/160 per esempi di sintassi dei filtri. Se non specifichi un valore o se filtri in base a una stringa vuota, vengono restituite tutte le attività. Per informazioni sulle proprietà delle attività in base alle quali puoi filtrare, consulta Elencare le attività.

ListTasksResponse

La risposta ListTasks che contiene l'insieme di attività che soddisfano i criteri del filtro in ListTasksRequest.

Campi
tasks[]

Task

L'insieme di attività che soddisfano i criteri di filtro richiesti. Se non viene specificato alcun filtro, la richiesta restituisce tutte le attività. Una risposta corretta può anche essere vuota. Una risposta vuota indica che non è stata trovata alcuna attività che soddisfa i criteri di filtro richiesti.
next_page_token

string

Passa questo token in ListTasksRequest per continuare a elencare i risultati. Se sono stati restituiti tutti i risultati, questo campo è una stringa vuota oppure non viene visualizzato nella risposta.
total_size

int64

Il numero totale di attività che corrispondono ai criteri della richiesta, in tutte le pagine.

LocationInfo

Una località con eventuali identificatori aggiuntivi.

Campi
point

LatLng

Le coordinate del luogo.

Attività

Un'attività nell'API Delivery rappresenta una singola azione da monitorare. In generale, esiste una distinzione tra le attività relative alla spedizione e le attività da rompere. A una spedizione possono essere associate più attività. Ad esempio, potrebbe esserci un'attività per il ritiro e un'altra per la consegna o il trasferimento. Inoltre, attività diverse per una determinata spedizione possono essere gestite da veicoli diversi. Ad esempio, un veicolo potrebbe gestire il ritiro, guidando la spedizione all'hub, mentre un altro veicolo porta la stessa spedizione dall'hub alla località di consegna.

Nota: le API gRPC e REST utilizzano convenzioni di denominazione dei campi diverse. Ad esempio, il campo Task.journey_sharing_info nell'API gRPC e il campo Task.journeySharingInfo nell'API REST fanno riferimento allo stesso campo.

Campi
name

string

Deve essere nel formato providers/{provider}/tasks/{task}.
type

Type

Obbligatorio. Immutabile. Definisce il tipo di attività. ad esempio una rottura o una spedizione.
state

State

Obbligatorio. Lo stato di esecuzione attuale dell'attività.
task_outcome

TaskOutcome

Il risultato dell'attività.
task_outcome_time

Timestamp

Il timestamp che indica quando il risultato di Task è stato impostato dal provider.
task_outcome_location

LocationInfo

La località in cui è stato impostato il risultato di Task. Questo valore viene aggiornato come parte di UpdateTask. Se questo valore non viene aggiornato esplicitamente dal provider, Fleet Engine lo compila per impostazione predefinita con l'ultima posizione nota del veicolo (la posizione non elaborata).
task_outcome_location_source

TaskOutcomeLocationSource

Indica la provenienza del valore di task_outcome_location.
tracking_id

string

Immutabile. Questo campo consente di memorizzare un ID per evitare di utilizzare una mappatura complicata. Non puoi impostare tracking_id per le attività di tipo UNAVAILABLE e SCHEDULED_STOP. Questi ID sono soggetti alle seguenti restrizioni:

  • Deve essere una stringa Unicode valida.
  • Lunghezza massima di 64 caratteri.
  • Normalizzato secondo lo Unicode Normalization Form C.
  • Non può contenere nessuno dei seguenti caratteri ASCII: "/", ":", "?", "," o "#".
delivery_vehicle_id

string

Solo output. L'ID del veicolo che esegue questa attività. Gli ID veicolo per la consegna sono soggetti alle seguenti limitazioni:

  • Deve essere una stringa Unicode valida.
  • Lunghezza massima di 64 caratteri.
  • Normalizzato secondo lo Unicode Normalization Form C.
  • Non può contenere nessuno dei seguenti caratteri ASCII: "/", ":", "?", "," o "#".
planned_location

LocationInfo

Immutabile. Il luogo in cui verrà completata l'attività. Facoltativo per UNAVAILABLE Tasks, ma obbligatorio per tutte le altre attività.
task_duration

Duration

Obbligatorio. Immutabile. Il tempo necessario per eseguire un'attività in questa posizione.
target_time_window

TimeWindow

L'intervallo di tempo durante il quale deve essere completata l'attività.
journey_sharing_info

JourneySharingInfo

Solo output. Campi specifici per la condivisione del percorso. Non compilato quando lo stato è CLOSED.
task_tracking_view_config

TaskTrackingViewConfig

La configurazione per il monitoraggio delle attività che specifica quali elementi dei dati sono visibili agli utenti finali in quali circostanze.
attributes[]

TaskAttribute

Un elenco di attributi personalizzati delle attività. Ogni attributo deve avere una chiave univoca.

JourneySharingInfo

Condivisione del percorso di campi specifici.

Campi
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Informazioni di monitoraggio delle fermate che il veicolo assegnato farà prima di completare questa attività. Tieni presente che questo elenco può contenere fermate di altre attività.

Il primo segmento, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), contiene informazioni sul percorso dall'ultima posizione nota del conducente al prossimo VehicleStop. Le informazioni attuali sul percorso solitamente provengono dall'app del conducente, ad eccezione di alcuni casi indicati nella documentazione di DeliveryVehicle.current_route_segment. Gli altri segmenti in Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments (REST) sono compilati da Fleet Engine. Forniscono informazioni sui percorsi tra i restanti VehicleStops.
last_location

DeliveryVehicleLocation

Indica l'ultima posizione segnalata del veicolo assegnato.
last_location_snappable

bool

Indica se l'ultima posizione del veicolo può essere agganciata a current_route_segment. Questo valore è False se last_location o current_route_segment non esistono. Questo valore viene calcolato da Fleet Engine. Gli aggiornamenti dei client vengono ignorati.

Stato

Lo stato di un'attività. Indica l'avanzamento delle attività.

Enum
STATE_UNSPECIFIED Predefinita. Utilizzato per uno stato dell'attività non specificato o non riconosciuto.
OPEN L'attività non è ancora stata assegnata a un veicolo per le consegne oppure il veicolo per le consegne non ha ancora superato l'arresto del veicolo assegnato da Task.
CLOSED Quando il veicolo supera il punto di arresto per questa attività.

TaskOutcome

Il risultato del tentativo di eseguire un'attività. Quando TaskState è chiuso, TaskOutcome indica se l'operazione è stata completata correttamente.

Enum
TASK_OUTCOME_UNSPECIFIED Il risultato dell'attività prima che sia impostato il relativo valore.
SUCCEEDED L'attività è stata completata.
FAILED Non è stato possibile completare l'attività o è stata annullata.

TaskOutcomeLocationSource

L'identità dell'origine che ha completato task_outcome_location.

Enum
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Il risultato dell'attività prima che venga impostato.
PROVIDER Il provider ha specificato task_outcome_location.
LAST_VEHICLE_LOCATION Il provider non ha specificato task_outcome_location, quindi Fleet Engine ha utilizzato l'ultima posizione nota del veicolo.

Tipo

Il tipo di attività.

Enum
TYPE_UNSPECIFIED Impostazione predefinita, il tipo di attività è sconosciuto.
PICKUP Un'attività di ritiro è l'azione intrapresa per ritirare una spedizione da un cliente. Per i prelievi in deposito o tramite distributore di veicoli devono essere utilizzati il tipo SCHEDULED_STOP.
DELIVERY Un'Attività di consegna è l'azione intrapresa per consegnare una spedizione a un cliente finale. I depositi o i punti di raccolta dei veicoli da traino devono essere di tipo SCHEDULED_STOP.
SCHEDULED_STOP Un'attività di interruzione pianificata viene utilizzata ai fini della pianificazione. Ad esempio, potrebbe rappresentare il ritiro o la consegna di spedizioni da veicoli o depositi di feeder. Non deve essere utilizzato per alcuna spedizione presa o consegnata da un cliente finale.
UNAVAILABLE Un'attività che indica che il veicolo non è disponibile per il servizio. Ad esempio, questo può accadere quando il conducente fa una pausa o quando il veicolo sta facendo rifornimento.

TaskAttribute

Descrive un attributo attività come coppia chiave-valore. La colonna "key:value" la lunghezza della stringa non può superare i 256 caratteri.

Campi
key

string

La chiave dell'attributo. Le chiavi non possono contenere i due punti (:).
Campo unione task_attribute_value. Il valore dell'attributo può essere di tipo stringa, bool o doppio. Se non viene impostato alcun valore, il valore string_value di TaskAttribute verrà memorizzato come stringa vuota "". task_attribute_value può essere solo uno dei seguenti:
string_value

string

Valore dell'attributo tipo di stringa.
bool_value

bool

Valore di attributo digitato con valore booleano.
number_value

double

Valore attributo doppio tipo.

TaskTrackingInfo

Il messaggio TaskTrackingInfo. Il messaggio contiene informazioni di monitoraggio delle attività che verranno utilizzate per la visualizzazione. Se un ID monitoraggio è associato a più attività, Fleet Engine utilizza un'euristica per decidere quale TaskTrackingInfo dell'attività selezionare.

Campi
name

string

Deve essere nel formato providers/{provider}/taskTrackingInfo/{tracking}, dove tracking rappresenta l'ID monitoraggio.
tracking_id

string

Immutabile. L'ID monitoraggio di un'attività. * Deve essere una stringa Unicode valida. * Lunghezza massima: 64 caratteri. * Normalizzato secondo lo standard Unicode Normalization Form C. * Non può contenere nessuno dei seguenti caratteri ASCII: "/", ":", "?", "", o "#".
vehicle_location

DeliveryVehicleLocation

L'ultima posizione del veicolo.
route_polyline_points[]

LatLng

Un elenco di punti che, se collegati, forma una polilinea del percorso previsto del veicolo verso la posizione di questa attività.
remaining_stop_count

Int32Value

Indica il numero di fermate rimanenti fino al raggiungimento della fermata dell'attività, inclusa la fermata dell'attività. Ad esempio, se la fermata successiva del veicolo è la fermata dell'attività, il valore sarà 1.
remaining_driving_distance_meters

Int32Value

La distanza totale rimanente in metri al VehicleStop di interesse.
estimated_arrival_time

Timestamp

Il timestamp che indica l'ora di arrivo prevista alla posizione della fermata.
estimated_task_completion_time

Timestamp

Timestamp che indica il tempo di completamento stimato di un'attività.
state

State

Lo stato di esecuzione attuale dell'attività.
task_outcome

TaskOutcome

Il risultato del tentativo di eseguire un'attività.
task_outcome_time

Timestamp

Il timestamp che indica quando il risultato dell'attività è stato impostato dal provider.
planned_location

LocationInfo

Immutabile. Il luogo in cui verrà completata l'attività.
target_time_window

TimeWindow

L'intervallo di tempo durante il quale deve essere completata l'attività.
attributes[]

TaskAttribute

Gli attributi personalizzati impostati nell'attività.

TaskTrackingViewConfig

Il messaggio di configurazione che definisce quando un elemento dati di un'attività deve essere visibile agli utenti finali.

Campi
route_polyline_points_visibility

VisibilityOption

Il campo che specifica quando possono essere visibili i punti delle polilinee della route. Se questo campo non viene specificato, verrà utilizzata la configurazione di visibilità predefinita a livello di progetto per questi dati.
estimated_arrival_time_visibility

VisibilityOption

Il campo che specifica quando può essere visibile l'ora di arrivo stimata. Se questo campo non viene specificato, verrà utilizzata la configurazione di visibilità predefinita a livello di progetto per questi dati.
estimated_task_completion_time_visibility

VisibilityOption

Il campo che specifica quando può essere visibile il tempo stimato di completamento dell'attività. Se questo campo non viene specificato, verrà utilizzata la configurazione di visibilità predefinita a livello di progetto per questi dati.
remaining_driving_distance_visibility

VisibilityOption

Il campo che specifica quando è necessario raggiungere la distanza di guida rimanente può essere visibile. Se questo campo non viene specificato, verrà utilizzata la configurazione di visibilità predefinita a livello di progetto per questi dati.
remaining_stop_count_visibility

VisibilityOption

Il campo che specifica quando il conteggio delle fermate rimanenti può essere visibile. Se questo campo non viene specificato, verrà utilizzata la configurazione di visibilità predefinita a livello di progetto per questi dati.
vehicle_location_visibility

VisibilityOption

Il campo che specifica quando la posizione del veicolo può essere visibile. Se questo campo non viene specificato, verrà utilizzata la configurazione di visibilità predefinita a livello di progetto per questi dati.

VisibilityOption

Il messaggio di opzione che definisce quando un elemento dei dati deve essere visibile agli utenti finali.

Campi
Campo unione visibility_option. L'opzione di visibilità specifica scelta. visibility_option può essere solo uno dei seguenti:
remaining_stop_count_threshold

int32

Questo elemento di dati è visibile agli utenti finali se il numero di tappe rimanenti è <=REMAINING_stop_count_threshold.
duration_until_estimated_arrival_time_threshold

Duration

Questo elemento di dati è visibile agli utenti finali se l'orario di arrivo stimato verso la fermata è <=duration_until_estimated_arrival_time_threshold.
remaining_driving_distance_meters_threshold

int32

Questo elemento di dati è visibile agli utenti finali se la distanza di guida rimanente in metri è <= left_driving_distance_meters_threshold.
always

bool

Se impostato su true, questo elemento dati è sempre visibile agli utenti finali senza soglie. Questo campo non può essere impostato su false.
never

bool

Se impostato su true, questo elemento dati è sempre nascosto agli utenti finali senza soglie. Questo campo non può essere impostato su false.

TimeWindow

Un intervallo di tempo.

Campi
start_time

Timestamp

Obbligatorio. L'ora di inizio della finestra temporale (inclusa).
end_time

Timestamp

Obbligatorio. L'ora di fine dell'intervallo di tempo (inclusa).

UpdateDeliveryVehicleRequest

Il messaggio di richiesta di UpdateDeliveryVehicle.

Campi
header

DeliveryRequestHeader

(Facoltativo) L'intestazione della richiesta API Delivery standard.
delivery_vehicle

DeliveryVehicle

Obbligatorio. L'aggiornamento dell'entità DeliveryVehicle da applicare. Nota: non puoi aggiornare il nome di DeliveryVehicle.
update_mask

FieldMask

Obbligatorio. Una maschera di campo che indica quali campi DeliveryVehicle aggiornare. Tieni presente che la maschera di aggiornamento deve contenere almeno un campo.

Si tratta di un elenco di nomi completi dei campi separati da virgole. Esempio: "remaining_vehicle_journey_segments".

UpdateTaskRequest

Il messaggio di richiesta di UpdateTask.

Campi
header

DeliveryRequestHeader

(Facoltativo) L'intestazione della richiesta API Delivery standard.
task

Task

Obbligatorio. L'attività associata all'aggiornamento. I seguenti campi sono gestiti da Fleet Engine. Non aggiornarli utilizzando Task.update.

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

Nota: una volta impostato, non puoi modificare il valore di task_outcome.

Se l'attività è stata assegnata a un veicolo per la consegna, non impostarne lo stato su CHIUSA utilizzando Task.update. Rimuovi invece l'elemento VehicleStop che contiene l'attività dal veicolo per la consegna, il che imposta automaticamente lo stato dell'attività su CHIUSA.
update_mask

FieldMask

Obbligatorio. La maschera dei campi che indica i campi delle attività da aggiornare. Nota: update_mask deve contenere almeno un campo.

Si tratta di un elenco di nomi completi dei campi separati da virgole. Esempio: "task_outcome,task_outcome_time,task_outcome_location".

VehicleJourneySegment

Rappresenta il segmento di viaggio di un veicolo, dalla fermata precedente a quella corrente. Se è la prima fermata attiva, significa che si trova dalla posizione attuale del veicolo a questa fermata.

Campi
stop

VehicleStop

Specifica la posizione della fermata, insieme ai Task associati. Alcuni campi di VehicleStop potrebbero non essere presenti se questo tratto di corsa fa parte di JourneySharingInfo.
driving_distance_meters

Int32Value

Solo output. La distanza da percorrere dalla fermata precedente a questa fermata. Se la fermata corrente è la prima fermata nell'elenco dei tratti di viaggio, il punto di partenza è la posizione del veicolo registrata nel momento in cui questa fermata è stata aggiunta all'elenco. Questo campo potrebbe non essere presente se questo tratto di viaggio fa parte di JourneySharingInfo.
driving_duration

Duration

Solo output. Il tempo di percorrenza dalla fermata precedente a questa fermata. Se la fermata attuale è la prima fermata nell'elenco dei tratti di viaggio, il punto di partenza è la posizione del Veicolo registrato nel momento in cui questa fermata è stata aggiunta all'elenco.

Se questo campo è definito nel percorso Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) o Task.remainingVehicleJourneySegments[0].drivingDuration (REST), è possibile che venga compilato con il valore di DeliveryVehicle.remaining_duration (gRPC) o DeliveryVehicle.remainingDuration (REST). In questo modo viene indicata la durata di guida rimanente in base all'ultima posizione nota dell'app del conducente anziché il tempo di guida dalla fermata precedente.
path[]

LatLng

Solo output. Il percorso dalla fermata precedente a questa fermata. Se la fermata attuale è la prima fermata nell'elenco dei tratti di viaggio, si tratta del percorso dalla posizione attuale del veicolo a questa fermata nel momento in cui la fermata è stata aggiunta all'elenco. Questo campo potrebbe non essere presente se questo tratto di viaggio fa parte di JourneySharingInfo.

Se questo campo è definito nel percorso Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST), potrebbe essere compilato con i LatLng decodificati in DeliveryVehicle.current_route_segment (gRPC) o DeliveryVehicle.currentRouteSegment (REST). In questo modo viene fornito il percorso di guida dall'ultima posizione nota dell'app del conducente anziché il percorso dalla fermata precedente.

VehicleStop

Descrive un punto in cui un veicolo si ferma per eseguire uno o più Task.

Campi
planned_location

LocationInfo

Obbligatorio. La posizione della fermata. Tieni presente che le località negli Task potrebbero non corrispondere esattamente a questa località, ma si troveranno a breve distanza da quest'ultima. Questo campo non verrà compilato nella risposta a una chiamata GetTask.
tasks[]

TaskInfo

L'elenco di Task da eseguire in questa fermata. Questo campo non verrà compilato nella risposta a una chiamata GetTask.
state

State

Lo stato di VehicleStop. Questo campo non verrà compilato nella risposta a una chiamata GetTask.

Stato

Lo stato attuale di un VehicleStop.

Enum
STATE_UNSPECIFIED Sconosciuto.
NEW L'operazione è stata creata, ma il routing non è attivo.
ENROUTE Assegnato e routing attivo.
ARRIVED Sei arrivato alla fermata. Presuppone che, quando il Veicolo instrada verso la fermata successiva, tutte le fermate precedenti siano state completate.

TaskInfo

Ulteriori informazioni sull'attività eseguita in questa fermata.

Campi
task_id

string

L'ID attività. Questo campo non verrà compilato nella risposta a una chiamata GetTask. Gli ID attività sono soggetti alle seguenti restrizioni:

  • Deve essere una stringa Unicode valida.
  • Lunghezza massima di 64 caratteri.
  • Normalizzato secondo lo Unicode Normalization Form C.
  • Non può contenere nessuno dei seguenti caratteri ASCII: "/", ":", "?", "," o "#".
task_duration

Duration

Solo output. Il tempo necessario per eseguire l'attività.
target_time_window

TimeWindow

Solo output. L'intervallo di tempo durante il quale deve essere completata l'attività. Viene impostato solo nella risposta a GetDeliveryVehicle.