REST Resource: providers.trips

संसाधन: यात्रा

यात्रा का मेटाडेटा.

जेएसओएन के काेड में दिखाना
{
  "name": string,
  "vehicleId": string,
  "tripStatus": enum (TripStatus),
  "tripType": enum (TripType),
  "pickupPoint": {
    object (TerminalLocation)
  },
  "actualPickupPoint": {
    object (StopLocation)
  },
  "actualPickupArrivalPoint": {
    object (StopLocation)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocation)
    }
  ],
  "intermediateDestinationsVersion": string,
  "intermediateDestinationIndex": integer,
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocation)
    }
  ],
  "actualIntermediateDestinations": [
    {
      object (StopLocation)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "actualDropoffPoint": {
    object (StopLocation)
  },
  "dropoffTime": string,
  "remainingWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "vehicleWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "route": [
    {
      object (LatLng)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolyline)
  },
  "currentRouteSegmentTrafficVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "remainingWaypointsVersion": string,
  "remainingWaypointsRouteVersion": string,
  "numberOfPassengers": integer,
  "lastLocation": {
    object (VehicleLocation)
  },
  "lastLocationSnappable": boolean,
  "view": enum (TripView)
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. "providers/{provider}/trips/{trip}" फ़ॉर्मैट में

vehicleId

string

इस यात्रा के लिए इस्तेमाल किए जा रहे वाहन का आईडी.

tripStatus

enum (TripStatus)

यात्रा की मौजूदा स्थिति.

tripType

enum (TripType)

यात्रा किस तरह की है.

pickupPoint

object (TerminalLocation)

वह जगह जहां ग्राहक संकेत देता है कि उसे पिक अप किया जाएगा.

actualPickupPoint

object (StopLocation)

सिर्फ़ इनपुट. ग्राहक को पिक अप करने के समय और जगह की असल जगह. यह फ़ील्ड, सेवा देने वाली कंपनी के लिए है. इसमें, पिकअप की असली जानकारी के बारे में सुझाव, शिकायत या राय दी जा सकती है.

actualPickupArrivalPoint

object (StopLocation)

सिर्फ़ इनपुट. पिकअप पॉइंट पर ड्राइवर के पहुंचने का असल समय और जगह. यह फ़ील्ड, सेवा देने वाली कंपनी के लिए है. इससे वह पिकअप पॉइंट पर पहुंचने की सही जानकारी के बारे में सुझाव दे सकता है.

pickupTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. राइडर को पिक अप करने के अनुमानित समय या राइड के पिक अप करने के असल समय की जानकारी दी जा सकती है.

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

intermediateDestinations[]

object (TerminalLocation)

यात्रा के अनुरोध के मुताबिक बीच के स्टॉप (पिकअप और ड्रॉप की जगह के अलावा). शुरुआत में, यह शेयर की गई यात्राओं के लिए उपलब्ध नहीं होगा.

intermediateDestinationsVersion

string (Timestamp format)

इससे पता चलता है कि intermediateDestinations में पिछली बार कब बदलाव किया गया था. आपके सर्वर को इस वैल्यू को कैश मेमोरी में सेव करना चाहिए. साथ ही, intermediateDestinationIndex को अपडेट करते समय, इसे UpdateTripRequest में पास करना चाहिए, ताकि यह पक्का किया जा सके कि intermediateDestinations में बदलाव न हो.

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

intermediateDestinationIndex

integer

TripStatus के ENROUTE_TO_INTERMEDIATE_DESTINATION होने पर, [0..N-1] के बीच की संख्या होती है, जिससे पता चलता है कि वाहन किस इंटरमीडिएट मंज़िल से होकर गुज़रेगा. जब TripStatus ARRIVED_AT_INTERMEDIATE_DESTINATION होता है, तो [0..N-1] के बीच की संख्या बताती है कि वाहन किस इंटरमीडिएट डेस्टिनेशन पर है. यह वैल्यू, सेवा देने वाली कंपनी सेट करती है. अगर कोई intermediateDestinations नहीं है, तो इस फ़ील्ड को अनदेखा कर दिया जाता है.

actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

सिर्फ़ इनपुट. किसी इंटरमीडिएट मंज़िल पर ड्राइवर के पहुंचने का असल समय और जगह. यह फ़ील्ड, सेवा देने वाली कंपनी के लिए है. इससे इंटरमीडिएट डेस्टिनेशन पर, पहुंचने की सही जानकारी के बारे में सुझाव, शिकायत या राय मिल सकती है.

actualIntermediateDestinations[]

object (StopLocation)

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

dropoffPoint

object (TerminalLocation)

वह जगह जहां ग्राहक यह बताता है कि उसे प्रॉडक्ट से हटा दिया जाएगा.

actualDropoffPoint

object (StopLocation)

सिर्फ़ इनपुट. वह समय और जगह जहां से ग्राहक ने प्रॉडक्ट को बीच में छोड़ा था. यह फ़ील्ड, सेवा देने वाली कंपनी के लिए है. यह फ़ील्ड, छोड़ने की असल जानकारी के बारे में सुझाव देने के लिए है.

dropoffTime

string (Timestamp format)

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

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

remainingWaypoints[]

object (TripWaypoint)

सिर्फ़ आउटपुट के लिए. मौजूदा जगह से ड्रॉप ऑफ़ पॉइंट तक का पूरा पाथ. इस रास्ते में दूसरी यात्राओं से वेपॉइंट शामिल हो सकते हैं.

vehicleWaypoints[]

object (TripWaypoint)

यह फ़ील्ड यात्रा के वेपॉइंट के मैन्युअल क्रम में काम करता है. इसमें असाइन किए गए वाहन के बाकी सभी वेपॉइंट हैं और इस यात्रा के लिए पिकअप और ड्रॉप-ऑफ़ वेपॉइंट भी शामिल हैं. अगर यात्रा किसी वाहन के लिए असाइन नहीं की गई है, तो फ़्लीट इंजन इस फ़ील्ड को अनदेखा कर देता है. निजता की वजह से, इस फ़ील्ड में सर्वर की मदद से सिर्फ़ trips.update और trips.create कॉल अपने-आप भर जाते हैं, trips.get कॉल के लिए नहीं.

route[]

object (LatLng)

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

currentRouteSegment

string

सिर्फ़ आउटपुट के लिए. अगले वेपॉइंट के लिए एन्कोड किया गया पाथ.

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

currentRouteSegmentVersion

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इससे पता चलता है कि पिछली बार रूट में कब बदलाव किया गया था.

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

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

currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

सिर्फ़ आउटपुट के लिए. यह बताता है कि currentRouteSegment के आस-पास ट्रैफ़िक की स्थिति कब उपलब्ध है.

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

currentRouteSegmentTrafficVersion

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इससे पता चलता है कि currentRouteSegmentTraffic में पिछली बार कब बदलाव किया गया था.

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

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

currentRouteSegmentEndPoint

object (TripWaypoint)

सिर्फ़ आउटपुट के लिए. वह पॉइंट जहां से currentRouteSegment खत्म होता है.

remainingDistanceMeters

integer

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

etaToFirstWaypoint

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. अगले वेपॉइंट (remainingWaypoints फ़ील्ड में पहली एंट्री) तक पहुंचने का अनुमानित समय. अगर यात्रा किसी वाहन को असाइन नहीं की गई है या यात्रा बंद है (पूरी हो गई है या रद्द कर दी गई है), तो वैल्यू की जानकारी नहीं दी जाती.

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

remainingTimeToFirstWaypoint

string (Duration format)

सिर्फ़ आउटपुट के लिए. यात्रा का डेटा वापस मिलने से लेकर Trip.eta_to_first_waypoint में लगने वाले समय तक की अवधि. अगर यात्रा किसी वाहन को असाइन नहीं की गई है या यात्रा बंद है (पूरी हो गई है या रद्द कर दी गई है), तो वैल्यू की जानकारी नहीं दी जाती.

सेकंड में अवधि, जिसमें नौ भिन्नात्मक अंक हो सकते हैं और जो 's' पर खत्म होती है. उदाहरण: "3.5s".

remainingWaypointsVersion

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इससे पता चलता है कि पिछली बार remainingWaypoints को कब बदला गया था (वेपॉइंट जोड़ा गया, हटाया गया या बदला गया).

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

remainingWaypointsRouteVersion

string (Timestamp format)

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

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

numberOfPassengers

integer

इम्यूटेबल. इस यात्रा में यात्रियों की संख्या दिखाता है और इसमें ड्राइवर शामिल नहीं है. vehicles.search के जवाब में, वाहन को लौटाने की क्षमता उपलब्ध होनी चाहिए.

lastLocation

object (VehicleLocation)

सिर्फ़ आउटपुट के लिए. यह बताता है कि आखिरी बार वाहन कहां पर चला था.

lastLocationSnappable

boolean

सिर्फ़ आउटपुट के लिए. यह बताता है कि वाहन के lastLocation को मौजूदाRouteसेगमेंट में स्नैप किया जा सकता है या नहीं. lastLocation या currentRouteSegment मौजूद न होने पर, गलत होता है. इसकी गणना फ़्लीट इंजन से की गई है. क्लाइंट के किसी भी अपडेट को अनदेखा कर दिया जाएगा.

view

enum (TripView)

यात्रा फ़ील्ड का वह सबसेट जो अपने-आप भर जाता है और उसे कैसे समझा जाना चाहिए.

TripStatus

यात्रा की प्रोग्रेस दिखाने वाली स्थिति.

Enums
UNKNOWN_TRIP_STATUS डिफ़ॉल्ट, इसका इस्तेमाल यात्रा की ऐसी स्थिति के लिए किया जाता है जिसके बारे में जानकारी नहीं है या जिसकी जानकारी नहीं है.
NEW नई यात्रा की योजना.
ENROUTE_TO_PICKUP ड्राइवर पिक अप पॉइंट पर जा रहा है.
ARRIVED_AT_PICKUP ड्राइवर पिक अप पॉइंट पर पहुंच गया है.
ARRIVED_AT_INTERMEDIATE_DESTINATION ड्राइवर किसी इंटरमीडिएट मंज़िल पर पहुंच गया है और यात्री का इंतज़ार कर रहा है.
ENROUTE_TO_INTERMEDIATE_DESTINATION ड्राइवर किसी इंटरमीडिएट मंज़िल (न कि उतरने की जगह) पर जा रहा है.
ENROUTE_TO_DROPOFF ड्राइवर ने राइडर को उठा लिया है और वह अगली मंज़िल के लिए रास्ते में है.
COMPLETE राइडर को ड्रॉप कर दिया गया है और यात्रा पूरी हो गई है.
CANCELED ड्राइवर, राइडर या राइडशेयर करने वाली कंपनी के पिकअप किए जाने से पहले ही यात्रा रद्द कर दी गई थी.

StopLocation

वह जगह जहां से स्टॉप (पिकअप/ड्रॉपऑफ़) आया.

जेएसओएन के काेड में दिखाना
{
  "point": {
    object (LatLng)
  },
  "timestamp": string,
  "stopTime": string
}
फ़ील्ड
point

object (LatLng)

ज़रूरी है. वास्तविक जगह दिखाता है.

timestamp

string (Timestamp format)

बताता है कि स्टॉप कब हुआ.

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

stopTime
(deprecated)

string (Timestamp format)

सिर्फ़ इनपुट. समर्थन नहीं होना या रुकना. टाइमस्टैंप फ़ील्ड का इस्तेमाल करें.

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

TripView

trips.get के जवाब में, यात्रा से जुड़े फ़ील्ड के अलग-अलग सेट के लिए सिलेक्टर. ज़्यादा जानकारी के लिए, AIP-157 देखें. इसमें और व्यू जोड़े जा सकते हैं.

Enums
TRIP_VIEW_UNSPECIFIED डिफ़ॉल्ट वैल्यू. पुराने सिस्टम के साथ काम करने की क्षमता के लिए, एपीआई डिफ़ॉल्ट रूप से SDK टूल व्यू पर सेट होगा. स्थिरता और सहायता को पक्का करने के लिए, ग्राहकों को SDK के अलावा कोई TripView चुनने की सलाह दी जाती है.
SDK इसमें ऐसे फ़ील्ड शामिल होते हैं जिन्हें सार्वजनिक तौर पर उपलब्ध लाइब्रेरी का इस्तेमाल करके, न समझा जा सकता हो या न ही इस्तेमाल किया जा सके.
JOURNEY_SHARING_V1S यात्रा की जानकारी शेयर करने के इस्तेमाल के उदाहरण के लिए, यात्रा फ़ील्ड में जानकारी अपने-आप भर जाती है. यह व्यू, सर्वर-टू-सर्वर कम्यूनिकेशन के लिए है.

तरीके

create

फ़्लीट इंजन में यात्रा बनाता है और नई यात्रा को लौटाता है.

get

किसी एक यात्रा के बारे में जानकारी पाना.
किसी खास वाहन से की गई सभी यात्राओं की जानकारी पाएं.

update

यात्रा का डेटा अपडेट करता है.