Method: providers.vehicles.list

แสดงรายการยานพาหนะที่ใส่เลขหน้าซึ่งเชื่อมโยงกับผู้ให้บริการที่ตรงกับตัวเลือกคำขอ

คำขอ HTTP

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
parent

string

ต้องระบุ ต้องอยู่ในรูปแบบ providers/{provider} ผู้ให้บริการต้องเป็นรหัสโปรเจ็กต์ (เช่น sample-cloud-project) ของโปรเจ็กต์ Google Cloud ที่บัญชีบริการที่ใช้การโทรนี้เป็นสมาชิก

พารามิเตอร์การค้นหา

พารามิเตอร์
header

object (RequestHeader)

ส่วนหัวคำขอ Fleet Engine มาตรฐาน
pageSize

integer

จำนวนสูงสุดของยานพาหนะที่จะส่งคืน ค่าเริ่มต้นคือ 100
pageToken

string

ค่าของ nextPageToken ที่ได้จากการเรียก vehicles.list ก่อนหน้านี้เพื่อให้คุณใส่เลขหน้าผ่านกลุ่มยานพาหนะได้ ค่านี้จะไม่มีการกำหนดหากเกณฑ์ตัวกรองของคำขอไม่ตรงกับเกณฑ์ตัวกรองสำหรับการเรียก vehicles.list ก่อนหน้านี้
minimumCapacity

integer

ระบุความจุขั้นต่ำที่กำหนดของยานพาหนะ ยานพาหนะทั้งหมดที่ส่งคืนจะมี maximumCapacity มากกว่าหรือเท่ากับค่านี้ หากกำหนดไว้ ค่าจะต้องมากกว่าหรือเท่ากับ 0
tripTypes[]

enum (TripType)

จำกัดการตอบสนองสำหรับยานพาหนะที่รองรับประเภทการเดินทางที่ระบุอย่างน้อย 1 ประเภท
maximumStaleness

string (Duration format)

จำกัดการตอบสนองสำหรับยานพาหนะที่ส่งการอัปเดตตำแหน่งไปยัง Fleet Engine ภายในระยะเวลาที่ระบุ ยานพาหนะที่อยู่นิ่งๆ ยังคงส่งข้อมูลตำแหน่งอยู่นั้นไม่ถือว่าเป็นข้อมูลเก่า หากมี ต้องเป็นระยะเวลาที่เป็นค่าบวกที่ถูกต้อง

ระยะเวลาเป็นวินาทีโดยมีตัวเลขเศษส่วนไม่เกิน 9 หลัก ซึ่งลงท้ายด้วย "s" เช่น "3.5s"
vehicleTypeCategories[]

enum (Category)

ต้องระบุ จำกัดการตอบสนองต่อยานพาหนะที่มีหมวดหมู่ประเภทที่ระบุอย่างใดอย่างหนึ่ง ไม่อนุญาต UNKNOWN
requiredAttributes[]

string

ผู้โทรจะสร้างการดำเนินการเชิงตรรกะที่ซับซ้อนได้โดยใช้การรวมกันของช่อง requiredAttributes, requiredOneOfAttributes และ requiredOneOfAttributeSets

requiredAttributes เป็นลิสต์ ส่วน requiredOneOfAttributes ใช้ข้อความที่อนุญาตลิสต์รายการ เมื่อใช้ร่วมกัน ฟิลด์สองฟิลด์จะช่วยให้สามารถเขียนนิพจน์นี้ได้

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

จำกัดการตอบสนองต่อยานพาหนะที่มีแอตทริบิวต์ที่ระบุ ช่องนี้เป็นการดำเนินการเชื่อม/และ อนุญาตให้มีแอตทริบิวต์ที่ต้องระบุได้สูงสุด 50 รายการ ค่านี้ตรงกับจำนวนแอตทริบิวต์สูงสุดที่อนุญาตในยานพาหนะ สตริงที่ซ้ำกันแต่ละรายการควรอยู่ในรูปแบบ "key:value"
requiredOneOfAttributes[]

string

จำกัดการตอบสนองต่อยานพาหนะที่มีแอตทริบิวต์ที่ระบุอย่างน้อย 1 รายการใน VehicleAttributeList แต่ละรายการ ยานพาหนะต้องตรงกับแอตทริบิวต์อย่างน้อย 1 รายการในแต่ละรายการ ช่องนี้เป็นการแยก/หรือการดำเนินการแบบเหมารวมในแต่ละ VehicleAttributeList และการดำเนินการเชื่อม/และในคอลเล็กชันของ VehicleAttributeList สตริงที่ซ้ำกันแต่ละรายการควรอยู่ในรูปแบบ "key1:value1|key2:value2|key3:value3"
requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets มีฟังก์ชันการทำงานเพิ่มเติม

คล้ายกับ requiredOneOfAttributes โดย requiredOneOfAttributeSets จะใช้ข้อความที่อนุญาตให้แสดงลิสต์รายการ โดยอนุญาตให้ใช้นิพจน์อย่างเช่นรายการนี้

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

จำกัดการตอบสนองต่อยานพาหนะที่ตรงกับแอตทริบิวต์ทั้งหมดใน VehicleAttributeList ยานพาหนะต้องตรงกับแอตทริบิวต์ทั้งหมดภายในแต่ละรายการ ช่องนี้เป็นการดำเนินการผนวก/และในแต่ละ VehicleAttributeList และการดำเนินงานแบบ Disjunction/OR ทั้งหมดในคอลเล็กชันของ VehicleAttributeList สตริงที่ซ้ำกันแต่ละรายการควรอยู่ในรูปแบบ "key1:value1|key2:value2|key3:value3"
vehicleState

enum (VehicleState)

จำกัดการตอบสนองสำหรับยานพาหนะที่มีสถานะยานพาหนะนี้
onTripOnly

boolean

ส่งคืนเฉพาะยานพาหนะที่มีการเดินทางในปัจจุบันเท่านั้น
filter

string

ไม่บังคับ การค้นหาตามตัวกรองที่จะนำไปใช้เมื่อแสดงยานพาหนะ โปรดดู http://aip.dev/160 เพื่อดูตัวอย่างไวยากรณ์ของตัวกรอง

ช่องนี้ออกแบบมาเพื่อแทนที่ช่อง requiredAttributes, requiredOneOfAttributes และ required_one_of_attributes_sets หากมีการระบุค่าที่ไม่ว่างเปล่าที่นี่ ช่องต่อไปนี้ต้องว่างเปล่า: requiredAttributes, requiredOneOfAttributes และ required_one_of_attributes_sets

ตัวกรองนี้ทำหน้าที่เป็นอนุประโยค "และ" ที่มีข้อจำกัดอื่นๆ เช่น vehicleState หรือ onTripOnly

โปรดทราบว่าระบบจะรองรับคำค้นหาเพียงรายการเดียวสำหรับแอตทริบิวต์ยานพาหนะ (เช่น attributes.<key> = <value> หรือ attributes.<key1> = <value1> AND attributes.<key2> = <value2>) จำนวนข้อจำกัดสูงสุดที่อนุญาตในการค้นหาตามตัวกรองคือ 50

นอกจากนี้ระบบจะจัดเก็บแอตทริบิวต์ทั้งหมดเป็นสตริง ดังนั้นการเปรียบเทียบกับแอตทริบิวต์ที่รองรับมีเพียงการเปรียบเทียบสตริงเท่านั้น ในการเปรียบเทียบกับตัวเลขหรือค่าบูลีน ค่าดังกล่าวจะต้องได้รับการยกมาแสดงอย่างชัดเจนเพื่อให้ถือว่าเป็นสตริง (เช่น attributes.<key> = "10" หรือ attributes.<key> = "true")
viewport

object (Viewport)

ไม่บังคับ ตัวกรองที่จำกัดการส่งคืนยานพาหนะที่ตำแหน่งสุดท้ายที่ทราบอยู่ในพื้นที่สี่เหลี่ยมผืนผ้าซึ่งกำหนดโดยวิวพอร์ต

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

vehicles.list ข้อความตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
ช่อง
vehicles[]

object (Vehicle)

ยานพาหนะที่ตรงกับเกณฑ์ในคำขอ จำนวนสูงสุดของยานพาหนะที่ส่งคืนจะกำหนดโดยช่อง pageSize ในคำขอ
nextPageToken

string

โทเค็นสำหรับเรียกดูหน้าถัดไปของยานพาหนะ หรือเว้นว่างไว้หากไม่มียานพาหนะอื่นๆ ที่ตรงกับเกณฑ์คำขอ
totalSize

string (int64 format)

ต้องระบุ จำนวนยานพาหนะทั้งหมดที่ตรงกับเกณฑ์คำขอในทุกหน้า

วิวพอร์ต

วิวพอร์ตละติจูด-ลองจิจูด ซึ่งแสดงในแนวทแยงมุม 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 (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
ช่อง
low

object (LatLng)

ต้องระบุ จุดต่ำของวิวพอร์ต
high

object (LatLng)

ต้องระบุ จุดสูงของวิวพอร์ต