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)

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

string

Tylko dane wyjściowe. Lista tripId przejazdów, które obecnie są przypisane do tego pojazdu.
lastLocation

object (VehicleLocation)

Ostatnio zgłoszona lokalizacja pojazdu.
maximumCapacity

integer

Łączna liczba pasażerów, którymi ten pojazd może przejechać. 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 klucz.
vehicleType

object (VehicleType)

Wymagane. Typ pojazdu. Tych informacji można używać do filtrowania pojazdów w wynikach wyszukiwania w kategorii vehicles.search. Wpływa też na szacowany czas dotarcia i trasę.
licensePlate

object (LicensePlate)

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

object (TerminalLocation)

Wycofane: użyj zasady Vehicle.waypoints.
currentRouteSegment

string

Linia łamana określająca trasę, którą aplikacja kierowcy ma pojechać do następnego punktu pośredniego. Ta lista jest też zwracana w 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 wejście. Fleet Engine wykorzystuje te informacje do ulepszania 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 nie uległy zmianie.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC 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, gdzie kończy się currentRouteSegment. Te dane mogą być dostarczane przez kierowców w przypadku połączeń w usłudze vehicles.update jako pełny punkt pośredni, punkt pośredni LatLng lub ostatni LatLng trasa currentRouteSegment. Fleet Engine dołoży wszelkich starań, aby interpolować do rzeczywistego punktu pośredniego, jeśli nie został on w pełni określony. To pole jest ignorowane w wywołaniach vehicles.update, chyba że określono również pole currentRouteSegment.
remainingDistanceMeters

integer

Pozostała odległość dojazdu samochodem z: currentRouteSegment. Ta wartość jest też zwracana w funkcji Trip.remaining_distance_meters w przypadku wszystkich aktywnych przejazdów przypisanych do pojazdu. Wartość nie jest określona, jeśli pole currentRouteSegment jest puste.
etaToFirstWaypoint

string (Timestamp format)

Szacowany czas dotarcia na miejsce dla 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 „Zulu” RFC3339 UTC 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 wejście. 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 pośrednie 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 zostanie zwrócone tylko wtedy, gdy zostanie zaktualizowane.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC 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 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 wejście. Informacje o ustawieniach urządzenia mobilnego używanego przez kierowcę.

VehicleState

Stan elementu Vehicle.

Wartości w polu enum
UNKNOWN_VEHICLE_STATE Wartość domyślna używana 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 przypisanej do niego podróży.
ONLINE Pojazd przyjmuje nowe trasy.

VehicleAttribute

Opisuje atrybut pojazdu w postaci pary klucz-wartość. Długość ciągu znaków „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 typem typu double. vehicle_attribute_value może być tylko jedną z tych wartości:
stringValue

string

Wartość atrybutu wpisanego przez ciąg znaków.

Uwaga: to pole jest takie samo jak pole value, które zostanie ostatecznie wycofane. W przypadku metod tworzenia lub aktualizacji możesz używać dowolnego z tych pól, ale zdecydowanie zalecamy używanie właściwości stringValue. Jeśli ustawisz zarówno wartość stringValue, jak i value, muszą być one identyczne. W przeciwnym razie wystąpi błąd. Oba pola są wypełniane w odpowiedziach.
boolValue

boolean

Wartość atrybutu o typie logicznym.
numberValue

number

Podwójna wartość atrybutu.

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 używana w przypadku nieokreślonych lub nierozpoznanych kategorii pojazdów.
AUTO Samochód.
TAXI Każdy pojazd pełniący funkcję taksówki (zwykle licencjonowany lub podlegający regulacjom prawnym).
TRUCK Zwykle jest to pojazd o dużej pojemności.
TWO_WHEELER Motocykl, motorower lub inny pojazd dwukołowy
BICYCLE Transport napędzany przez człowieka.
PEDESTRIAN Osoba transportowa, zazwyczaj idąca lub biegająca, podróżująca po chodnikach.

LicensePlate

Informacje o tablicy rejestracyjnej pojazdu. Aby zapobiec przechowywaniu 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 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

Informacje o natężeniu ruchu 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 pokolorować jedną część 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 nie muszą się na siebie nakładać i nie muszą obejmować całej trasy.

Jeśli nie ma fragmentu drogi do stylu, klient powinien zastosować do trasy domyślne hasło.

RoadStretch

Jeden odcinek drogi do wyrenderowania.

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

enum (Style)

Wymagane. Styl, który ma zostać zastosowany.
offsetMeters

integer

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

integer

Wymagane. Długość ścieżki, w której ma zostać zastosowany 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 zwalnia.
TRAFFIC_JAM Jest 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)

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 stanie interaktywnym.
batteryInfo

object (BatteryInfo)

Informacje o stanie baterii.

LocationPowerSaveMode

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

Wartości w polu enum
UNKNOWN_LOCATION_POWER_SAVE_MODE Nieokreślony tryb oszczędzania energii w lokalizacji
LOCATION_MODE_NO_CHANGE Oszczędzanie baterii nie powinno mieć wpływu na dostawców usług lub jest wyłączone.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Dostawca usług lokalizacyjnych 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 Gdy oszczędzanie baterii jest włączone, a urządzenie nie jest interaktywne, wszyscy dostawcy usług lokalizacyjnych powinni być wyłączeni.
LOCATION_MODE_FOREGROUND_ONLY Wszyscy dostawcy lokalizacji pozostaną dostępni, ale poprawki lokalizacji należy podawać 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 będzie ograniczać wszystkie żądania wysyłane do dostawców, gdy urządzenie nie jest interaktywne.

BatteryInfo

Informacje o baterii urządzenia.

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

enum (BatteryStatus)

Stan baterii, czy to w pełni naładowana, czy w pełni naładowana.
powerSource

enum (PowerSource)

Stan źródła zasilania z baterii.
batteryPercentage

number

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

BatteryStatus

Stan baterii, czy to w pełni naładowana, czy w pełni naładowana.

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 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 Źródło zasilania to ładowarka sieciowa.
POWER_SOURCE_USB Źródłem zasilania jest 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 usługodawcą oferującym wspólne przejazdy lub dostawy.

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.

update

 Zapisuje zaktualizowane dane pojazdu we Fleet Engine.

updateAttributes

 Częściowo aktualizuje atrybuty pojazdu.