REST Resource: providers.vehicles

संसाधन: वाहन

वाहन का मेटाडेटा.

JSON के काेड में दिखाना 
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    object (VehicleLocation)
  },
  "pastLocations": [
    {
      object (VehicleLocation)
    }
  ],
  "maximumCapacity": integer,
  "attributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "vehicleType": {
    object (VehicleType)
  },
  "licensePlate": {
    object (LicensePlate)
  },
  "route": [
    {
      object (TerminalLocation)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentTraffic": {
    object (TrafficPolylineData)
  },
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeSeconds": integer,
  "waypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "waypointsVersion": string,
  "backToBackEnabled": boolean,
  "navigationStatus": enum (NavigationStatus),
  "deviceSettings": {
    object (DeviceSettings)
  }
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. इस वाहन का यूनीक नाम. फ़ॉर्मैट providers/{provider}/vehicles/{vehicle} है.
vehicleState

enum (VehicleState)

वाहन की स्थिति.
supportedTripTypes[]

enum (TripType)

इस वाहन से की जाने वाली यात्राओं के टाइप.
currentTrips[]

string

सिर्फ़ आउटपुट के लिए. इस वाहन को फ़िलहाल असाइन की गई यात्राओं के लिए tripId की सूची.
lastLocation

object (VehicleLocation)

वाहन की पिछली बार रिपोर्ट की गई जगह की जानकारी.
pastLocations[]

object (VehicleLocation)

सिर्फ़ इनपुट के लिए. ऐसी जगहें जहां यह वाहन पहले गया था, लेकिन जिनकी अब तक Fleet Engine को जानकारी नहीं दी गई है. इसका इस्तेमाल UpdateVehicleRequest में, उन जगहों को रिकॉर्ड करने के लिए किया जाता है जिन्हें पहले सर्वर पर नहीं भेजा जा सका था. आम तौर पर, ऐसा तब होता है, जब वाहन में इंटरनेट कनेक्शन न हो.
maximumCapacity

integer

इस वाहन में कुल कितने लोग सफ़र कर सकते हैं. इस वैल्यू में ड्राइवर को शामिल नहीं किया जाता. यह वैल्यू एक या उससे ज़्यादा होनी चाहिए.
attributes[]

object (VehicleAttribute)

वाहन के एट्रिब्यूट की सूची. किसी वाहन के लिए ज़्यादा से ज़्यादा 100 एट्रिब्यूट हो सकते हैं. साथ ही, हर एट्रिब्यूट के लिए एक यूनीक कुंजी होनी चाहिए.
vehicleType

object (VehicleType)

ज़रूरी है. यह वाहन किस तरह का है. इसका इस्तेमाल, vehicles.search के नतीजों में वाहनों को फ़िल्टर करने के लिए किया जा सकता है. इसका असर ईटीए और रास्ते के हिसाब से यात्रा में लगने वाले समय पर भी पड़ता है.
licensePlate

object (LicensePlate)

वाहन की लाइसेंस प्लेट की जानकारी.
route[]
(deprecated)

object (TerminalLocation)

बंद कर दिया गया है: इसके बजाय, Vehicle.waypoints का इस्तेमाल करें.
currentRouteSegment

string

पॉलीलाइन, जिससे यह पता चलता है कि ड्राइवर ऐप्लिकेशन अगले वेपॉइंट तक किस रास्ते से जाना चाहता है. यह सूची, वाहन को असाइन की गई सभी चालू यात्राओं के लिए Trip.current_route_segment में भी दिखती है.

ध्यान दें: इस फ़ील्ड का इस्तेमाल सिर्फ़ Driver SDK के लिए किया जाता है. फ़िलहाल, डिकोड करने की सुविधा उपलब्ध नहीं है.
currentRouteSegmentTraffic

object (TrafficPolylineData)

सिर्फ़ इनपुट के लिए. फ़्लीट इंजन, यात्रा की जानकारी शेयर करने की सुविधा को बेहतर बनाने के लिए इस जानकारी का इस्तेमाल करता है. ध्यान दें: इस फ़ील्ड का इस्तेमाल सिर्फ़ Driver SDK के लिए किया जाता है.
currentRouteSegmentVersion

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. currentRouteSegment सेट होने का समय. क्लाइंट इसे सेव कर सकता है और आने वाले समय में vehicles.get अनुरोधों में पास कर सकता है, ताकि बदले नहीं गए रास्तों को फिर से दिखाने से रोका जा सके.

आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़्ड होगा और इसमें 0, 3, 6 या 9 दशमलव अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
currentRouteSegmentEndPoint

object (TripWaypoint)

वह वेपॉइंट जहां currentRouteSegment खत्म होता है. vehicles.update कॉल पर ड्राइवर, इसे पूरी यात्रा के वेपॉइंट, वेपॉइंट LatLng या currentRouteSegment के आखिरी LatLng के तौर पर दे सकते हैं. अगर किसी वेपॉइंट की पूरी जानकारी नहीं दी गई है, तो फ़्लीट इंजन उसे सही वेपॉइंट में बदलने की पूरी कोशिश करेगा. vehicles.update कॉल में इस फ़ील्ड को तब तक अनदेखा किया जाता है, जब तक currentRouteSegment की वैल्यू भी नहीं दी जाती.
remainingDistanceMeters

integer

currentRouteSegment तक ड्राइव करके तय की जाने वाली बाकी दूरी. यह वैल्यू, वाहन को असाइन की गई सभी चालू यात्राओं के लिए Trip.remaining_distance_meters में भी दिखती है. अगर currentRouteSegment फ़ील्ड खाली है, तो वैल्यू नहीं दी गई है.
etaToFirstWaypoint

string (Timestamp format)

waypoints फ़ील्ड में पहली एंट्री के लिए ईटीए. अगर waypoints फ़ील्ड खाली है या Vehicle.current_route_segment फ़ील्ड खाली है, तो वैल्यू नहीं दी गई है.

वाहन की जानकारी अपडेट करते समय, एक ही अनुरोध में remainingTimeSeconds को etaToFirstWaypoint से प्राथमिकता दी जाती है.

आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़्ड होगा और इसमें 0, 3, 6 या 9 दशमलव अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
remainingTimeSeconds

integer

सिर्फ़ इनपुट के लिए. currentRouteSegment तक ड्राइव करके जाने में बचे हुए समय की जानकारी. अगर waypoints फ़ील्ड खाली है या Vehicle.current_route_segment फ़ील्ड खाली है, तो वैल्यू नहीं दी गई है. अगर सभी पक्ष एक ही घड़ी का इस्तेमाल कर रहे हैं, तो यह वैल्यू etaToFirstWaypoint - current_time से मेल खानी चाहिए.

वाहन की जानकारी अपडेट करते समय, एक ही अनुरोध में remainingTimeSeconds को etaToFirstWaypoint से प्राथमिकता दी जाती है.
waypoints[]

object (TripWaypoint)

इस वाहन के लिए असाइन किए गए बाकी वेपॉइंट.
waypointsVersion

string (Timestamp format)

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

आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़्ड होगा और इसमें 0, 3, 6 या 9 दशमलव अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
backToBackEnabled

boolean

इससे पता चलता है कि ड्राइवर एक के बाद एक राइड स्वीकार करता है या नहीं. अगर true, vehicles.search में वाहन को शामिल किया जाता है, तो भले ही वह फ़िलहाल किसी यात्रा के लिए असाइन किया गया हो. डिफ़ॉल्ट वैल्यू false है.
navigationStatus

enum (NavigationStatus)

वाहन के नेविगेशन की स्थिति.
deviceSettings

object (DeviceSettings)

सिर्फ़ इनपुट के लिए. ड्राइवर के इस्तेमाल किए जा रहे मोबाइल डिवाइस की सेटिंग की जानकारी.

VehicleState

Vehicle की स्थिति.

Enums
UNKNOWN_VEHICLE_STATE डिफ़ॉल्ट, इसका इस्तेमाल वाहन की ऐसी स्थितियों के लिए किया जाता है जिनके बारे में नहीं बताया गया है या जिनकी पहचान नहीं की जा सकती.
OFFLINE वाहन से नई यात्राएं बुक नहीं की जा रही हैं. ध्यान दें: असाइन की गई यात्रा पूरी करते समय, वाहन इस स्थिति में काम करना जारी रख सकता है.
ONLINE वाहन से नई यात्राएं बुक की जा रही हों.

VehicleAttribute

वाहन के एट्रिब्यूट की जानकारी, की-वैल्यू पेयर के तौर पर देता है. "key:value" स्ट्रिंग की लंबाई 256 से ज़्यादा वर्ण नहीं हो सकती.

JSON के काेड में दिखाना 
{
  "key": string,
  "value": string,

  // Union field vehicle_attribute_value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field vehicle_attribute_value.
}
फ़ील्ड
key

string

एट्रिब्यूट की कुंजी. बटन में कोलन वर्ण (:) नहीं हो सकता.
value

string

एट्रिब्यूट की वैल्यू.
यूनियन फ़ील्ड vehicle_attribute_value. एट्रिब्यूट की वैल्यू, स्ट्रिंग, बूल या डबल टाइप में हो सकती है. vehicle_attribute_value इनमें से कोई एक हो सकता है:
stringValue

string

स्ट्रिंग टाइप की गई एट्रिब्यूट वैल्यू.

ध्यान दें: यह value फ़ील्ड जैसा ही है. इसे बाद में बंद कर दिया जाएगा. बनाने या अपडेट करने के तरीकों के लिए, दोनों फ़ील्ड का इस्तेमाल किया जा सकता है. हालांकि, हमारा सुझाव है कि stringValue का इस्तेमाल करें. अगर stringValue और value, दोनों सेट हैं, तो वे एक जैसे होने चाहिए. ऐसा न होने पर, गड़बड़ी का मैसेज दिखेगा. जवाबों में, दोनों फ़ील्ड अपने-आप पॉप्युलेट हो जाते हैं.
boolValue

boolean

बूलियन टाइप की एट्रिब्यूट वैल्यू.
numberValue

number

डबल टाइप की एट्रिब्यूट वैल्यू.

VehicleType

वाहन का टाइप.

JSON के काेड में दिखाना 
{
  "category": enum (Category)
}
फ़ील्ड
category

enum (Category)

वाहन के टाइप की कैटगरी

कैटगरी

वाहन के टाइप की कैटगरी

Enums
UNKNOWN डिफ़ॉल्ट, इसका इस्तेमाल उन वाहनों की कैटगरी के लिए किया जाता है जिनके बारे में जानकारी नहीं दी गई है या जिनकी पहचान नहीं की जा सकी है.
AUTO कोई वाहन.
TAXI ऐसा कोई भी वाहन जो टैक्सी के तौर पर काम करता है. आम तौर पर, ऐसे वाहनों के लिए लाइसेंस लेना ज़रूरी होता है या उन पर नियम-कानून लागू होते हैं.
TRUCK आम तौर पर, ऐसा वाहन जिसमें स्टोरेज की क्षमता ज़्यादा होती है.
TWO_WHEELER मोटरसाइकल, मोपेड या अन्य दोपहिया वाहन
BICYCLE मानव-शक्ति से चलने वाली गाड़ियां.
PEDESTRIAN पैदल चलने या दौड़ने वाला कोई व्यक्ति, जो आम तौर पर पैदल चलने के रास्तों पर यात्रा कर रहा हो.

LicensePlate

वाहन की लाइसेंस प्लेट की जानकारी. व्यक्तिगत पहचान से जुड़ी जानकारी को सेव करने से बचने के लिए, इकाई के हिस्से के तौर पर लाइसेंस प्लेट की सिर्फ़ कम से कम जानकारी सेव की जाती है.

JSON के काेड में दिखाना 
{
  "countryCode": string,
  "lastCharacter": string
}
फ़ील्ड
countryCode

string

ज़रूरी है. देश/इलाके का CLDR कोड. उदाहरण के लिए, अमेरिका के लिए US या भारत के लिए IN.
lastCharacter

string

लाइसेंस प्लेट का आखिरी अंक या "-1", जिसका मतलब है कि लाइसेंस प्लेट में कोई अंक नहीं है.

  • "ABC 1234" -> "4"
  • "AB 123 CD" -> "3"
  • "ABCDEF" -> "-1"

TrafficPolylineData

वाहन के अनुमानित रास्ते पर ट्रैफ़िक की स्थिति.

JSON के काेड में दिखाना 
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
फ़ील्ड
trafficRendering

object (VisualTrafficReportPolylineRendering)

ग्राहक की यात्रा के एक हिस्से में, सभी इलाकों में ट्रैफ़िक की रफ़्तार दिखाने वाली पॉलीलाइन रेंडरिंग.

VisualTrafficReportPolylineRendering

इससे पता चलता है कि क्लाइंट को रूट के साथ-साथ पॉलीलाइन के किसी हिस्से को किस तरह रंगना चाहिए.

JSON के काेड में दिखाना 
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
फ़ील्ड
roadStretch[]

object (RoadStretch)

ज़रूरी नहीं. सड़क के ऐसे हिस्से जिन्हें पॉलीलाइन के साथ रेंडर करना है. यह पक्का किया जाता है कि स्ट्रेच ओवरलैप न हों. हालांकि, यह ज़रूरी नहीं है कि वे पूरे रास्ते पर हों.

अगर सड़क के किसी हिस्से को स्टाइल करने के लिए कोई वैल्यू नहीं दी गई है, तो क्लाइंट को रूट के लिए डिफ़ॉल्ट वैल्यू लागू करनी चाहिए.

RoadStretch

सड़क का एक हिस्सा, जिसे रेंडर करना है.

JSON के काेड में दिखाना 
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
फ़ील्ड
style

enum (Style)

ज़रूरी है. लागू किया जाने वाला स्टाइल.
offsetMeters

integer

ज़रूरी है. स्टाइल, [offsetMeters, offsetMeters + lengthMeters) के बीच लागू किया जाना चाहिए.
lengthMeters

integer

ज़रूरी है. उस पाथ की लंबाई जहां स्टाइल लागू करना है.

स्टाइल

ट्रैफ़िक का स्टाइल, जो ट्रैफ़िक की स्पीड दिखाता है.

Enums
STYLE_UNSPECIFIED कोई स्टाइल नहीं चुना गया.
SLOWER_TRAFFIC ट्रैफ़िक कम हो रहा है.
TRAFFIC_JAM ट्रैफ़िक जाम है.

DeviceSettings

मोबाइल डिवाइस पर मौजूद अलग-अलग सेटिंग के बारे में जानकारी.

JSON के काेड में दिखाना 
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
फ़ील्ड
locationPowerSaveMode

enum (LocationPowerSaveMode)

बैटरी सेवर मोड चालू होने पर, जगह की जानकारी की सुविधाएं डिवाइस पर कैसे काम करती हैं.
isPowerSaveMode

boolean

डिवाइस फ़िलहाल पावर सेव मोड में है या नहीं.
isInteractive

boolean

डिवाइस, इंटरैक्टिव मोड में है या नहीं.
batteryInfo

object (BatteryInfo)

बैटरी की स्थिति के बारे में जानकारी.

LocationPowerSaveMode

जब डिवाइसों पर "बैटरी सेवर" मोड चालू होता है, तो जगह की जानकारी की सुविधाओं को मोबाइल डिवाइस पर कैसे कॉन्फ़िगर किया जाता है. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enums
UNKNOWN_LOCATION_POWER_SAVE_MODE Undefined LocationPowerSaveMode
LOCATION_MODE_NO_CHANGE जगह की जानकारी देने वाली सेवाओं पर, बैटरी सेवर की सुविधा का असर नहीं पड़ना चाहिए या बैटरी सेवर की सुविधा बंद होनी चाहिए.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF बैटरी सेवर मोड चालू होने और डिवाइस के इंटरैक्टिव न होने पर, जीपीएस पर आधारित जगह की जानकारी देने वाली सेवा बंद होनी चाहिए.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF बैटरी सेवर मोड चालू होने और डिवाइस के इंटरैक्टिव न होने पर, जगह की जानकारी देने वाली सभी सेवाएं बंद होनी चाहिए.
LOCATION_MODE_FOREGROUND_ONLY जगह की जानकारी देने वाली सभी सेवाएं उपलब्ध रहेंगी. हालांकि, जगह की जानकारी से जुड़ी गड़बड़ियों को ठीक करने की सुविधा सिर्फ़ फ़ोरग्राउंड ऐप्लिकेशन के लिए उपलब्ध कराई जानी चाहिए.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF जगह की जानकारी की सुविधा बंद नहीं होगी. हालांकि, जब डिवाइस पर कोई इंटरैक्शन नहीं होगा, तब LocationManager, सेवा देने वाली कंपनियों को भेजे जाने वाले सभी अनुरोधों को कम कर देगा.

BatteryInfo

डिवाइस की बैटरी के बारे में जानकारी.

JSON के काेड में दिखाना 
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
फ़ील्ड
batteryStatus

enum (BatteryStatus)

बैटरी की स्थिति, जैसे कि बैटरी पूरी तरह चार्ज है या चार्ज हो रही है वगैरह.
powerSource

enum (PowerSource)

बैटरी के पावर सोर्स की स्थिति.
batteryPercentage

number

बैटरी का मौजूदा प्रतिशत [0-100].

BatteryStatus

बैटरी की स्थिति, जैसे कि बैटरी पूरी तरह चार्ज है या चार्ज हो रही है वगैरह.

Enums
UNKNOWN_BATTERY_STATUS इस बारे में जानकारी नहीं है कि अभी बैटरी कितनी चार्ज है.
BATTERY_STATUS_CHARGING बैटरी चार्ज हो रही है.
BATTERY_STATUS_DISCHARGING बैटरी डिस्चार्ज हो रही है.
BATTERY_STATUS_FULL बैटरी पूरी तरह चार्ज हो गई है.
BATTERY_STATUS_NOT_CHARGING बैटरी चार्ज नहीं हो रही है.
BATTERY_STATUS_POWER_LOW डिवाइस की बैटरी कम है.

PowerSource

बैटरी चार्ज करने के लिए इस्तेमाल किए जा रहे चार्जर का टाइप.

Enums
UNKNOWN_POWER_SOURCE पावर सोर्स की जानकारी नहीं है.
POWER_SOURCE_AC पावर सोर्स, AC चार्जर है.
POWER_SOURCE_USB पावर सोर्स, यूएसबी पोर्ट है.
POWER_SOURCE_WIRELESS पावर सोर्स वायरलेस हो.
POWER_SOURCE_UNPLUGGED बैटरी अनप्लग हो गई है.

तरीके

create

 ऑन-डिमांड राइडशेयर या डिलीवरी सेवा देने वाली कंपनी से जुड़े नए वाहन को तुरंत इंस्टैंशिएट करता है.

delete

 फ़्लीट इंजन से वाहन को मिटाता है.

get

 फ़्लीट इंजन से वाहन की जानकारी दिखाता है.

list

 अनुरोध के विकल्पों से मैच करने वाली सेवा देने वाली कंपनी से जुड़े वाहनों की पेज की गई सूची दिखाता है.
अनुरोध के विकल्पों से मेल खाने वाले वाहनों की सूची दिखाता है.

update

 वाहन का अपडेट किया गया डेटा, Fleet Engine में लिखता है.

updateAttributes

 वाहन के एट्रिब्यूट को कुछ हद तक अपडेट करता है.