REST Resource: providers.vehicles

{
  "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)
  }
}

string

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

enum (VehicleState)

สถานะของรถ

enum (TripType)

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

string

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

object (VehicleLocation)

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

integer

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

object (VehicleAttribute)

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

object (VehicleType)

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

object (LicensePlate)

ข้อมูลป้ายทะเบียนรถ

object (TerminalLocation)

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

string

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

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

object (TrafficPolylineData)

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

string (Timestamp format)

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

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

object (TripWaypoint)

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

integer

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

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"

integer

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

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

object (TripWaypoint)

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

string (Timestamp format)

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

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

boolean

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

enum (NavigationStatus)

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

object (DeviceSettings)

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

{
  "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.
}

string

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

string

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

string

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

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

boolean

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

number

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

{
  "category": enum (Category)
}

enum (Category)

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

{
  "countryCode": string,
  "lastCharacter": string
}

string

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

string

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

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

{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}

object (VisualTrafficReportPolylineRendering)

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

{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}

object (RoadStretch)

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

หากไม่มีถนนยืดตามรูปแบบ ลูกค้าควรใช้ค่าเริ่มต้นกับเส้นทาง

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

enum (Style)

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

integer

ต้องระบุ ควรใช้รูปแบบระหว่าง [offsetMeters, offsetMeters + lengthMeters)

integer

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

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

enum (LocationPowerSaveMode)

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

boolean

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

boolean

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

object (BatteryInfo)

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

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

enum (BatteryStatus)

สถานะของแบตเตอรี่ ไม่ว่าจะเต็มหรือชาร์จอยู่ เป็นต้น

enum (PowerSource)

สถานะของแหล่งพลังงานแบตเตอรี่

number

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