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)

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