REST Resource: providers.vehicles

संसाधन: वाहन

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

JSON के काेड में दिखाना
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    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)

पिछली बार गाड़ी किस जगह बताई गई.

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 में भी दिखाई जाएगी.

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

currentRouteSegmentTraffic

object (TrafficPolylineData)

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

currentRouteSegmentVersion

string (Timestamp format)

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

आरएफ़सी3339 यूटीसी के "ज़ुलू" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंक हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

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 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड रिज़ॉल्यूशन और नौ दशमलव अंकों के साथ. उदाहरण के लिए: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

remainingTimeSeconds

integer

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

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

waypoints[]

object (TripWaypoint)

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

waypointsVersion

string (Timestamp format)

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

आरएफ़सी3339 यूटीसी के "ज़ुलू" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंक हैं. उदाहरण के लिए: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

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 अनिर्धारित 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

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

get

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

list

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

update

यह फ़्लेट इंजन में, वाहन का अपडेट किया गया डेटा लिखता है.

updateAttributes

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