Method: providers.vehicles.search

object (RequestHeader)

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

object (TerminalLocation)

ज़रूरी है. पिकअप पॉइंट के आस-पास खोजने के लिए.

object (TerminalLocation)

ग्राहक ने डिवाइस को कहां छोड़ना है. अगर tripTypes में TripType.SHARED शामिल है, तो इस फ़ील्ड को भरना ज़रूरी है.

integer

ज़रूरी है. यह पिकअप पॉइंट के आस-पास, वाहन खोजने के दायरे के बारे में बताता है. खोज के दायरे में आने वाले वाहन ही दिखाए जाएंगे. वैल्यू, 400 से 10,000 मीटर के बीच होनी चाहिए.

integer

ज़रूरी है. यह बताता है कि कितने वाहन दिखाने हैं. वैल्यू, 1 से 50 के बीच होनी चाहिए.

integer

ज़रूरी है. इससे किसी यात्रा के लिए, यात्रियों की संख्या का पता चलता है. वैल्यू, एक या उससे ज़्यादा होनी चाहिए. ड्राइवर को कपैसिटी की वैल्यू में शामिल नहीं किया जाता.

enum (TripType)

ज़रूरी है. यह सुझाई गई यात्रा के टाइप के बारे में बताता है. इसमें सिर्फ़ एक टाइप शामिल होना चाहिए. UNKNOWN_TRIP_TYPE की अनुमति नहीं है. इससे खोज सिर्फ़ उन वाहनों तक सीमित हो जाती है जो उस तरह की यात्रा के लिए उपलब्ध हैं.

string (Duration format)

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

सेकंड में कुल अवधि, जिसमें दशमलव के बाद नौ अंक हो सकते हैं. यह अवधि 's' पर खत्म होती है. उदाहरण: "3.5s".

object (VehicleType)

ज़रूरी है. यह विकल्प चुनने पर, खोज के नतीजों में सिर्फ़ उन वाहनों की जानकारी दिखती है जो बताए गए किसी एक टाइप के हैं. कम से कम एक तरह के वाहन की जानकारी देना ज़रूरी है. UNKNOWN कैटगरी वाली VehicleTypes की अनुमति नहीं है.

object (VehicleAttribute)

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

object (VehicleAttributeList)

यह खोज को सिर्फ़ उन वाहनों तक सीमित करता है जिनमें हर VehicleAttributeList में कम से कम एक एट्रिब्यूट मौजूद हो. हर सूची में, वाहन कम से कम एक एट्रिब्यूट से मैच करना चाहिए. यह फ़ील्ड, हर VehicleAttributeList में शामिल डिसजंक्शन/OR ऑपरेशन है. साथ ही, VehicleAttributeList के कलेक्शन में एक साथ होने वाले/AND ऑपरेशन है.

object (VehicleAttributeList)

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 ऑपरेशन है.

enum (VehicleMatchOrder)

ज़रूरी है. नतीजों के लिए, क्रम से लगाने की पसंदीदा शर्त तय करता है.

boolean

इससे पता चलता है कि एक ही सक्रिय यात्रा वाले वाहन, इस खोज के लिए ज़रूरी शर्तें पूरी करते हैं या नहीं. इस फ़ील्ड का इस्तेमाल सिर्फ़ तब किया जाता है, जब currentTripsPresent की जानकारी न दी गई हो. जब currentTripsPresent की वैल्यू सबमिट नहीं की जाती है और यह फ़ील्ड false पर सेट होता है, तो असाइन की गई यात्राओं वाले वाहनों को खोज के नतीजों से बाहर रखा जाता है. अगर currentTripsPresent की वैल्यू सबमिट नहीं की गई है और यह फ़ील्ड true है, तो खोज के नतीजों में ऐसे वाहन शामिल हो सकते हैं जिनकी एक चालू यात्रा है और जिनकी स्थिति ENROUTE_TO_DROPOFF है. currentTripsPresent की वैल्यू सबमिट करने पर, इस फ़ील्ड को 'सही है' पर सेट नहीं किया जा सकता.

डिफ़ॉल्ट वैल्यू false है.

string

इस SearchVehicleRequest से जुड़ी यात्रा के बारे में बताता है.

enum (CurrentTripsPresent)

इससे पता चलता है कि चालू यात्राएं करने वाले वाहन, इस खोज के लिए ज़रूरी शर्तें पूरी करते हैं या नहीं. अगर tripType में SHARED शामिल है, तो इसे CURRENT_TRIPS_PRESENT_UNSPECIFIED के बजाय किसी अन्य वैल्यू पर सेट किया जाना चाहिए.

string

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

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

यह फ़िल्टर, minimumCapacity या vehicleTypes जैसी अन्य शर्तों के साथ AND क्लॉज़ के तौर पर काम करता है.

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

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