- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- จุดอ้างอิง
- VehicleMatchType
แสดงรายการยานพาหนะที่ตรงกับตัวเลือกคำขอ
คำขอ HTTP
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
parent |
ต้องระบุ ต้องอยู่ในรูปแบบ |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "header": { object ( |
ช่อง | |
---|---|
header |
ส่วนหัวของคำขอ Fleet Engine มาตรฐาน |
pickupPoint |
ต้องระบุ จุดรับสินค้าที่จะค้นหาใกล้ๆ |
dropoffPoint |
สถานที่ส่งของลูกค้าที่ต้องการ ต้องกรอกข้อมูลในช่องนี้หาก |
pickupRadiusMeters |
ต้องระบุ กำหนดรัศมีการค้นหารถรอบๆ จุดรับ ระบบจะแสดงเฉพาะยานพาหนะที่อยู่ในรัศมีการค้นหาเท่านั้น ค่าต้องอยู่ระหว่าง 400 ถึง 10,000 เมตร (รวม) |
count |
ต้องระบุ ระบุจำนวนสูงสุดของยานพาหนะที่จะส่งคืน ค่าต้องอยู่ระหว่าง 1 ถึง 50 (รวม) |
minimumCapacity |
ต้องระบุ ระบุจำนวนผู้โดยสารที่ต้องใช้ในการเดินทาง ค่าต้องมากกว่าหรือเท่ากับ 1 ไม่ได้พิจารณาคนขับในค่าความจุ |
tripTypes[] |
ต้องระบุ แสดงประเภทการเดินทางที่เสนอ ต้องมีเพียงประเภทเดียว ไม่อนุญาต |
maximumStaleness |
จำกัดการค้นหาเฉพาะยานพาหนะที่ส่งการอัปเดตตำแหน่งไปยัง Fleet Engine ภายในระยะเวลาที่กำหนด ยานพาหนะที่อยู่นิ่งที่ยังคงส่งข้อมูลตำแหน่งอยู่ไม่ถือว่าไม่มีอัปเดต หากไม่ได้ตั้งค่าช่องนี้ เซิร์ฟเวอร์จะใช้ 5 นาทีเป็นค่าเริ่มต้น ระยะเวลาเป็นวินาทีที่มีเลขเศษส่วนไม่เกิน 9 หลัก ลงท้ายด้วย " |
vehicleTypes[] |
ต้องระบุ จำกัดการค้นหาเฉพาะยานพาหนะที่มีหนึ่งในประเภทที่ระบุ ต้องระบุประเภทยานพาหนะอย่างน้อย 1 ประเภท ไม่อนุญาตให้ใช้ยานพาหนะประเภท |
requiredAttributes[] |
ผู้โทรจะสร้างการดำเนินการเชิงตรรกะที่ซับซ้อนได้โดยใช้การผสมช่อง
จำกัดการค้นหาเฉพาะยานพาหนะที่มีแอตทริบิวต์ที่ระบุ ช่องนี้เป็นการดำเนินการเชื่อม/และ มีแอตทริบิวต์ที่ต้องระบุได้สูงสุด 50 รายการ ซึ่งเท่ากับจำนวนแอตทริบิวต์สูงสุดที่อนุญาตในยานพาหนะ 1 คัน |
requiredOneOfAttributes[] |
จำกัดการค้นหาเฉพาะยานพาหนะที่มีแอตทริบิวต์ที่ระบุอย่างน้อย 1 รายการใน |
requiredOneOfAttributeSets[] |
เช่นเดียวกับ
จำกัดการค้นหาเฉพาะยานพาหนะที่มีแอตทริบิวต์ทั้งหมดใน |
orderBy |
ต้องระบุ ระบุเกณฑ์การจัดลำดับที่ต้องการสำหรับผลลัพธ์ |
includeBackToBack |
ข้อมูลนี้บ่งชี้ว่ายานพาหนะที่มีการเดินทางเพียงครั้งเดียวมีสิทธิ์สำหรับการค้นหานี้หรือไม่ ระบบจะใช้ช่องนี้เมื่อไม่ได้ระบุ ค่าเริ่มต้นคือ |
tripId |
ระบุการเดินทางที่เกี่ยวข้องกับ |
currentTripsPresent |
ข้อมูลนี้ระบุว่ายานพาหนะที่มีการเดินทางที่ใช้งานอยู่มีสิทธิ์ใช้การค้นหานี้หรือไม่ ต้องตั้งค่านี้เป็นอย่างอื่นที่ไม่ใช่ |
filter |
ไม่บังคับ ตัวกรองการค้นหาที่ใช้เมื่อค้นหายานพาหนะ ดูตัวอย่างไวยากรณ์ของตัวกรองได้ที่ http://aip.dev/160 ช่องนี้ออกแบบมาเพื่อแทนที่ช่อง ตัวกรองนี้จะทำหน้าที่เป็นคำสั่ง "และ" ที่มีข้อจำกัดอื่นๆ เช่น โปรดทราบว่าการค้นหาที่รองรับมีแค่ในแอตทริบิวต์ยานพาหนะเท่านั้น (เช่น นอกจากนี้ แอตทริบิวต์ทั้งหมดจะจัดเก็บเป็นสตริง ดังนั้นการเปรียบเทียบกับแอตทริบิวต์ที่รองรับจึงเป็นการเปรียบเทียบสตริงเท่านั้น ในการเปรียบเทียบกับตัวเลขหรือค่าบูลีน ค่าจะต้องได้รับการยกข้อความมาอย่างชัดเจนเพื่อให้ถือว่าเป็นสตริง (เช่น |
เนื้อหาการตอบกลับ
vehicles.search
ข้อความตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"matches": [
{
object ( |
ช่อง | |
---|---|
matches[] |
รายการยานพาหนะที่ตรงกับเกณฑ์ |
VehicleAttributeList
ประเภทข้อมูลของรายการสําหรับแอตทริบิวต์ยานพาหนะ
การแสดง JSON |
---|
{
"attributes": [
{
object ( |
ช่อง | |
---|---|
attributes[] |
รายการแอตทริบิวต์ในคอลเล็กชันนี้ |
VehicleMatchOrder
ระบุลำดับของยานพาหนะที่ตรงกันในการตอบกลับ
Enum | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
ค่าเริ่มต้น ใช้สำหรับลำดับการจับคู่ยานพาหนะที่ไม่ได้ระบุหรือไม่รู้จัก |
PICKUP_POINT_ETA |
ลำดับจากน้อยไปมากโดยใช้เวลาขับรถไปยังจุดรับสินค้า |
PICKUP_POINT_DISTANCE |
ลำดับจากน้อยไปมากตามระยะทางขับรถไปยังจุดรับสินค้า |
DROPOFF_POINT_ETA |
ลำดับจากน้อยไปมากตามเวลาในการขับยานพาหนะไปยังจุดส่ง ลำดับนี้จะใช้ได้เฉพาะเมื่อมีการระบุจุดส่งในคำขอเท่านั้น |
PICKUP_POINT_STRAIGHT_DISTANCE |
ลำดับจากน้อยไปมากตามระยะทางแบบเส้นตรงจากตำแหน่งที่รายงานล่าสุดของยานพาหนะไปยังจุดรับสินค้า |
COST |
เรียงลำดับจากน้อยไปมากตามค่าใช้จ่ายการจับคู่ที่กำหนดค่าไว้ การจับคู่ต้นทุนหมายถึงการคำนวณแบบถ่วงน้ำหนักระหว่างระยะทางเส้นตรงกับเวลาถึงโดยประมาณ น้ำหนักมีการตั้งค่าด้วยค่าเริ่มต้น และสามารถแก้ไขได้ต่อลูกค้า 1 ราย โปรดติดต่อทีมสนับสนุนของ Google หากจำเป็นต้องแก้ไขน้ำหนักเหล่านี้สำหรับโปรเจ็กต์ของคุณ |
CurrentTripsPresent
ระบุประเภทของข้อจำกัดในการเดินทางปัจจุบันของยานพาหนะ
Enum | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
ความพร้อมให้บริการของยานพาหนะที่มีการเดินทางจะอยู่ในบังคับของฟิลด์ includeBackToBack |
NONE |
ยานพาหนะที่ไม่มีการเดินทางอาจปรากฏในผลการค้นหา เมื่อใช้ค่านี้ includeBackToBack จะเป็น true ไม่ได้ |
ANY |
ยานพาหนะที่มีการเดินทางในปัจจุบันไม่เกิน 5 รายการและจุดอ้างอิง 10 แห่งจะรวมอยู่ในผลการค้นหา เมื่อใช้ค่านี้ includeBackToBack จะเป็น true ไม่ได้ |
VehicleMatch
มียานพาหนะและค่าประมาณที่เกี่ยวข้องของยานพาหนะที่ตรงกับจุดการเดินทางที่ใช้งานอยู่ของยานพาหนะ SearchVehiclesRequest
การแสดง JSON |
---|
{ "vehicle": { object ( |
ช่อง | |
---|---|
vehicle |
ต้องระบุ ยานพาหนะที่ตรงกับคำขอ |
vehiclePickupEta |
เวลาถึงโดยประมาณของรถที่จะขับไปยังจุดรับที่ระบุไว้ในคำขอ ค่าว่างหมายความว่าคำนวณเวลาถึงโดยประมาณของยานพาหนะไม่สำเร็จ หาก การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขที่เป็นเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: |
vehiclePickupDistanceMeters |
ระยะทางจากตำแหน่งปัจจุบันของยานพาหนะไปยังจุดรับสินค้าที่ระบุไว้ในคำขอ รวมถึงจุดรับของหรือจุดส่งของการเดินทางที่มีอยู่ ระยะทางนี้ประกอบไปด้วยระยะทางขับรถ (เส้นทาง) ที่คำนวณไว้ บวกกับระยะทางในแนวตรงระหว่างจุดสิ้นสุดของการนำทางและจุดรับคำขอที่ขอ (โดยทั่วไปจะมีระยะทางระหว่างจุดสิ้นสุดการนำทางและจุดรับสินค้าที่ขอมักจะน้อย) ค่าว่างหมายถึงเกิดข้อผิดพลาดในการคำนวณระยะทาง |
vehiclePickupStraightLineDistanceMeters |
ต้องระบุ ระยะทางในแนวตรงระหว่างยานพาหนะและจุดรับสินค้าที่ระบุไว้ในคำขอ |
vehicleDropoffEta |
เวลาถึงโดยประมาณในการขับขี่ยานพาหนะที่สมบูรณ์ไปยังจุดส่งที่ระบุไว้ในคำขอ เวลาถึงโดยประมาณรวมถึงการหยุดที่จุดอ้างอิงก่อนถึง การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขที่เป็นเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: |
vehiclePickupToDropoffDistanceMeters |
ระยะทางที่รถวิ่งได้ (หน่วยเป็นเมตร) จากจุดรับสินค้าถึงจุดส่งที่ระบุไว้ในคำขอ ระยะทางจะอยู่ระหว่าง 2 จุดเท่านั้น โดยไม่รวมตำแหน่งของยานพาหนะหรือจุดอื่นๆ ที่ต้องเข้าชมก่อนที่ยานพาหนะจะไปยังจุดรับสินค้าหรือจุดส่ง ระบบจะเติมค่าเมื่อมีการระบุ |
tripType |
ต้องระบุ ประเภทการเดินทางของคำขอที่ใช้ในการคำนวณเวลาถึงโดยประมาณไปยังจุดรับสินค้า |
vehicleTripsWaypoints[] |
รายการเรียงลำดับของจุดอ้างอิงที่ใช้ในการคำนวณ ETA รายการดังกล่าวรวมถึงตำแหน่งของยานพาหนะ จุดรับของการเดินทางที่ใช้งานอยู่สำหรับยานพาหนะ และจุดรับสินค้าที่ระบุไว้ในคำขอ รายการที่ว่างเปล่าแสดงว่าการคำนวณเวลาถึงโดยประมาณของรถล้มเหลว |
vehicleMatchType |
ประเภทยานพาหนะที่ตรงกัน |
requestedOrderedBy |
คำสั่งที่ขอในการจัดเรียงยานพาหนะที่ตรงกัน |
orderedBy |
คำสั่งซื้อจริงที่ใช้สำหรับยานพาหนะนี้ โดยปกติแล้ว ค่านี้จะตรงกับช่อง "orderBy" จากคำขอ แต่ในบางกรณี เช่น ข้อผิดพลาดภายในเซิร์ฟเวอร์ อาจมีการใช้วิธีการอื่น (เช่น |
จุดบอกทาง
อธิบายจุดกึ่งกลางตลอดเส้นทางสำหรับ VehicleMatch
ใน SearchVehiclesResponse
แนวคิดนี้จะแสดงเป็น TripWaypoint
ในปลายทางอื่นๆ ทั้งหมด
การแสดง JSON |
---|
{
"latLng": {
object ( |
ช่อง | |
---|---|
latLng |
ตำแหน่งของจุดอ้างอิงนี้ |
eta |
เวลาโดยประมาณที่ยานพาหนะจะมาถึงจุดอ้างอิงนี้ การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขที่เป็นเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: |
VehicleMatchType
ประเภทยานพาหนะที่ตรงกัน
Enum | |
---|---|
UNKNOWN |
ประเภทการจับคู่ยานพาหนะที่ไม่รู้จัก |
EXCLUSIVE |
ขณะนี้รถยังไม่มีการกำหนดการเดินทาง และสามารถไปยังจุดรับสินค้าได้ |
BACK_TO_BACK |
ขณะนี้มีการกำหนดยานพาหนะสำหรับการเดินทางแล้ว แต่สามารถไปยังจุดรับสินค้าได้หลังจากการเดินทางที่อยู่ระหว่างดำเนินการเสร็จสมบูรณ์แล้ว การคำนวณเวลาถึงโดยประมาณและระยะทางจะคำนึงถึงการเดินทางปัจจุบัน |
CARPOOL |
ยานพาหนะมีความจุเพียงพอสำหรับการเดินทางร่วมกัน |
CARPOOL_BACK_TO_BACK |
พาหนะจะสิ้นสุดการเดินทางปัจจุบันที่ใช้งานอยู่ก่อนที่จะไปยังจุดรับสินค้า การคำนวณเวลาถึงโดยประมาณและระยะทางจะคำนึงถึงการเดินทางปัจจุบัน |