यह विकल्प, अनुरोध के विकल्पों से मेल खाने वाले वाहनों की सूची दिखाता है.
एचटीटीपी अनुरोध
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ के पैरामीटर
पैरामीटर | |
---|---|
parent |
ज़रूरी है. |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में इस तरह का डेटा शामिल होता है:
जेएसओएन के काेड में दिखाना |
---|
{ "header": { object ( |
फ़ील्ड | |
---|---|
header |
स्टैंडर्ड फ़्लीट इंजन अनुरोध हेडर. |
pickupPoint |
ज़रूरी है. आस-पास खोजने के लिए पिकअप की जगह. |
dropoffPoint |
ग्राहक जिस जगह से सामान छोड़ना चाहता है वह जगह. अगर |
pickupRadiusMeters |
ज़रूरी है. पिकअप पॉइंट के आस-पास वाहन की खोज का दायरा तय करता है. सिर्फ़ खोज के दायरे में आने वाले वाहन दिखेंगे. इसकी वैल्यू 400 और 10,000 मीटर (दोनों शामिल) के बीच होनी चाहिए. |
count |
ज़रूरी है. इससे यह पता चलता है कि ज़्यादा से ज़्यादा कितने वाहन लौटाए जा सकते हैं. वैल्यू 1 से 50 (दोनों शामिल) के बीच होनी चाहिए. |
minimumCapacity |
ज़रूरी है. उन यात्रियों की संख्या बताता है जिन्हें यात्रा के लिए चुना जा रहा है. वैल्यू, एक से ज़्यादा या उसके बराबर होनी चाहिए. ड्राइवर को क्षमता की वैल्यू में शामिल नहीं किया गया है. |
tripTypes[] |
ज़रूरी है. यह बताता है कि यात्रा किस तरह की है. सटीक रूप से एक प्रकार शामिल होना चाहिए. |
maximumStaleness |
इस सेटिंग से, सिर्फ़ उन वाहनों को खोजा जा सकता है जिन्होंने तय समय के दौरान, फ़्लीट इंजन को जगह की जानकारी के अपडेट भेजे हैं. स्टेशनरी वाहन जो अभी भी अपने स्थान को ट्रांसमिट कर रहे हैं उन्हें पुराना नहीं माना जाता. अगर यह फ़ील्ड सेट नहीं है, तो सर्वर डिफ़ॉल्ट वैल्यू के तौर पर पांच मिनट इस्तेमाल करता है. सेकंड में अवधि, जिसमें नौ भिन्नात्मक अंक हो सकते हैं और जो ' |
vehicleTypes[] |
ज़रूरी है. खोज को, इसी तरह के किसी एक टाइप के वाहनों तक सीमित करता है. कम से कम एक वाहन का टाइप बताना ज़रूरी है. |
requiredAttributes[] |
कॉलर
खोज को सिर्फ़ उन वाहनों तक सीमित करता है जिनके लिए खास एट्रिब्यूट होते हैं. यह फ़ील्ड एक संयोजी/और कार्रवाई है. ज़्यादा से ज़्यादा 50 requiredAttributes का इस्तेमाल किया जा सकता है. यह एट्रिब्यूट, वाहन में इस्तेमाल किए जा सकने वाले एट्रिब्यूट की संख्या से मेल खाता है. |
requiredOneOfAttributes[] |
खोज को सिर्फ़ उन वाहनों तक सीमित करता है जिनके हर |
requiredOneOfAttributeSets[] |
खोज को सिर्फ़ उन वाहनों तक सीमित करता है जिनमें |
orderBy |
ज़रूरी है. नतीजों के लिए मनचाहे क्रम की शर्त तय करता है. |
includeBackToBack |
इससे पता चलता है कि एक ही यात्रा वाले वाहन इस खोज में शामिल किए जा सकते हैं या नहीं. इस फ़ील्ड का इस्तेमाल सिर्फ़ तब किया जाता है, जब डिफ़ॉल्ट वैल्यू |
tripId |
इस |
currentTripsPresent |
इससे पता चलता है कि चालू यात्राओं वाले वाहन इस खोज में शामिल किए जा सकते हैं या नहीं. अगर |
filter |
ज़रूरी नहीं. वाहनों की खोज करते समय लागू की जाने वाली फ़िल्टर क्वेरी. फ़िल्टर सिंटैक्स के उदाहरणों के लिए, http://aip.dev/160 देखें. यह फ़ील्ड यह फ़िल्टर, ध्यान दें कि सिर्फ़ वाहन के एट्रिब्यूट (जैसे कि साथ ही, सभी एट्रिब्यूट, स्ट्रिंग के तौर पर सेव किए जाते हैं. इसलिए, एट्रिब्यूट के लिए सिर्फ़ स्ट्रिंग की तुलनाएं की जाती हैं. संख्या या बूलियन वैल्यू से तुलना करने के लिए, वैल्यू को साफ़ तौर पर स्ट्रिंग के तौर पर माना जाना चाहिए, जैसे कि |
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में SearchVehiclesResponse
का एक इंस्टेंस शामिल किया जाता है.