इस दस्तावेज़ में उन तरीकों के बारे में बताया गया है जिनकी मदद से, किसी टास्क की जानकारी ढूंढी जा सकती है सर्वर या ब्राउज़र खोलें. फ़्लीट इंजन में टास्क ढूंढने के दो तरीके हैं:
टास्क खोजना: टास्क को इन आईडी से खोजा जा सकता है:
- टास्क आईडी: इसका इस्तेमाल फ़्लीट ऑपरेटर जैसे उपयोगकर्ता करते हैं. इनके पास टास्क के डेटा के पूरे व्यू का ऐक्सेस होता है.
- ट्रैकिंग ID: आपके क्लाइंट सॉफ़्टवेयर द्वारा सीमित जानकारी प्रदान करने के लिए उपयोग किया जाता है असली उपयोगकर्ता को भेजना. जैसे, उसके घर पर पैकेज मिलने की उम्मीद हो.
टास्क आईडी और टास्क ट्रैकिंग आईडी के बीच का अंतर समझना न भूलें. वे एक समान नहीं होते हैं. शेड्यूल किए गए टास्क की गाइड में, टास्क के बुनियादी फ़ील्ड देखें.
टास्क की सूची बनाना: टास्क का पूरा ऐक्सेस, जो सिर्फ़ भरोसेमंद उपयोगकर्ताओं के लिए है.
टास्क देखना
इस सेक्शन में बताया गया है कि टास्क आईडी या ट्रैकिंग आईडी की मदद से टास्क कैसे देखें. इसके लिए, ये ज़रूरी शर्तें पूरी करनी होंगी:
ट्रैकिंग आईडी के हिसाब से लुकअप, ट्रैक किए गए ऑब्जेक्ट के लिए दिखने के नियम में बताए गए नियमों का पालन करते हैं.
सुरक्षा से जुड़े खतरों को कम करने के लिए, सबसे छोटे टोकन का इस्तेमाल करें. उदाहरण के लिए, अगर किसी डिलीवरी कंज़्यूमर टोकन का इस्तेमाल करना चाहिए, तो सिर्फ़ उस असली उपयोगकर्ता से जुड़ी जानकारी होनी चाहिए, जैसे कि शिपर या एक शिपमेंट भेजने वाले को. फ़्लीट इंजन, जवाब. टोकन के बारे में ज़्यादा जानकारी के लिए, JSON वेब टोकन देखें.
टास्क आईडी से टास्क देखना
gRPC या आराम नीचे दिए गए उदाहरणों में, GetTask के लिए Java gRPC लाइब्रेरी या 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;
}
आराम
GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<taskId>
- <id>, टास्क के लिए यूनीक आइडेंटिफ़ायर है.
- <taskId>, उस टास्क का आईडी है जिसे खोजना है.
- अनुरोध हेडर में, अनुमति फ़ील्ड होना चाहिए, जिसकी वैल्यू 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}"
ट्रैकिंग आईडी के हिसाब से टास्क देखना
यहां दिए गए उदाहरणों में, GetTaskTrackingInfo
पर gRPC या HTTP 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}"
टास्क की सूची
टास्क की सूची बनाने पर, टास्क का ऐक्सेस सभी को दिया जाता है. टास्क की सूची बनाने की सुविधा सिर्फ़ भरोसेमंद उपयोगकर्ताओं के लिए है. सूची में टास्क जोड़ने के अनुरोध करते समय, डिलीवरी फ़्लीट रीडर या डिलीवरी एडमिन के ऑथेंटिकेशन टोकन का इस्तेमाल करें. ज़्यादा जानकारी के लिए, सेवा खाते की भूमिकाएं देखें जानकारी.
सूची पर नंबर डालें
टास्क की सूचियों को पेज में बांटा जाता है. टास्क की सूची के अनुरोधों में, पेज का साइज़ तय किया जा सकता है. अगर पेज का साइज़ बताया गया है, तो लौटाए गए टास्क की संख्या इससे ज़्यादा नहीं होती तय पेज साइज़ से ज़्यादा है. अगर पेज का कोई साइज़ मौजूद नहीं है, तो एक सही डिफ़ॉल्ट साइज़ का इस्तेमाल किया जाता है. अगर अनुरोध किए गए पेज का साइज़, अंदरूनी अधिकतम वैल्यू से ज़्यादा है, तो आंतरिक अधिकतम का इस्तेमाल किया जाता है.
टास्क की सूची में, नतीजों के अगले पेज को पढ़ने के लिए टोकन शामिल हो सकता है. यहां की यात्रा पर हूं तो उस अगले पेज को वापस पाने के लिए, पेज टोकन के साथ वही अनुरोध फिर से जारी करें. जब दिखाया गया पेज टोकन खाली होता है, तो फिर से पाने के लिए कोई और टास्क उपलब्ध नहीं होता.
टास्क की सूची बनाते समय दिखने वाले फ़ील्ड
टास्क की सूची बनाते समय, फ़्लीट इंजन इन फ़ील्ड को छिपाने के लिए बदलाव करता है:
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 देखें. अगर कोई फ़िल्टर क्वेरी नहीं दी गई है, तो सभी टास्क सूची में दिखते हैं.
इस टेबल में मान्य टास्क प्रॉपर्टी दी गई हैं, जिनका इस्तेमाल फ़िल्टर करने के लिए किया जा सकता है:
सूचियों को फ़िल्टर करने के लिए टास्क प्रॉपर्टी | |
---|---|
|
|
फ़िल्टर क्वेरी ऑपरेटर की पूरी सूची के लिए, AIP-160 देखें.
सूची टास्क के उदाहरण
नीचे दिए गए उदाहरण में, deliveryVehicleId
और
टास्क एट्रिब्यूट, दोनों के साथ Java gRPC लाइब्रेरी और एचटीटीपी REST कॉल टू
ListTasks
.
जवाब मिलने के बावजूद, वह खाली हो सकता है. खाली रिस्पॉन्स का मतलब है कि दिए गए 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;
}
आराम
GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks
सूची में दिए गए टास्क पर कोई फ़िल्टर लगाने के लिए, "फ़िल्टर" शामिल करें इसकी वैल्यू के तौर पर, यूआरएल-एस्केप्ड फ़िल्टर क्वेरी वाला यूआरएल पैरामीटर.
अनुरोध हेडर में, 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}"