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)

ज़रूरी नहीं. Delivery API के अनुरोध का स्टैंडर्ड हेडर.
pageSize

integer

ज़रूरी नहीं. लौटाए जाने वाले वाहनों की ज़्यादा से ज़्यादा संख्या. हो सकता है कि सेवा इस संख्या से कम नतीजे दिखाए. अगर आप यह संख्या नहीं देते हैं, तो सर्वर यह तय करता है कि कितने नतीजे वापस करने हैं.
pageToken

string

ज़रूरी नहीं. पेज टोकन, जो पिछले deliveryVehicles.list कॉल से मिला था. अगला पेज देखने के लिए, आपको यह जानकारी देनी होगी.

पेज बनाते समय, deliveryVehicles.list के लिए दिए गए सभी अन्य पैरामीटर, उस कॉल से मेल खाने चाहिए जिसने पेज टोकन दिया था.
filter

string

ज़रूरी नहीं. डिलीवरी करने वाले वाहनों की सूची बनाते समय लागू करने के लिए फ़िल्टर क्वेरी. फ़िल्टर सिंटैक्स के उदाहरणों के लिए, http://aip.dev/160 देखें. अगर आपने कोई वैल्यू नहीं दी है या फ़िल्टर के लिए कोई खाली स्ट्रिंग दी है, तो सभी डिलीवरी वाहन दिखाए जाते हैं.

ध्यान दें कि सिर्फ़ वाहन के एट्रिब्यूट (जैसे कि attributes.<key> = <value> या attributes.<key1> = <value1> AND attributes.<key2> = <value2>) के लिए ही deliveryVehicles.list क्वेरी का इस्तेमाल किया जा सकता है. साथ ही, सभी एट्रिब्यूट को स्ट्रिंग के तौर पर सेव किया जाता है. इसलिए, एट्रिब्यूट के लिए सिर्फ़ स्ट्रिंग की तुलना की जा सकती है. संख्या या बूलियन वैल्यू से तुलना करने के लिए, वैल्यू को साफ़ तौर पर कोट किया जाना चाहिए, ताकि उन्हें स्ट्रिंग के तौर पर माना जाए. जैसे, 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": { "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)

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