REST Resource: providers.vehicles

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

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

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

string

เอาต์พุตเท่านั้น ชื่อเฉพาะของรถยนต์คันนี้ รูปแบบคือ providers/{provider}/vehicles/{vehicle}
vehicleState

enum (VehicleState)

สถานะของยานพาหนะ
supportedTripTypes[]

enum (TripType)

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

string

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

object (VehicleLocation)

ตำแหน่งที่รายงานล่าสุดของยานพาหนะ
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 ในอนาคตเพื่อป้องกันเส้นทางกลับที่ยังไม่ได้เปลี่ยนแปลง

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
currentRouteSegmentEndPoint

object (TripWaypoint)

จุดอ้างอิงที่ currentRouteSegment สิ้นสุด ผู้ให้บริการอาจจัดเตรียมข้อมูลไว้ให้เมื่อโทรกับ vehicles.update ทั้งที่เป็นจุดอ้างอิงแบบเต็มเที่ยว จุดอ้างอิง 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 ในคำขอเดียวกัน

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
remainingTimeSeconds

integer

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

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

object (TripWaypoint)

จุดอ้างอิงที่เหลือที่กำหนดให้กับรถคันนี้
waypointsVersion

string (Timestamp format)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
backToBackEnabled

boolean

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

enum (NavigationStatus)

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

object (DeviceSettings)

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

VehicleState

สถานะของ Vehicle

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

VehicleAttribute

อธิบายแอตทริบิวต์ยานพาหนะเป็นคู่คีย์-ค่า สตริง "key:value" ต้องไม่เกิน 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 รายการต้องเหมือนกัน ไม่เช่นนั้นระบบจะแสดงข้อผิดพลาด ระบบจะเติมข้อมูลให้กับทั้ง 2 ช่องในคำตอบ
boolValue

boolean

ค่าแอตทริบิวต์ที่พิมพ์ด้วยบูลีน
numberValue

number

ค่าแอตทริบิวต์แบบพิมพ์คู่

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

ถนนหนึ่งสายที่ควรจะแสดงผล

การแสดง 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

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

get

 ส่งคืนยานพาหนะจาก Fleet Engine

list

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

searchFuzzed
(deprecated)

 เลิกใช้งานแล้ว: ใช้ SearchVehicles แทน

update

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

updateAttributes

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

updateLocation
(deprecated)

 เลิกใช้งานแล้ว: ใช้เมธอด UpdateVehicle แทน