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)

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

วิวพอร์ต

วิวพอร์ตละติจูด-ลองจิจูดที่แสดงเป็นจุด low และ high 2 จุดที่ตรงข้ามกันตามแนวทแยงมุม วิวพอร์ตถือเป็นภูมิภาคแบบปิด กล่าวคือ วิวพอร์ตจะมีขอบเขตของตัวเอง ขอบเขตละติจูดต้องอยู่ในช่วง -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)

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