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 एक पाबंदी है.
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 पॉइंट के दो तिरछे तरीके से दिखाया गया है. व्यूपोर्ट को एक बंद क्षेत्र माना जाता है, यानी कि इसमें इसकी सीमा शामिल होती है. अक्षांश की सीमाएं -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": { "अक्षांश": 40.477398, "देशांतर": -74.259087 }, "high": { "अक्षांश": 40.91618, "देशांतर": -73.70018 } }

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

object (LatLng)

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

object (LatLng)

ज़रूरी है. व्यूपोर्ट का सबसे ऊपरी पॉइंट.