Method: providers.tasks.search

अब सेवा में नहीं है: इसके बजाय taskTrackingInfo.get का इस्तेमाल करें.

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

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/tasks:search

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

पाथ के पैरामीटर

पैरामीटर
parent

string

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

क्वेरी पैरामीटर

पैरामीटर
header

object (DeliveryRequestHeader)

ज़रूरी नहीं. डिलीवरी एपीआई अनुरोध का स्टैंडर्ड हेडर.

trackingId

string

ज़रूरी है. मिलते-जुलते टास्क के सेट का आइडेंटिफ़ायर, जिसका अनुरोध किया जा रहा है. ट्रैकिंग आईडी पर ये पाबंदियां लागू होती हैं:

  • एक मान्य यूनिकोड स्ट्रिंग होनी चाहिए.
  • इसमें 64 से ज़्यादा वर्ण इस्तेमाल नहीं किए जा सकते.
  • यूनिकोड नॉर्मलाइज़ेशन फ़ॉर्म C के हिसाब से नॉर्मलाइज़ किया गया.
  • इनमें से कोई भी ASCII वर्ण शामिल नहीं हो सकता: '/', ':', '?', ',' या '#'.
pageSize

integer

ज़रूरी नहीं. लौटाए जाने वाले टास्क की ज़्यादा से ज़्यादा संख्या. सेवा, इस वैल्यू से कम वैल्यू दिखा सकती है. अगर यह वैल्यू नहीं दी जाती है, तो सर्वर तय करता है कि कितने नतीजे दिखाने हैं.

pageToken

string

ज़रूरी नहीं. पिछले tasks.search कॉल से मिला पेज टोकन. बाद वाले पेज को वापस पाने के लिए, आपको यह वैल्यू देनी होगी.

पेजों को पेजों में जोड़ते समय, tasks.search को दिए गए अन्य सभी पैरामीटर, उस कॉल से मेल खाने चाहिए जिससे पेज टोकन दिया गया था.

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

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

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

tasks.search जवाब. इसमें ऐसे टास्क होते हैं जो SearchTasksRequest में खोज की शर्तों को पूरा करते हैं.

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

जेएसओएन के काेड में दिखाना
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
tasks[]

object (Task)

trackingId के लिए, Tasks का सेट. सही जवाब देने वाले फ़ील्ड को भी खाली छोड़ा जा सकता है. खाली जवाब बताता है कि दिए गए trackingId से कोई भी टास्क नहीं जुड़ा है.

nextPageToken

string

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