REST Resource: providers.deliveryVehicles

Risorsa: 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 anche le spedizioni direttamente dal luogo di ritiro al luogo 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.

Rappresentazione JSON 
{
  "name": string,
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "navigationStatus": enum (DeliveryVehicleNavigationStatus),
  "currentRouteSegment": string,
  "currentRouteSegmentEndPoint": {
    object (LatLng)
  },
  "remainingDistanceMeters": integer,
  "remainingDuration": string,
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "attributes": [
    {
      object (DeliveryVehicleAttribute)
    }
  ],
  "type": enum (DeliveryVehicleType)
}
Campi
name

string

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

object (DeliveryVehicleLocation)

L'ultima posizione segnalata del veicolo di consegna.
navigationStatus

enum (DeliveryVehicleNavigationStatus)

Lo stato di navigazione del veicolo di consegna.
currentRouteSegment

string (bytes format)

La polilinea codificata che specifica il percorso consigliato dalla navigazione fino al waypoint successivo. L'app del conducente aggiorna questa informazione quando viene raggiunta o superata una fermata e quando la navigazione reindirizza. Questi LatLng vengono restituiti in Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) o Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) per tutte le attività attive assegnate al veicolo.

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

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

  • L'app del conducente non ha aggiornato la sua posizione di recente, pertanto il valore dell'ultimo aggiornamento di questo campo potrebbe non essere aggiornato.

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

In questi casi, Fleet Engine compila questo campo con un percorso dal capolinea del veicolo più recente a quello successivo per garantire che il consumatore di questo campo disponga delle migliori informazioni disponibili sul percorso attuale del veicolo di consegna.

Una stringa con codifica base64.
currentRouteSegmentEndPoint

object (LatLng)

Il luogo in cui termina l'evento currentRouteSegment. Al momento questo campo non viene compilato dall'app per i conducenti, ma puoi fornirlo durante le chiamate deliveryVehicles.patch. Si tratta della LatLng della fermata successiva del veicolo o dell'ultima LatLng del currentRouteSegment. Fleet Engine farà del suo meglio per eseguire l'interpolazione in base a un valore VehicleStop effettivo.

Questo campo viene ignorato nelle chiamate a deliveryVehicles.patch se il campo currentRouteSegment è vuoto.
remainingDistanceMeters

integer

La distanza in auto rimanente per currentRouteSegment. In genere, questo campo è fornito dall'app Driver, ma in alcune circostanze Fleet Engine sostituisce il valore inviato dall'app. Per ulteriori informazioni, 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 currentRouteSegment è vuoto.
remainingDuration

string (Duration format)

Il tempo di percorrenza rimanente per currentRouteSegment. In genere, questo campo è 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 currentRouteSegment è vuoto.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

I segmenti di viaggio assegnati a questo veicolo di consegna, a partire dalla posizione più recente registrata del veicolo. Questo campo non verrà compilato nella risposta di deliveryVehicles.list.
attributes[]

object (DeliveryVehicleAttribute)

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

enum (DeliveryVehicleType)

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

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 è passata alla modalità GUIDED_NAV.
OFF_ROUTE Il veicolo ha deviato dal percorso suggerito.
ARRIVED_AT_DESTINATION Il veicolo si trova a circa 50 m dalla destinazione.

DeliveryVehicleAttribute

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

Rappresentazione JSON 
{
  "key": string,
  "value": string,

  // Union field delivery_vehicle_attribute_value can be only one of the
  // following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field
  // delivery_vehicle_attribute_value.
}
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 doppio. delivery_vehicle_attribute_value può essere solo uno dei seguenti:
stringValue

string

Valore dell'attributo tipo di stringa.

Nota: questo campo è identico al campo value, che verrà ritirato in futuro. Per i metodi di creazione o aggiornamento, puoi utilizzare uno dei due campi, ma ti consigliamo vivamente di utilizzare stringValue. Se stringValue e value sono impostati, devono essere identici, altrimenti verrà visualizzato un errore. Entrambi i campi vengono compilati nelle risposte.
boolValue

boolean

Valore dell'attributo di tipo booleano.
numberValue

number

Valore dell'attributo con tipo doppio.

DeliveryVehicleType

Il tipo di veicolo per la consegna.

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

Metodi

create

 Crea e restituisce un nuovo DeliveryVehicle.

get

 Restituisce l'istanza DeliveryVehicle specificata.

list

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

patch

 Scrive i dati DeliveryVehicle aggiornati su Fleet Engine e assegna Tasks a DeliveryVehicle.