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. Niepowtarzalna 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 tripId na potrzeby podróży aktualnie przypisanych do tego pojazdu.
lastLocation

object (VehicleLocation)

Ostatnio zgłoszona lokalizacja pojazdu.
maximumCapacity

integer

Łączna liczba osób, które może przewieźć ten pojazd. Kierowca nie jest uwzględniany w tej wartości. 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 klucz.
vehicleType

object (VehicleType)

Wymagane. Typ tego pojazdu. Może służyć do filtrowania pojazdów w wynikach wyszukiwania w usłudze vehicles.search. Wpływa też na szacowany czas dotarcia na miejsce i obliczanie trasy.
licensePlate

object (LicensePlate)

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

object (TerminalLocation)

Wycofane: użyj atrybutu Vehicle.waypoints.
currentRouteSegment

string

Linia łamana określająca trasę, którą aplikacja kierowcy zamierza podążać do następnego punktu pośredniego. Ta lista jest też zwracana w języku Trip.current_route_segment w przypadku wszystkich aktywnych podróży przypisanych do pojazdu.

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

object (TrafficPolylineData)

Tylko dane wejściowe. Fleet Engine używa tych informacji do ulepszania udostępniania przejazdów. Uwaga: to pole jest przeznaczone tylko do użytku przez pakiet Driver SDK.
currentRouteSegmentVersion

string (Timestamp format)

Tylko dane wyjściowe. Czas ustawienia parametru currentRouteSegment. Może być przechowywany przez klienta i przekazywana w przyszłych żądaniach vehicles.get, aby zapobiec zwrotowi tras, które nie uległy zmianie.

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

object (TripWaypoint)

Punkt na trasie, w którym kończy się currentRouteSegment. Mogą je przekazać kierowcy podczas połączeń vehicles.update jako punkt na trasie obejmującej całą podróż, jako punkt pośredni LatLng lub jako ostatni element LatLng pojazdu currentRouteSegment. Jeśli nie zostanie w pełni określony, Fleet Engine podejmie wtedy wszelkie możliwe działania, aby interpolować do rzeczywistego punktu pośredniego. To pole jest ignorowane w wywołaniach vehicles.update, chyba że określono też pole currentRouteSegment.
remainingDistanceMeters

integer

Pozostały dystans jazdy samochodem przez currentRouteSegment. Ta wartość jest też zwracana w polu Trip.remaining_distance_meters w przypadku wszystkich aktywnych podróży przypisanych do pojazdu. Wartość jest nieokreślona, jeśli pole currentRouteSegment jest puste.
etaToFirstWaypoint

string (Timestamp format)

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

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

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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ść jest nieokreślona, jeśli pole waypoints jest puste lub pole Vehicle.current_route_segment jest puste. Ta wartość powinna pasować do zakresu od etaToFirstWaypoint do current_time, jeśli wszystkie strony używają tego samego zegara.

Podczas aktualizowania pojazdu zasada remainingTimeSeconds ma w tym samym żądaniu pierwszeństwo przed zasadą etaToFirstWaypoint.
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. Klienty powinny buforować tę wartość i przekazywać ją w narzędziu GetVehicleRequest, aby mieć pewność, że pole waypoints będzie zwracane tylko wtedy, gdy zostanie zaktualizowane.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 połączenia w obie strony. Jeśli zasada true, vehicles.search może uwzględniać pojazd, nawet jeśli jest 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 elementu Vehicle.

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

VehicleAttribute

Opisuje atrybut pojazdu w postaci pary klucz-wartość. Pole „klucz:wartość” Długość ciągu znaków 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 z ciągiem znaków.

Uwaga: działa tak samo jak pole value, które z czasem zostanie wycofane. Do tworzenia i aktualizacji danych możesz użyć dowolnego z tych pól, ale zdecydowanie zalecamy użycie stringValue. Jeśli ustawione są zarówno wartości stringValue, jak i value, muszą one być identyczne, w przeciwnym razie wystąpi błąd. Oba pola są wypełniane w odpowiedziach.
boolValue

boolean

Wartość atrybutu wpisanego z użyciem wartości logicznej.
numberValue

number

Wartość atrybutu została wpisana dwukrotnie.

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ślnie używana w przypadku nieokreślonych lub nierozpoznanych kategorii pojazdów.
AUTO Samochód.
TAXI Wszelkie pojazdy służące jako taksówka (zwykle licencjonowane lub objęte regulacjami).
TRUCK Zazwyczaj pojazd z dużą pojemnością pamięci masowej.
TWO_WHEELER Motocykl, motorower lub inny pojazd dwukołowy
BICYCLE Transport napędzany przez człowieka.
PEDESTRIAN Osobisty środek transportu, zwykle pieszo lub biegnący po ścieżkach.

LicensePlate

Informacje o tablicach rejestracyjnych Pojazdu. Aby uniknąć przechowywania informacji umożliwiających identyfikację osób, w ramach danego podmiotu przechowujemy tylko minimalną ilość informacji na temat tablicy rejestracyjnej.

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

string

Wymagane. Kod kraju/regionu CLDR. Na przykład US w przypadku Stanów Zjednoczonych lub IN w przypadku Indii.
lastCharacter

string

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

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

TrafficPolylineData

Warunki na drodze do oczekiwanej trasy pojazdu.

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

object (VisualTrafficReportPolylineRendering)

Renderowanie liniowe obrazujące prędkość ruchu we wszystkich regionach na jednym odcinku przejazdu klienta.

VisualTrafficReportPolylineRendering

Opisuje, jak klienci powinni kolorować jedną część linii łamanej na trasie.

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

object (RoadStretch)

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

Jeśli nie ma rozciągania drogi do stylu, klient powinien zastosować do trasy domyślną wartość.

RoadStretch

Jeden odcinek drogi do wyrenderowania.

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

enum (Style)

Wymagane. Styl, który zostanie zastosowany.
offsetMeters

integer

Wymagane. Styl powinien być stosowany między [offsetMeters, offsetMeters + lengthMeters).
lengthMeters

integer

Wymagane. Długość ścieżki, w której chcesz zastosować styl.

Styl

Styl ruchu wskazujący prędkość ruchu.

Wartości w polu enum
STYLE_UNSPECIFIED Nie wybrano stylu.
SLOWER_TRAFFIC Ruch jest zwalniany.
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)

Jak funkcje lokalizacji działają na urządzeniu po włączeniu oszczędzania baterii.
isPowerSaveMode

boolean

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

boolean

Wskazuje, czy urządzenie jest w trybie interaktywnym.
batteryInfo

object (BatteryInfo)

Informacje o stanie baterii.

LocationPowerSaveMode

Jak są skonfigurowane funkcje lokalizacji do działania na urządzeniu mobilnym po włączeniu trybu „Oszczędzanie baterii” jest włączona. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Wartości w polu enum
UNKNOWN_LOCATION_POWER_SAVE_MODE Niezdefiniowany tryb oszczędzania lokalizacji
LOCATION_MODE_NO_CHANGE Oszczędzanie baterii nie powinno mieć wpływu na dostawców usług lokalizacyjnych lub w przypadku tej funkcji jest ona wyłączona.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Dostawca lokalizacji wykorzystujący GPS powinien być wyłączony, gdy jest włączone oszczędzanie baterii, a urządzenie nie jest interaktywne.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Wyłącz wszystkich dostawców usług lokalizacji, gdy urządzenie nie jest interaktywne, a tryb oszczędzania baterii jest włączony.
LOCATION_MODE_FOREGROUND_ONLY Wszyscy dostawcy lokalizacji będą dostępni, ale poprawki lokalizacji należy udostępniać tylko w przypadku aplikacji działających na pierwszym planie.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF Lokalizacja nie zostanie wyłączona, ale LocationManager będzie ograniczać wszystkie żądania 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, stan naładowania, stan naładowania itd.
powerSource

enum (PowerSource)

Stan źródła zasilania baterii.
batteryPercentage

number

Bieżąca wartość procentowa baterii [0–100].

BatteryStatus

Stan baterii, stan naładowania, stan naładowania 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 naładowana.
BATTERY_STATUS_NOT_CHARGING Bateria się nie ładuje.
BATTERY_STATUS_POWER_LOW Bateria jest słaba.

PowerSource

Typ ładowarki używanej do ładowania baterii.

Wartości w polu enum
UNKNOWN_POWER_SOURCE Nieznane źródło zasilania.
POWER_SOURCE_AC Jego źródłem zasilania jest ładowarka sieciowa.
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

 Tworzony jest nowy pojazd powiązany z usługą wspólnych przejazdów na żądanie lub z dostawcą.

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, które pasują do opcji żądania.

update

 Zapisuje zaktualizowane dane pojazdu we Fleet Engine.

updateAttributes

 Częściowo aktualizuje atrybuty pojazdu.