REST Resource: providers.deliveryVehicles

משאב: DeliveryVehicle

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

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

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

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

טיפוסים בני מנייה (enums)
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

הסוג של כלי הרכב.

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

שיטות

create

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

get

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

list

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

patch

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