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)

Fleet Engine के अनुरोध का स्टैंडर्ड हेडर.
pageSize

integer

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

string

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

integer

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

enum (TripType)

इस नीति से, ऐसे वाहनों पर रिस्पॉन्स नहीं दिया जाता जो किसी खास तरह की यात्रा के साथ काम करते हों.
maximumStaleness

string (Duration format)

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

सेकंड में एक अवधि, जिसमें ज़्यादा से ज़्यादा नौ दशमलव अंक होते हैं और जो '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
...)

यह विकल्प, तय किए गए एट्रिब्यूट वाले वाहनों के लिए ही जवाब दिखाता है. यह फ़ील्ड एक संयोजन/AND कार्रवाई है. ज़्यादा से ज़्यादा 50 ज़रूरी एट्रिब्यूट जोड़े जा सकते हैं. यह वाहन के लिए तय की गई ज़्यादा से ज़्यादा संख्या से मेल खाती है. दोहराई गई हर स्ट्रिंग, "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 में एक साथ होने वाली घटनाओं/AND ऑपरेशन और VehicleAttributeList के कलेक्शन में शामिल अलग-अलग घटनाओं/OR ऑपरेशन है. दोहराई गई हर स्ट्रिंग का फ़ॉर्मैट "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 जवाब का मैसेज.

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

JSON के काेड में दिखाना 
{
  "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, दोनों को पॉप्युलेट किया जाना चाहिए. साथ ही, ऊपर दी गई परिभाषाओं के मुताबिक, दिखाया गया बॉक्स खाली नहीं होना चाहिए. व्यूपोर्ट को खाली छोड़ने पर गड़बड़ी हो सकती है.

उदाहरण के लिए, यह व्यूपोर्ट न्यूयॉर्क शहर को पूरी तरह से घेरता है:

{ &quot;low&quot;: { &quot;latitude&quot;: 40.477398, &quot;longitude&quot;: -74.259087 }, &quot;high&quot;: { &quot;latitude&quot;: 40.91618, &quot;longitude&quot;: -73.70018 } }

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

object (LatLng)

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

object (LatLng)

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