Method: providers.vehicles.search

{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}

object (RequestHeader)

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

object (TerminalLocation)

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

object (TerminalLocation)

वह जगह जहां ग्राहक वापस आना चाहते हैं. अगर tripTypes में TripType.SHARED है, तो इस फ़ील्ड में वैल्यू डालना ज़रूरी है.

integer

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

integer

ज़रूरी है. इससे पता चलता है कि ज़्यादा से ज़्यादा कितने वाहन लौटाए जा सकते हैं. वैल्यू, 1 से 50 के बीच होनी चाहिए. इसमें ये दोनों भी शामिल हैं.

integer

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

enum (TripType)

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

string (Duration format)

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

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

object (VehicleType)

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

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.

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

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

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