सेवा देने वाली कंपनी से जुड़े वाहनों की पेज नंबर वाली सूची दिखाता है, जो अनुरोध के विकल्पों से मेल खाती है.
एचटीटीपी अनुरोध
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ के पैरामीटर
पैरामीटर | |
---|---|
parent |
ज़रूरी है. |
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
header |
स्टैंडर्ड फ़्लीट इंजन अनुरोध हेडर. |
pageSize |
लौटाए जाने वाले वाहनों की ज़्यादा से ज़्यादा संख्या. डिफ़ॉल्ट वैल्यू: 100. |
pageToken |
|
minimumCapacity |
इससे पता चलता है कि वाहन की कम से कम कितनी क्षमता होनी चाहिए. लौटाए गए सभी वाहनों के लिए, इस वैल्यू से |
tripTypes[] |
इस नीति से, उन वाहनों के लिए रिस्पॉन्स नहीं मिलता जो कम से कम किसी एक तरह की यात्रा से जुड़े हों. |
maximumStaleness |
इस नीति से, उन वाहनों पर कार्रवाई करने की अनुमति नहीं मिलती जिन्होंने तय अवधि के दौरान, फ़्लीट इंजन को जगह की जानकारी के अपडेट भेजे हैं. स्टेशनरी वाहन जो अभी भी अपने स्थान को ट्रांसमिट कर रहे हैं उन्हें पुराना नहीं माना जाता. अगर यह मौजूद है, तो एक मान्य पॉज़िटिव अवधि होनी चाहिए. सेकंड में अवधि, जिसमें नौ भिन्नात्मक अंक हो सकते हैं और जो ' |
vehicleTypeCategories[] |
ज़रूरी है. किसी खास टाइप की कैटगरी वाले वाहनों के लिए रिस्पॉन्स को सीमित करता है. |
requiredAttributes[] |
कॉलर
तय किए गए एट्रिब्यूट वाले वाहनों के लिए रिस्पॉन्स को सीमित करता है. यह फ़ील्ड एक संयोजी/और कार्रवाई है. ज़्यादा से ज़्यादा 50 requiredAttributes का इस्तेमाल किया जा सकता है. यह एट्रिब्यूट, वाहन में इस्तेमाल किए जा सकने वाले एट्रिब्यूट की संख्या से मेल खाता है. दोहराई गई हर स्ट्रिंग "key:value" फ़ॉर्मैट में होनी चाहिए. |
requiredOneOfAttributes[] |
इस नीति से, हर |
requiredOneOfAttributeSets[] |
इस नीति से, उन वाहनों के लिए रिस्पॉन्स नहीं मिलता जो |
vehicleState |
इस मोड में, ऐसे वाहनों के लिए रिस्पॉन्स नहीं दिया जा सकता. |
onTripOnly |
सिर्फ़ मौजूदा यात्रा(यात्राओं) के लिए वाहन वापस करें. |
filter |
ज़रूरी नहीं. वाहनों की लिस्टिंग करते समय लागू की जाने वाली फ़िल्टर क्वेरी. फ़िल्टर सिंटैक्स के उदाहरणों के लिए, http://aip.dev/160 देखें. यह फ़ील्ड यह फ़िल्टर, ध्यान दें कि सिर्फ़ वाहन के एट्रिब्यूट (जैसे कि साथ ही, सभी एट्रिब्यूट, स्ट्रिंग के तौर पर सेव किए जाते हैं. इसलिए, एट्रिब्यूट के लिए सिर्फ़ स्ट्रिंग की तुलनाएं की जाती हैं. संख्या या बूलियन वैल्यू से तुलना करने के लिए, वैल्यू को साफ़ तौर पर स्ट्रिंग के तौर पर माना जाना चाहिए, जैसे कि |
viewport |
ज़रूरी नहीं. यह एक ऐसा फ़िल्टर है जो वाहनों को उन लोगों को ही दिखाता है जिनकी आखिरी जगह, व्यूपोर्ट की मदद से तय किए गए आयताकार इलाके में थी. |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
vehicles.list
जवाब मैसेज.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
जेएसओएन के काेड में दिखाना |
---|
{
"vehicles": [
{
object ( |
फ़ील्ड | |
---|---|
vehicles[] |
ऐसे वाहन जो अनुरोध में बताई गई शर्तों के मुताबिक हैं. अनुरोध में मौजूद |
nextPageToken |
यह टोकन, वाहनों की लिस्टिंग वाले पेज का नया पेज फ़ेच करता है. अगर अनुरोध की शर्तों को पूरा करने वाली कोई और गाड़ी नहीं है, तो इस टोकन को खाली छोड़ा जा सकता है. |
totalSize |
ज़रूरी है. सभी पेजों पर, अनुरोध की शर्तों से मेल खाने वाले वाहनों की कुल संख्या. |
व्यूपोर्ट
अक्षांश-देशांतर व्यूपोर्ट, जिसे 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
, दोनों में जानकारी अपने-आप भरी होनी चाहिए. साथ ही, दिखाया गया बॉक्स खाली नहीं छोड़ा जा सकता (जैसा कि ऊपर दी गई परिभाषाओं में बताया गया है). खाली व्यूपोर्ट से गड़बड़ी होगी.
उदाहरण के लिए, यह व्यूपोर्ट न्यूयॉर्क शहर को पूरी तरह से घेरता है:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
जेएसओएन के काेड में दिखाना |
---|
{ "low": { object ( |
फ़ील्ड | |
---|---|
low |
ज़रूरी है. व्यूपोर्ट का निचला पॉइंट. |
high |
ज़रूरी है. व्यूपोर्ट का उच्च बिंदु. |