REST Resource: providers.deliveryVehicles

משאב: DeliveryVehicle

ההודעה DeliveryVehicle. רכב משלוחים מוביל משלוחים מנקודת איסוף ליעד משלוחים, ומנקודת איסוף אל תחנת המשלוחים. במקרים מסוימים, כלי הרכב של חברת השליחויות גם מעבירים משלוחים ישירות מנקודת האיסוף לנקודת המסירה.

הערה: ממשקי API ל-gRPC ול-REST משתמשים במוסכמות שונות של מתן שמות לשדות. לדוגמה, השדה DeliveryVehicle.current_route_segment ב-API ל-gRPC והשדה DeliveryVehicle.currentRouteSegment ב-API ל-REST מפנים לאותו שדה.

ייצוג JSON 
{
  "name": string,
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "navigationStatus": enum (DeliveryVehicleNavigationStatus),
  "currentRouteSegment": string,
  "currentRouteSegmentEndPoint": {
    object (LatLng)
  },
  "remainingDistanceMeters": integer,
  "remainingDuration": string,
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "attributes": [
    {
      object (DeliveryVehicleAttribute)
    }
  ],
  "type": enum (DeliveryVehicleType)
}
שדות
name

string

השם הייחודי של כלי הרכב להעברה. הפורמט הוא providers/{provider}/deliveryVehicles/{vehicle}.
lastLocation

object (DeliveryVehicleLocation)

המיקום האחרון שדווח על רכב המסירה.
navigationStatus

enum (DeliveryVehicleNavigationStatus)

סטטוס הניווט של כלי הרכב לצורך מסירה.
currentRouteSegment

string (bytes format)

הקו הפוליגוני המקודד שמציין את המסלול שהניווט ממליץ לנסוע בו לנקודת הציון הבאה. האפליקציה של הנהג או הנהגת מעדכנת את המידע הזה כשמגיעים לתחנה או עוברים אותה, וכשהניווט משנה את המסלול. ערכי ה-LatLng האלה מוחזרים ב-Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) או ב-Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) לכל המשימות הפעילות שהוקצו לרכב.

יש כמה מקרים שבהם לא ניתן להשתמש בשדה הזה כדי לאכלס את Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) או את Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

  • נקודת הקצה ב-currentRouteSegment לא תואמת ל-DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) או ל-DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • המיקום של אפליקציית הנהג לא עודכן לאחרונה, לכן יכול להיות שהערך האחרון שעודכן בשדה הזה לא עדכני.

  • אפליקציית הנהג עדכנה לאחרונה את המיקום שלה, אבל אפליקציית currentRouteSegment לא עדכנית והיא מפנה לתחנה קודמת של רכב.

במקרים כאלה, מערכת Fleet Engine מאכלסת את השדה הזה במסלול מהרכב האחרון שהועבר אל חברת VehicleStop הבאה, כדי לוודא שלצרכן בשדה הזה יש את המידע הזמין הטוב ביותר לגבי הנתיב הנוכחי של רכב המסירה.

מחרוזת בקידוד Base64.
currentRouteSegmentEndPoint

object (LatLng)

המיקום שבו currentRouteSegment מסתיים. בשלב הזה, האפליקציה של הנהג לא מאכלסת את השדה הזה, אבל אפשר לספק אותו בקריאות ל-deliveryVehicles.patch. זהו LatLng מתחנת הרכב הקרובה, או LatLng האחרון של currentRouteSegment. לאחר מכן, Fleet Engine יעשה כמיטב יכולתו כדי לבצע אינטרפולציה ל-VehicleStop בפועל.

המערכת מתעלמת מהשדה הזה בקריאות ל-deliveryVehicles.patch אם השדה currentRouteSegment ריק.
remainingDistanceMeters

integer

מרחק הנסיעה שנותר עבור currentRouteSegment. בדרך כלל אפליקציית Driver מספקת את השדה הזה, אבל יש מקרים שבהם Fleet Engine יבטל את הערך שנשלח על ידי האפליקציה. מידע נוסף זמין בכתובת DeliveryVehicle.current_route_segment. השדה הזה מוחזר ב-Task.remaining_vehicle_journey_segments[0].driving_distance_meters‏ (gRPC) או ב-Task.remainingVehicleJourneySegments[0].drivingDistanceMeters‏ (REST) לכל הערכים הפעילים של Task שהוקצו לכלי המסירה.

המערכת של Fleet Engine מתעלמת מהשדה הזה ב-UpdateDeliveryVehicleRequest אם השדה currentRouteSegment ריק.
remainingDuration

string (Duration format)

משך הנסיעה שנותר ב-currentRouteSegment. השדה הזה בדרך כלל מופיע באפליקציית Driver, אבל יש כמה נסיבות שבהן מערכת Fleet Engine תשנה את הערך שנשלח מהאפליקציה. מידע נוסף זמין במאמר DeliveryVehicle.current_route_segment. השדה הזה מוחזר ב-Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) או ב-Task.remainingVehicleJourneySegments[0].drivingDuration (REST) לכל המשימות הפעילות שהוקצו לכלי המסירה.

המערכת של Fleet Engine מתעלמת מהשדה הזה ב-UpdateDeliveryVehicleRequest אם השדה currentRouteSegment ריק.

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

קטעי המסלול שהוקצו לרכב המסירה הזה, החל מהמיקום האחרון שדווח על הרכב. השדה הזה לא מאוכלס בתגובה של deliveryVehicles.list.
attributes[]

object (DeliveryVehicleAttribute)

רשימה של מאפיינים מותאמים אישית של כלי מסירה. לרכב מסירה יכולים להיות עד 100 מאפיינים, וכל מאפיין חייב לכלול מפתח ייחודי.
type

enum (DeliveryVehicleType)

סוג כלי התחבורה למשלוח. אם לא תגדירו את הערך, הערך שמוגדר כברירת מחדל הוא AUTO.

DeliveryVehicleNavigationStatus

סטטוס הניווט של הרכב.

טיפוסים בני מנייה (enum)
UNKNOWN_NAVIGATION_STATUS סטטוס ניווט לא צוין.
NO_GUIDANCE התכונה 'ניווט' באפליקציית הנהיגה נמצאת במצב FREE_NAV.
ENROUTE_TO_DESTINATION מסלול מפורט זמין והניווט באפליקציית Driver עבר למצב GUIDED_NAV.
OFF_ROUTE הרכב סטה מהמסלול שהצענו.
ARRIVED_AT_DESTINATION הרכב נמצא בטווח של כ-50 מטרים מהיעד.

DeliveryVehicleAttribute

מתאר מאפיין של רכב כצמד מפתח/ערך. אורך המחרוזת 'key:value' לא יכול לחרוג מ-256 תווים.

ייצוג ב-JSON 
{
  "key": string,
  "value": string,

  // Union field delivery_vehicle_attribute_value can be only one of the
  // following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field
  // delivery_vehicle_attribute_value.
}
שדות
key

string

המַּפתח של המאפיין.
value

string

הערך של המאפיין.
שדה האיחוד delivery_vehicle_attribute_value. ערך המאפיין יכול להיות מסוג מחרוזת, bool או double. הערך של delivery_vehicle_attribute_value יכול להיות רק אחת מהאפשרויות הבאות:
stringValue

string

ערך מאפיין מסוג מחרוזת.

הערה: השדה הזה זהה לשדה value, שיוצא משימוש בסופו של דבר. בשיטות ליצירה או לעדכון, אפשר להשתמש בכל אחד מהשדות, אבל מומלץ מאוד להשתמש ב-stringValue. אם גם stringValue וגם value מוגדרים, הם חייבים להיות זהים, אחרת תופיע שגיאה. שני השדות מאוכלסים בתשובות.
boolValue

boolean

ערך מאפיין מסוג בוליאני.
numberValue

number

ערך מאפיין מסוג double.

DeliveryVehicleType

סוג כלי התחבורה למשלוח.

טיפוסים בני מנייה (enum)
DELIVERY_VEHICLE_TYPE_UNSPECIFIED לא נעשה שימוש בערך.
AUTO רכב.
TWO_WHEELER אופנוע, קטנוע או כלי רכב דו-גלגלי אחר
BICYCLE תחבורה מונעת על ידי אדם.
PEDESTRIAN אדם שנע, בדרך כלל הולך או רץ, בשבילים להולכי רגל.

שיטות

create

 יצירה ומחזירה של DeliveryVehicle חדש.

get

 הפונקציה מחזירה את המופע שצוין בשדה DeliveryVehicle.

list

 הפונקציה מקבלת את כל הפריטים מסוג 'DeliveryVehicle' שעומדים בקריטריונים לסינון שצוינו.

patch

 כתיבת נתונים מעודכנים של DeliveryVehicle ל-Fleet Engine, ומקצה את Tasks ל-DeliveryVehicle.