แสดงรายการยานพาหนะที่มีเลขหน้าซึ่งเชื่อมโยงกับผู้ให้บริการที่ตรงกับตัวเลือกคำขอ
คำขอ HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
parent |
ต้องระบุ ต้องอยู่ในรูปแบบ |
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
header |
ส่วนหัวคำขอของ Fleet Engine มาตรฐาน |
page |
จำนวนยานพาหนะสูงสุดที่จะส่งคืน ค่าเริ่มต้นคือ 100 |
page |
ค่าของ |
minimum |
ระบุความจุขั้นต่ำที่จำเป็นของยานพาหนะ ยานพาหนะทั้งหมดที่แสดงผลจะมี |
trip |
จำกัดการตอบกลับให้แสดงเฉพาะยานพาหนะที่รองรับประเภทการเดินทางที่ระบุอย่างน้อย 1 ประเภท |
maximum |
จำกัดการตอบกลับไว้สำหรับยานพาหนะที่ส่งการอัปเดตตำแหน่งไปยัง Fleet Engine ภายในระยะเวลาที่ระบุ ยานพาหนะที่หยุดนิ่งแต่ยังส่งตำแหน่งอยู่จะไม่ถือว่าล้าสมัย หากมี ต้องเป็นระยะเวลาบวกที่ถูกต้อง ระยะเวลาเป็นวินาทีโดยมีเลขเศษส่วนไม่เกิน 9 หลัก ลงท้ายด้วย " |
vehicle |
ต้องระบุ จำกัดการตอบสนองให้แสดงเฉพาะยานพาหนะที่ตรงกับหมวดหมู่ประเภทใดประเภทหนึ่งตามที่ระบุ ไม่อนุญาต |
required |
ผู้เรียกใช้สามารถสร้างการดำเนินการเชิงตรรกะที่ซับซ้อนได้โดยใช้ช่อง
จำกัดการตอบสนองไปยังยานพาหนะที่มีแอตทริบิวต์ที่ระบุ ช่องนี้เป็นการดำเนินการแบบเชื่อม/AND ต้องระบุแอตทริบิวต์ที่จำเป็นสูงสุด 50 รายการ ซึ่งเท่ากับจำนวนแอตทริบิวต์สูงสุดที่อนุญาตในยานพาหนะ สตริงที่ซ้ำกันแต่ละรายการควรอยู่ในรูปแบบ "คีย์:ค่า" |
required |
จำกัดการตอบสนองต่อยานพาหนะที่มีแอตทริบิวต์ที่ระบุอย่างน้อย 1 รายการใน |
required |
จำกัดการตอบสนองต่อยานพาหนะที่ตรงกับแอตทริบิวต์ทั้งหมดใน |
vehicle |
จำกัดการตอบสนองไว้สำหรับยานพาหนะที่สถานะยานพาหนะเป็นค่านี้ |
on |
แสดงเฉพาะยานพาหนะที่อยู่ระหว่างการเดินทาง |
filter |
ไม่บังคับ คําค้นหาตัวกรองที่จะนำไปใช้เมื่อแสดงยานพาหนะ ดูตัวอย่างไวยากรณ์ตัวกรองได้ที่ http://aip.dev/160 ช่องนี้ออกแบบมาเพื่อแทนที่ช่อง ตัวกรองนี้ทำหน้าที่เป็นอนุประโยค "และ" ที่มีข้อจำกัดอื่นๆ เช่น โปรดทราบว่าการค้นหาที่รองรับมีเพียงแอตทริบิวต์ยานพาหนะ (เช่น นอกจากนี้ ระบบจะจัดเก็บแอตทริบิวต์ทั้งหมดเป็นสตริง ดังนั้นการเปรียบเทียบกับแอตทริบิวต์ที่รองรับได้คือ การเปรียบเทียบสตริงเท่านั้น หากต้องการเปรียบเทียบกับค่าตัวเลขหรือบูลีน ค่าดังกล่าวต้องใส่เครื่องหมายคำพูดอย่างชัดเจนเพื่อให้ระบบถือว่าเป็นสตริง (เช่น |
viewport |
ไม่บังคับ ตัวกรองที่จำกัดยานพาหนะที่แสดงผลไว้เฉพาะยานพาหนะที่ตำแหน่งสุดท้ายที่ทราบอยู่ในรูปสี่เหลี่ยมผืนผ้าที่วิวพอร์ตกำหนด |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
vehicles.list
ข้อความตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"vehicles": [
{
object ( |
ช่อง | |
---|---|
vehicles[] |
ยานพาหนะที่ตรงกับเกณฑ์ในคำขอ จำนวนยานพาหนะสูงสุดที่ส่งคืนได้กำหนดโดยช่อง |
next |
โทเค็นสำหรับดึงข้อมูลยานพาหนะหน้าถัดไป หรือว่างเปล่าหากไม่มียานพาหนะใดที่ตรงกับเกณฑ์คำขออีก |
total |
ต้องระบุ จำนวนยานพาหนะทั้งหมดที่ตรงกับเกณฑ์คำขอในทุกหน้า |
วิวพอร์ต
วิวพอร์ตละติจูด-ลองจิจูด ซึ่งแสดงเป็นเส้นทแยงมุม 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 |
ต้องระบุ จุดสูงของวิวพอร์ต |