REST Resource: providers.vehicles

Zasób: Vehicle

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 dla podróży obecnie przypisanych do tego pojazdu.
lastLocation

object (VehicleLocation)

Ostatnio zgłoszona lokalizacja pojazdu.
maximumCapacity

integer

Łączna liczba pasażerów, których może przewieźć pojazd. W tej wartości nie uwzględnia się kierowcy. Ta wartość musi być większa niż lub równa 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. Można go użyć do filtrowania pojazdów w wynikach vehicles.search. Wpływa też na szacowany czas dotarcia na miejsce i obliczanie trasy.
licensePlate

object (LicensePlate)

Informacje o tablicy rejestracyjnej pojazdu.
route[]
(deprecated)

object (TerminalLocation)

Wycofane: użyj w zastępstwie zasady Vehicle.waypoints.
currentRouteSegment

string

Linia łamana określająca trasę, którą aplikacja kierowcy ma poprowadzić do następnego punktu orientacyjnego. Ta lista jest również zwracana w Trip.current_route_segment dla wszystkich aktywnych przejazdów przypisanych do pojazdu.

Uwaga: to pole jest przeznaczone tylko do użycia 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życia przez pakiet Driver SDK.
currentRouteSegmentVersion

string (Timestamp format)

Tylko dane wyjściowe. Czas ustawienia 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 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 na trasie, w którym kończy się currentRouteSegment. Kierowcy mogą podać te informacje podczas wywołania vehicles.update jako punkt na całej trasie, punkt na trasie LatLng lub ostatni LatLng na currentRouteSegment. Fleet Engine zrobi, co w jego mocy, aby interpolować do rzeczywistego punktu kontrolnego, jeśli nie jest on w pełni określony. To pole jest ignorowane w wywołaniach vehicles.update, chyba że podano też parametr currentRouteSegment.
remainingDistanceMeters

integer

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

string (Timestamp format)

Przewidywany czas dotarcia do pierwszego elementu w polu waypoints. Jeśli pole waypoints lub Vehicle.current_route_segment jest puste, wartość jest nieokreślona.

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

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc 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. Jeśli pole waypoints lub Vehicle.current_route_segment jest puste, wartość jest nieokreślona. Ta wartość powinna być równa etaToFirstWaypoint - 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. Ostatnia aktualizacja 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 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 z kolei. 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ślny, używany w przypadku nieokreślonych lub nierozpoznanych stanów pojazdu.
OFFLINE Pojazd nie przyjmuje nowych rezerwacji. Uwaga: pojazd może nadal działać w tym stanie podczas wykonywania przypisanej mu podróży.
ONLINE Pojazd przyjmuje nowe przejazdy.

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ć dwukropka (:).
value

string

Wartość atrybutu.
Pole sumy vehicle_attribute_value. Wartość atrybutu może być typu string, bool lub double. 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 opcje stringValue i value są ustawione, muszą być identyczne, w przeciwnym razie wystąpi błąd. Oba pola są wypełniane w odpowiedziach.
boolValue

boolean

Wartość atrybutu typu logicznego.
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ślna, używana w przypadku nieokreślonych lub nierozpoznanych kategorii pojazdów.
AUTO Samochód.
TAXI Każdy pojazd, który pełni funkcję taksówki (zazwyczaj jest licencjonowany lub regulowany).
TRUCK Zazwyczaj pojazd o dużej pojemności.
TWO_WHEELER motocykl, skuter lub inny pojazd dwukołowy;
BICYCLE Transport napędzany siłą ludzkich mięśni.
PEDESTRIAN Osobisty środek transportu, zwykle pieszo lub biegnący po ścieżkach.

LicensePlate

Informacje o tablicy rejestracyjnej pojazdu. Aby uniknąć przechowywania informacji umożliwiających identyfikację osób, w ramach danego podmiotu przechowywana jest tylko minimalna 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 numeru rejestracyjnego lub „-1”, aby wskazać, że numer rejestracyjny nie zawiera wartości liczbowej.

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

TrafficPolylineData

warunki na drodze na przewidywanej trasie pojazdu;

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

object (VisualTrafficReportPolylineRendering)

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

VisualTrafficReportPolylineRendering

Opisuje, jak klienci powinni pokolorować jeden fragment ścieżki wielopunktowej.

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, który powinien zostać wyświetlony.

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, na której ma być zastosowany styl.

Styl

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

Wartości w polu enum
STYLE_UNSPECIFIED Nie wybrano stylu.
SLOWER_TRAFFIC Ruch się spowalnia.
TRAFFIC_JAM Wystąpił 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, gdy włączone jest oszczędzanie baterii.
isPowerSaveMode

boolean

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

boolean

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

object (BatteryInfo)

Informacje o stanie baterii.

LocationPowerSaveMode

Jak funkcje lokalizacji są skonfigurowane 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 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 danych o lokalizacji na podstawie GPS powinien być wyłączony, gdy włączone jest oszczędzanie baterii, a urządzenie nie jest aktywne.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Gdy włączone jest oszczędzanie baterii, a urządzenie nie jest aktywne, wszyscy dostawcy lokalizacji powinni być wyłączeni.
LOCATION_MODE_FOREGROUND_ONLY W dalszym ciągu będą dostępne wszystkie usługi lokalizacyjne, ale poprawki lokalizacji powinny być dostarczane tylko aplikacjom 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, czy jest naładowana, czy ładowana itp.
powerSource

enum (PowerSource)

Stan źródła zasilania baterii.
batteryPercentage

number

Aktualny poziom naładowania baterii [0–100].

BatteryStatus

Stan baterii, czy jest naładowana, czy ładowana itp.

Wartości w polu enum
UNKNOWN_BATTERY_STATUS Stan baterii jest nieznany.
BATTERY_STATUS_CHARGING Bateria jest ładowana.
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 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

 Tworzy nowy pojazd powiązany z usługą przewozu osób lub dostaw 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, które pasują do opcji żądania.

update

 Zapisuje zaktualizowane dane pojazdu w Fleet Engine.

updateAttributes

 Częściowo aktualizuje atrybuty pojazdu.