แสดงรายการยานพาหนะที่ใส่เลขหน้าซึ่งเชื่อมโยงกับผู้ให้บริการที่ตรงกับตัวเลือกคำขอ
คำขอ HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
parent |
ต้องระบุ ต้องอยู่ในรูปแบบ |
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
header |
ส่วนหัวคำขอ Fleet Engine มาตรฐาน |
pageSize |
จำนวนสูงสุดของยานพาหนะที่จะส่งคืน ค่าเริ่มต้นคือ 100 |
pageToken |
ค่าของ |
minimumCapacity |
ระบุความจุขั้นต่ำที่กำหนดของยานพาหนะ ยานพาหนะทั้งหมดที่ส่งคืนจะมี |
tripTypes[] |
จำกัดการตอบสนองสำหรับยานพาหนะที่รองรับประเภทการเดินทางที่ระบุอย่างน้อย 1 ประเภท |
maximumStaleness |
จำกัดการตอบสนองสำหรับยานพาหนะที่ส่งการอัปเดตตำแหน่งไปยัง Fleet Engine ภายในระยะเวลาที่ระบุ ยานพาหนะที่อยู่นิ่งๆ ยังคงส่งข้อมูลตำแหน่งอยู่นั้นไม่ถือว่าเป็นข้อมูลเก่า หากมี ต้องเป็นระยะเวลาที่เป็นค่าบวกที่ถูกต้อง ระยะเวลาเป็นวินาทีโดยมีตัวเลขเศษส่วนไม่เกิน 9 หลัก ซึ่งลงท้ายด้วย " |
vehicleTypeCategories[] |
ต้องระบุ จำกัดการตอบสนองต่อยานพาหนะที่มีหมวดหมู่ประเภทที่ระบุอย่างใดอย่างหนึ่ง ไม่อนุญาต |
requiredAttributes[] |
ผู้โทรจะสร้างการดำเนินการเชิงตรรกะที่ซับซ้อนได้โดยใช้การรวมกันของช่อง
จำกัดการตอบสนองต่อยานพาหนะที่มีแอตทริบิวต์ที่ระบุ ช่องนี้เป็นการดำเนินการเชื่อม/และ อนุญาตให้มีแอตทริบิวต์ที่ต้องระบุได้สูงสุด 50 รายการ ค่านี้ตรงกับจำนวนแอตทริบิวต์สูงสุดที่อนุญาตในยานพาหนะ สตริงที่ซ้ำกันแต่ละรายการควรอยู่ในรูปแบบ "key:value" |
requiredOneOfAttributes[] |
จำกัดการตอบสนองต่อยานพาหนะที่มีแอตทริบิวต์ที่ระบุอย่างน้อย 1 รายการใน |
requiredOneOfAttributeSets[] |
คล้ายกับ
จำกัดการตอบสนองต่อยานพาหนะที่ตรงกับแอตทริบิวต์ทั้งหมดใน |
vehicleState |
จำกัดการตอบสนองสำหรับยานพาหนะที่มีสถานะยานพาหนะนี้ |
onTripOnly |
ส่งคืนเฉพาะยานพาหนะที่มีการเดินทางในปัจจุบันเท่านั้น |
filter |
ไม่บังคับ การค้นหาตามตัวกรองที่จะนำไปใช้เมื่อแสดงยานพาหนะ โปรดดู http://aip.dev/160 เพื่อดูตัวอย่างไวยากรณ์ของตัวกรอง ช่องนี้ออกแบบมาเพื่อแทนที่ช่อง ตัวกรองนี้ทำหน้าที่เป็นอนุประโยค "และ" ที่มีข้อจำกัดอื่นๆ เช่น โปรดทราบว่าระบบจะรองรับคำค้นหาเพียงรายการเดียวสำหรับแอตทริบิวต์ยานพาหนะ (เช่น นอกจากนี้ระบบจะจัดเก็บแอตทริบิวต์ทั้งหมดเป็นสตริง ดังนั้นการเปรียบเทียบกับแอตทริบิวต์ที่รองรับมีเพียงการเปรียบเทียบสตริงเท่านั้น ในการเปรียบเทียบกับตัวเลขหรือค่าบูลีน ค่าดังกล่าวจะต้องได้รับการยกมาแสดงอย่างชัดเจนเพื่อให้ถือว่าเป็นสตริง (เช่น |
viewport |
ไม่บังคับ ตัวกรองที่จำกัดการส่งคืนยานพาหนะที่ตำแหน่งสุดท้ายที่ทราบอยู่ในพื้นที่สี่เหลี่ยมผืนผ้าซึ่งกำหนดโดยวิวพอร์ต |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
vehicles.list
ข้อความตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"vehicles": [
{
object ( |
ช่อง | |
---|---|
vehicles[] |
ยานพาหนะที่ตรงกับเกณฑ์ในคำขอ จำนวนสูงสุดของยานพาหนะที่ส่งคืนจะกำหนดโดยช่อง |
nextPageToken |
โทเค็นสำหรับเรียกดูหน้าถัดไปของยานพาหนะ หรือเว้นว่างไว้หากไม่มียานพาหนะอื่นๆ ที่ตรงกับเกณฑ์คำขอ |
totalSize |
ต้องระบุ จำนวนยานพาหนะทั้งหมดที่ตรงกับเกณฑ์คำขอในทุกหน้า |
วิวพอร์ต
วิวพอร์ตละติจูด-ลองจิจูด ซึ่งแสดงในแนวทแยงมุม 2 จุดตรงข้ามกับจุด low
และ high
จุด วิวพอร์ตถือเป็นพื้นที่แบบปิด กล่าวคือ รวมขอบเขตไว้ด้วย ขอบเขตละติจูดต้องอยู่ในช่วง -90 ถึง 90 องศา และขอบเขตลองจิจูดต้องอยู่ในช่วง -180 ถึง 180 องศา หลายกรณี ได้แก่
หาก
low
=high
วิวพอร์ตจะประกอบด้วยจุดเดียวนั้นหาก
low.longitude
>high.longitude
ช่วงลองจิจูดจะกลับสี (วิวพอร์ตข้ามเส้นลองจิจูด 180 องศา)หาก
low.longitude
= -180 องศาและhigh.longitude
= 180 องศา วิวพอร์ตจะรวมลองจิจูดทั้งหมดหาก
low.longitude
= 180 องศา และhigh.longitude
= -180 องศา ช่วงลองจิจูดจะว่างเปล่าหากเป็น
low.latitude
>high.latitude
ช่วงละติจูดจะว่างเปล่า
ต้องระบุทั้ง low
และ high
และช่องที่นำเสนอต้องไม่ว่างเปล่า (ตามที่ระบุโดยคำจำกัดความด้านบน) วิวพอร์ตที่ว่างเปล่าจะทำให้เกิดข้อผิดพลาด
ตัวอย่างเช่น วิวพอร์ตนี้ปิดครอบคลุมนครนิวยอร์กทั้งหมด:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
การแสดง JSON |
---|
{ "low": { object ( |
ช่อง | |
---|---|
low |
ต้องระบุ จุดต่ำของวิวพอร์ต |
high |
ต้องระบุ จุดสูงของวิวพอร์ต |