REST Resource: providers.deliveryVehicles

Risorsa: 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 la 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 per la consegna. Il formato è providers/{provider}/deliveryVehicles/{vehicle}.

lastLocation

object (DeliveryVehicleLocation)

L'ultima posizione segnalata del veicolo per la consegna.

navigationStatus

enum (DeliveryVehicleNavigationStatus)

Lo stato di navigazione del veicolo per la consegna.

currentRouteSegment

string (bytes format)

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

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

  • L'endpoint di 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, quindi l'ultimo valore aggiornato per questo campo potrebbe essere inattivo.

  • L'app del conducente ha aggiornato di recente la sua posizione, ma la currentRouteSegment è 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 in questo campo abbia le migliori informazioni disponibili sul percorso corrente del veicolo per la consegna.

Una stringa con codifica Base64.

currentRouteSegmentEndPoint

object (LatLng)

La località in cui termina currentRouteSegment. Al momento non è compilato dall'app del conducente, ma puoi fornirlo nelle chiamate deliveryVehicles.patch. È l'orario LatLng della prossima fermata del veicolo oppure l'ultimo LatLng di currentRouteSegment. Fleet Engine farà del suo meglio per interpolare in un VehicleStop effettivo.

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

remainingDistanceMeters

integer

La distanza percorsa rimanente per il currentRouteSegment. In genere l'app Driver fornisce questo campo, ma in alcuni casi Fleet Engine sovrascriverà 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 currentRouteSegment è vuoto.

remainingDuration

string (Duration format)

Il tempo di guida rimanente per il currentRouteSegment. In genere l'app Driver fornisce questo campo, ma in alcuni casi Fleet Engine sovrascriverà 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 per la 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 per le consegne, a partire dalla posizione del veicolo segnalata più di recente. Questo campo non verrà compilato nella risposta di deliveryVehicles.list.

attributes[]

object (DeliveryVehicleAttribute)

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

type

enum (DeliveryVehicleType)

Il tipo di questo veicolo per la consegna. Se non viene configurato, il valore predefinito sarà 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 È disponibile la navigazione passo passo e la navigazione nell'app Driver è attivata in modalità GUIDED_NAV.
OFF_ROUTE Il veicolo ha deviato il percorso suggerito.
ARRIVED_AT_DESTINATION Il veicolo si trova a circa 50 metri dalla destinazione.

DeliveryVehicleAttribute

Descrive un attributo di un veicolo come coppia chiave-valore. La lunghezza della stringa "key:value" 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 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:
stringValue

string

Valore dell'attributo di tipo stringa.

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

boolValue

boolean

Valore dell'attributo di tipo booleano.

numberValue

number

Valore dell'attributo di tipo doppio.

DeliveryVehicleType

Il tipo di veicolo per la consegna.

Enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Il valore non è utilizzato.
AUTO Un'automobile.
TWO_WHEELER Un motociclo, un ciclomotore o un altro veicolo a due ruote.
BICYCLE Trasporto alimentato da esseri umani.
PEDESTRIAN Un veicolo di trasporto umano, in genere a piedi o di corsa, che si sposta lungo sentieri pedonali.

Metodi

create

Crea e restituisce un nuovo DeliveryVehicle.

get

Restituisce l'istanza DeliveryVehicle specificata.

list

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

patch

Scrive dati aggiornati di DeliveryVehicle in Fleet Engine e assegna Tasks a DeliveryVehicle.