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