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 viaggio 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 di questo veicolo. Il driver non viene considerato in questo valore. Questo valore deve essere maggiore o uguale a uno.
attributes[]

object (VehicleAttribute)

Elenco degli attributi del veicolo. Un veicolo può avere al massimo 100 attributi e ogni attributo deve avere una chiave univoca.
vehicleType

object (VehicleType)

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

object (LicensePlate)

Informazioni sulla targa del veicolo.
route[]
(deprecated)

object (TerminalLocation)

Deprecato: usa invece Vehicle.waypoints.
currentRouteSegment

string

La polilinea che specifica il percorso che l'app del conducente intende seguire per raggiungere la tappa successiva. 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 del 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 del driver.
currentRouteSegmentVersion

string (Timestamp format)

Solo output. Ora in cui è stata impostata la funzionalità currentRouteSegment. Può essere archiviato dal client e passato nelle future richieste di vehicles.get per impedire la restituzione di route che non sono state modificate.

Un timestamp nel formato RFC3339 UTC "Zulu" 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 waypoint dove finisce currentRouteSegment. Può essere fornito dai conducenti nelle chiamate vehicles.update come tappa completa, tappa LatLng o come ultima LatLng currentRouteSegment. Fleet Engine farà del proprio meglio per interpolare fino a una tappa effettiva se non è completamente specificata. Questo campo viene ignorato nelle chiamate vehicles.update a meno che non venga specificato anche currentRouteSegment.
remainingDistanceMeters

integer

La distanza in auto rimanente per il currentRouteSegment. Questo valore viene restituito anche in Trip.remaining_distance_meters per tutte le corse attive assegnate al veicolo. Se il campo currentRouteSegment è vuoto, il valore non è specificato.
etaToFirstWaypoint

string (Timestamp format)

L'orario di arrivo stimato della prima voce nel campo waypoints. Il valore non è 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 nel formato RFC3339 UTC "Zulu" 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 è 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)

Le tappe rimanenti assegnate 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 trasmetterlo a GetVehicleRequest per garantire che il campo waypoints venga restituito solo se viene aggiornato.

Un timestamp nel formato RFC3339 UTC "Zulu" 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 Vehicle.

Enum
UNKNOWN_VEHICLE_STATE Valore predefinito, utilizzato per gli stati del veicolo non specificati o non riconosciuti.
OFFLINE Il veicolo non accetta nuove corse. Nota: il veicolo può continuare a funzionare in questo stato durante il completamento di una corsa assegnata.
ONLINE Il veicolo accetta nuove corse.

VehicleAttribute

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

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

boolean

Valore di attributo digitato con valore booleano.
numberValue

number

Valore attributo doppio tipo.

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 Valore predefinito, utilizzato per le categorie di veicoli non specificate o non riconosciute.
AUTO Un'automobile.
TAXI Qualsiasi veicolo che funge da taxi (in genere con licenza o regolamentato).
TRUCK In genere, un veicolo con una grande capacità di archiviazione.
TWO_WHEELER Una motocicletta, un ciclomotore o un altro veicolo a due ruote
BICYCLE Trasporto a energia umana.
PEDESTRIAN Un trasportatore, di solito cammina o corre, che percorre percorsi pedonali.

LicensePlate

Le informazioni della targa del Veicolo. Per evitare di memorizzare informazioni che consentono l'identificazione personale, nell'entità vengono memorizzate 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 sulla targa.

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

TrafficPolylineData

Condizioni del traffico lungo il percorso previsto per i veicoli.

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

object (VisualTrafficReportPolylineRendering)

Rendering polilinea che indica la velocità del traffico per tutte le regioni lungo un tratto della corsa di un cliente.

VisualTrafficReportPolylineRendering

Descrive come i clienti devono colorare una parte della polilinea lungo il percorso.

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

object (RoadStretch)

(Facoltativo) Tratti della strada che dovrebbero essere visualizzati lungo la polilinea. È garantito che gli tratti non si sovrappongano e non coprono necessariamente l'intero percorso.

In assenza di un tratto stradale, il cliente deve applicare il valore predefinito al percorso.

RoadStretch

Un tratto di strada che dovrebbe essere visualizzato.

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 in 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)

Il comportamento delle funzionalità di geolocalizzazione sul dispositivo quando è attivo il risparmio energetico.
isPowerSaveMode

boolean

Se il dispositivo è attualmente in modalità di risparmio energetico.
isInteractive

boolean

Se il dispositivo è in stato interattivo.
batteryInfo

object (BatteryInfo)

Informazioni sullo stato della batteria.

LocationPowerSaveMode

Comportamento delle funzionalità di geolocalizzazione sul dispositivo mobile quando viene attivato "risparmio energetico" sia attiva. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enum
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode non definita
LOCATION_MODE_NO_CHANGE Il fornitore della posizione non dovrebbe essere interessato dal risparmio energetico oppure il risparmio energetico è disattivato.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Il fornitore della posizione basato sul GPS deve essere disattivato quando il risparmio energetico è attivo e il dispositivo non è interattivo.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Tutti i provider di posizione devono essere disattivati quando il risparmio energetico è attivo e il dispositivo non è interattivo.
LOCATION_MODE_FOREGROUND_ONLY Tutti i fornitori di posizione rimarranno disponibili, ma le correzioni della 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 provider 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 o in carica, ecc.
powerSource

enum (PowerSource)

Stato della fonte di alimentazione della batteria.
batteryPercentage

number

Percentuale attuale della batteria [0-100].

BatteryStatus

Stato della batteria, se carica o in carica, ecc.

Enum
UNKNOWN_BATTERY_STATUS Stato della batteria sconosciuto.
BATTERY_STATUS_CHARGING La 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 ridesharing o di consegne on demand.

get

 Restituisce un veicolo da Fleet Engine.

list

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

update

 Scrive dati aggiornati del veicolo su Fleet Engine.

updateAttributes

 Aggiorna parzialmente gli attributi di un veicolo.