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 מאכלסת את השדה הזה במסלול מהרכב האחרון שהועבר אל קרון הרכב הבא כדי להבטיח שלצרכן בשדה הזה יש את המידע שזמין בצורה הטובה ביותר לגבי הנתיב הנוכחי של רכב המסירה.

מחרוזת בקידוד 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) לכל המשימות הפעילות שהוקצו לכלי המסירה.

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

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'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. ערך המאפיין יכול להיות מחרוזת, בוליאני או סוג כפול. delivery_vehicle_attribute_value יכול להיות רק אחת מהאפשרויות הבאות:
stringValue

string

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

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

boolean

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

number

ערך המאפיין הוקלד פעמיים.

DeliveryVehicleType

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

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

שיטות

create

 יצירת DeliveryVehicle חדש והחזרתו.

get

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

list

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

patch

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