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)

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

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

Recupera tutti i valori Task che soddisfano i criteri di filtro specificati.
SearchTasks

rpc SearchTasks(SearchTasksRequest) returns (SearchTasksResponse)

Deprecato: utilizza GetTaskTrackingInfo.
UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Scrive dati DeliveryVehicle aggiornati in Fleet Engine e assegna Tasks a DeliveryVehicle. Non puoi aggiornare il nome di DeliveryVehicle. Tuttavia puoi aggiornare remaining_vehicle_journey_segments, ma deve contenere tutti i VehicleJourneySegment attualmente presenti nella DeliveryVehicle. I task_id vengono recuperati da remaining_vehicle_journey_segments e i Tasks corrispondenti vengono assegnati a DeliveryVehicle, se non sono ancora stati assegnati.
UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Aggiorna i dati di Task.

BatchCreateTasksRequest

Il messaggio di richiesta BatchCreateTask.

Campi
header

DeliveryRequestHeader

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard. Nota: se imposti questo campo, il campo dell'intestazione nei messaggi CreateTaskRequest deve essere vuoto o deve corrispondere a questo campo.
parent

string

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

CreateTaskRequest

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

BatchCreateTasksResponse

Il messaggio di risposta BatchCreateTask.

Campi
tasks[]

Task

Le attività create.

CreateDeliveryVehicleRequest

Il messaggio di richiesta CreateDeliveryVehicle.

Campi
header

DeliveryRequestHeader

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard.
parent

string

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

string

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

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

DeliveryVehicle

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

  • last_location
  • attributes

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

CreateTaskRequest

Il messaggio di richiesta CreateTask.

Campi
header

DeliveryRequestHeader

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard.
parent

string

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

string

Obbligatoria. L'ID attività deve essere univoco, ma non deve essere un ID monitoraggio della spedizione. Per archiviare 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 limitazioni:

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

Task

Obbligatoria. 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 UNAVAILABLE o SCHEDULED_STOP attività, 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 dell'attività non devono essere impostati, altrimenti viene restituito un errore.

DeliveryRequestHeader

Un'intestazione 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, vedi http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Se non viene specificato alcun nome, la risposta può essere in qualsiasi lingua, con una preferenza per l'inglese, se esiste un nome di questo tipo. Esempio di valore del campo: en-US.
region_code

string

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

string

Versione dell'SDK per le chiamate, 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 le chiamate. Esempi di valori del campo: 4.4.1, 12.1.
device_model

string

Modello del dispositivo su cui è in esecuzione l'SDK per le chiamate. Esempi di valori del campo: 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 per le chiamate, 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 per le chiamate, se applicabile. Il formato della versione è "major.minor.patch", ad esempio 2.1.0.
platform

Platform

Piattaforma dell'SDK per le chiamate.
manufacturer

string

Produttore del dispositivo Android dall'SDK per le chiamate; applicabile soltanto per gli SDK Android. Esempio di valore del campo: Samsung.
android_api_level

int32

Livello API Android dell'SDK per le chiamate, applicabile solo agli SDK Android. Esempio di valore del campo: 23.
trace_id

string

ID facoltativo che può essere fornito ai fini del logging per identificare la richiesta.

Piattaforma

La piattaforma dell'SDK per le chiamate.

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 sdk_type viene omesso.
CONSUMER L'SDK per le chiamate è consumer.
DRIVER L'SDK per le chiamate è Driver.
JAVASCRIPT L'SDK per le chiamate è JavaScript.

DeliveryVehicle

Il messaggio DeliveryVehicle. Un veicolo per la consegna trasporta le spedizioni da un deposito a un luogo di consegna e da un punto di ritiro al deposito. In alcuni casi, i veicoli per le consegne trasportano anche le spedizioni direttamente dal luogo di ritiro 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 per raggiungere il waypoint successivo. L'app del conducente si aggiorna quando viene raggiunta o superata una fermata e quando la navigazione cambia. 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 completare 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, quindi l'ultimo valore aggiornato per questo campo potrebbe essere inattivo.

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

In questi casi, Fleet Engine compila questo campo con un percorso dall'ultimo VehicleStop passato al successivo VehicleStop per garantire che il consumatore di questo campo disponga delle migliori informazioni disponibili sul percorso corrente del veicolo per la consegna.
current_route_segment_end_point

LatLng

La località in cui termina current_route_segment. Al momento questo campo non è compilato dall'app del conducente, ma puoi fornirlo nelle chiamate UpdateDeliveryVehicle. Si tratta del LatLng della prossima fermata del veicolo o dell'ultimo LatLng del current_route_segment. Fleet Engine farà quindi del suo meglio per interpolare in un 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. L'app Driver in genere fornisce questo campo, ma in alcuni casi Fleet Engine sostituisce 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 per la 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. L'app Driver in genere fornisce questo campo, ma in alcuni casi Fleet Engine sostituisce 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 la consegna, a partire dall'ultima posizione del veicolo segnalata. 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 sarà AUTO.

DeliveryVehicleType

Il tipo di veicolo per la consegna.

Enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Il valore è inutilizzato.
AUTO Un'automobile.
TWO_WHEELER Un motociclo, un ciclomotore o un altro veicolo a due ruote.
BICYCLE Trasporto umano.
PEDESTRIAN Un mezzi di trasporto umano, in genere a piedi o di corsa, lungo percorsi pedonali.

DeliveryVehicleAttribute

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

Campi
key

string

La chiave dell'attributo.
value

string

Il valore dell'attributo.
Campo di 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 di tipo stringa.

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

bool

Valore dell'attributo con tipo booleano.
number_value

double

Valore dell'attributo con 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 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: utilizza latlng_accuracy.
latlng_accuracy

DoubleValue

Precisione di location in metri come raggio.
heading

Int32Value

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

DoubleValue

Deprecato: utilizza heading_accuracy.
heading_accuracy

DoubleValue

Precisione di heading in gradi.
altitude

DoubleValue

Altitudine in metri sopra WGS84.
vertical_accuracy
(deprecated)

DoubleValue

Deprecato: utilizza altitude_accuracy.
altitude_accuracy

DoubleValue

Precisione di altitude in metri.
speed_kmph
(deprecated)

Int32Value

Velocità del veicolo in chilometri orari. Deprecato: utilizza speed.
speed

DoubleValue

Velocità del veicolo in metri/secondo
speed_accuracy

DoubleValue

Precisione di speed in metri/secondo.
update_time

Timestamp

L'ora in cui location è stato segnalato dal sensore 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 portatile.
time_since_update

Int32Value

Solo input. Tempo (in secondi) dall'invio della posizione al server. Questo sarà pari a 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 grezza del veicolo (non elaborata da Autosnapper).
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 integrata.
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: utilizza 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 di telefonia mobile o punto di accesso Wi-Fi.
PASSIVE Punto di accesso Wi-Fi o ID ripetitore di telefonia mobile.
ROAD_SNAPPED_LOCATION_PROVIDER Una posizione determinata dal dispositivo mobile come la posizione stradale più probabile.
CUSTOMER_SUPPLIED_LOCATION Una posizione fornita dal cliente da una fonte indipendente. In genere, questo valore viene utilizzato per una posizione fornita da fonti diverse dal dispositivo mobile che esegue l'SDK Driver. Se la fonte originale è descritta da uno degli altri valori di enum, utilizza quel valore. Le sedi contrassegnate con CUSTOMER_SUPPLIED_LOCATION in genere vengono fornite tramite il last_location.supplemental_location_sensor di DeliveryVeicoli.
FLEET_ENGINE_LOCATION Una località calcolata da Fleet Engine in base ai segnali 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 della 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 È disponibile la navigazione passo passo e la navigazione dell'app Driver è passata alla modalità GUIDED_NAV.
OFF_ROUTE Il veicolo ha abbandonato il percorso suggerito.
ARRIVED_AT_DESTINATION Il veicolo si trova a circa 50 metri dalla destinazione.

GetDeliveryVehicleRequest

Il messaggio di richiesta GetDeliveryVehicle.

Campi
header

DeliveryRequestHeader

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard.
name

string

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

GetTaskRequest

Il messaggio di richiesta GetTask.

Campi
header

DeliveryRequestHeader

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard.
name

string

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

GetTaskTrackingInfoRequest

Il messaggio di richiesta GetTaskTrackingInfoRequest.

Campi
header

DeliveryRequestHeader

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard.
name

string

Obbligatoria. Deve essere nel formato providers/{provider}/taskTrackingInfo/{tracking_id}. provider deve essere l'ID 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 ListDeliveryVehicles.

Campi
header

DeliveryRequestHeader

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard.
parent

string

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

int32

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

string

Campo facoltativo. Un token di pagina, ricevuto da una chiamata ListDeliveryVehicles precedente. Devi fornirlo per 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

Campo facoltativo. Una query di filtro da applicare quando elenca i veicoli per la consegna. Vedi http://aip.dev/160 per esempi di sintassi del filtro. Se non specifichi un valore o specifichi una stringa vuota per il filtro, vengono restituiti tutti i veicoli per la consegna.

Tieni presente che le uniche query supportate per ListDeliveryVehicles riguardano gli attributi del veicolo (ad esempio, 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 i confronti di stringhe. Per eseguire un confronto con valori numerici o booleani, i valori devono essere racchiusi esplicitamente tra virgolette per essere trattati come stringhe (ad esempio attributes.<key> = "10" o attributes.<key> = "true").

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

Viewport

Campo facoltativo. Un filtro che limita i veicoli restituiti a quelli la cui ultima posizione nota si trovava nell'area rettangolare definita dall'area visibile.

ListDeliveryVehiclesResponse

Il messaggio di risposta ListDeliveryVehicles.

Campi
delivery_vehicles[]

DeliveryVehicle

L'insieme di veicoli di pubblicazione 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 nell'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 ListTasks.

Campi
header

DeliveryRequestHeader

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard.
parent

string

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

int32

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

string

Campo facoltativo. Un token di pagina ricevuto da una chiamata ListTasks precedente. Puoi fornire questo campo 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

Campo facoltativo. Una query di filtro da applicare quando elenca 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, vedi Elencare le attività.

ListTasksResponse

La risposta ListTasks che contiene il set di attività che soddisfano i criteri di 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 sono state trovate attività che soddisfano i criteri di filtro richiesti.
next_page_token

string

Passa questo token nel 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 della località.

SearchTasksRequest

Deprecato: problema di GetTaskTrackingInfoRequest in GetTaskTrackingInfo.

Campi
header

DeliveryRequestHeader

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard.
parent

string

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

string

Obbligatoria. L'identificatore dell'insieme di attività correlate richieste. Gli ID monitoraggio sono soggetti alle seguenti limitazioni:

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

int32

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

string

Campo facoltativo. Un token di pagina, ricevuto da una chiamata SearchTasks precedente. Devi fornire questo valore per recuperare la pagina successiva.

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

SearchTasksResponse

La risposta SearchTasks. Contiene il set di attività che soddisfano i criteri di ricerca in SearchTasksRequest.

Campi
tasks[]

Task

Il set di attività per l'elemento tracking_id richiesto. Una risposta corretta può anche essere vuota. Una risposta vuota indica che nessuna attività è associata all'oggetto tracking_id fornito.
next_page_token

string

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

Attività

Un'attività nell'API Delivery rappresenta una singola azione da monitorare. In generale, esiste una distinzione tra Tasks relativo alla spedizione e Tasks interrotto. 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, veicoli diversi possono gestire attività diverse per una determinata spedizione. Ad esempio, un veicolo potrebbe gestire il ritiro, facendo in modo che il pacco arriva fino all'hub, mentre un altro può guidare la stessa spedizione dall'hub al punto 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

Obbligatoria. Immutabile. Definisce il tipo di attività. Ad esempio, una pausa o una spedizione.
state

State

Obbligatoria. 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 nell'ambito di UpdateTask. Se questo valore non viene aggiornato esplicitamente dal fornitore, Fleet Engine lo completa per impostazione predefinita con l'ultima posizione nota del veicolo (la posizione grezza).
task_outcome_location_source

TaskOutcomeLocationSource

Indica da dove proviene il valore di task_outcome_location.
tracking_id

string

Immutabile. Questo campo facilita l'archiviazione di un ID per evitare di utilizzare una mappatura complicata. Non puoi impostare tracking_id per attività di tipo UNAVAILABLE e SCHEDULED_STOP. Questi ID sono soggetti alle seguenti limitazioni:

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

string

Solo output. L'ID del veicolo su cui è in corso questa attività. Gli ID veicolo per la consegna sono soggetti alle seguenti limitazioni:

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

LocationInfo

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

Duration

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

TimeWindow

La finestra temporale durante la quale deve essere completata l'attività.
journey_sharing_info

JourneySharingInfo

Solo output. Campi specifici della 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 di dati sono visibili agli utenti finali e in quali circostanze.
attributes[]

TaskAttribute

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

JourneySharingInfo

Condivisione di campi specifici nel percorso.

Campi
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Informazioni di monitoraggio relative alle fermate che il veicolo assegnato farà prima che completi questa attività. Tieni presente che questo elenco può contenere fermate da 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 VehicleStop successivo. Le informazioni sul percorso corrente in genere 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) vengono compilati da Fleet Engine. Forniscono informazioni sul percorso tra i restanti VehicleStops.
last_location

DeliveryVehicleLocation

Indica l'ultima posizione segnalata del veicolo.
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 dai client vengono ignorati.

Stato

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

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

TaskOutcome

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

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

TaskOutcomeLocationSource

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

Enum
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Il risultato dell'attività prima che sia 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. I ritiri dei veicoli con feeder o deposito devono essere di tipo SCHEDULED_STOP.
DELIVERY Un'attività di consegna è l'azione intrapresa per consegnare una spedizione a un cliente finale. Le riduzioni dei veicoli per il deposito o la stazione di carico devono essere di tipo SCHEDULED_STOP.
SCHEDULED_STOP Un'attività con interruzione pianificata viene utilizzata a scopo di pianificazione. Ad esempio, potrebbe rappresentare il ritiro o la consegna delle spedizioni dai veicoli con feeder o dai depositi. Non deve essere utilizzato per qualsiasi spedizione ritirata o consegnata da un cliente finale.
UNAVAILABLE Un'attività che indica che il veicolo non è disponibile per il servizio. Ciò può accadere, ad esempio, quando il conducente fa una pausa o quando il veicolo viene rifornito.

TaskAttribute

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

Campi
key

string

La chiave dell'attributo. Le chiavi non possono contenere i due punti (:).
Campo di unione task_attribute_value. Il valore dell'attributo può essere di tipo stringa, bool o doppio. Se non viene impostato nessuno, 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 di tipo stringa.
bool_value

bool

Valore dell'attributo con tipo booleano.
number_value

double

Valore dell'attributo con doppio tipo.

TaskTrackingInfo

Il messaggio TaskTrackingInfo. Il messaggio contiene informazioni sul monitoraggio delle attività che verranno utilizzate per la visualizzazione. Se un ID monitoraggio è associato a più Tasks, 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. * Limitato a una lunghezza massima di 64 caratteri. * Normalizzata 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 dal veicolo verso il luogo in cui si svolge l'attività.
remaining_stop_count

Int32Value

Indica il numero di fermate rimanenti del veicolo fino al raggiungimento dell'arresto attività, incluso l'arresto 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

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

State

Lo stato di esecuzione attuale dell'attività.
task_outcome

TaskOutcome

L'esito 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. La posizione in cui verrà completata l'attività.
target_time_window

TimeWindow

La finestra temporale durante la quale deve essere completata l'attività.
attributes[]

TaskAttribute

Gli attributi personalizzati impostati nell'attività.

TaskTrackingViewConfig

Il messaggio di configurazione che definisce quando un elemento di 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 del percorso. Se questo campo non viene specificato, verrà utilizzata la configurazione della 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 prevista. Se questo campo non viene specificato, verrà utilizzata la configurazione della 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 di completamento stimato dell'attività. Se questo campo non viene specificato, verrà utilizzata la configurazione della visibilità predefinita a livello di progetto per questi dati.
remaining_driving_distance_visibility

VisibilityOption

Il campo che specifica la distanza percorsa rimanente in auto può essere visibile. Se questo campo non viene specificato, verrà utilizzata la configurazione della visibilità predefinita a livello di progetto per questi dati.
remaining_stop_count_visibility

VisibilityOption

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

VisibilityOption

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

VisibilityOption

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

Campi
Campo di unione visibility_option. È stata scelta l'opzione di visibilità specifica. 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 fermate rimanenti è <= left_stop_count_threshold.
duration_until_estimated_arrival_time_threshold

Duration

Questo elemento di dati è visibile agli utenti finali se l'orario di arrivo stimato fino alla fermata è <= lifetime_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 viene impostato su true, questo elemento di dati è sempre visibile agli utenti finali senza soglie. Questo campo non può essere impostato su false.
never

bool

Se viene impostato su true, questo elemento di 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

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

Timestamp

Obbligatoria. L'ora di fine della finestra temporale (inclusa).

UpdateDeliveryVehicleRequest

Il messaggio di richiesta UpdateDeliveryVehicle.

Campi
header

DeliveryRequestHeader

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard.
delivery_vehicle

DeliveryVehicle

Obbligatoria. Aggiornamento dell'entità DeliveryVehicle da applicare. Nota: non puoi aggiornare il nome di DeliveryVehicle.
update_mask

FieldMask

Obbligatoria. Una maschera dei campi che indica quali DeliveryVehicle campi aggiornare. Tieni presente che update_mask deve contenere almeno un campo.

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

UpdateTaskRequest

Il messaggio di richiesta UpdateTask.

Campi
header

DeliveryRequestHeader

Campo facoltativo. L'intestazione della richiesta dell'API Delivery standard.
task

Task

Obbligatoria. L'attività associata all'aggiornamento. I seguenti campi sono gestiti da Fleet Engine. Non aggiornarle usando Task.update.

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

Nota: non puoi modificare il valore di task_outcome dopo averlo impostato.

Se l'attività è stata assegnata a un veicolo per le consegne, non impostarne lo stato su CHIUSA utilizzando Task.update. Rimuovi invece dal veicolo per la consegna il VehicleStop che contiene l'attività. In questo modo lo stato dell'attività viene impostato automaticamente su CHIUSA.
update_mask

FieldMask

Obbligatoria. La maschera dei campi che indica quali campi Attività aggiornare. Nota: update_mask deve contenere almeno un campo.

Si tratta di un elenco separato da virgole di nomi completi dei campi. 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 tratta dalla posizione attuale del veicolo a questa fermata.

Campi
stop

VehicleStop

Specifica la posizione della fermata, insieme ai Task associati alla fermata. Alcuni campi di VehicleStop potrebbero non essere presenti se questo tratto di viaggio 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 segmenti del viaggio, il punto di partenza è la posizione del veicolo registrata al momento in cui la fermata è stata aggiunta all'elenco. Questo campo potrebbe non essere presente se questo tratto del percorso fa parte di JourneySharingInfo.
driving_duration

Duration

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

Se questo campo viene definito nel percorso Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) o Task.remainingVehicleJourneySegments[0].drivingDuration (REST), è possibile inserire il valore di DeliveryVehicle.remaining_duration (gRPC) o DeliveryVehicle.remainingDuration (REST). Fornisce la durata di guida rimanente dall'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 corrente è la prima fermata nell'elenco dei segmenti del viaggio, questo è il percorso dalla posizione corrente del veicolo a questa fermata nel momento in cui la fermata è stata aggiunta all'elenco. Questo campo potrebbe non essere presente se questo tratto del percorso fa parte di JourneySharingInfo.

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

VehicleStop

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

Campi
planned_location

LocationInfo

Obbligatoria. La posizione della fermata. Tieni presente che le località negli Task potrebbero non corrispondere esattamente a questa località, ma saranno a breve distanza dalla località. Questo campo non verrà compilato nella risposta di una chiamata GetTask o SearchTasks.
tasks[]

TaskInfo

Elenco di Task da eseguire in questa fermata. Questo campo non verrà compilato nella risposta a una chiamata GetTask o SearchTasks.
state

State

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

Stato

Lo stato attuale di un oggetto VehicleStop.

Enum
STATE_UNSPECIFIED Sconosciuto.
NEW L'elemento è stato creato, ma il routing non è attivo.
ENROUTE Assegnati e routing attivo.
ARRIVED Arrivato alla fermata. Presuppone che, quando il veicolo sta passando alla fermata successiva, che tutte le fermate precedenti siano state completate.

TaskInfo

Informazioni aggiuntive sull'attività eseguita in questa fermata.

Campi
task_id

string

L'ID attività. Questo campo non verrà compilato nella risposta di una chiamata GetTask o SearchTasks. Gli ID attività sono soggetti alle seguenti limitazioni:

  • Deve essere una stringa Unicode valida.
  • Lunghezza massima: 64 caratteri.
  • Normalizzata secondo lo standard 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. La finestra temporale durante la quale deve essere completata l'attività. Questo valore è impostato solo nella risposta a GetDeliveryVehicle.