REST Resource: providers.vehicles

Sumber daya: Kendaraan

Metadata kendaraan.

Representasi 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)
  }
}
Kolom
name

string

Hanya output. Nama unik untuk kendaraan ini. Formatnya adalah providers/{provider}/vehicles/{vehicle}.

vehicleState

enum (VehicleState)

Status kendaraan.

supportedTripTypes[]

enum (TripType)

Jenis perjalanan yang didukung oleh kendaraan ini.

currentTrips[]

string

Hanya output. Daftar tripId untuk perjalanan yang saat ini ditetapkan ke kendaraan ini.

lastLocation

object (VehicleLocation)

Lokasi kendaraan yang terakhir dilaporkan.

maximumCapacity

integer

Jumlah total penumpang yang dapat dibawa kendaraan ini. Driver tidak dipertimbangkan dalam nilai ini. Nilai ini harus lebih besar dari atau sama dengan satu.

attributes[]

object (VehicleAttribute)

Daftar atribut kendaraan. Kendaraan dapat memiliki maksimal 100 atribut, dan setiap atribut harus memiliki kunci yang unik.

vehicleType

object (VehicleType)

Wajib diisi. Jenis kendaraan ini. Dapat digunakan untuk memfilter kendaraan di hasil vehicles.search. Juga memengaruhi PWT dan penghitungan rute.

licensePlate

object (LicensePlate)

Informasi pelat nomor untuk kendaraan.

route[]
(deprecated)

object (TerminalLocation)

Tidak digunakan lagi: Sebagai gantinya, gunakan Vehicle.waypoints.

currentRouteSegment

string

Polyline yang menetapkan rute yang akan diambil aplikasi pengemudi ke titik jalan berikutnya. Daftar ini juga ditampilkan dalam Trip.current_route_segment untuk semua perjalanan aktif yang ditetapkan untuk kendaraan.

Catatan: Kolom ini hanya ditujukan untuk digunakan oleh Driver SDK. Dekode belum didukung.

currentRouteSegmentTraffic

object (TrafficPolylineData)

Input saja. Fleet Engine menggunakan informasi ini untuk meningkatkan kualitas berbagi perjalanan. Catatan: Kolom ini hanya ditujukan untuk digunakan oleh Driver SDK.

currentRouteSegmentVersion

string (Timestamp format)

Hanya output. Waktu saat currentRouteSegment disetel. Data ini dapat disimpan oleh klien dan diteruskan dalam permintaan vehicles.get mendatang untuk mencegah rute yang kembali yang tidak berubah.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

currentRouteSegmentEndPoint

object (TripWaypoint)

Titik jalan tempat currentRouteSegment berakhir. Ini dapat diberikan oleh pengemudi pada panggilan vehicles.update sebagai titik jalan perjalanan penuh, titik jalan LatLng, atau sebagai LatLng terakhir dari currentRouteSegment. Fleet Engine kemudian akan melakukan yang terbaik untuk berinterpolasi dengan titik jalan sebenarnya jika tidak ditentukan sepenuhnya. Kolom ini diabaikan dalam panggilan vehicles.update kecuali jika currentRouteSegment juga ditentukan.

remainingDistanceMeters

integer

Jarak mengemudi yang tersisa untuk currentRouteSegment. Nilai ini juga ditampilkan dalam Trip.remaining_distance_meters untuk semua perjalanan aktif yang ditetapkan ke kendaraan. Nilai tidak ditentukan jika kolom currentRouteSegment kosong.

etaToFirstWaypoint

string (Timestamp format)

PWT ke entri pertama di kolom waypoints. Nilai tidak ditentukan jika kolom waypoints kosong atau kolom Vehicle.current_route_segment kosong.

Saat mengupdate kendaraan, remainingTimeSeconds akan lebih diprioritaskan daripada etaToFirstWaypoint dalam permintaan yang sama.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

remainingTimeSeconds

integer

Input saja. Sisa waktu mengemudi untuk currentRouteSegment. Nilai tidak ditentukan jika kolom waypoints kosong atau kolom Vehicle.current_route_segment kosong. Nilai ini harus cocok dengan etaToFirstWaypoint - current_time jika semua pihak menggunakan jam yang sama.

Saat mengupdate kendaraan, remainingTimeSeconds akan lebih diprioritaskan daripada etaToFirstWaypoint dalam permintaan yang sama.

waypoints[]

object (TripWaypoint)

Titik jalan yang tersisa yang ditetapkan untuk Kendaraan ini.

waypointsVersion

string (Timestamp format)

Hanya output. Terakhir kali kolom waypoints diperbarui. Klien harus menyimpan nilai ini dalam cache dan meneruskannya dalam GetVehicleRequest untuk memastikan kolom waypoints hanya ditampilkan jika diperbarui.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

backToBackEnabled

boolean

Menunjukkan apakah pengemudi menerima perjalanan bolak-balik. Jika true, vehicles.search dapat menyertakan kendaraan meskipun saat ini ditetapkan ke perjalanan. Nilai defaultnya adalah false.

navigationStatus

enum (NavigationStatus)

Status navigasi kendaraan.

deviceSettings

object (DeviceSettings)

Input saja. Informasi tentang setelan di perangkat seluler yang digunakan oleh pengemudi.

VehicleState

Status Vehicle.

Enum
UNKNOWN_VEHICLE_STATE Default, digunakan untuk status kendaraan yang tidak ditentukan atau tidak dikenal.
OFFLINE Kendaraan tidak menerima perjalanan baru. Catatan: kendaraan dapat terus beroperasi di negara bagian ini sambil menyelesaikan perjalanan yang ditetapkan untuknya.
ONLINE Kendaraan menerima perjalanan baru.

VehicleAttribute

Menjelaskan atribut kendaraan sebagai pasangan nilai kunci. "key:value" panjang string tidak boleh lebih dari 256 karakter.

Representasi 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.
}
Kolom
key

string

Kunci atribut. Kunci tidak boleh berisi karakter titik dua (:).

value

string

Nilai atribut.

Kolom union vehicle_attribute_value. Nilai atribut, dapat berupa string, bool, atau tipe ganda. vehicle_attribute_value hanya dapat berupa salah satu dari berikut:
stringValue

string

Nilai atribut berjenis string.

Catatan: Ini sama dengan kolom value yang pada akhirnya tidak akan digunakan lagi. Untuk metode pembuatan atau update, kedua kolom dapat digunakan, tetapi sangat direkomendasikan untuk menggunakan stringValue. Jika stringValue dan value ditetapkan, keduanya harus identik atau error akan ditampilkan. Kedua kolom diisi dalam respons.

boolValue

boolean

Nilai atribut yang diketik Boolean.

numberValue

number

Nilai atribut dengan jenis ganda.

VehicleType

Jenis kendaraan.

Representasi JSON
{
  "category": enum (Category)
}
Kolom
category

enum (Category)

Kategori jenis kendaraan

Kategori

Kategori jenis kendaraan

Enum
UNKNOWN Default, digunakan untuk kategori kendaraan yang tidak ditentukan atau tidak dikenal.
AUTO Mobil.
TAXI Kendaraan apa pun yang bertindak sebagai taksi (biasanya berlisensi atau diatur oleh hukum).
TRUCK Umumnya, kendaraan dengan kapasitas penyimpanan yang besar.
TWO_WHEELER Sepeda motor, moped, atau kendaraan roda dua lainnya
BICYCLE Transportasi yang ditenagai oleh manusia.
PEDESTRIAN Pengangkut manusia, biasanya berjalan atau berlari, yang berjalan di sepanjang jalur pejalan kaki.

LicensePlate

Informasi pelat nomor Kendaraan. Untuk menghindari penyimpanan informasi identitas pribadi, hanya informasi minimum tentang pelat nomor yang disimpan sebagai bagian dari entitas.

Representasi JSON
{
  "countryCode": string,
  "lastCharacter": string
}
Kolom
countryCode

string

Wajib diisi. Kode Negara/Wilayah CLDR. Misalnya, US untuk Amerika Serikat, atau IN untuk India.

lastCharacter

string

Angka terakhir pelat nomor atau "-1" untuk menunjukkan tidak ada nilai numerik pada pelat nomor kendaraan.

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

TrafficPolylineData

Kondisi lalu lintas di sepanjang rute kendaraan yang diperkirakan.

Representasi JSON
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
Kolom
trafficRendering

object (VisualTrafficReportPolylineRendering)

Rendering polyline yang menggambarkan kecepatan lalu lintas untuk semua region di sepanjang satu perjalanan pelanggan.

VisualTrafficReportPolylineRendering

Menjelaskan bagaimana klien harus mewarnai satu bagian polyline di sepanjang rute.

Representasi JSON
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
Kolom
roadStretch[]

object (RoadStretch)

Opsional. Jalan membentang yang harus dirender sepanjang polyline. Peregangan dijamin tidak akan tumpang tindih, dan tidak selalu mencakup rute penuh.

Jika tidak ada bentangan jalan untuk gaya, klien harus menerapkan default untuk rute.

RoadStretch

Satu bentangan jalan yang harus dirender.

Representasi JSON
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
Kolom
style

enum (Style)

Wajib diisi. Gaya yang akan diterapkan.

offsetMeters

integer

Wajib diisi. Gaya harus diterapkan antara [offsetMeters, offsetMeters + lengthMeters).

lengthMeters

integer

Wajib diisi. Panjang jalur tempat gaya akan diterapkan.

Gaya

Gaya lalu lintas, yang menunjukkan kecepatan lalu lintas.

Enum
STYLE_UNSPECIFIED Tidak ada gaya yang dipilih.
SLOWER_TRAFFIC Lalu lintas melambat.
TRAFFIC_JAM Terjadi kemacetan lalu lintas.

DeviceSettings

Informasi tentang berbagai setelan di perangkat seluler.

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

enum (LocationPowerSaveMode)

Cara fitur lokasi disetel untuk berperilaku di perangkat saat penghemat baterai aktif.

isPowerSaveMode

boolean

Apakah perangkat saat ini dalam mode hemat daya.

isInteractive

boolean

Apakah perangkat dalam status interaktif.

batteryInfo

object (BatteryInfo)

Informasi tentang status baterai.

LocationPowerSaveMode

Cara fitur lokasi dikonfigurasi untuk berperilaku di perangkat seluler saat perangkat "penghemat baterai" aktif. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enum
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode Tidak Ditentukan
LOCATION_MODE_NO_CHANGE Salah satu penyedia lokasi tidak seharusnya terpengaruh oleh penghemat baterai, atau penghemat baterai nonaktif.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Penyedia lokasi berbasis GPS harus dinonaktifkan saat penghemat baterai aktif dan perangkat tidak interaktif.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Semua penyedia lokasi harus dinonaktifkan saat penghemat baterai aktif dan perangkat tidak interaktif.
LOCATION_MODE_FOREGROUND_ONLY Semua penyedia lokasi akan tetap tersedia, tetapi perbaikan lokasi hanya boleh diberikan untuk aplikasi latar depan.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF Lokasi tidak akan dinonaktifkan, tetapi LocationManager akan men-throttle semua permintaan ke penyedia saat perangkat non-interaktif.

BatteryInfo

Informasi tentang baterai perangkat.

Representasi JSON
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
Kolom
batteryStatus

enum (BatteryStatus)

Status baterai, apakah penuh atau mengisi daya, dll.

powerSource

enum (PowerSource)

Status sumber daya baterai.

batteryPercentage

number

Persentase baterai saat ini [0-100].

BatteryStatus

Status baterai, apakah penuh atau mengisi daya, dll.

Enum
UNKNOWN_BATTERY_STATUS Status baterai tidak diketahui.
BATTERY_STATUS_CHARGING Baterai sedang diisi dayanya.
BATTERY_STATUS_DISCHARGING Daya baterai sedang habis.
BATTERY_STATUS_FULL Baterai penuh.
BATTERY_STATUS_NOT_CHARGING Baterai tidak mengisi daya.
BATTERY_STATUS_POWER_LOW Daya baterai lemah.

PowerSource

Jenis pengisi daya yang digunakan untuk mengisi daya baterai.

Enum
UNKNOWN_POWER_SOURCE Sumber listrik tidak diketahui.
POWER_SOURCE_AC Sumber daya adalah pengisi daya AC.
POWER_SOURCE_USB Sumber daya adalah port USB.
POWER_SOURCE_WIRELESS Sumber dayanya nirkabel.
POWER_SOURCE_UNPLUGGED Baterai dicabut.

Metode

create

Membuat instance kendaraan baru yang terkait dengan penyedia transportasi online atau pengiriman on-demand.

get

Menampilkan kendaraan dari Fleet Engine.

list

Menampilkan daftar kendaraan bernomor halaman yang terkait dengan penyedia yang cocok dengan opsi permintaan.
Menampilkan daftar kendaraan yang cocok dengan opsi permintaan.

update

Menulis data kendaraan yang diperbarui ke Fleet Engine.

updateAttributes

Memperbarui atribut kendaraan sebagian.