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 रिस्पॉन्स मैसेज.

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

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

object (Trip)

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

nextPageToken

string

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