Package maps.fleetengine.delivery.v1

Indice

DeliveryService

Servizio di consegna dell'ultimo miglio.

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

rpc DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest) returns (Empty)

Elimina un DeliveryVehicle da Fleet Engine.

Restituisce FAILED_PRECONDITION se a DeliveryVehicle sono assegnate attività APERTE.
DeleteTask

rpc DeleteTask(DeleteTaskRequest) returns (Empty)

Elimina una singola attività.

Restituisce FAILED_PRECONDITION se l'attività è OPEN e assegnata a un DeliveryVehicle.
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 DeliveryVehicle che soddisfano i criteri di filtro specificati.
ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

Recupera tutti i Task che soddisfano i criteri di filtro specificati.
UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Scrive i dati DeliveryVehicle aggiornati in 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. I task_id vengono recuperati da remaining_vehicle_journey_segments e i relativi Tasks 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 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 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 progetto Google Cloud. Ad esempio: sample-cloud-project. Il campo principale nei messaggi CreateTaskRequest deve essere vuoto o 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à in un batch.

BatchCreateTasksResponse

Il messaggio di risposta 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 fornitore deve essere l'ID progetto Google Cloud. Ad esempio, sample-cloud-project.
delivery_vehicle_id

string

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

  • Deve essere una stringa Unicode valida.
  • Limitato a una lunghezza massima di 64 caratteri.
  • Normalizzato in base al modulo di normalizzazione Unicode C.
  • Non può contenere i seguenti caratteri ASCII: '/', ':', '?', ',' o '#'.
delivery_vehicle

DeliveryVehicle

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

  • tipo
  • last_location
  • attributi

Nota: il campo name di DeliveryVehicle viene ignorato. Tutti gli altri campi DeliveryVehicle 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 progetto Google Cloud. Ad esempio: sample-cloud-project.
task_id

string

Obbligatorio. L'ID attività deve essere univoco, ma non deve essere un ID di monitoraggio della spedizione. Per memorizzare un ID monitoraggio 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.
  • Limitato a una lunghezza massima di 64 caratteri.
  • Normalizzato in base al modulo di normalizzazione Unicode C.
  • Non può contenere i seguenti caratteri ASCII: '/', ':', '?', ',' o '#'.
task

Task

Obbligatorio. L'entità Attività 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 le attività UNAVAILABLE)
  • task_duration

È possibile impostare facoltativamente i seguenti campi:

  • target_time_window
  • task_tracking_view_config
  • attributes

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

DeleteDeliveryVehicleRequest

Messaggio di richiesta DeleteDeliveryVehicle.

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 progetto Google Cloud. Ad esempio: sample-cloud-project.

DeleteTaskRequest

Messaggio di richiesta DeleteTask.

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 progetto Google Cloud. Ad esempio: sample-cloud-project.

DeliveryRequestHeader

Un RequestHeader contiene campi comuni a tutte le richieste RPC di Delivery.

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 ne viene specificata nessuna, la risposta può essere in qualsiasi lingua, con una preferenza per l'inglese se esiste un nome. Esempio di valore del campo: en-US.
region_code

string

Obbligatorio. Codice regione CLDR della regione da 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

La versione del sistema operativo su cui è in esecuzione l'SDK di chiamata. Esempi di valori dei campi: 4.4.1, 12.1.
device_model

string

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

SdkType

Il tipo di SDK che invia la richiesta.
maps_sdk_version

string

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

string

Versione dell'SDK di navigazione da cui dipende l'SDK chiamante, se applicabile. Il formato della versione è "major.minor.patch", ad esempio 2.1.0.
platform

Platform

Piattaforma dell'SDK chiamante.
manufacturer

string

Produttore del dispositivo Android dall'SDK chiamante, applicabile solo agli SDK Android. Esempio di valore del campo: Samsung.
android_api_level

int32

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

string

ID facoltativo che può essere fornito a scopo di registrazione per identificare la richiesta.

Piattaforma

La piattaforma dell'SDK chiamante.

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 di chiamata è Consumer.
DRIVER L'SDK chiamante è Driver.
JAVASCRIPT L'SDK chiamante è JavaScript.

DeliveryVehicle

Il messaggio DeliveryVehicle. Un veicolo di consegna trasporta le spedizioni da un deposito a un luogo di consegna e da un luogo di ritiro al deposito. In alcuni casi, i veicoli di consegna trasportano 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 di consegna. Il formato è providers/{provider}/deliveryVehicles/{vehicle}.
last_location

DeliveryVehicleLocation

L'ultima posizione segnalata del veicolo di consegna.
past_locations[]

DeliveryVehicleLocation

Solo input. Posizioni in cui si trovava questo veicolo di consegna in passato e che non sono ancora state segnalate a Fleet Engine. Questo valore viene utilizzato in UpdateDeliveryVehicleRequest per registrare le posizioni che in precedenza non era possibile inviare al server. In genere, questo accade quando il veicolo di consegna non ha connettività a internet.
navigation_status

DeliveryVehicleNavigationStatus

Lo stato di navigazione del veicolo di consegna.
current_route_segment

bytes

La polilinea codificata che specifica il percorso che la navigazione consiglia di seguire fino al waypoint successivo. L'app per i conducenti aggiorna questo valore quando viene raggiunto o superato un punto di sosta e quando la navigazione viene ricalcolata. 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.

Esistono alcuni casi in cui 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 per i conducenti non ha aggiornato di recente la sua posizione, quindi l'ultimo valore aggiornato per questo campo potrebbe essere obsoleto.

  • L'app autista ha aggiornato di recente la sua posizione, ma il current_route_segment è obsoleto e indica una fermata precedente del veicolo.

In questi casi, Fleet Engine compila questo campo con un percorso dalla fermata del veicolo superata più di recente alla fermata del veicolo successiva per garantire che il consumatore di questo campo disponga delle migliori informazioni disponibili sul percorso attuale del veicolo di consegna.
current_route_segment_end_point

LatLng

La posizione in cui termina current_route_segment. Al momento non viene compilato dall'app per i conducenti, ma puoi fornirlo durante le chiamate al numero UpdateDeliveryVehicle. Si tratta del LatLng della fermata del veicolo successiva o degli ultimi LatLng del current_route_segment. Fleet Engine farà del suo meglio per interpolare un VehicleStop effettivo.

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

Int32Value

La distanza rimanente da percorrere per current_route_segment. In genere, questo campo viene fornito dall'app Driver, ma in alcune circostanze Fleet Engine sostituirà il valore inviato dall'app. Per saperne di più, consulta 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 current_route_segment. In genere, questo campo viene fornito dall'app Driver, ma in alcune circostanze Fleet Engine sostituirà il valore inviato dall'app. Per saperne di più, consulta 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 del viaggio assegnati a questo veicolo di consegna, a partire dalla posizione più recente segnalata del veicolo. Questo campo non verrà compilato nella risposta di ListDeliveryVehicles.
attributes[]

DeliveryVehicleAttribute

Un elenco di attributi personalizzati del veicolo di consegna. Un veicolo di consegna può avere al massimo 100 attributi e ciascun attributo deve avere una chiave univoca.
type

DeliveryVehicleType

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

DeliveryVehicleType

Il tipo di veicolo di consegna.

Enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Il valore non viene utilizzato.
AUTO Un'automobile.
TWO_WHEELER Una motocicletta, un ciclomotore o un altro veicolo a due ruote
BICYCLE Trasporto a propulsione umana.
PEDESTRIAN Un trasportatore umano, in genere a piedi o di corsa, che si sposta lungo i percorsi pedonali.

DeliveryVehicleAttribute

Descrive un attributo del veicolo come coppia chiave-valore. La lunghezza della stringa "chiave:valore" 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, booleano o double. delivery_vehicle_attribute_value può essere solo uno dei seguenti:
string_value

string

Valore dell'attributo di tipo stringa.

Nota: questo campo è identico al campo value, che verrà ritirato. Per i metodi di creazione o aggiornamento, è possibile utilizzare uno dei due campi, ma è vivamente consigliato di utilizzare string_value. Se sono impostati sia string_value sia value, devono essere identici, altrimenti verrà generato un errore. Entrambi i campi vengono compilati nelle risposte.
bool_value

bool

Valore dell'attributo di tipo booleano.
number_value

double

Valore dell'attributo di tipo double.

DeliveryVehicleLocation

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

Campi
location

LatLng

La posizione del veicolo. Quando viene inviata a Fleet Engine, la posizione del veicolo è una posizione GPS. Quando lo 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: utilizza latlng_accuracy.
latlng_accuracy

DoubleValue

Precisione di location metri come raggio.
heading

Int32Value

Direzione di movimento 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 gradi.
altitude

DoubleValue

Altitudine in metri sopra il WGS84.
vertical_accuracy
(deprecated)

DoubleValue

Deprecato: utilizza altitude_accuracy.
altitude_accuracy

DoubleValue

Precisione di altitude metri.
speed_kmph
(deprecated)

Int32Value

Velocità del veicolo in chilometri all'ora. 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 dei 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) trascorso da quando questa posizione è stata inviata per la prima volta al server. Questo valore sarà zero per il primo aggiornamento. Se l'ora non è nota (ad esempio, quando l'app viene riavviata), questo valore viene reimpostato su zero.
num_stale_updates
(deprecated)

Int32Value

Solo input. Obsoleto: ora vengono utilizzati altri indicatori per determinare se una posizione è obsoleta.
raw_location

LatLng

Posizione grezza del veicolo (non elaborata da road-snapper).
raw_location_time

Timestamp

Timestamp associato alla posizione non elaborata.
raw_location_sensor

DeliveryVehicleLocationSensor

Origine della posizione non elaborata. Il valore predefinito è GPS.
raw_location_accuracy

DoubleValue

Precisione di raw_location come raggio, in metri.
flp_location

LatLng

La posizione fornita da Fused Location Provider di Android.
flp_update_time

Timestamp

Aggiorna il timestamp di flp_location
flp_latlng_accuracy_meters

DoubleValue

Precisione di flp_location metri come raggio.
flp_heading_degrees

Int32Value

Direzione di movimento del veicolo in gradi, determinata dal Fused Location Provider. 0 rappresenta il nord. L'intervallo valido è [0,360).
supplemental_location

LatLng

Posizione supplementare fornita dall'app di integrazione.
supplemental_location_time

Timestamp

Timestamp associato alla posizione supplementare.
supplemental_location_sensor

DeliveryVehicleLocationSensor

Origine della posizione 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 della torre cellulare o punto di accesso Wi-Fi.
PASSIVE ID torre cellulare o punto di accesso Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Una posizione determinata dal dispositivo mobile come la posizione stradale più probabile.
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 che esegue Driver SDK. Se l'origine originale è descritta da uno degli altri valori enum, utilizza quel valore. Le posizioni contrassegnate con CUSTOMER_SUPPLIED_LOCATION vengono in genere fornite tramite last_location.supplemental_location_sensor di DeliveryVehicle.
FLEET_ENGINE_LOCATION Una posizione calcolata da Fleet Engine in base ai segnali a sua disposizione. Solo output. Questo valore verrà rifiutato se ricevuto in una richiesta.
FUSED_LOCATION_PROVIDER Fused Location Provider di Android.
CORE_LOCATION Il fornitore di servizi di localizzazione 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 dell'app Driver è entrata in modalità GUIDED_NAV.
OFF_ROUTE Il veicolo si è allontanato dal percorso suggerito.
ARRIVED_AT_DESTINATION Il veicolo si trova a circa 50 metri 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 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 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 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 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. 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 ListDeliveryVehicles. Devi fornire questo valore per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a ListDeliveryVehicles devono corrispondere alla chiamata che ha fornito il token di pagina.
filter

string

(Facoltativo) Una query di filtro da applicare quando vengono elencati i veicoli di consegna. Consulta la pagina http://aip.dev/160 per esempi della sintassi del filtro. Se non specifichi un valore o se specifichi una stringa vuota per il filtro, vengono restituiti tutti i veicoli di 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, quindi gli unici confronti supportati con gli attributi sono i confronti tra stringhe. Per eseguire il confronto con valori numerici o booleani, i valori devono essere 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 limitazione fa parte della query del modulo attribute.<KEY> <COMPARATOR> <VALUE>, ad esempio attributes.foo = bar è una limitazione.
viewport

Viewport

(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 consegna che soddisfano i criteri di filtro richiesti. Se non viene specificato alcun filtro, la richiesta restituisce tutti i veicoli di consegna. Una risposta riuscita può anche essere vuota. Una risposta vuota indica che non sono stati trovati veicoli di 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 di 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 progetto Google Cloud. Ad esempio: sample-cloud-project.
page_size

int32

(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

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

Durante la paginazione, tutti gli altri parametri forniti a ListTasks devono corrispondere alla chiamata che ha fornito il token di pagina.
filter

string

(Facoltativo) Una query di filtro da applicare quando vengono elencate le attività. Consulta la pagina 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à su cui puoi filtrare, consulta Elenca attività.

ListTasksResponse

La risposta ListTasks che contiene l'insieme 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 riuscita 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 in ListTasksRequest per continuare a elencare i risultati. Se sono stati restituiti tutti i risultati, questo campo è una stringa vuota o 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 posizione con eventuali identificatori aggiuntivi.

Campi
point

LatLng

Le coordinate della posizione. È necessario specificare point o place come input. Se vengono specificati entrambi, point verrà utilizzato per il routing e place per i metadati. Se viene specificato solo place come input, point verrà calcolato a partire da place e incluso nell'output.
place

string

Il nome della risorsa del luogo che rappresenta questa posizione. Il formato è places/{place_id}. È necessario specificare point o place come input. Se vengono specificati entrambi, point verrà utilizzato per il routing e place per i metadati. place è incluso nell'output solo se era incluso nell'input, il che significa che non viene eseguita alcuna ricerca di place da LatLng.

Questa è una funzione sperimentale.
point_location_source

PointSource

Solo output. L'origine del campo latlng point. Questa funzionalità fa parte di una funzionalità sperimentale.

PointSource

Indica l'origine di un LatLng.

Enum
POINT_SOURCE_UNSPECIFIED Origine puntuale non specificata.
POINT_SOURCE_DEVELOPER_PROVIDED LatLng è stato fornito esplicitamente dallo sviluppatore.
POINT_SOURCE_CALCULATED_FROM_PLACE Il LatLng è stato calcolato a partire dal luogo fornito.

Attività

Un'attività nell'API Delivery rappresenta una singola azione da monitorare. In generale, esiste una distinzione tra le attività correlate alla spedizione e le attività di pausa. A una spedizione possono essere associati più compiti. Ad esempio, potrebbe esserci un'attività per il ritiro e una per la consegna o il trasferimento. Inoltre, diverse attività per una determinata spedizione possono essere gestite da veicoli diversi. Ad esempio, un veicolo potrebbe occuparsi del ritiro e del trasporto della spedizione all'hub, mentre un altro veicolo potrebbe trasportare la stessa spedizione dall'hub alla sede 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 pausa 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 fornitore.
task_outcome_location

LocationInfo

La posizione 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 compila per impostazione predefinita con l'ultima posizione nota del veicolo (la posizione raw).
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 in modo da evitare di utilizzare una mappatura complessa. Non puoi impostare tracking_id per le attività di tipo UNAVAILABLE e SCHEDULED_STOP. Questi ID sono soggetti alle seguenti limitazioni:

  • Deve essere una stringa Unicode valida.
  • Limitato a una lunghezza massima di 64 caratteri.
  • Normalizzato in base al modulo di normalizzazione Unicode C.
  • Non può contenere i seguenti caratteri ASCII: '/', ':', '?', ',' o '#'.
delivery_vehicle_id

string

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

  • Deve essere una stringa Unicode valida.
  • Limitato a una lunghezza massima di 64 caratteri.
  • Normalizzato in base al modulo di normalizzazione Unicode C.
  • Non può contenere i seguenti caratteri ASCII: '/', ':', '?', ',' o '#'.
planned_location

LocationInfo

Immutabile. La località 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

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

JourneySharingInfo

Solo output. Campi specifici per la condivisione del viaggio. 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 dell'attività. Ogni attributo deve avere una chiave univoca.

JourneySharingInfo

Campi specifici della condivisione del viaggio.

Campi
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Informazioni di monitoraggio per le fermate che il veicolo assegnato effettuerà prima di completare questa attività. Tieni presente che questo elenco può contenere tappe di altre attività.

Il primo segmento, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), contiene le informazioni sul percorso dall'ultima posizione nota del conducente al prossimo VehicleStop. Le informazioni sull'itinerario attuale provengono in genere dall'app per i conducenti, ad eccezione di alcuni casi indicati nella documentazione per 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 VehicleStops rimanenti.
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 dell'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 di consegna oppure il veicolo di consegna non ha ancora superato la fermata assegnata al veicolo di Task.
CLOSED Quando il veicolo supera la fermata per questa attività.

TaskOutcome

Il risultato del tentativo di esecuzione di un'attività. Quando TaskState è chiuso, TaskOutcome indica se è stato completato correttamente.

Enum
TASK_OUTCOME_UNSPECIFIED Il risultato dell'attività prima che venga impostato il suo valore.
SUCCEEDED L'attività è stata completata correttamente.
FAILED L'attività non è stata completata o è 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 venga impostato.
PROVIDER Il fornitore ha specificato task_outcome_location.
LAST_VEHICLE_LOCATION Il fornitore 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 Per impostazione predefinita, il tipo di attività è sconosciuto.
PICKUP Un'attività di ritiro è l'azione intrapresa per ritirare una spedizione da un cliente. I ritiri presso il deposito o con veicolo di alimentazione devono utilizzare il tipo SCHEDULED_STOP.
DELIVERY Un'attività di consegna è l'azione intrapresa per consegnare una spedizione a un cliente finale. I depositi o i veicoli di alimentazione devono utilizzare il tipo SCHEDULED_STOP.
SCHEDULED_STOP Un'attività di sosta programmata viene utilizzata a scopo di pianificazione. Ad esempio, potrebbe rappresentare il ritiro o la consegna di spedizioni da veicoli o depositi di alimentazione. Non deve essere utilizzato per le spedizioni ritirate o consegnate da un cliente finale.
UNAVAILABLE Un'attività che indica che il veicolo non è disponibile per l'assistenza. Ad esempio, questo può accadere quando l'autista fa una pausa o quando il veicolo viene rifornito.

TaskAttribute

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

Campi
key

string

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

double

Valore dell'attributo di tipo double.

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 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. * Limite massimo di 64 caratteri. * Normalizzato in base al modulo di normalizzazione Unicode C. * Non può contenere i seguenti caratteri ASCII: '/', ':', '?', ',' o '#'.
vehicle_location

DeliveryVehicleLocation

L'ultima posizione del veicolo.
route_polyline_points[]

LatLng

Un elenco di punti che, se collegati, formano una polilinea del percorso previsto del veicolo fino alla posizione di questa attività.
remaining_stop_count

Int32Value

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

Int32Value

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

Timestamp

Il timestamp che indica l'orario di arrivo stimato alla posizione della fermata.
estimated_task_completion_time

Timestamp

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

State

Lo stato di esecuzione attuale dell'attività.
task_outcome

TaskOutcome

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

Timestamp

Il timestamp che indica quando il fornitore ha impostato il risultato dell'attività.
planned_location

LocationInfo

Immutabile. La località in cui verrà completata l'attività.
target_time_window

TimeWindow

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

TaskAttribute

Il set di attributi personalizzati impostato 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 i punti della polilinea dell'itinerario possono essere visibili. 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 l'ora di arrivo stimata può essere visibile. 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 può essere visibile la distanza di guida rimanente. 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 può essere visibile il conteggio delle fermate rimanenti. 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 dell'opzione che definisce quando un elemento di 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 fermate rimanenti è <= remaining_stop_count_threshold.
duration_until_estimated_arrival_time_threshold

Duration

Questo elemento di dati è visibile agli utenti finali se l'ETA alla 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 è <= remaining_driving_distance_meters_threshold.
always

bool

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

Obbligatorio. L'ora di inizio dell'intervallo di tempo (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 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 di UpdateTask.

Campi
header

DeliveryRequestHeader

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

Task

Obbligatorio. L'attività associata all'aggiornamento. I seguenti campi vengono 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 di consegna, non impostare lo stato dell'attività su CHIUSA utilizzando Task.update. Rimuovi invece VehicleStop che contiene l'attività dal veicolo di consegna, in modo da impostare automaticamente lo stato dell'attività su CHIUSA.
update_mask

FieldMask

Obbligatorio. La maschera di campo che indica quali campi dell'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 attuale. Se è la prima fermata attiva, il percorso va 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 segmento del viaggio fa parte di JourneySharingInfo.
driving_distance_meters

Int32Value

Solo output. La distanza percorsa dalla fermata precedente a questa. Se la fermata attuale è la prima nell'elenco dei segmenti del viaggio, il punto di partenza è la posizione del veicolo registrata al momento dell'aggiunta di questa fermata all'elenco. Questo campo potrebbe non essere presente se questo segmento del percorso 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 nell'elenco dei segmenti del viaggio, il punto di partenza è la posizione del veicolo registrata al momento dell'aggiunta di questa fermata all'elenco.

Se questo campo è definito nel percorso Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) o Task.remainingVehicleJourneySegments[0].drivingDuration (REST), potrebbe essere compilato con il valore di DeliveryVehicle.remaining_duration (gRPC) o DeliveryVehicle.remainingDuration (REST). In questo modo viene fornita la durata di guida rimanente dall'ultima posizione nota dell'app per i conducenti anziché il tempo di guida dalla fermata precedente.
path[]

LatLng

Solo output. Il percorso dalla fermata precedente a questa. Se la fermata attuale è la prima nell'elenco dei segmenti del viaggio, questo è il percorso dalla posizione attuale del veicolo a questa fermata nel momento in cui è stata aggiunta all'elenco. Questo campo potrebbe non essere presente se questo segmento del percorso 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 da DeliveryVehicle.current_route_segment (gRPC) o DeliveryVehicle.currentRouteSegment (REST). In questo modo, il percorso viene calcolato dall'ultima posizione nota dell'app per i conducenti anziché dalla fermata precedente.

VehicleStop

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

Campi
planned_location

LocationInfo

Obbligatorio. La posizione della fermata. Tieni presente che le posizioni indicate nei Task potrebbero non corrispondere esattamente a questa posizione, ma si troveranno a breve distanza. Questo campo non verrà compilato nella risposta di una chiamata GetTask.
tasks[]

TaskInfo

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

State

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

Stato

Lo stato attuale di un VehicleStop.

Enum
STATE_UNSPECIFIED Sconosciuto.
NEW Creata, ma non instradata attivamente.
ENROUTE Assegnato e con routing attivo.
ARRIVED Arrivato alla fermata. Presuppone che, quando il veicolo si dirige 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 di una chiamata GetTask. Gli ID attività sono soggetti alle seguenti limitazioni:

  • Deve essere una stringa Unicode valida.
  • Limitato a una lunghezza massima di 64 caratteri.
  • Normalizzato in base al modulo di normalizzazione Unicode C.
  • Non può contenere i 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à. Questa proprietà viene impostata solo nella risposta a GetDeliveryVehicle.