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 del veicolo. Il formato è providers/{provider}/vehicles/{vehicle}.

vehicleState

enum (VehicleState)

Lo stato del veicolo.

supportedTripTypes[]

enum (TripType)

Tipi di viaggi supportati da questo veicolo.

currentTrips[]

string

Solo output. Elenco di tripId per i viaggi attualmente assegnati a questo veicolo.

lastLocation

object (VehicleLocation)

Ultima posizione segnalata del veicolo.

maximumCapacity

integer

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

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 veicolo. Può essere utilizzato per filtrare i veicoli nei risultati di vehicles.search. Influisce anche sui calcoli dell'orario di arrivo stimato e del percorso.

licensePlate

object (LicensePlate)

Dati della targa del veicolo.

route[]
(deprecated)

object (TerminalLocation)

Deprecato: utilizza Vehicle.waypoints.

currentRouteSegment

string

La polilinea che specifica il percorso che l'app del conducente intende seguire fino al waypoint successivo. Questo elenco viene restituito anche in Trip.current_route_segment per tutti i viaggi attivi assegnati al veicolo.

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

currentRouteSegmentTraffic

object (TrafficPolylineData)

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

currentRouteSegmentVersion

string (Timestamp format)

Solo output. Ora in cui è stato impostato currentRouteSegment. Può essere memorizzato dal client e trasmesso in richieste vehicles.get future per impedire il ritorno a percorsi che non sono stati modificati.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

currentRouteSegmentEndPoint

object (TripWaypoint)

Il waypoint in cui termina currentRouteSegment. Questo valore può essere fornito dai conducenti durante le chiamate vehicles.update come waypoint per l'intero viaggio, come waypoint LatLng o come ultimo LatLng del currentRouteSegment. Fleet Engine farà del suo meglio per eseguire l'interpolazione fino a un punto di passaggio effettivo se non è completamente specificato. Questo campo viene ignorato nelle chiamate a vehicles.update, a meno che non venga specificato anche currentRouteSegment.

remainingDistanceMeters

integer

La distanza in auto rimanente per currentRouteSegment. Questo valore viene restituito anche in Trip.remaining_distance_meters per tutti i viaggi attivi assegnati al veicolo. Il valore non è 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 è specificato se il campo waypoints è vuoto o se il campo Vehicle.current_route_segment è vuoto.

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

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

remainingTimeSeconds

integer

Solo input. Il tempo di percorrenza rimanente per currentRouteSegment. Il valore non è specificato se il campo waypoints è vuoto o se 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 waypoint rimanenti assegnati a questo veicolo.

waypointsVersion

string (Timestamp format)

Solo output. Data dell'ultimo aggiornamento del campo waypoints. I client devono memorizzare nella cache questo valore e passarlo in GetVehicleRequest per assicurarsi che il campo waypoints venga restituito solo se aggiornato.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

backToBackEnabled

boolean

Indica se il conducente accetta viaggi consecutivi. Se true, vehicles.search può includere il veicolo anche se al momento è assegnato a un viaggio. 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 nuovi viaggi. Nota: il veicolo potrebbe continuare a funzionare in questo stato durante il completamento di una corsa assegnata.
ONLINE Il veicolo accetta nuovi viaggi.

VehicleAttribute

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 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 il carattere due punti (:).

value

string

Il valore dell'attributo.

Campo unione vehicle_attribute_value. Il valore dell'attributo può essere di tipo stringa, booleano o doppio. vehicle_attribute_value può essere solo uno dei seguenti:
stringValue

string

Valore dell'attributo di tipo 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 sono impostati sia stringValue sia value, questi devono essere identici, altrimenti verrà generato 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.

VehicleType

Il tipo di veicolo.

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

enum (Category)

Categoria del tipo di veicolo

Categoria

Categorie di tipo di veicolo

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 autorizzato o regolamentato).
TRUCK In genere, un veicolo con una grande capacità di carico.
TWO_WHEELER Una motocicletta, un motorino o un altro veicolo a due ruote
BICYCLE Trasporto a propulsione umana.
PEDESTRIAN Un trasportatore umano, in genere a piedi o in corsa, che si sposta lungo percorsi pedonali.

LicensePlate

Le informazioni sulla 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.

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

TrafficPolylineData

Condizioni del traffico lungo il percorso previsto del veicolo.

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

object (VisualTrafficReportPolylineRendering)

Un rendering di polilinee che mostra la velocità del traffico per tutte le regioni lungo un tratto del tragitto di un cliente.

VisualTrafficReportPolylineRendering

Descrive in che modo i client devono colorare una parte del polilinea lungo il percorso.

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

object (RoadStretch)

(Facoltativo) Tratti stradali che devono essere visualizzati lungo la polilinea. È garantito che i tratti non si sovrappongano e non coprono necessariamente l'intero percorso.

In assenza di un tratto di strada da stilizzare, il client deve applicare il valore predefinito per il percorso.

RoadStretch

Un tratto di strada da visualizzare.

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 su 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 è attiva la modalità di risparmio energetico.

isPowerSaveMode

boolean

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

isInteractive

boolean

Indica se il dispositivo è in uno stato interattivo.

batteryInfo

object (BatteryInfo)

Informazioni sullo stato della batteria.

LocationPowerSaveMode

Il modo in cui le funzionalità di geolocalizzazione sono configurate per funzionare sul dispositivo mobile quando è attiva la funzionalità "risparmio energetico" del dispositivo. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enum
UNKNOWN_LOCATION_POWER_SAVE_MODE Undefined LocationPowerSaveMode
LOCATION_MODE_NO_CHANGE I fornitori di servizi di geolocalizzazione non devono essere interessati dal risparmio energetico oppure questa funzionalità deve essere disattivata.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Il fornitore di servizi di geolocalizzazione basato su GPS deve essere disattivato quando il risparmio energetico è attivo e il dispositivo non è interattivo.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Tutti i fornitori di servizi di geolocalizzazione devono essere disattivati quando il risparmio energetico è attivo e il dispositivo non è interattivo.
LOCATION_MODE_FOREGROUND_ONLY Tutti i fornitori di servizi di geolocalizzazione rimarranno disponibili, ma le correzioni della posizione devono essere fornite solo alle app in primo piano.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF La posizione non verrà disattivata, ma LocationManager ridurrà 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 o in carica e così via.

powerSource

enum (PowerSource)

Stato dell'alimentazione a batteria.

batteryPercentage

number

Percentuale attuale della batteria [0-100].

BatteryStatus

Stato della batteria, se è carica o in carica e così via.

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 La batteria è carica.
BATTERY_STATUS_NOT_CHARGING La batteria non si carica.
BATTERY_STATUS_POWER_LOW La batteria è in esaurimento.

PowerSource

Tipo di caricabatterie utilizzato per ricaricare la batteria.

Enum
UNKNOWN_POWER_SOURCE 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 L'alimentazione è wireless.
POWER_SOURCE_UNPLUGGED La batteria è scollegata.

Metodi

create

Consente di creare un nuovo veicolo associato a un fornitore di servizi di ridesharing o consegne on demand.

get

Restituisce un veicolo dal motore del parco risorse.

list

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

update

Scrive i dati aggiornati del veicolo in Fleet Engine.

updateAttributes

Aggiorna parzialmente gli attributi di un veicolo.