- คำขอ 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 มาตรฐาน |
pickup |
ต้องระบุ จุดรับสินค้าที่จะค้นหาใกล้ๆ |
dropoff |
สถานที่ส่งสินค้าที่ต้องการของลูกค้า ต้องระบุข้อมูลในช่องนี้หาก |
pickup |
ต้องระบุ กำหนดรัศมีการค้นหายานพาหนะรอบๆ จุดรับ ระบบจะแสดงเฉพาะยานพาหนะที่อยู่ในรัศมีการค้นหาเท่านั้น ค่าต้องอยู่ระหว่าง 400 ถึง 10,000 เมตร |
count |
ต้องระบุ ระบุจำนวนยานพาหนะสูงสุดที่จะส่งคืน ค่าต้องอยู่ระหว่าง 1 ถึง 50 (รวมเลขตัวแรกและตัวสุดท้าย) |
minimum |
ต้องระบุ ระบุจํานวนผู้โดยสารที่พิจารณาสําหรับการเดินทาง ค่าต้องมากกว่าหรือเท่ากับ 1 ระบบจะไม่พิจารณาคนขับในค่าความจุ |
trip |
ต้องระบุ แสดงประเภทการเดินทางที่เสนอ ต้องมีเพียงประเภทเดียว ไม่อนุญาต |
maximum |
จำกัดการค้นหาไว้เฉพาะยานพาหนะที่ส่งการอัปเดตตำแหน่งไปยัง Fleet Engine ภายในช่วงระยะเวลาที่ระบุ ยานพาหนะแบบอยู่กับที่ที่ยังคงส่งข้อมูลตำแหน่งอยู่ไม่ถือว่าล้าสมัย หากไม่ได้ตั้งค่าฟิลด์นี้ เซิร์ฟเวอร์จะใช้ 5 นาทีเป็นค่าเริ่มต้น ระยะเวลาเป็นวินาทีโดยมีเลขเศษส่วนไม่เกิน 9 หลัก ลงท้ายด้วย " |
vehicle |
ต้องระบุ จำกัดการค้นหาให้แสดงเฉพาะยานพาหนะที่อยู่ในประเภทที่ระบุ ต้องระบุประเภทยานพาหนะอย่างน้อย 1 ประเภท ไม่อนุญาตประเภทยานพาหนะที่มีหมวดหมู่เป็น |
required |
ผู้เรียกใช้สามารถสร้างการดำเนินการเชิงตรรกะที่ซับซ้อนได้โดยใช้ช่อง
จำกัดการค้นหาเฉพาะยานพาหนะที่มีแอตทริบิวต์ที่ระบุ ช่องนี้เป็นการดำเนินการแบบเชื่อม/AND ต้องระบุแอตทริบิวต์ที่จำเป็นสูงสุด 50 รายการ ซึ่งเท่ากับจำนวนแอตทริบิวต์สูงสุดที่อนุญาตในยานพาหนะ |
required |
จำกัดการค้นหาเฉพาะยานพาหนะที่มีแอตทริบิวต์ที่ระบุอย่างน้อย 1 รายการในแต่ละ |
required |
จำกัดการค้นหาเฉพาะยานพาหนะที่มีแอตทริบิวต์ทั้งหมดใน |
order |
ต้องระบุ ระบุเกณฑ์การจัดเรียงที่ต้องการสําหรับผลลัพธ์ |
include |
ข้อมูลนี้ระบุว่ายานพาหนะที่เดินทางอยู่ 1 เที่ยวมีสิทธิ์สำหรับการค้นหานี้หรือไม่ ช่องนี้จะใช้เมื่อไม่ได้ระบุ ค่าเริ่มต้นคือ |
trip |
ระบุการเดินทางที่เชื่อมโยงกับ |
current |
ข้อมูลนี้จะระบุว่ายานพาหนะที่มีการเดินทางที่ใช้งานอยู่มีสิทธิ์สำหรับการค้นหานี้หรือไม่ ค่านี้ต้องตั้งค่าเป็นอย่างอื่นที่ไม่ใช่ |
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 |
เรียงจากน้อยไปมากตามต้นทุนการจับคู่ที่กำหนดค่าไว้ ต้นทุนการจับคู่หมายถึงการคำนวณถ่วงน้ำหนักระหว่างระยะทางในเส้นตรงกับเวลาถึงโดยประมาณ น้ำหนักได้รับการกำหนดด้วยค่าเริ่มต้น และสามารถแก้ไขได้สำหรับลูกค้าแต่ละราย โปรดติดต่อทีมสนับสนุนของ Google หากจำเป็นต้องแก้ไขน้ำหนักเหล่านี้สำหรับโปรเจ็กต์ของคุณ |
CurrentTripsPresent
ระบุประเภทข้อจำกัดในการเดินทางปัจจุบันของยานพาหนะ
Enum | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
ความพร้อมให้บริการของยานพาหนะที่มีการเดินทางอยู่ในบังคับของฟิลด์ includeBackToBack |
NONE |
ยานพาหนะที่ไม่มีการเดินทางอาจปรากฏในผลการค้นหา เมื่อใช้ค่านี้ includeBackToBack จะเป็น true ไม่ได้ |
ANY |
ยานพาหนะที่อยู่ระหว่างการเดินทางอยู่ไม่เกิน 5 เที่ยวและมีจุดแวะพัก 10 จุดจะรวมอยู่ในผลการค้นหา เมื่อใช้ค่านี้ includeBackToBack จะเป็น true ไม่ได้ |
VehicleMatch
ประกอบด้วยยานพาหนะและค่าประมาณที่เกี่ยวข้องสำหรับยานพาหนะที่ตรงกับจุดการเดินทางที่ใช้งานอยู่ของยานพาหนะ SearchVehiclesRequest
การแสดง JSON |
---|
{ "vehicle": { object ( |
ช่อง | |
---|---|
vehicle |
ต้องระบุ ยานพาหนะที่ตรงกับคำขอ |
vehicle |
เวลาถึงโดยประมาณของยานพาหนะในการขับรถไปยังจุดรับที่ระบุในคำขอ ค่าว่างบ่งบอกว่าคำนวณเวลาถึงโดยประมาณสำหรับยานพาหนะไม่สำเร็จ หาก การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่างเช่น |
vehicle |
ระยะทางจากตําแหน่งปัจจุบันของรถไปยังจุดรับที่ระบุไว้ในคําขอ รวมถึงจุดรับหรือจุดส่งกลางคันสำหรับการเดินทางที่มีอยู่ ระยะทางนี้ประกอบด้วยระยะทางขับรถ (เส้นทาง) ที่คำนวณไว้ และระยะทางในเส้นตรงระหว่างจุดสิ้นสุดการนำทางและจุดรับที่ขอ (โดยปกติระยะห่างระหว่างจุดสิ้นสุดการนำทางกับจุดรับสินค้าที่ขอจะมีขนาดเล็ก) ค่าว่างหมายถึงข้อผิดพลาดในการคำนวณระยะทาง |
vehicle |
ต้องระบุ ระยะทางเป็นเส้นตรงระหว่างยานพาหนะกับจุดรับที่ระบุไว้ในคําขอ |
vehicle |
เวลาถึงโดยประมาณของยานพาหนะในการขับขี่ไปยังจุดส่งที่ระบุไว้ในคำขอ เวลาถึงโดยประมาณจะรวมการหยุดที่จุดอ้างอิงก่อน การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: |
vehicle |
ระยะทางที่รถวิ่งได้ (หน่วยเป็นเมตร) จากจุดรับถึงจุดส่งที่ระบุในคำขอ ระยะทางระหว่าง 2 จุดเท่านั้นและไม่รวมตำแหน่งยานพาหนะหรือจุดอื่นๆ ที่ต้องเข้าชมก่อนที่รถจะไปถึงจุดรับหรือจุดส่ง ระบบจะป้อนค่าก็ต่อเมื่อมีระบุ |
trip |
ต้องระบุ ประเภทการเดินทางของคำขอที่ใช้คำนวณเวลาถึงจุดรับ |
vehicle |
รายการจุดแวะพักตามลําดับที่ใช้คํานวณเวลาถึงโดยประมาณ รายการนี้ประกอบด้วยตำแหน่งของยานพาหนะ จุดรับของการเดินทางที่ดำเนินอยู่สำหรับยานพาหนะ และจุดรับที่ระบุไว้ในคำขอ รายการที่ว่างเปล่าหมายถึงการคำนวณเวลาถึงโดยประมาณสำหรับยานพาหนะล้มเหลว |
vehicle |
ประเภทการจับคู่ยานพาหนะ |
requested |
คำสั่งซื้อที่ขอในการจัดเรียงยานพาหนะที่ตรงกัน |
ordered |
คำสั่งซื้อจริงที่ใช้สำหรับยานพาหนะนี้ โดยปกติแล้วค่านี้จะตรงกับช่อง "orderBy" จากคำขอ แต่ในบางกรณี เช่น ข้อผิดพลาดของเซิร์ฟเวอร์ภายใน ระบบอาจใช้วิธีอื่น (เช่น |
จุดบอกทาง
อธิบายจุดกึ่งกลางระหว่างเส้นทางสำหรับ VehicleMatch
ใน SearchVehiclesResponse
แนวคิดนี้จะแสดงเป็น TripWaypoint
ในปลายทางอื่นๆ ทั้งหมด
การแสดง JSON |
---|
{
"latLng": {
object ( |
ช่อง | |
---|---|
lat |
ตำแหน่งของจุดอ้างอิงนี้ |
eta |
เวลาโดยประมาณที่รถจะมาถึงจุดอ้างอิงนี้ การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและทศนิยมสูงสุด 9 หลัก ตัวอย่าง: |
VehicleMatchType
ประเภทการจับคู่ยานพาหนะ
Enum | |
---|---|
UNKNOWN |
ประเภทการทำงานของคีย์เวิร์ดยานพาหนะที่ไม่รู้จัก |
EXCLUSIVE |
ตอนนี้รถยังไม่ได้กำหนดการเดินทางและไปยังจุดรับได้ |
BACK_TO_BACK |
ปัจจุบันมีการกำหนดยานพาหนะให้กับการเดินทาง แต่จะสามารถไปยังจุดรับได้หลังจากเดินทางอยู่ระหว่างดำเนินการเรียบร้อยแล้ว การคำนวณเวลาถึงโดยประมาณและระยะทางจะพิจารณาการเดินทางที่มีอยู่ |
CARPOOL |
ยานพาหนะมีความจุเพียงพอสำหรับการเดินทางที่ใช้ร่วมกัน |
CARPOOL_BACK_TO_BACK |
ยานพาหนะจะขับขี่ให้เสร็จสิ้นก่อนไปยังจุดรับ การคำนวณเวลาถึงโดยประมาณและระยะทางจะพิจารณาการเดินทางที่มีอยู่ |