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

อธิบายแอตทริบิวต์ยานพาหนะเป็นคู่คีย์-ค่า "คีย์:ค่า" สตริงต้องมีความยาวไม่เกิน 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 ค่าของแอตทริบิวต์อาจเป็นสตริง บูลีน หรือประเภท Double vehicle_attribute_value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
stringValue

string

ค่าแอตทริบิวต์ที่พิมพ์โดยสตริง

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

ความยาวถนน 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 ตำแหน่งที่ไม่ได้กำหนด PowerSaveMode
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

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

update

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

updateAttributes

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