Method: providers.deliveryVehicles.list

फ़िल्टर करने की तय शर्तों को पूरा करने वाले सभी DeliveryVehicle दिखाता है.

एचटीटीपी अनुरोध

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

यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. providers/{provider} फ़ॉर्मैट में होना चाहिए. provider, Google Cloud प्रोजेक्ट आईडी होना चाहिए. उदाहरण के लिए, sample-cloud-project.

क्वेरी पैरामीटर

पैरामीटर
header

object (DeliveryRequestHeader)

ज़रूरी नहीं. डिलीवरी एपीआई अनुरोध का स्टैंडर्ड हेडर.
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 रिस्पॉन्स मैसेज.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "deliveryVehicles": [
    {
      object (DeliveryVehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
फ़ील्ड
deliveryVehicles[]

object (DeliveryVehicle)

डिलीवरी की सुविधा देने वाले उन वाहनों का सेट जो अनुरोध किए गए फ़िल्टर करने की शर्तों को पूरा करते हैं. अगर कोई फ़िल्टर सेट नहीं किया गया है, तो अनुरोध करने पर डिलीवरी में शामिल सभी वाहनों को लौटाने का अनुरोध किया जाता है. सही जवाब देने वाले फ़ील्ड को भी खाली छोड़ा जा सकता है. कोई जवाब न मिलने का मतलब है कि डिलीवरी करने वाला कोई भी वाहन, अनुरोध किए गए फ़िल्टर की शर्तों को पूरा नहीं करता.
nextPageToken

string

नतीजों की सूची बनाना जारी रखने के लिए, इस टोकन को ListDeliveryVehiclesRequest में पास किया जा सकता है. जब सभी नतीजे दिखाए जाते हैं, तो जवाब में यह फ़ील्ड नहीं दिखेगा या यह एक खाली स्ट्रिंग होगी.
totalSize

string (int64 format)

सभी पेजों पर, अनुरोध की शर्तों के हिसाब से डिलीवरी करने वाले वाहनों की कुल संख्या.

व्यूपोर्ट

अक्षांश-देशांतर व्यूपोर्ट, जिसे 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 } }

जेएसओएन के काेड में दिखाना 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
फ़ील्ड
low

object (LatLng)

ज़रूरी है. व्यूपोर्ट का निचला पॉइंट.
high

object (LatLng)

ज़रूरी है. व्यूपोर्ट का उच्च बिंदु.