टास्क ढूंढें

इस दस्तावेज़ में, सर्वर या ब्राउज़र से टास्क की जानकारी पाने के तरीके बताए गए हैं. Fleet Engine में, टास्क ढूंढने के दो तरीके उपलब्ध हैं:

  • टास्क ढूंढना: टास्क को इन आईडी के हिसाब से ढूंढा जा सकता है:

    • टास्क आईडी: इसका इस्तेमाल फ्लीट ऑपरेटर जैसे उपयोगकर्ता करते हैं. इनके पास टास्क के डेटा का पूरा व्यू ऐक्सेस करने की अनुमति होती है.
    • ट्रैकिंग आईडी: इसका इस्तेमाल आपका क्लाइंट सॉफ़्टवेयर करता है. इससे, वह किसी व्यक्ति को सीमित जानकारी दे पाता है. जैसे, किसी पैकेज के उसके घर पहुंचने की संभावित तारीख.

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

  • टास्क की सूची बनाना: टास्क को ऐक्सेस करने का ज़्यादा दायरा. यह सिर्फ़ भरोसेमंद उपयोगकर्ताओं के लिए है.

टास्क देखना

इस सेक्शन में, टास्क आईडी या ट्रैकिंग आईडी के हिसाब से टास्क ढूंढने का तरीका बताया गया है. इसके लिए, ये ज़रूरी शर्तें पूरी करनी होंगी:

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

  • सुरक्षा से जुड़े जोखिमों को कम करने के लिए, सबसे छोटे टोकन का इस्तेमाल करें. उदाहरण के लिए, अगर आपने डिलीवरी कंज्यूमर टोकन का इस्तेमाल किया है, तो सभी कॉल सिर्फ़ असली उपयोगकर्ता से जुड़ी जानकारी दिखाएंगे. जैसे, शिपमेंट भेजने वाले या पाने वाले व्यक्ति की जानकारी. Fleet Engine, जवाबों में मौजूद अन्य सभी जानकारी को छिपा देता है. टोकन के बारे में ज़्यादा जानने के लिए, JSON वेब टोकन देखें.

टास्क आईडी के हिसाब से टास्क ढूंढना

gRPC या REST का इस्तेमाल करके, सर्वर एनवायरमेंट से किसी टास्क को उसके टास्क आईडी से खोजा जा सकता है. यहां दिए गए उदाहरणों में, Java gRPC लाइब्रेरी या GetTask के लिए REST अनुरोध का इस्तेमाल करने का तरीका बताया गया है.

gRPC

 static final String PROJECT_ID = "my-delivery-co-gcp-project";
 static final String TASK_ID = "task-8597549";

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Task request
 String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
 GetTaskRequest getTaskRequest = GetTaskRequest.newBuilder()  // No need for the header
     .setName(taskName)
     .build();

 try {
   Task task = deliveryService.getTask(getTaskRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;

      case PERMISSION_DENIED:
        break;
   }
   return;
 }

REST

GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<taskId>

  • <id>, टास्क के लिए यूनीक आइडेंटिफ़ायर होता है.
  • <taskId>, उस टास्क का आईडी है जिसे ढूंढना है.
  • अनुरोध हेडर में Authorization फ़ील्ड होना चाहिए. इसकी वैल्यू Bearer <token> होनी चाहिए. यहां <token> को आपका सर्वर जारी करता है. यह सेवा खाते की भूमिकाओं और JSON वेब टोकन में बताए गए दिशा-निर्देशों के मुताबिक होना चाहिए.
  • अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
  • अगर लुकअप पूरा हो जाता है, तो जवाब के मुख्य हिस्से में टास्क की इकाई शामिल होती है.

curl निर्देश का उदाहरण:

    # Set JWT, PROJECT_ID, and TASK_ID in the local environment
    curl -H "Authorization: Bearer ${JWT}" \
      "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}"

ट्रैकिंग आईडी के हिसाब से टास्क ढूंढना

यहां दिए गए उदाहरणों में, शिपमेंट ट्रैकिंग आईडी के हिसाब से टास्क खोजने का तरीका बताया गया है. इसके लिए, gRPC या GetTaskTrackingInfo पर एचटीटीपी REST कॉल का इस्तेमाल किया जाता है.

gRPC

static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TRACKING_ID = "TID-7449w087464x5";

DeliveryServiceBlockingStub deliveryService =
  DeliveryServiceGrpc.newBlockingStub(channel);

// Tasks request
String parent = "providers/" + PROJECT_ID;
GetTaskTrackingInfoRequest getTaskTrackingInfoRequest = GetTaskTrackingInfoRequest.newBuilder()  // No need for the header
    .setParent(parent)
    .setTrackingId(TRACKING_ID)
    .build();

try {
  TaskTrackingInfo taskTrackingInfo = deliveryService.getTaskTrackingInfo(getTaskTrackingInfoRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
     case NOT_FOUND:
       break;

     case PERMISSION_DENIED:
       break;
  }
  return;
}

REST

GET https://fleetengine.googleapis.com/v1/providers/<project_id>/taskTrackingInfo/<tracking_id>

  • <tracking_id>, टास्क से जुड़ा ट्रैकिंग आईडी है.

  • अनुरोध हेडर में, Authorization फ़ील्ड होना चाहिए. इसकी वैल्यू Bearer <token> होनी चाहिए. यहां <token> में, सेवा खाते की सही भूमिका होनी चाहिए. सेवा खाते की भूमिकाएं देखें.

  • अगर लुकअप पूरा हो जाता है, तो जवाब के मुख्य हिस्से में taskTrackingInfo इकाई शामिल होती है.

curl निर्देश का उदाहरण:

# Set JWT, PROJECT_ID, and TRACKING_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
  "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/taskTrackingInfo/${TRACKING_ID}"

टास्क की सूची बनाना

टास्क की सूची बनाने वाले ऐप्लिकेशन को टास्क का ऐक्सेस ज़्यादा से ज़्यादा लोगों को देने का अनुरोध करना चाहिए. टास्क की सूची बनाने की सुविधा सिर्फ़ भरोसेमंद उपयोगकर्ताओं के लिए है. टास्क की सूची बनाने के अनुरोध करते समय, Delivery Fleet Reader या Delivery Admin के पुष्टि करने वाले टोकन का इस्तेमाल करें. ज़्यादा जानकारी के लिए, सेवा खाते की भूमिकाएं देखें.

सूचियों को पेज के हिसाब से बांटना

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

टास्क की सूची में, नतीजों के अगले पेज को पढ़ने के लिए एक टोकन शामिल हो सकता है. अगले पेज को वापस पाने के लिए, पेज टोकन के साथ उसी अनुरोध को फिर से जारी करें. जब लौटाया गया पेज टोकन खाली होता है, तो इसका मतलब है कि अब कोई और टास्क नहीं है जिसे वापस लाया जा सकता है.

टास्क की सूची बनाते समय इस्तेमाल किए जाने वाले फ़ील्ड

टास्क की सूची बनाते समय, Fleet Engine इन फ़ील्ड के डेटा को छिपा देता है:

  • VehicleStop.planned_location
  • VehicleStop.state
  • VehicleStop.TaskInfo.taskId

Google API को बेहतर बनाने के सुझावों के आधार पर, फ़ील्ड के इन फ़ॉर्मैट का इस्तेमाल करें:

फ़ील्ड प्रकार फ़ॉर्मैट उदाहरण
टाइमस्टैम्प RFC-3339 task_outcome_time = 2022-03-01T11:30:00-08:00
कुल समय सेकंड की संख्या के बाद s task_duration = 120s
Enum स्ट्रिंग state = CLOSED AND type = PICKUP
जगह point.latitude और point.longitude planned_location.point.latitude > 36.1 AND planned_location.point.longitude < -122.0

सूची में शामिल टास्क फ़िल्टर करना

टास्क की ज़्यादातर प्रॉपर्टी के हिसाब से, सूची में शामिल टास्क को फ़िल्टर किया जा सकता है. फ़िल्टर क्वेरी के सिंटैक्स के बारे में जानने के लिए, AIP-160 देखें. अगर कोई फ़िल्टर क्वेरी नहीं दी गई है, तो सभी टास्क दिखते हैं.

यहां दी गई टेबल में, टास्क की मान्य प्रॉपर्टी दिखाई गई हैं. इनका इस्तेमाल फ़िल्टर करने के लिए किया जा सकता है:

सूचियों को फ़िल्टर करने के लिए टास्क की प्रॉपर्टी
  • type
  • attributes
  • tracking_id
  • delivery_vehicle_id
  • state
  • planned_location
  • task_duration
  • task_duration_outcome
  • task_outcome
  • task_outcome_location
  • task_outcome_time

फ़िल्टर क्वेरी ऑपरेटर की पूरी सूची के लिए, AIP-160 देखें.

टास्क के उदाहरणों की सूची

यहां दिए गए उदाहरण में, deliveryVehicleId और टास्क एट्रिब्यूट के लिए टास्क की सूची बनाने का तरीका दिखाया गया है. इसके लिए, Java gRPC लाइब्रेरी और ListTasks पर एचटीटीपी REST कॉल, दोनों का इस्तेमाल किया गया है.

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

gRPC

 static final String PROJECT_ID = "my-delivery-co-gcp-project";
 static final String TRACKING_ID = "TID-7449w087464x5";

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Tasks request
 String parent = "providers/" + PROJECT_ID;
 ListTasksRequest listTasksRequest = ListTasksRequest.newBuilder()  // No need for the header
     .setParent(parent)
     .setFilter("delivery_vehicle_id = 123 AND attributes.foo = true")
     .build();

 try {
   ListTasksResponse listTasksResponse = deliveryService.listTasks(listTasksRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;

      case PERMISSION_DENIED:
        break;
   }
   return;
 }

REST

GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks

सूची में शामिल टास्क पर फ़िल्टर लागू करने के लिए, "filter" यूआरएल पैरामीटर को शामिल करें. साथ ही, यूआरएल-एस्केप्ड फ़िल्टर क्वेरी को इसकी वैल्यू के तौर पर शामिल करें.

अनुरोध हेडर में, Authorization फ़ील्ड होना चाहिए. इसकी वैल्यू Bearer <token> होनी चाहिए. यहां <token> में, सेवा खाते की सही भूमिका होनी चाहिए. सेवा खाते की भूमिकाएं देखें.

सर्च करने पर, जवाब के मुख्य हिस्से में यह स्ट्रक्चर दिखता है:

    // JSON representation
    {
      "tasks": [
        {
          object (Task)
        }
      ],
      "nextPageToken": string,
      "totalSize": integer
    }

curl निर्देश का उदाहरण:

 # Set JWT, PROJECT_ID, and VEHICLE_ID in the local environment
 curl -H "Authorization: Bearer ${JWT}" \
   "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?filter=state%20%3D%20OPEN%20AND%20delivery_vehicle_id%20%3D%20${VEHICLE_ID}"

आगे क्या करना है