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
...)

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

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

ตัวอย่างเช่น วิดเจ็ตนี้แสดงภาพนิวยอร์กซิตี้โดยสมบูรณ์

{ "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)

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