Method: providers.vehicles.list

सेवा देने वाली कंपनी से जुड़े वाहनों की पेज नंबर वाली सूची दिखाता है, जो अनुरोध के विकल्पों से मेल खाती है.

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

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

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

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

पैरामीटर
parent

string

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

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

पैरामीटर
header

object (RequestHeader)

स्टैंडर्ड फ़्लीट इंजन अनुरोध हेडर.
pageSize

integer

लौटाए जाने वाले वाहनों की ज़्यादा से ज़्यादा संख्या. डिफ़ॉल्ट वैल्यू: 100.
pageToken

string

vehicles.list को किए गए पिछले कॉल से nextPageToken की वैल्यू मिली है, ताकि आप वाहनों के ग्रुप को अलग-अलग नंबर से नंबर दे सकें. अगर अनुरोध और vehicles.list को किए गए पिछले कॉल की फ़िल्टर शर्तों के बीच अंतर है, तो वैल्यू के बारे में कोई जानकारी नहीं दी जाती.
minimumCapacity

integer

इससे पता चलता है कि वाहन की कम से कम कितनी क्षमता होनी चाहिए. लौटाए गए सभी वाहनों के लिए, इस वैल्यू से maximumCapacity ज़्यादा या इसके बराबर होना चाहिए. अगर यह नीति सेट है, तो यह 0 से ज़्यादा या इसके बराबर होनी चाहिए.
tripTypes[]

enum (TripType)

इस नीति से, उन वाहनों के लिए रिस्पॉन्स नहीं मिलता जो कम से कम किसी एक तरह की यात्रा से जुड़े हों.
maximumStaleness

string (Duration format)

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

सेकंड में अवधि, जिसमें नौ भिन्नात्मक अंक हो सकते हैं और जो 's' पर खत्म होती है. उदाहरण: "3.5s".
vehicleTypeCategories[]

enum (Category)

ज़रूरी है. किसी खास टाइप की कैटगरी वाले वाहनों के लिए रिस्पॉन्स को सीमित करता है. UNKNOWN की अनुमति नहीं है.
requiredAttributes[]

string

कॉलर requiredAttributes, requiredOneOfAttributes, और requiredOneOfAttributeSets फ़ील्ड के किसी भी कॉम्बिनेशन का इस्तेमाल करके, मुश्किल लॉजिकल ऑपरेशन बना सकते हैं.

requiredAttributes एक सूची है; requiredOneOfAttributes मैसेज का इस्तेमाल करता है, जिससे सूचियों की सूची बनाई जा सकती है. संयोजन में, दो फ़ील्ड इस एक्सप्रेशन की संरचना की अनुमति देते हैं:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

तय किए गए एट्रिब्यूट वाले वाहनों के लिए रिस्पॉन्स को सीमित करता है. यह फ़ील्ड एक संयोजी/और कार्रवाई है. ज़्यादा से ज़्यादा 50 requiredAttributes का इस्तेमाल किया जा सकता है. यह एट्रिब्यूट, वाहन में इस्तेमाल किए जा सकने वाले एट्रिब्यूट की संख्या से मेल खाता है. दोहराई गई हर स्ट्रिंग "key:value" फ़ॉर्मैट में होनी चाहिए.
requiredOneOfAttributes[]

string

इस नीति से, हर VehicleAttributeList में बताए गए कम से कम एक एट्रिब्यूट वाले वाहनों के लिए रिस्पॉन्स मिलता है. हर सूची में, वाहन कम से कम एक एट्रिब्यूट से मेल खाना चाहिए. यह फ़ील्ड, हर VehicleAttributeList में शामिल डिसजंक्शन/OR ऑपरेशन और VehicleAttributeList के पूरे कलेक्शन में होने वाली जोड़ी/AND कार्रवाई को शामिल करता है. दोहराई गई हर स्ट्रिंग "key1:value1|key2:value2|key3:value3" फ़ॉर्मैट में होनी चाहिए.
requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets अतिरिक्त सुविधाएं देता है.

requiredOneOfAttributes की तरह, requiredOneOfAttributeSets एक मैसेज का इस्तेमाल करता है, जो सूचियों की सूची बनाने की अनुमति देता है, जिससे इस तरह के एक्सप्रेशन की अनुमति मिलती है:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

इस नीति से, उन वाहनों के लिए रिस्पॉन्स नहीं मिलता जो VehicleAttributeList में सभी एट्रिब्यूट से मेल खाते हैं. हर सूची में मौजूद वाहन, सभी एट्रिब्यूट से मेल खाना चाहिए. यह फ़ील्ड, हर VehicleAttributeList में होने वाली जोड़ी/और कार्रवाई को कहते हैं. साथ ही, यह VehicleAttributeList के पूरे कलेक्शन में डिसजंक्शन/या की सभी कार्रवाइयों को शामिल करता है. दोहराई गई हर स्ट्रिंग "key1:value1|key2:value2|key3:value3" फ़ॉर्मैट में होनी चाहिए.
vehicleState

enum (VehicleState)

इस मोड में, ऐसे वाहनों के लिए रिस्पॉन्स नहीं दिया जा सकता.
onTripOnly

boolean

सिर्फ़ मौजूदा यात्रा(यात्राओं) के लिए वाहन वापस करें.
filter

string

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

यह फ़ील्ड requiredAttributes, requiredOneOfAttributes, और required_one_of_attributes_sets फ़ील्ड को बदलने के लिए डिज़ाइन किया गया है. अगर यहां ऐसी वैल्यू डाली गई है जो खाली नहीं है, तो ये फ़ील्ड खाली होने चाहिए: requiredAttributes, requiredOneOfAttributes, और required_one_of_attributes_sets.

यह फ़िल्टर, vehicleState या onTripOnly जैसी अन्य कंस्ट्रेंट के साथ एक AND क्लॉज़ के रूप में काम करता है.

ध्यान दें कि सिर्फ़ वाहन के एट्रिब्यूट (जैसे कि attributes.<key> = <value> या attributes.<key1> = <value1> AND attributes.<key2> = <value2>) के लिए की जाने वाली क्वेरी का इस्तेमाल किया जा सकता है. फ़िल्टर क्वेरी में ज़्यादा से ज़्यादा 50 पाबंदियां हो सकती हैं.

साथ ही, सभी एट्रिब्यूट, स्ट्रिंग के तौर पर सेव किए जाते हैं. इसलिए, एट्रिब्यूट के लिए सिर्फ़ स्ट्रिंग की तुलनाएं की जाती हैं. संख्या या बूलियन वैल्यू से तुलना करने के लिए, वैल्यू को साफ़ तौर पर स्ट्रिंग के तौर पर माना जाना चाहिए, जैसे कि attributes.<key> = "10" या attributes.<key> = "true".
viewport

object (Viewport)

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

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

vehicles.list जवाब मैसेज.

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

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

object (Vehicle)

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

string

यह टोकन, वाहनों की लिस्टिंग वाले पेज का नया पेज फ़ेच करता है. अगर अनुरोध की शर्तों को पूरा करने वाली कोई और गाड़ी नहीं है, तो इस टोकन को खाली छोड़ा जा सकता है.
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)

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