इस दस्तावेज़ में, डिलीवरी के लिए इस्तेमाल होने वाले वाहनों को लिस्ट करने का तरीका बताया गया है.
एनवायरमेंट और सीमाएं
डिलीवरी के लिए इस्तेमाल होने वाले वाहनों को सर्वर या ब्राउज़र एनवायरमेंट से लिस्ट किया जा सकता है. Driver SDK, डिलीवरी के लिए इस्तेमाल होने वाले वाहनों की लिस्टिंग की सुविधा नहीं देता.
डिलीवरी वाहनों को लिस्ट करने के लिए, डिलीवरी वाहनों के डेटा का ऐक्सेस मांगा जाता है. यह ऐक्सेस सिर्फ़ भरोसेमंद लोगों को दिया जाता है. डिलीवरी के लिए वाहनों की सूची बनाने के अनुरोध करते समय, Delivery Fleet Reader या Fleet Engine Delivery Admin टोकन का इस्तेमाल करें.
जवाब के साइज़ पर असर पड़ने की वजह से, डिलीवरी के लिए इस्तेमाल किए जाने वाले वाहनों की सूची में इन फ़ील्ड को छिपा दिया गया है:
CurrentRouteSegment
RemainingVehicleJourneySegments
इस्तेमाल
एट्रिब्यूट फ़िल्टर और व्यूपोर्ट बाउंड के हिसाब से, वाहनों को लिस्ट किया जा सकता है. अगर आपने कोई फ़िल्टर या व्यूपोर्ट नहीं चुना है, तो जवाब में सभी डिलीवरी वाहनों की जानकारी शामिल होगी.
एट्रिब्यूट फ़िल्टर वाली सूची
डिलिवरी के लिए इस्तेमाल होने वाले वाहनों को उनकी attributes
प्रॉपर्टी का इस्तेमाल करके, फ़िल्टर के हिसाब से लिस्ट किया जा सकता है. उदाहरण के लिए, my_key
कुंजी और my_value
वैल्यू वाले एट्रिब्यूट के बारे में क्वेरी करने के लिए, attributes.my_key = my_value
का इस्तेमाल करें. एक से ज़्यादा एट्रिब्यूट के लिए क्वेरी करने के लिए, AND
और OR
लॉजिकल ऑपरेटर का इस्तेमाल करके क्वेरी जोड़ें. जैसे, attributes.key1 = value1 AND
attributes.key2 = value2
. फ़िल्टर क्वेरी के सिंटैक्स के बारे में पूरी जानकारी के लिए, AIP-160 देखें. व्यूपोर्ट की सीमाओं के साथ फ़िल्टर को जोड़ने पर, फ़िल्टर, व्यूपोर्ट की सीमा के लिए AND
ऑपरेटर के तौर पर काम करता है. ज़्यादा जानकारी के लिए, वाहन के एट्रिब्यूट के हिसाब से फ़िल्टर करने की क्वेरी देखें.
व्यूपोर्ट की सीमाओं वाली सूची
viewport
अनुरोध पैरामीटर का इस्तेमाल करके, डिलीवरी के लिए उपलब्ध वाहनों को जगह के हिसाब से फ़िल्टर किया जा सकता है. viewport
अनुरोध पैरामीटर, दो बाउंडिंग कोऑर्डिनेट का इस्तेमाल करके व्यूपोर्ट तय करता है: high
(उत्तर-पूर्व) और low
(दक्षिण-पश्चिम) अक्षांश और देशांतर कोऑर्डिनेट का पेयर. अगर अनुरोधों में ऐसा अक्षांश शामिल है जो भौगोलिक रूप से कम अक्षांश से कम है, तो उन्हें अस्वीकार कर दिया जाता है.
जवाबों की सूची बनाना
डिफ़ॉल्ट रूप से, डिलीवरी करने वाले वाहनों की सूचियों को पेज के साइज़ के हिसाब से बांटा जाता है. पेज का साइज़ तय करने पर, अनुरोध में सिर्फ़ वाहनों की वह संख्या दिखेगी जो सीमा के हिसाब से तय की गई है या उससे कम है. अगर अनुरोध किए गए पेज का साइज़, तय की गई ज़्यादा से ज़्यादा वैल्यू से ज़्यादा है, तो तय की गई ज़्यादा से ज़्यादा वैल्यू का इस्तेमाल किया जाता है. पेज का डिफ़ॉल्ट और ज़्यादा से ज़्यादा साइज़, दोनों 100 वाहन हैं.
डिलीवरी के लिए इस्तेमाल होने वाले वाहनों की सूची में, नतीजों के अगले पेज को पढ़ने के लिए टोकन शामिल हो सकता है. पेज टोकन, जवाब में सिर्फ़ तब मौजूद होता है, जब डिलीवरी वाहनों के ज़्यादा पेज वापस पाने के लिए उपलब्ध हों. टास्क का अगला पेज पाने के लिए, पेज टोकन का इस्तेमाल करें. यह टोकन, पिछले अनुरोध के जैसा ही होना चाहिए.
वाहन की लिस्टिंग के उदाहरण
किसी खास एट्रिब्यूट के साथ किसी इलाके में डिलीवरी वाहनों की लिस्टिंग करने के लिए, Java gRPC लाइब्रेरी या REST का इस्तेमाल किया जा सकता है. जवाब में कोई डेटा न होने पर भी, उसे मान्य माना जा सकता है. ऐसा होने पर, इसका मतलब है कि चुने गए व्यूपोर्ट में, बताए गए एट्रिब्यूट वाले कोई वाहन मौजूद नहीं हैं.
Java
static final String PROJECT_ID = "my-delivery-co-gcp-project";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Tasks request
String parent = "providers/" + PROJECT_ID;
ListDeliveryVehiclesRequest listDeliveryVehiclesRequest =
ListDeliveryVehiclesRequest.newBuilder() // No need for the header
.setParent(parent)
.setViewport(
Viewport.newBuilder()
.setHigh(LatLng.newBuilder()
.setLatitude(37.45)
.setLongitude(-122.06)
.build())
.setLow(LatLng.newBuilder()
.setLatitude(37.41)
.setLongitude(-122.11)
.build())
.setFilter("attributes.my_key = my_value")
.build();
try {
ListDeliveryVehiclesResponse listDeliveryVehiclesResponse =
deliveryService.listDeliveryVehicles(listDeliveryVehiclesRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
# HTTP request
html GET https://fleetengine.googleapis.com/v1/providers/<project_id>/deliveryVehicles
# Request with a filter
# Request sets JWT, PROJECT_ID, and VEHICLE_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/deliveryVehicles?filter=attributes.my_key%20%3D%20my_value%20&viewport.high.latitude=37.45&viewport.high.longitude=-122.06&viewport.low.latitude=37.41&viewport.low.longitude=-122.11"
अगर लुकअप सही से हो जाता है, तो जवाब के मुख्य हिस्से में इस स्ट्रक्चर का डेटा शामिल होता है:
// JSON representation
{
"deliveryVehicles": [
{
object (DeliveryVehicle)
}
],
"nextPageToken": string,
"totalSize": integer
}