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 รายการในแต่ละรายการ ช่องนี้เป็นการดำเนินการ Disjunction/OR แบบรวมในแต่ละ VehicleAttributeList และการดำเนินการการรวม/AND ในคอลเล็กชันของ VehicleAttributeList สตริงที่ซ้ำแต่ละรายการควรอยู่ในรูปแบบ "key1:value1|key2:value2|key3:value3"
requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets มีฟังก์ชันเพิ่มเติม

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

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

ตัวอย่างเช่น วิวพอร์ตนี้ล้อมรอบนิวยอร์กซิตี้ทั้งหมด

{ &quot;low&quot;: { &quot;latitude&quot;: 40.477398, &quot;longitude&quot;: -74.259087 }, &quot;high&quot;: { &quot;latitude&quot;: 40.91618, &quot;longitude&quot;: -73.70018 } }

การแสดง JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
ช่อง
low

object (LatLng)

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

object (LatLng)

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