REST Resource: providers.vehicles

Zasób: Pojazd

Metadane pojazdu.

Zapis 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)
  }
}
Pola
name

string

Tylko dane wyjściowe. Unikalna nazwa tego pojazdu. Format to providers/{provider}/vehicles/{vehicle}.
vehicleState

enum (VehicleState)

Stan pojazdu.
supportedTripTypes[]

enum (TripType)

Typy podróży obsługiwane przez ten pojazd.
currentTrips[]

string

Tylko dane wyjściowe. Lista podróży przypisanych obecnie do tego pojazdu (tripId).
lastLocation

object (VehicleLocation)

Ostatnio zgłoszona lokalizacja pojazdu.
maximumCapacity

integer

Łączna liczba pasażerów, którzy mogą przejechać tym pojazdem. Ta wartość nie uwzględnia kierowcy. Ta wartość nie może być mniejsza niż 1.
attributes[]

object (VehicleAttribute)

Lista atrybutów pojazdu. Pojazd może mieć maksymalnie 100 atrybutów, a każdy atrybut musi mieć unikalny kluczyk.
vehicleType

object (VehicleType)

To pole jest wymagane. Typ pojazdu. Tego ustawienia można używać do filtrowania pojazdów w wynikach wyszukiwania vehicles.search. Wpływa również na szacowany czas dotarcia i trasę.
licensePlate

object (LicensePlate)

Informacje o tablicach rejestracyjnych pojazdu.
route[]
(deprecated)

object (TerminalLocation)

Wycofane: zamiast tego użyj elementu Vehicle.waypoints.
currentRouteSegment

string

Linia łamana wskazująca trasę, którą aplikacja kierowcy ma podróżować do następnego punktu pośredniego. Ta lista jest też zwracana w polu Trip.current_route_segment w przypadku wszystkich aktywnych przejazdów przypisanych do pojazdu.

Uwaga: to pole jest przeznaczone tylko do użycia przez pakiet SDK sterownika. Dekodowanie nie jest jeszcze obsługiwane.
currentRouteSegmentTraffic

object (TrafficPolylineData)

Tylko dane wejściowe. Fleet Engine wykorzystuje te informacje do usprawnienia udostępniania podróży. Uwaga: to pole jest przeznaczone tylko do użycia przez pakiet SDK sterownika.
currentRouteSegmentVersion

string (Timestamp format)

Tylko dane wyjściowe. Godzina, o której ustawiono currentRouteSegment. Może być przechowywany przez klienta i przekazywany w przyszłych żądaniach vehicles.get, aby zapobiegać zwróceniu tras, które się nie zmieniły.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
currentRouteSegmentEndPoint

object (TripWaypoint)

Punkt pośredni, gdzie kończy się currentRouteSegment. Te dane mogą być podawane przez kierowców podczas połączeń w sieci vehicles.update jako punkt na trasie, punkt pośredni LatLng lub ostatni LatLng autostrady currentRouteSegment. Jeśli nie jest on w pełni określony, Fleet Engine postara się interpolować do rzeczywistego punktu pośredniego. To pole jest ignorowane w wywołaniach funkcji vehicles.update, chyba że określono też currentRouteSegment.
remainingDistanceMeters

integer

Pozostała odległość dojazdu samochodem z lotniska currentRouteSegment. Ta wartość jest też zwracana w Trip.remaining_distance_meters w przypadku wszystkich aktywnych przejazdów przypisanych do pojazdu. Jeśli pole currentRouteSegment jest puste, wartość jest nieokreślona.
etaToFirstWaypoint

string (Timestamp format)

Szacowany czas dotarcia do pierwszego wpisu w polu waypoints. Wartość nie jest określona, jeśli pole waypoints jest puste lub pole Vehicle.current_route_segment jest puste.

Podczas aktualizowania pojazdu zasada remainingTimeSeconds ma pierwszeństwo przed zasadą etaToFirstWaypoint w tym samym żądaniu.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
remainingTimeSeconds

integer

Tylko dane wejściowe. Pozostały czas jazdy samochodem: currentRouteSegment. Wartość nie jest określona, jeśli pole waypoints jest puste lub pole Vehicle.current_route_segment jest puste. Ta wartość powinna być zgodna z etaToFirstWaypoint–current_time, jeśli wszystkie strony używają tego samego zegara.

Podczas aktualizowania pojazdu zasada remainingTimeSeconds ma pierwszeństwo przed zasadą etaToFirstWaypoint w tym samym żądaniu.
waypoints[]

object (TripWaypoint)

Pozostałe punkty na trasie przypisane do tego pojazdu.
waypointsVersion

string (Timestamp format)

Tylko dane wyjściowe. Data ostatniej aktualizacji pola waypoints. Klienci powinni buforować tę wartość i przekazywać ją w GetVehicleRequest, aby mieć pewność, że pole waypoints będzie zwracane tylko wtedy, gdy zostanie zaktualizowane.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
backToBackEnabled

boolean

Wskazuje, czy kierowca akceptuje przejazdy jedna po drugiej. Jeśli true, vehicles.search może uwzględnić pojazd, nawet jeśli jest on obecnie przypisany do podróży. Wartością domyślną jest false.
navigationStatus

enum (NavigationStatus)

Stan nawigacji pojazdu.
deviceSettings

object (DeviceSettings)

Tylko dane wejściowe. Informacje o ustawieniach urządzenia mobilnego używanego przez kierowcę.

VehicleState

Stan: Vehicle.

Wartości w polu enum
UNKNOWN_VEHICLE_STATE Domyślny, używany w przypadku nieokreślonych lub nierozpoznanych stanów pojazdu.
OFFLINE Pojazd nie przyjmuje nowych tras. Uwaga: pojazd może nadal działać w tym stanie podczas wykonywania przypisanej do niego podróży.
ONLINE Pojazd przyjmuje nowe trasy.

VehicleAttribute

Opisuje atrybut pojazdu jako parę klucz-wartość. Długość ciągu „klucz:wartość” nie może przekraczać 256 znaków.

Zapis 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.
}
Pola
key

string

Klucz atrybutu. Klucze nie mogą zawierać znaku dwukropka (:).
value

string

Wartość atrybutu.
Pole sumy vehicle_attribute_value. Wartość atrybutu może być ciągiem znaków, wartością logiczną lub liczbą zmiennoprzecinkową. vehicle_attribute_value może mieć tylko jedną z tych wartości:
stringValue

string

Wartość atrybutu wpisana na podstawie ciągu znaków.

Uwaga: ta wartość jest taka sama jak wartość pola value, które zostanie w końcu wycofane. W przypadku metod tworzenia lub aktualizacji można użyć dowolnego z tych pól, ale zdecydowanie zalecamy używanie pola stringValue. Jeśli ustawiono zarówno stringValue, jak i value, muszą one być identyczne. W przeciwnym razie zostanie zgłoszony błąd. Oba pola są wypełniane w odpowiedziach.
boolValue

boolean

Wartość atrybutu o typie wartości logicznej.
numberValue

number

Wartość atrybutu z podwójnym wpisanym.

VehicleType

Typ pojazdu.

Zapis JSON 
{
  "category": enum (Category)
}
Pola
category

enum (Category)

Kategoria typu pojazdu

Kategoria

Kategorie typów pojazdów

Wartości w polu enum
UNKNOWN Domyślna w przypadku nieokreślonych lub nierozpoznanych kategorii pojazdów.
AUTO Samochód.
TAXI Każdy pojazd, który jest taksówką (zwykle licencjonowany lub regulowany).
TRUCK Zwykle jest to pojazd z dużą ilością miejsca na dane.
TWO_WHEELER Motocykl, motorower lub inny pojazd dwukołowy
BICYCLE Transport oparty na ludziach.
PEDESTRIAN Transporter, zwykle idący lub biegnący, poruszający się po chodnikach.

LicensePlate

Informacje o tablicy rejestracyjnej Pojazdu. Aby uniknąć przechowywania informacji umożliwiających identyfikację osób, jako część danego podmiotu przechowujemy tylko ich minimum.

Zapis JSON 
{
  "countryCode": string,
  "lastCharacter": string
}
Pola
countryCode

string

To pole jest wymagane. Kod kraju/regionu CLDR. Na przykład US dla Stanów Zjednoczonych i IN dla Indii.
lastCharacter

string

Ostatnia cyfra na tablicy rejestracyjnej lub „-1” oznacza brak wartości liczbowej.

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

TrafficPolylineData

Warunki drogowe na oczekiwanej trasie pojazdu.

Zapis JSON 
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
Pola
trafficRendering

object (VisualTrafficReportPolylineRendering)

Renderowanie za pomocą linii łamanej szybkości ruchu we wszystkich regionach na jednym odcinku przejazdu klienta.

VisualTrafficReportPolylineRendering

Opisuje, jak klienci powinni kolorować jeden fragment linii łamanej na trasie.

Zapis JSON 
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
Pola
roadStretch[]

object (RoadStretch)

Opcjonalnie. Fragmenty dróg, które powinny być renderowane wzdłuż linii łamanej. Rozciągnięcia mają gwarantowaną, że nie nakładają się na siebie i nie muszą obejmować całej trasy.

Jeśli nie ma zastosowania rozciągania drogi do stylu, klient powinien zastosować do trasy ustawienie domyślne.

RoadStretch

Jeden odcinek drogi do wyrenderowania.

Zapis JSON 
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
Pola
style

enum (Style)

To pole jest wymagane. Styl, który ma zostać zastosowany.
offsetMeters

integer

To pole jest wymagane. Styl powinien być stosowany w zakresie [offsetMeters, offsetMeters + lengthMeters).
lengthMeters

integer

To pole jest wymagane. Długość ścieżki, w której zastosować styl.

Styl

Styl natężenia ruchu, który wskazuje prędkość ruchu.

Wartości w polu enum
STYLE_UNSPECIFIED Nie wybrano stylu.
SLOWER_TRAFFIC Ruch spada.
TRAFFIC_JAM Występuje korek.

DeviceSettings

Informacje o różnych ustawieniach na urządzeniu mobilnym.

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

enum (LocationPowerSaveMode)

Określa sposób działania funkcji lokalizacji na urządzeniu przy włączonym oszczędzaniu baterii.
isPowerSaveMode

boolean

Określa, czy urządzenie jest obecnie w trybie oszczędzania energii.
isInteractive

boolean

Określa, czy urządzenie jest w trybie interaktywnym.
batteryInfo

object (BatteryInfo)

Informacje o stanie baterii.

LocationPowerSaveMode

Konfiguracja funkcji lokalizacji na urządzeniu mobilnym, gdy włączona jest funkcja oszczędzania baterii. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Wartości w polu enum
UNKNOWN_LOCATION_POWER_SAVE_MODE Nieokreślona lokalizacja i tryb oszczędzania energii
LOCATION_MODE_NO_CHANGE Oszczędzanie baterii nie powinno mieć wpływu na dostawców usług lub jest ono wyłączone.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Dostawca lokalizacji oparty na GPS powinien być wyłączony, gdy oszczędzanie baterii jest włączone, a urządzenie nie jest interaktywne.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Wszyscy dostawcy usług lokalizacyjnych powinni być wyłączone, gdy oszczędzanie baterii jest włączone, a urządzenie nie jest interaktywne.
LOCATION_MODE_FOREGROUND_ONLY Wszyscy dostawcy lokalizacji pozostaną dostępni, ale poprawki lokalizacji należy wprowadzać tylko w aplikacjach działających na pierwszym planie.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF Lokalizacja nie zostanie wyłączona, ale Menedżer lokalizacji ograniczy wszystkie żądania wysyłane do dostawców, gdy urządzenie nie będzie interaktywne.

BatteryInfo

Informacje o baterii urządzenia.

Zapis JSON 
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
Pola
batteryStatus

enum (BatteryStatus)

Stan baterii: naładowana, ładowana itd.
powerSource

enum (PowerSource)

Stan źródła zasilania baterii.
batteryPercentage

number

Obecny procentowy poziom naładowania baterii [0–100].

BatteryStatus

Stan baterii: naładowana, ładowana itd.

Wartości w polu enum
UNKNOWN_BATTERY_STATUS Nieznany stan baterii.
BATTERY_STATUS_CHARGING Trwa ładowanie baterii.
BATTERY_STATUS_DISCHARGING Bateria się rozładowuje.
BATTERY_STATUS_FULL Bateria jest pełna.
BATTERY_STATUS_NOT_CHARGING Bateria się nie ładuje.
BATTERY_STATUS_POWER_LOW Bateria jest rozładowana.

PowerSource

Typ ładowarki używanej do ładowania baterii.

Wartości w polu enum
UNKNOWN_POWER_SOURCE Nieznane źródło zasilania.
POWER_SOURCE_AC Źródło zasilania to ładowarka prądu przemiennego.
POWER_SOURCE_USB Źródło zasilania to port USB.
POWER_SOURCE_WIRELESS Źródło zasilania jest bezprzewodowe.
POWER_SOURCE_UNPLUGGED Bateria jest odłączona.

Metody

create

 Tworzy instancję nowego pojazdu powiązanego z dostawcą usług transportu publicznego na żądanie.

get

 Zwraca pojazd z Fleet Engine.

list

 Zwraca podzieloną na strony listę pojazdów powiązanych z dostawcą, które pasują do opcji żądania.
Zwraca listę pojazdów pasujących do opcji w żądaniu.

searchFuzzed
(deprecated)

 Wycofane: zamiast tego użyj elementu SearchVehicles.

update

 Zapisuje zaktualizowane dane o pojazdach w Fleet Engine.

updateAttributes

 Częściowo aktualizuje atrybuty pojazdu.

updateLocation
(deprecated)

 Wycofana: użyj metody UpdateVehicle.