REST Resource: providers.vehicles

ทรัพยากร: ยานพาหนะ

ข้อมูลเมตาของยานพาหนะ

การแสดง JSON 
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    object (VehicleLocation)
  },
  "pastLocations": [
    {
      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)
  }
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อที่ไม่ซ้ำกันสำหรับยานพาหนะนี้ รูปแบบคือ providers/{provider}/vehicles/{vehicle}
vehicleState

enum (VehicleState)

สถานะยานพาหนะ
supportedTripTypes[]

enum (TripType)

ประเภทการเดินทางที่ยานพาหนะนี้รองรับ
currentTrips[]

string

เอาต์พุตเท่านั้น รายการ tripId สำหรับการเดินทางที่กำหนดให้กับยานพาหนะนี้ในปัจจุบัน
lastLocation

object (VehicleLocation)

ตำแหน่งล่าสุดที่รายงานของยานพาหนะ
pastLocations[]

object (VehicleLocation)

อินพุตเท่านั้น ตำแหน่งที่ยานพาหนะคันนี้เคยอยู่ซึ่งยังไม่ได้รายงานไปยัง Fleet Engine ข้อมูลนี้ใช้ใน UpdateVehicleRequest เพื่อบันทึกตำแหน่งที่ก่อนหน้านี้ไม่สามารถส่งไปยังเซิร์ฟเวอร์ได้ ซึ่งมักเกิดขึ้นเมื่อรถไม่มีการเชื่อมต่ออินเทอร์เน็ต
maximumCapacity

integer

จำนวนผู้โดยสารทั้งหมดที่ยานพาหนะนี้บรรทุกได้ ระบบจะไม่พิจารณาคนขับในค่านี้ ค่านี้ต้องมากกว่าหรือเท่ากับ 1
attributes[]

object (VehicleAttribute)

รายการแอตทริบิวต์ของยานพาหนะ ยานพาหนะหนึ่งๆ มีแอตทริบิวต์ได้ไม่เกิน 100 รายการ และแอตทริบิวต์แต่ละรายการต้องมีคีย์ที่ไม่ซ้ำกัน
vehicleType

object (VehicleType)

ต้องระบุ ประเภทของยานพาหนะนี้ ใช้เพื่อกรองยานพาหนะในผลการค้นหา vehicles.search ได้ รวมถึงส่งผลต่อการคำนวณเวลาถึงโดยประมาณและเส้นทางด้วย
licensePlate

object (LicensePlate)

ข้อมูลป้ายทะเบียนของยานพาหนะ
route[]
(deprecated)

object (TerminalLocation)

เลิกใช้งานแล้ว: ให้ใช้ Vehicle.waypoints แทน
currentRouteSegment

string

เส้นประกอบที่ระบุเส้นทางที่แอปคนขับตั้งใจจะไปยังจุดสังเกตถัดไป ระบบจะแสดงรายการนี้ใน Trip.current_route_segment สำหรับการเดินทางที่ใช้งานอยู่ทั้งหมดซึ่งกำหนดให้กับยานพาหนะด้วย

หมายเหตุ: ช่องนี้มีไว้สำหรับ Driver SDK เท่านั้น ยังไม่รองรับการถอดรหัส
currentRouteSegmentTraffic

object (TrafficPolylineData)

อินพุตเท่านั้น ฟีเจอร์ Fleet Engine จะใช้ข้อมูลนี้เพื่อปรับปรุงการแชร์เส้นทาง หมายเหตุ: ช่องนี้มีไว้สำหรับ Driver SDK เท่านั้น
currentRouteSegmentVersion

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่ตั้งค่า currentRouteSegment ไคลเอ็นต์สามารถจัดเก็บและส่งในคำขอ vehicles.get ในอนาคตเพื่อป้องกันไม่ให้แสดงเส้นทางเดิมที่ไม่ได้เปลี่ยนแปลง

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่างเช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
currentRouteSegmentEndPoint

object (TripWaypoint)

จุดสังเกตที่ currentRouteSegment สิ้นสุด ซึ่งคนขับสามารถระบุในvehicles.update call ได้ทั้งเป็นจุดแวะพักตลอดการเดินทาง LatLng หรือเป็นLatLngสุดท้ายของcurrentRouteSegment จากนั้น Fleet Engine จะพยายามอย่างเต็มที่เพื่อหาค่าที่อยู่ระหว่างจุดแวะพักจริงหากไม่ได้ระบุไว้อย่างสมบูรณ์ ระบบจะไม่สนใจฟิลด์นี้ในการเรียกใช้ vehicles.update เว้นแต่จะมีการระบุ currentRouteSegment ด้วย
remainingDistanceMeters

integer

ระยะทางขับรถที่เหลือสำหรับ currentRouteSegment ระบบจะแสดงค่านี้ในสกุลเงิน Trip.remaining_distance_meters สำหรับการเดินทางที่ใช้งานอยู่ทั้งหมดซึ่งกำหนดให้กับยานพาหนะด้วย ระบบจะไม่ระบุค่าหากช่อง currentRouteSegment ว่างเปล่า
etaToFirstWaypoint

string (Timestamp format)

เวลาถึงจุดหมายโดยประมาณไปยังรายการแรกในช่อง waypoints ระบบจะไม่ระบุค่าหากช่อง waypoints หรือช่อง Vehicle.current_route_segment ว่างเปล่า

เมื่ออัปเดตยานพาหนะ remainingTimeSeconds จะมีความสำคัญเหนือกว่า etaToFirstWaypoint ในคำขอเดียวกัน

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่างเช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
remainingTimeSeconds

integer

อินพุตเท่านั้น เวลาขับรถที่เหลือสำหรับ currentRouteSegment ระบบจะไม่ระบุค่าหากช่อง waypoints หรือช่อง Vehicle.current_route_segment ว่างเปล่า ค่านี้ควรตรงกับ etaToFirstWaypoint - current_time หากทุกฝ่ายใช้นาฬิกาเดียวกัน

เมื่ออัปเดตยานพาหนะ remainingTimeSeconds จะมีความสำคัญเหนือกว่า etaToFirstWaypoint ในคำขอเดียวกัน
waypoints[]

object (TripWaypoint)

จุดแวะพักที่เหลือซึ่งกำหนดให้กับยานพาหนะนี้
waypointsVersion

string (Timestamp format)

เอาต์พุตเท่านั้น ครั้งล่าสุดที่มีการอัปเดตช่อง waypoints ไคลเอ็นต์ควรแคชค่านี้และส่งค่าใน GetVehicleRequest เพื่อให้ระบบแสดงผลช่อง waypoints เฉพาะในกรณีที่มีการอัปเดตเท่านั้น

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่างเช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
backToBackEnabled

boolean

บ่งบอกว่าคนขับยอมรับการเดินทางติดต่อกันหรือไม่ หากเป็น true vehicles.search อาจรวมยานพาหนะนั้นแม้ว่าจะกำหนดให้ยานพาหนะดังกล่าวอยู่ในการเดินทางอยู่ก็ตาม ค่าเริ่มต้นคือ false
navigationStatus

enum (NavigationStatus)

สถานะการนำทางของยานพาหนะ
deviceSettings

object (DeviceSettings)

อินพุตเท่านั้น ข้อมูลเกี่ยวกับการตั้งค่าในอุปกรณ์เคลื่อนที่ที่ผู้ขับขี่ใช้

VehicleState

สถานะของ Vehicle

Enum
UNKNOWN_VEHICLE_STATE ค่าเริ่มต้นที่ใช้สำหรับสถานะยานพาหนะที่ระบุหรือไม่รู้จัก
OFFLINE ยานพาหนะไม่รับการเดินทางใหม่ หมายเหตุ: ยานพาหนะอาจทำงานต่อไปในสถานะนี้ขณะทำการเดินทางที่ได้รับมอบหมายให้เสร็จสมบูรณ์
ONLINE ยานพาหนะรับคำขอเดินทางใหม่

VehicleAttribute

อธิบายแอตทริบิวต์ยานพาหนะเป็นคู่คีย์-ค่า ความยาวสตริง "คีย์:ค่า" ต้องไม่เกิน 256 อักขระ

การแสดง 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.
}
ช่อง
key

string

คีย์ของแอตทริบิวต์ คีย์ต้องไม่มีอักขระโคลอน (:)
value

string

ค่าของแอตทริบิวต์
ฟิลด์สหภาพ vehicle_attribute_value ค่าของแอตทริบิวต์อาจเป็นสตริง บูลีน หรือเลขทศนิยม vehicle_attribute_value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
stringValue

string

ค่าแอตทริบิวต์ที่เป็นสตริง

หมายเหตุ: ช่องนี้เหมือนกับช่อง value ซึ่งจะเลิกใช้งานในที่สุด สำหรับวิธีการสร้างหรืออัปเดต คุณจะใช้ช่องใดก็ได้ แต่เราขอแนะนำอย่างยิ่งให้ใช้ stringValue หากตั้งค่าทั้ง stringValue และ value ค่าทั้งสองต้องเหมือนกัน ไม่เช่นนั้นระบบจะแสดงข้อผิดพลาด ระบบจะป้อนข้อมูลในช่องทั้ง 2 ช่องในคำตอบ
boolValue

boolean

ค่าแอตทริบิวต์ประเภทบูลีน
numberValue

number

ค่าแอตทริบิวต์ประเภท Double

VehicleType

ประเภทยานพาหนะ

การแสดง JSON 
{
  "category": enum (Category)
}
ช่อง
category

enum (Category)

หมวดหมู่ประเภทยานพาหนะ

หมวดหมู่

หมวดหมู่ประเภทยานพาหนะ

Enum
UNKNOWN ค่าเริ่มต้นที่ใช้สำหรับหมวดหมู่ยานพาหนะที่ระบุหรือไม่รู้จัก
AUTO รถยนต์
TAXI ยานพาหนะที่ทำหน้าที่เป็นแท็กซี่ (โดยทั่วไปแล้วจะได้รับอนุญาตหรือควบคุมดูแล)
TRUCK โดยทั่วไปแล้วหมายถึงยานพาหนะที่มีพื้นที่เก็บสัมภาระขนาดใหญ่
TWO_WHEELER รถจักรยานยนต์ โมเพด หรือยานพาหนะ 2 ล้ออื่นๆ
BICYCLE ยานพาหนะที่ขับเคลื่อนด้วยคน
PEDESTRIAN ยานพาหนะขนส่งคน ซึ่งมักเดินหรือวิ่งไปตามทางเท้า

LicensePlate

ข้อมูลป้ายทะเบียนของยานพาหนะ ระบบจะจัดเก็บเฉพาะข้อมูลขั้นต่ำเกี่ยวกับป้ายทะเบียนไว้เป็นส่วนหนึ่งของเอนทิตีเพื่อหลีกเลี่ยงการจัดเก็บข้อมูลส่วนบุคคลที่ระบุตัวบุคคลนั้นได้

การแสดง JSON 
{
  "countryCode": string,
  "lastCharacter": string
}
ช่อง
countryCode

string

ต้องระบุ รหัสประเทศ/ภูมิภาค CLDR เช่น US สำหรับสหรัฐอเมริกา หรือ IN สำหรับอินเดีย
lastCharacter

string

ตัวเลขสุดท้ายของป้ายทะเบียนหรือ "-1" เพื่อระบุว่าไม่มีค่าตัวเลขในป้ายทะเบียน

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

TrafficPolylineData

สภาพการจราจรตามเส้นทางที่ยานพาหนะคาดว่าจะวิ่ง

การแสดง JSON 
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
ช่อง
trafficRendering

object (VisualTrafficReportPolylineRendering)

การแสดงผลเส้นประกอบของความเร็วการจราจรสำหรับทุกภูมิภาคตลอดเส้นทางการขับขี่ของลูกค้า

VisualTrafficReportPolylineRendering

อธิบายวิธีที่ไคลเอ็นต์ควรระบายสีส่วนหนึ่งของเส้นประกอบตามเส้นทาง

การแสดง JSON 
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
ช่อง
roadStretch[]

object (RoadStretch)

ไม่บังคับ ส่วนของถนนที่ควรแสดงผลตามเส้นประกอบ เราไม่รับประกันว่าช่วงจะไม่ทับซ้อนกัน และช่วงไม่จำเป็นต้องครอบคลุมทั้งเส้นทาง

หากไม่มีส่วนของถนนที่จะจัดสไตล์ ไคลเอ็นต์ควรใช้ค่าเริ่มต้นสำหรับเส้นทาง

RoadStretch

ถนน 1 เส้นที่ควรแสดงผล

การแสดง JSON 
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
ช่อง
style

enum (Style)

ต้องระบุ รูปแบบที่จะใช้
offsetMeters

integer

ต้องระบุ ควรใช้สไตล์ระหว่าง [offsetMeters, offsetMeters + lengthMeters)
lengthMeters

integer

ต้องระบุ ความยาวของเส้นทางที่จะใช้รูปแบบ

รูปแบบ

รูปแบบการจราจรที่แสดงความเร็วการจราจร

Enum
STYLE_UNSPECIFIED ไม่ได้เลือกรูปแบบ
SLOWER_TRAFFIC การจราจรเริ่มช้าลง
TRAFFIC_JAM มีการจราจรติดขัด

DeviceSettings

ข้อมูลเกี่ยวกับการตั้งค่าต่างๆ ในอุปกรณ์เคลื่อนที่

การแสดง JSON 
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
ช่อง
locationPowerSaveMode

enum (LocationPowerSaveMode)

การตั้งค่าลักษณะการทำงานของฟีเจอร์ตำแหน่งในอุปกรณ์เมื่อเปิดโหมดประหยัดแบตเตอรี่
isPowerSaveMode

boolean

ระบุว่าอุปกรณ์อยู่ในโหมดประหยัดพลังงานหรือไม่
isInteractive

boolean

ระบุว่าอุปกรณ์อยู่ในสถานะอินเทอร์แอกทีฟหรือไม่
batteryInfo

object (BatteryInfo)

ข้อมูลเกี่ยวกับสถานะแบตเตอรี่

LocationPowerSaveMode

การกำหนดค่าฟีเจอร์ตำแหน่งให้ทำงานในอุปกรณ์เคลื่อนที่เมื่อฟีเจอร์ "โหมดประหยัดแบตเตอรี่" ของอุปกรณ์เปิดอยู่ (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enum
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode ไม่ระบุ
LOCATION_MODE_NO_CHANGE ผู้ให้บริการตำแหน่งไม่ควรได้รับผลกระทบจากโหมดประหยัดแบตเตอรี่ หรือโหมดประหยัดแบตเตอรี่ปิดอยู่
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF คุณควรปิดใช้ผู้ให้บริการตำแหน่งที่อิงตาม GPS เมื่อโหมดประหยัดแบตเตอรี่เปิดอยู่และอุปกรณ์ไม่โต้ตอบ
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF คุณควรปิดใช้ผู้ให้บริการตำแหน่งทั้งหมดเมื่อโหมดประหยัดแบตเตอรี่เปิดอยู่และอุปกรณ์ไม่โต้ตอบ
LOCATION_MODE_FOREGROUND_ONLY ผู้ให้บริการตำแหน่งทั้งหมดจะยังคงใช้งานได้ แต่ควรระบุการแก้ไขตำแหน่งให้กับแอปที่ทำงานอยู่เบื้องหน้าเท่านั้น
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF ระบบจะไม่ปิดตำแหน่ง แต่ LocationManager จะจำกัดคำขอทั้งหมดไปยังผู้ให้บริการเมื่ออุปกรณ์ไม่โต้ตอบ

BatteryInfo

ข้อมูลเกี่ยวกับแบตเตอรี่ของอุปกรณ์

การแสดง JSON 
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
ช่อง
batteryStatus

enum (BatteryStatus)

สถานะของแบตเตอรี่ว่าเต็มหรือกำลังชาร์จอยู่ ฯลฯ
powerSource

enum (PowerSource)

สถานะแหล่งจ่ายไฟจากแบตเตอรี่
batteryPercentage

number

เปอร์เซ็นต์แบตเตอรี่ปัจจุบัน [0-100]

BatteryStatus

สถานะของแบตเตอรี่ว่าเต็มหรือกำลังชาร์จอยู่ ฯลฯ

Enum
UNKNOWN_BATTERY_STATUS ไม่ทราบสถานะแบตเตอรี่
BATTERY_STATUS_CHARGING กำลังชาร์จแบตเตอรี่
BATTERY_STATUS_DISCHARGING แบตเตอรี่กำลังคายประจุ
BATTERY_STATUS_FULL แบตเตอรี่เต็ม
BATTERY_STATUS_NOT_CHARGING แบตเตอรี่ไม่ชาร์จ
BATTERY_STATUS_POWER_LOW แบตเตอรี่เหลือน้อย

PowerSource

ประเภทที่ชาร์จที่ใช้ชาร์จแบตเตอรี่

Enum
UNKNOWN_POWER_SOURCE ไม่ทราบแหล่งจ่ายไฟ
POWER_SOURCE_AC แหล่งจ่ายไฟคือที่ชาร์จ AC
POWER_SOURCE_USB แหล่งจ่ายไฟคือพอร์ต USB
POWER_SOURCE_WIRELESS แหล่งจ่ายไฟเป็นแบบไร้สาย
POWER_SOURCE_UNPLUGGED ถอดแบตเตอรี่ออกแล้ว

เมธอด

create

 สร้างอินสแตนซ์ยานพาหนะใหม่ซึ่งเชื่อมโยงกับผู้ให้บริการขนส่งหรือร่วมเดินทางแบบออนดีมานด์

delete

 ลบยานพาหนะออกจากเครื่องมือจัดการฟลีต

get

 แสดงผลยานพาหนะจากเครื่องมือจัดการยานพาหนะ

list

 แสดงรายการยานพาหนะที่เชื่อมโยงกับผู้ให้บริการซึ่งตรงกับตัวเลือกคำขอแบบแบ่งหน้า
แสดงรายการยานพาหนะที่ตรงกับตัวเลือกคำขอ

update

 เขียนข้อมูลยานพาหนะที่อัปเดตแล้วลงใน Fleet Engine

updateAttributes

 อัปเดตแอตทริบิวต์ของยานพาหนะบางส่วน