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

nextPageToken की वैल्यू, vehicles.list को पिछली बार किए गए कॉल में दी गई है, ताकि आप वाहनों के ग्रुप पर नंबर डाल सकें. अगर अनुरोध का फ़िल्टर मानदंड, 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
...)

यह नीति, बताए गए एट्रिब्यूट वाले वाहनों पर ही रिस्पॉन्स देती है. यह फ़ील्ड एक संयोजन/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.

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

ध्यान दें कि सिर्फ़ वाहन के एट्रिब्यूट के लिए क्वेरी इस्तेमाल की जा सकती हैं, जैसे कि 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)

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