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

object (VehicleLocation)

Ostatnia 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. Ma też wpływ na obliczenia czasu dojazdu i 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, aby ulepszyć udostępnianie 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 przekazywany w przyszłych żądaniach vehicles.get, aby zapobiec zwracaniu tras, które się nie zmieniły.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
currentRouteSegmentEndPoint

object (TripWaypoint)

Punkt orientacyjny, w którym kończy się currentRouteSegment. Kierowcy mogą podać te informacje w wywołaniu vehicles.update jako punkt kontrolny pełnej podróży, punkt kontrolny LatLng lub ostatni LatLng w currentRouteSegment. Jeśli punkt kontrolny nie jest w pełni określony, Fleet Engine zrobi, co w jego mocy, aby go interpolować. To pole jest ignorowane w wywołaniach vehicles.update, chyba że podano też parametr currentRouteSegment.
remainingDistanceMeters

integer

Pozostała odległość do przejechania w przypadku currentRouteSegment. Ta wartość jest również zwracana w Trip.remaining_distance_meters w przypadku wszystkich aktywnych podróży przypisanych do pojazdu. Jeśli pole currentRouteSegment jest puste, wartość nie jest określona.
etaToFirstWaypoint

string (Timestamp format)

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

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

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
remainingTimeSeconds

integer

Tylko dane wejściowe. Pozostały czas jazdy w przypadku 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 w tym samym żądaniu remainingTimeSeconds ma pierwszeństwo przed etaToFirstWaypoint.
waypoints[]

object (TripWaypoint)

Pozostałe punkty drogi przypisane do tego pojazdu.
waypointsVersion

string (Timestamp format)

Tylko dane wyjściowe. Ostatnia aktualizacja pola waypoints. Klienci powinni przechowywać tę wartość w pamięci podręcznej i przekazywać ją w polu GetVehicleRequest, aby mieć pewność, że pole waypoints zostanie zwrócone tylko wtedy, gdy zostanie zaktualizowane.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
backToBackEnabled

boolean

Wskazuje, czy kierowca akceptuje przejazdy z powrotem. Jeśli true, vehicles.search może obejmować 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 zleceń. Uwaga: pojazd może nadal działać w tym stanie podczas wykonywania przypisanej mu podróży.
ONLINE Pojazd przyjmuje nowe rezerwacje.

VehicleAttribute

Opisuje atrybut pojazdu jako parę 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ć dwukropka (:).
value

string

Wartość atrybutu.
Pole unii vehicle_attribute_value. Wartość atrybutu może być typu string, bool lub double. vehicle_attribute_value może być tylko jednym z tych elementów:
stringValue

string

Wartość atrybutu typu ciąg znaków.

Uwaga: to pole jest identyczne z polem value, które zostanie wycofane. W przypadku metod tworzenia lub aktualizowania możesz użyć dowolnego pola, ale zdecydowanie zalecamy użycie pola stringValue. Jeśli opcje stringValue i value są skonfigurowane, 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 podwójnego typu.

VehicleType

Typ pojazdu.

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

enum (Category)

Kategoria typu pojazdu

Kategoria

Kategorie typu pojazdu

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 Osoba poruszająca się pieszo lub biegnąca po ścieżce dla pieszych.

LicensePlate

Informacje o tablicy rejestracyjnej pojazdu. Aby uniknąć przechowywania informacji umożliwiających identyfikację, w ramach elementu są przechowywane tylko minimalne informacje o 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, którą ma przejechać pojazd;

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

object (VisualTrafficReportPolylineRendering)

Wyrenderowanie ścieżki wieloliniowej pokazujące, jak szybki jest ruch w poszczególnych regionach na jednym odcinku trasy 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. Odcinki nie mogą się nakładać i nie muszą obejmować całej trasy.

Jeśli nie ma odcinka drogi do stylizacji, klient powinien zastosować domyślny styl dla trasy.

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 do zastosowania.
offsetMeters

integer

Wymagane. Styl należy zastosować w miejscu [offsetMeters, offsetMeters + lengthMeters).
lengthMeters

integer

Wymagane. Długość ścieżki, na której ma być zastosowany styl.

Styl

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

Wartości w polu enum
STYLE_UNSPECIFIED Nie wybrano żadnego 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 Nieokreślony tryb oszczędzania energii
LOCATION_MODE_NO_CHANGE Oszczędzanie baterii nie powinno wpływać na dostawców lokalizacji lub powinno być wyłączone.
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 W przypadku włączonego trybu oszczędzania baterii i nieużywania urządzenia należy wyłączyć wszystkich dostawców danych o lokalizacji.
LOCATION_MODE_FOREGROUND_ONLY W dalszym ciągu będą dostępne wszystkie usługi lokalizacyjne, ale poprawki lokalizacji powinny być udostępniane tylko aplikacjom na pierwszym planie.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF Lokalizacja nie zostanie wyłączona, ale gdy urządzenie nie będzie interaktywne, LocationManager będzie ograniczać wszystkie żądania do dostawców.

BatteryInfo

informacje o baterii urządzenia;

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

enum (BatteryStatus)

stan baterii (czy jest w pełni naładowana, czy ładowana itp.);
powerSource

enum (PowerSource)

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

number

Bieżący procent naładowania baterii [0-100].

BatteryStatus

stan baterii (czy jest w pełni 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 Źródło zasilania nieznane.
POWER_SOURCE_AC Ź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 ponumerowane listy 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.