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 इस जानकारी का इस्तेमाल, यात्रा की जानकारी शेयर करने की सुविधा को बेहतर बनाने के लिए करता है. ध्यान दें: इस फ़ील्ड का इस्तेमाल सिर्फ़ ड्राइवर 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 के तौर पर किया जा सकता है. अगर फ़्लीट इंजन की पूरी जानकारी नहीं दी गई है, तो यह असल वेपॉइंट में दिखाने की पूरी कोशिश करेगा. जब तक currentRouteSegment के लिए भी कोई वैल्यू नहीं डाली जाती, तब तक इस फ़ील्ड को vehicles.update कॉल में अनदेखा कर दिया जाता है.

remainingDistanceMeters

integer

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

etaToFirstWaypoint

string (Timestamp format)

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

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

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "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

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

lastCharacter

string

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

  • "ABC 1234" -> "चार"
  • "AB 123 CD" -> "तीन"
  • "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 पावर सोर्स, एसी चार्जर है.
POWER_SOURCE_USB पावर सोर्स एक यूएसबी पोर्ट है.
POWER_SOURCE_WIRELESS पावर सोर्स वायरलेस है.
POWER_SOURCE_UNPLUGGED बैटरी का प्लग हटा दिया गया है.

तरीके

create

मांग पर राइडशेयर या डिलीवरी की सेवा देने वाली कंपनी से जुड़ा नया वाहन चालू करता है.

get

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

list

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

update

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

updateAttributes

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