REST Resource: providers.vehicles

Risorsa: veicolo

Metadati del veicolo.

Rappresentazione JSON
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    object (VehicleLocation)
  },
  "maximumCapacity": integer,
  "attributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "vehicleType": {
    object (VehicleType)
  },
  "licensePlate": {
    object (LicensePlate)
  },
  "route": [
    {
      object (TerminalLocation)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentTraffic": {
    object (TrafficPolylineData)
  },
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeSeconds": integer,
  "waypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "waypointsVersion": string,
  "backToBackEnabled": boolean,
  "navigationStatus": enum (NavigationStatus),
  "deviceSettings": {
    object (DeviceSettings)
  }
}
Campi
name

string

Solo output. Il nome univoco di questo veicolo. Il formato è providers/{provider}/vehicles/{vehicle}.

vehicleState

enum (VehicleState)

Lo stato del veicolo.

supportedTripTypes[]

enum (TripType)

Tipi di corsa supportati da questo veicolo.

currentTrips[]

string

Solo output. Elenco di tripId per le corse attualmente assegnate a questo veicolo.

lastLocation

object (VehicleLocation)

Ultima posizione segnalata del veicolo.

maximumCapacity

integer

Il numero totale di passeggeri che questo veicolo può trasportare. Il conducente non è considerato in questo valore. Questo valore deve essere maggiore o uguale a uno.

attributes[]

object (VehicleAttribute)

Elenco di attributi dei veicoli. Un veicolo può avere al massimo 100 attributi e ogni attributo deve avere una chiave univoca.

vehicleType

object (VehicleType)

Obbligatorio. Il tipo di veicolo. Può essere utilizzato per filtrare i veicoli nei risultati di vehicles.search. Influisce anche sui calcoli dell'orario di arrivo stimato e dei percorsi.

licensePlate

object (LicensePlate)

Informazioni sulla targa del veicolo.

route[]
(deprecated)

object (TerminalLocation)

Obsoleto: utilizza Vehicle.waypoints.

currentRouteSegment

string

La polilinea che specifica il percorso che l'app del conducente intende percorrere per il tappa successivo. Questo elenco viene restituito anche in Trip.current_route_segment per tutte le corse attive assegnate al veicolo.

Nota: questo campo è destinato esclusivamente all'utilizzo da parte dell'SDK Driver. La decodifica non è ancora supportata.

currentRouteSegmentTraffic

object (TrafficPolylineData)

Solo input. Fleet Engine utilizza queste informazioni per migliorare la condivisione del percorso. Nota: questo campo è destinato esclusivamente all'utilizzo da parte dell'SDK Driver.

currentRouteSegmentVersion

string (Timestamp format)

Solo output. Ora in cui è stato impostato currentRouteSegment. Può essere archiviato dal client e trasmesso nelle future richieste vehicles.get per evitare route di ritorno che non sono cambiate.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

currentRouteSegmentEndPoint

object (TripWaypoint)

Il tappa in cui termina currentRouteSegment. Questo può essere fornito dai conducenti nelle chiamate vehicles.update come tappa completa del viaggio, come tappa LatLng o come ultimo LatLng del currentRouteSegment. Fleet Engine farà del suo meglio per eseguire l'interpolazione su un Waypoint effettivo se non è completamente specificato. Questo campo viene ignorato nelle chiamate vehicles.update, a meno che non venga specificato anche currentRouteSegment.

remainingDistanceMeters

integer

La distanza percorsa rimanente per il currentRouteSegment. Questo valore viene restituito anche in Trip.remaining_distance_meters per tutte le corse attive assegnate al veicolo. Il valore non viene specificato se il campo currentRouteSegment è vuoto.

etaToFirstWaypoint

string (Timestamp format)

L'orario di arrivo stimato per la prima voce nel campo waypoints. Il valore non viene specificato se il campo waypoints è vuoto o il campo Vehicle.current_route_segment è vuoto.

Quando aggiorni un veicolo, remainingTimeSeconds ha la precedenza su etaToFirstWaypoint nella stessa richiesta.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

remainingTimeSeconds

integer

Solo input. Il tempo di guida rimanente per il currentRouteSegment. Il valore non viene specificato se il campo waypoints è vuoto o il campo Vehicle.current_route_segment è vuoto. Questo valore deve corrispondere a etaToFirstWaypoint - current_time se tutte le parti utilizzano lo stesso orologio.

Quando aggiorni un veicolo, remainingTimeSeconds ha la precedenza su etaToFirstWaypoint nella stessa richiesta.

waypoints[]

object (TripWaypoint)

I restanti Waypoint assegnati a questo Veicolo.

waypointsVersion

string (Timestamp format)

Solo output. L'ultima volta che il campo waypoints è stato aggiornato. I client devono memorizzare nella cache questo valore e passarlo in GetVehicleRequest per garantire che il campo waypoints venga restituito solo se viene aggiornato.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

backToBackEnabled

boolean

Indica se il conducente accetta corse consecutive. Se true, vehicles.search potrebbe includere il veicolo anche se è attualmente assegnato a una corsa. Il valore predefinito è false.

navigationStatus

enum (NavigationStatus)

Lo stato di navigazione del veicolo.

deviceSettings

object (DeviceSettings)

Solo input. Informazioni sulle impostazioni del dispositivo mobile utilizzato dal conducente.

VehicleState

Lo stato di un elemento Vehicle.

Enum
UNKNOWN_VEHICLE_STATE Predefinita, utilizzata per gli stati dei veicoli non specificati o non riconosciuti.
OFFLINE Il veicolo non accetta nuove corse. Nota: il veicolo potrebbe continuare a funzionare in questo stato durante il completamento di una corsa assegnata.
ONLINE Il veicolo accetta nuove corse.

VehicleAttribute

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 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 vehicle_attribute_value.
}
Campi
key

string

La chiave dell'attributo. Le chiavi non possono contenere i due punti (:).

value

string

Il valore dell'attributo.

Campo di unione vehicle_attribute_value. Il valore dell'attributo può essere di tipo stringa, bool o doppio. 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.

VehicleType

Il tipo di veicolo.

Rappresentazione JSON
{
  "category": enum (Category)
}
Campi
category

enum (Category)

Categoria del tipo di veicolo

Categoria

Categorie dei tipi di veicoli

Enum
UNKNOWN Predefinita, utilizzata per categorie di veicoli non specificate o non riconosciute.
AUTO Un'automobile.
TAXI Qualsiasi veicolo che agisce come taxi (solitamente con licenza o regolamentata).
TRUCK In genere, si tratta di un veicolo con un ampio spazio di archiviazione.
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.

LicensePlate

Le informazioni sulla targa del veicolo. Per evitare di memorizzare informazioni che consentono l'identificazione personale, per l'entità vengono conservate solo le informazioni minime sulla targa.

Rappresentazione JSON
{
  "countryCode": string,
  "lastCharacter": string
}
Campi
countryCode

string

Obbligatorio. Codice paese/regione CLDR. Ad esempio, US per gli Stati Uniti o IN per l'India.

lastCharacter

string

L'ultima cifra della targa o "-1" per indicare che non è presente alcun valore numerico.

  • "ABC 1234" -> "4"
  • "AB 123 CD" -> "3"
  • "ABCDEF" -> "-1"

TrafficPolylineData

Condizioni del traffico lungo il percorso previsto per il veicolo.

Rappresentazione JSON
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
Campi
trafficRendering

object (VisualTrafficReportPolylineRendering)

Una polilinea di rendering della velocità del traffico per tutte le regioni lungo un tratto del percorso di un cliente.

VisualTrafficReportPolylineRendering

Descrive come i clienti dovrebbero colorare una porzione della polilinea lungo il percorso.

Rappresentazione JSON
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
Campi
roadStretch[]

object (RoadStretch)

Campo facoltativo. Tratti stradali che devono essere realizzati lungo la polilinea. È garantito che gli stretching non si sovrappongano e non coprano necessariamente l'intero percorso.

In assenza di un tratto stradale conforme allo stile, il cliente deve applicare il valore predefinito per il percorso.

RoadStretch

Un tratto stradale che deve essere sottoposto a rendering.

Rappresentazione JSON
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
Campi
style

enum (Style)

Obbligatorio. Lo stile da applicare.

offsetMeters

integer

Obbligatorio. Lo stile deve essere applicato tra [offsetMeters, offsetMeters + lengthMeters).

lengthMeters

integer

Obbligatorio. La lunghezza del percorso a cui applicare lo stile.

Stile

Lo stile del traffico, che indica la velocità del traffico.

Enum
STYLE_UNSPECIFIED Nessuno stile selezionato.
SLOWER_TRAFFIC Il traffico sta rallentando.
TRAFFIC_JAM C'è un ingorgo.

DeviceSettings

Informazioni sulle varie impostazioni del dispositivo mobile.

Rappresentazione JSON
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
Campi
locationPowerSaveMode

enum (LocationPowerSaveMode)

Comportamento delle funzionalità di geolocalizzazione sul dispositivo quando è attivo il risparmio energetico.

isPowerSaveMode

boolean

Indica se il dispositivo è attualmente in modalità di risparmio energetico.

isInteractive

boolean

Indica se il dispositivo è in stato interattivo.

batteryInfo

object (BatteryInfo)

Informazioni sullo stato della batteria.

LocationPowerSaveMode

Come vengono configurate il comportamento delle funzionalità di geolocalizzazione sul dispositivo mobile quando è attiva la funzionalità "Risparmio energetico" dei dispositivi. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enum
UNKNOWN_LOCATION_POWER_SAVE_MODE Modalità di salvataggio della posizione non definita
LOCATION_MODE_NO_CHANGE Il Risparmio energetico non dovrebbe influire sui fornitori di posizione oppure il Risparmio energetico è disattivato.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Il fornitore di servizi di localizzazione basato su GPS deve essere disattivato quando la modalità di risparmio energetico è attiva e il dispositivo non è interattivo.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Tutti i fornitori di servizi di localizzazione devono essere disattivati quando il risparmio energetico è attivo e il dispositivo non è interattivo.
LOCATION_MODE_FOREGROUND_ONLY Tutti i fornitori di posizione continueranno a essere disponibili, ma le correzioni di posizione dovrebbero essere fornite soltanto alle app in primo piano.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF La posizione non verrà disattivata, ma LocationManager limiterà tutte le richieste ai fornitori quando il dispositivo non è interattivo.

BatteryInfo

Informazioni sulla batteria del dispositivo.

Rappresentazione JSON
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
Campi
batteryStatus

enum (BatteryStatus)

Stato della batteria, se carica, ricarica e così via.

powerSource

enum (PowerSource)

Stato della fonte di alimentazione della batteria.

batteryPercentage

number

Percentuale attuale della batteria [0-100].

BatteryStatus

Stato della batteria, se carica, ricarica e così via.

Enum
UNKNOWN_BATTERY_STATUS Stato della batteria sconosciuto.
BATTERY_STATUS_CHARGING Batteria in carica.
BATTERY_STATUS_DISCHARGING La batteria si sta scaricando.
BATTERY_STATUS_FULL Batteria carica.
BATTERY_STATUS_NOT_CHARGING La batteria non si carica.
BATTERY_STATUS_POWER_LOW Il livello della batteria è basso.

PowerSource

Tipo di caricabatterie utilizzato per caricare la batteria.

Enum
UNKNOWN_POWER_SOURCE Fonte di alimentazione sconosciuta.
POWER_SOURCE_AC La fonte di alimentazione è un caricabatterie CA.
POWER_SOURCE_USB La fonte di alimentazione è una porta USB.
POWER_SOURCE_WIRELESS La fonte di alimentazione è wireless.
POWER_SOURCE_UNPLUGGED La batteria è scollegata.

Metodi

create

Crea un'istanza per un nuovo veicolo associato a un fornitore di servizi di ridesharing o consegne on demand.

get

Restituisce un veicolo dal Fleet Engine.

list

Restituisce un elenco impaginato di veicoli associati a un fornitore che corrispondono alle opzioni di richiesta.
Restituisce un elenco di veicoli che corrispondono alle opzioni di richiesta.

searchFuzzed
(deprecated)

Obsoleto: utilizza SearchVehicles.

update

Scrive i dati aggiornati del veicolo in Fleet Engine.

updateAttributes

Aggiorna parzialmente gli attributi di un veicolo.

updateLocation
(deprecated)

Deprecato: utilizza il metodo UpdateVehicle.