במאמר הזה מוסבר איך להציג רשימה של רכבי משלוחים.
סביבות ומגבלות
אתם יכולים להציג רכבי משלוחים מסביבת שרת או מסביבת דפדפן. Driver SDK לא תומך בהצגת רשימה של רכבי משלוחים.
הצגת רשימה של רכבי משלוחים דורשת גישה רחבה לרכבי משלוחים, והיא מיועדת רק למשתמשים מהימנים. כששולחים בקשות להצגת רשימה של רכבי משלוחים, משתמשים באסימונים של Delivery Fleet Reader או של Fleet Engine Delivery Admin.
השדות הבאים של כלי הרכב למשלוחים שמופיעים ברשימה נמחקו בגלל ההשפעה שלהם על גודל התגובה:
CurrentRouteSegmentRemainingVehicleJourneySegments
שימוש
אפשר להציג רשימה של כלי רכב לפי מסנני מאפיינים וגבולות של אזור תצוגה. אם לא תציינו מסנן או אזור תצוגה, התשובה תכלול את כל רכבי המשלוחים.
רשימה עם מסנני מאפיינים
אפשר להציג רשימה של רכבי משלוחים לפי מסנן באמצעות המאפיין 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
}