Method: providers.trips.search

किसी खास वाहन की सभी यात्राएं देखें.

एचटीटीपी अनुरोध

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/trips:search

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. providers/{provider} फ़ॉर्मैट में होना चाहिए. प्रोवाइडर, उस Google Cloud प्रोजेक्ट का प्रोजेक्ट आईडी (उदाहरण के लिए, sample-cloud-project) होना चाहिए जिसका यह कॉल करने वाला सेवा खाता सदस्य है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य भाग में, नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:

JSON के काेड में दिखाना 
{
  "header": {
    object (RequestHeader)
  },
  "vehicleId": string,
  "activeTripsOnly": boolean,
  "pageSize": integer,
  "pageToken": string,
  "minimumStaleness": string
}
फ़ील्ड
header

object (RequestHeader)

स्टैंडर्ड फ़्लीट इंजन अनुरोध का हेडर.
vehicleId

string

अनुरोध में बताई गई यात्राओं से जुड़ा वाहन. अगर जानकारी नहीं दी गई है, तो वापस की गई यात्राओं में ये शामिल नहीं होंगे:

  • currentRouteSegment
  • remainingWaypoints
  • remainingDistanceMeters
  • etaToFirstWaypoint
activeTripsOnly

boolean

अगर इसकी वैल्यू 'सही' पर सेट है, तो जवाब में ऐसी यात्राएं शामिल होती हैं जिनसे ड्राइवर के रास्ते पर असर पड़ता है.
pageSize

integer

अगर इस नीति को सेट नहीं किया जाता है, तो सर्वर यह तय करता है कि कितने नतीजे मिलेंगे.
pageToken

string

पिछले नतीजों से जारी रखने के लिए, इसे SearchTripsResponse में पहले दी गई वैल्यू पर सेट करें.
minimumStaleness

string (Duration format)

अगर यह तय किया गया है, तो (current - minimumStaleness) समय के बाद अपडेट नहीं की गई यात्राओं की जानकारी दिखाता है.

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

जवाब का मुख्य भाग

trips.search response message.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "trips": [
    {
      object (Trip)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
trips[]

object (Trip)

अनुरोध किए गए वाहन के लिए यात्राओं की सूची.
nextPageToken

string

इस टोकन को SearchTripsRequest में पास करके, सूची के नतीजों वाले पेज पर जाएं. एपीआई हर कॉल पर यात्रा की सूची दिखाता है. जब कोई नतीजा नहीं मिलता है, तो यात्रा की सूची खाली हो जाती है.