Method: providers.deliveryVehicles.list

รับ DeliveryVehicle ทั้งหมดที่ตรงกับเกณฑ์การกรองที่ระบุ

คำขอ HTTP

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

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

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

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

string

ต้องระบุ ต้องอยู่ในรูปแบบ providers/{provider} provider ต้องเป็นรหัสโปรเจ็กต์ Google Cloud เช่น sample-cloud-project

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

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

object (DeliveryRequestHeader)

ไม่บังคับ ส่วนหัวของคำขอ Delivery API แบบมาตรฐาน
pageSize

integer

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

string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการโทร deliveryVehicles.list ก่อนหน้า คุณต้องระบุข้อมูลนี้เพื่อเรียกหน้าถัดไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ deliveryVehicles.list ต้องตรงกับการเรียกใช้ที่ระบุโทเค็นของหน้าเว็บ
filter

string

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

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

จำนวนข้อจำกัดสูงสุดที่อนุญาตในการค้นหาของตัวกรองคือ 50 ข้อจำกัดเป็นส่วนหนึ่งของการค้นหาในรูปแบบ attribute.<KEY> <COMPARATOR> <VALUE> ตัวอย่างเช่น attributes.foo = bar คือข้อจำกัด 1 รายการ
viewport

object (Viewport)

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

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

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

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

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

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

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

object (DeliveryVehicle)

ชุดยานพาหนะสำหรับนำส่งสินค้าที่ตรงตามเกณฑ์การกรองที่ขอ เมื่อไม่มีการระบุตัวกรอง คำขอจะแสดงยานพาหนะสำหรับนำส่งทั้งหมด หรือเว้นว่างไว้ก็ได้ การตอบกลับที่ว่างเปล่าบ่งชี้ว่าไม่พบยานพาหนะนำส่งที่ตรงตามเกณฑ์การกรองที่ขอ
nextPageToken

string

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

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