REST Resource: providers.deliveryVehicles

משאב: DeliveryAutomotive

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

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 יש ניווט במסלול מפורט, והניווט באפליקציית הנהג עבר למצב 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.