Package maps.fleetengine.delivery.v1

אינדקס

DeliveryService

שירות המשלוחים של The Last Mile.

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

יצירת קבוצה של אובייקטים חדשים מסוג Task והחזרתה.
CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

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

rpc CreateTask(CreateTaskRequest) returns (Task)

יצירת אובייקט Task חדש והחזרתו.
DeleteDeliveryVehicle

rpc DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest) returns (Empty)

מחיקה של כלי רכב מסוג DeliveryVehicle מ-Fleet Engine.

הפונקציה מחזירה את הערך FAILED_PRECONDITION אם למשאב DeliveryVehicle הוקצו משימות פתוחות.
DeleteTask

rpc DeleteTask(DeleteTaskRequest) returns (Empty)

מחיקה של משימה אחת.

הפונקציה מחזירה את הערך FAILED_PRECONDITION אם המשימה פתוחה והוקצה לה כלי רכב להעברה.
GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

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

rpc GetTask(GetTaskRequest) returns (Task)

אחזור מידע על Task.
GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

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

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

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

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

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

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

המערכת כותבת את נתוני DeliveryVehicle המעודכנים ב-Fleet Engine ומקצה את Tasks ל-DeliveryVehicle. אי אפשר לעדכן את השם של DeliveryVehicle. אפשר לעדכן את remaining_vehicle_journey_segments, אבל הוא חייב להכיל את כל הערכים של VehicleJourneySegment שרוצים לשמור ב-DeliveryVehicle. הערכים של task_id מאוחזרים מ-remaining_vehicle_journey_segments, והערכים התואמים של Tasks מוקצים ל-DeliveryVehicle אם הם עדיין לא הוקצו.
UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

עדכון הנתונים של Task.

BatchCreateTasksRequest

הודעת הבקשה BatchCreateTask.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API. הערה: אם מגדירים את השדה הזה, שדה הכותרת בהודעות CreateTaskRequest חייב להיות ריק או תואם לשדה הזה.
parent

string

חובה. משאב ההורה שמשותף לכל המשימות. הערך חייב להיות בפורמט providers/{provider}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project. שדה ההורה בהודעות CreateTaskRequest חייב להיות ריק או תואם לשדה הזה.
requests[]

CreateTaskRequest

חובה. הודעת הבקשה שמציינת את המשאבים שרוצים ליצור. הערה: אפשר ליצור עד 500 משימות בקבוצה.

BatchCreateTasksResponse

הודעת התגובה BatchCreateTask.

שדות
tasks[]

Task

המשימות שנוצרו.

CreateDeliveryVehicleRequest

הודעת הבקשה CreateDeliveryVehicle.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
parent

string

חובה. הפורמט הנדרש הוא providers/{provider}. הספק חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.
delivery_vehicle_id

string

חובה. מזהה כלי הרכב להעברה חייב להיות ייחודי ועונה על ההגבלות הבאות:

  • צריכה להיות מחרוזת Unicode חוקית.
  • האורך המקסימלי הוא 64 תווים.
  • מנורמלים בהתאם לפורמט נירמול C של Unicode.
  • אסור לכלול את תווים ה-ASCII הבאים: '/',‏ ':',‏ '?',‏ ',' או '#'.
delivery_vehicle

DeliveryVehicle

חובה. הישות DeliveryVehicle שרוצים ליצור. כשיוצרים כלי רכב חדש להעברה, אפשר להגדיר את השדות האופציונליים הבאים:

  • סוג
  • last_location
  • מאפיינים

הערה: המערכת מתעלמת מהשדה name של DeliveryVehicle. אסור להגדיר את כל שדות DeliveryVehicle האחרים, אחרת תוחזר שגיאה.

CreateTaskRequest

הודעת הבקשה CreateTask.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
parent

string

חובה. הפורמט הנדרש הוא providers/{provider}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.
task_id

string

חובה. מזהה המשימה חייב להיות ייחודי, אבל הוא לא יכול להיות מזהה מעקב אחר משלוח. כדי לשמור מזהה מעקב של משלוח, משתמשים בשדה tracking_id. הערה: ליותר ממשימות אחת יכול להיות אותו tracking_id. מזהי המשימות כפופים להגבלות הבאות:

  • צריכה להיות מחרוזת Unicode חוקית.
  • האורך המקסימלי הוא 64 תווים.
  • מנורמלים בהתאם לפורמט נירמול C של Unicode.
  • אסור לכלול את תווים ה-ASCII הבאים: '/',‏ ':',‏ '?',‏ ',' או '#'.
task

Task

חובה. ישות המשימה שיוצרים. כשיוצרים משימה, חובה למלא את השדות הבאים:

  • type
  • state (צריך להגדיר את הערך OPEN)
  • tracking_id (אסור להגדיר את השדה למשימות מסוג UNAVAILABLE או SCHEDULED_STOP, אבל הוא נדרש לכל שאר סוגי המשימות)
  • planned_location (אופציונלי למשימות UNAVAILABLE)
  • task_duration

אפשר להגדיר את השדות הבאים:

  • target_time_window
  • task_tracking_view_config
  • attributes

הערה: המערכת מתעלמת מהשדה name של המשימה. אסור להגדיר את כל שדות המשימה האחרים, אחרת תוחזר שגיאה.

DeleteDeliveryVehicleRequest

הודעת הבקשה של DeleteDeliveryVehicle.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
name

string

חובה. הפורמט הנדרש הוא providers/{provider}/deliveryVehicles/{delivery_vehicle}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.

DeleteTaskRequest

הודעת הבקשה של DeleteTask.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
name

string

חובה. הפורמט הנדרש הוא providers/{provider}/tasks/{task}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.

DeliveryRequestHeader

RequestHeader מכיל שדות שקיימים בכל בקשות ה-RPC של העברה.

שדות
language_code

string

קוד השפה לפי BCP-47, למשל en-US או sr-Latn. מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. אם לא צוין שום שם, התגובה עשויה להיות בכל שפה, עם העדפה לאנגלית אם קיים שם כזה. דוגמה לערך שדה: en-US.
region_code

string

חובה. קוד האזור במאגר CLDR של האזור שממנו הגיעה הבקשה. דוגמה לערך שדה: US.
sdk_version

string

גרסת ה-SDK של מבצע הקריאה, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: 1.1.2.
os_version

string

גרסת מערכת ההפעלה שבה פועל ה-SDK הקורא. דוגמאות לערכי שדות: 4.4.1, ‏ 12.1.
device_model

string

הדגם של המכשיר שבו פועלת ערכת ה-SDK הקריאה. דוגמאות לערכי שדות: iPhone12,1, ‏ SM-G920F.
sdk_type

SdkType

סוג ה-SDK ששולח את הבקשה.
maps_sdk_version

string

גרסת MapSDK שעליה ה-SDK הקורא תלוי, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: 5.2.1.
nav_sdk_version

string

גרסת NavSDK שעל אחת מהן מבוססת ערכת ה-SDK הקריאה, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: 2.1.0.
platform

Platform

הפלטפורמה של ה-SDK הקורא.
manufacturer

string

היצרן של מכשיר Android מערכת ה-SDK הקוראת, רלוונטי רק לערכות ה-SDK של Android. דוגמה לערך שדה: Samsung.
android_api_level

int32

רמת ה-API של Android ב-SDK הקורא, רלוונטית רק ל-SDK של Android. דוגמה לערך שדה: 23.
trace_id

string

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

פלטפורמה

הפלטפורמה של ה-SDK הקורא.

טיפוסים בני מנייה (enum)
PLATFORM_UNSPECIFIED ערך ברירת המחדל. המערכת משתמשת בערך הזה אם לא מציינים את הפלטפורמה.
ANDROID הבקשה מגיעה מ-Android.
IOS הבקשה מגיעה מ-iOS.
WEB הבקשה מגיעה מהאינטרנט.

SdkType

סוגי ה-SDK האפשריים.

טיפוסים בני מנייה (enum)
SDK_TYPE_UNSPECIFIED ערך ברירת המחדל. המערכת משתמשת בערך הזה אם השדה sdk_type מושמט.
CONSUMER ה-SDK הקורא הוא צרכן.
DRIVER ערכת ה-SDK שמבצעת את הקריאה היא Driver.
JAVASCRIPT ה-SDK הקורא הוא JavaScript.

DeliveryVehicle

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

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

שדות
name

string

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

DeliveryVehicleLocation

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

DeliveryVehicleLocation

קלט בלבד. מיקומים שבהם כלי הרכב למשלוח היה בעבר, שעדיין לא דווחו ל-Fleet Engine. השדה הזה משמש ב-UpdateDeliveryVehicleRequest כדי לתעד מיקומים שלא ניתן היה לשלוח לשרת בעבר. בדרך כלל זה קורה כשאין חיבור לאינטרנט ברכב המסירה.
navigation_status

DeliveryVehicleNavigationStatus

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

bytes

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

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

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

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

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

LatLng

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

המערכת מתעלמת מהשדה הזה בקריאות ל-UpdateDeliveryVehicle אם השדה current_route_segment ריק.
remaining_distance_meters

Int32Value

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

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

Duration

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

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

VehicleJourneySegment

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

DeliveryVehicleAttribute

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

DeliveryVehicleType

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

DeliveryVehicleType

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

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

DeliveryVehicleAttribute

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

שדות
key

string

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

string

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

string

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

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

bool

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

double

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

DeliveryVehicleLocation

המיקום, המהירות והכיוון של רכב בנקודת זמן מסוימת.

שדות
location

LatLng

המיקום של הרכב. כשהמיקום נשלח ל-Fleet Engine, הוא מוגדר כמיקום GPS. כשמקבלים אותו בתגובה, המיקום של הרכב יכול להיות מיקום GPS, מיקום משלים או מיקום משוער אחר. המקור מצוין ב-location_sensor.
horizontal_accuracy
(deprecated)

DoubleValue

האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-latlng_accuracy.
latlng_accuracy

DoubleValue

רמת הדיוק של location במטרים כרדיוס.
heading

Int32Value

הכיוון שאליו הרכב נע, במדידה בפרוגרסיב. הערך 0 מייצג את הצפון. הטווח החוקי הוא [0,360).
bearing_accuracy
(deprecated)

DoubleValue

האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-heading_accuracy.
heading_accuracy

DoubleValue

דיוק של heading מעלות.
altitude

DoubleValue

הגובה במטרים מעל WGS84.
vertical_accuracy
(deprecated)

DoubleValue

האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-altitude_accuracy.
altitude_accuracy

DoubleValue

רמת דיוק של altitude מטרים.
speed_kmph
(deprecated)

Int32Value

מהירות הרכב בקילומטרים לשעה. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-speed.
speed

DoubleValue

מהירות הרכב במטרים לשנייה
speed_accuracy

DoubleValue

דיוק של speed במטרים לשנייה.
update_time

Timestamp

השעה שבה location דווח על ידי החיישן לפי השעון של החיישן.
server_time

Timestamp

פלט בלבד. השעה שבה השרת קיבל את פרטי המיקום.
location_sensor

DeliveryVehicleLocationSensor

ספק של נתוני מיקום (לדוגמה, GPS).
is_road_snapped

BoolValue

האם location מוצמד לכביש.
is_gps_sensor_enabled

BoolValue

קלט בלבד. מציין אם חיישן ה-GPS מופעל במכשיר הנייד.
time_since_update

Int32Value

קלט בלבד. הזמן (בשניות) מאז שהמיקום הזה נשלח לשרת בפעם הראשונה. הערך הזה יהיה אפס בעדכון הראשון. אם הזמן לא ידוע (לדוגמה, כשהאפליקציה מופעלת מחדש), הערך הזה מתאפס.
num_stale_updates
(deprecated)

Int32Value

קלט בלבד. הוצא משימוש: עכשיו נעשה שימוש באותות אחרים כדי לקבוע אם מיקום מסוים לא עדכני.
raw_location

LatLng

מיקום הרכב הגולמי (לא עבר עיבוד על ידי road-snapper).
raw_location_time

Timestamp

חותמת הזמן שמשויכת למיקום הגולמי.
raw_location_sensor

DeliveryVehicleLocationSensor

המקור של המיקום הגולמי. ברירת המחדל היא GPS.
raw_location_accuracy

DoubleValue

רמת הדיוק של raw_location כרדיום, במטרים.
supplemental_location

LatLng

מיקום משלים שמסופק על ידי האפליקציה המשולבת.
supplemental_location_time

Timestamp

חותמת הזמן שמשויכת למיקום המשלים.
supplemental_location_sensor

DeliveryVehicleLocationSensor

המקור של המיקום המשלים. ברירת המחדל היא CUSTOMER_SUPPLIED_LOCATION.
supplemental_location_accuracy

DoubleValue

רמת הדיוק של supplemental_location כרדיום, במטרים.
road_snapped
(deprecated)

bool

האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-is_road_snapped.

DeliveryVehicleLocationSensor

החיישן או השיטה ששימשו לקביעת המיקום.

טיפוסים בני מנייה (enum)
UNKNOWN_SENSOR החיישן לא צוין או לא ידוע.
GPS GPS או Assisted GPS.
NETWORK GPS משופר, מזהה מגדל תקשורת או נקודת גישה ל-Wi-Fi.
PASSIVE מזהה של תורן סלולרי או נקודת גישה ל-Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER מיקום שנקבע על ידי המכשיר הנייד כמיקום האפשרי ביותר בכביש.
CUSTOMER_SUPPLIED_LOCATION מיקום שסופק על ידי הלקוח ממקור עצמאי. בדרך כלל, הערך הזה משמש למיקום שסופק ממקורות אחרים מלבד המכשיר הנייד שבו פועל Driver SDK. אם המקור המקורי מתואר באחד מערכי המניין האחרים, צריך להשתמש בערך הזה. מיקומים שמסומנים בתווית CUSTOMER_SUPPLIED_LOCATION בדרך כלל מוצגים באמצעות השדה last_location.supplemental_location_sensor של DeliveryVehicle.
FLEET_ENGINE_LOCATION מיקום שמחושב על ידי Fleet Engine על סמך האותות שזמינים לו. פלט בלבד. הערך הזה יידחה אם הוא יקבל בבקשה.
FUSED_LOCATION_PROVIDER ספק המיקום המשולב של Android.
CORE_LOCATION ספק המיקום במערכות ההפעלה של Apple.

DeliveryVehicleNavigationStatus

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

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

GetDeliveryVehicleRequest

הודעת הבקשה GetDeliveryVehicle.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
name

string

חובה. הפורמט הנדרש הוא providers/{provider}/deliveryVehicles/{delivery_vehicle}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.

GetTaskRequest

הודעת הבקשה GetTask.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
name

string

חובה. הפורמט הנדרש הוא providers/{provider}/tasks/{task}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.

GetTaskTrackingInfoRequest

הודעת הבקשה GetTaskTrackingInfoRequest.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
name

string

חובה. הפורמט הנדרש הוא providers/{provider}/taskTrackingInfo/{tracking_id}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud, והשדה tracking_id חייב להיות מזהה המעקב שמשויך למשימה. שם לדוגמה יכול להיות providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id.

ListDeliveryVehiclesRequest

הודעת הבקשה ListDeliveryVehicles.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
parent

string

חובה. הפורמט הנדרש הוא providers/{provider}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.
page_size

int32

זה שינוי אופציונלי. המספר המקסימלי של כלי רכב להחזרה. יכול להיות שהשירות יחזיר פחות מהמספר הזה. אם לא מציינים את המספר הזה, השרת קובע את מספר התוצאות שיוחזר.
page_token

string

זה שינוי אופציונלי. אסימון דף, שהתקבל משיחה קודמת של ListDeliveryVehicles. צריך לספק את הפרטים האלה כדי לאחזר את הדף הבא.

כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListDeliveryVehicles חייבים להתאים לקריאה שסיפקה את אסימון הדף.
filter

string

זה שינוי אופציונלי. שאילתת סינון שחלה כשמעלים כלי רכב להעברת מוצרים. דוגמאות לתחביר של המסנן זמינות בכתובת http://aip.dev/160. אם לא מציינים ערך או אם מציינים מחרוזת ריקה למסנן, כל כלי המסירה יוחזרו.

שימו לב שהשאילתות היחידות שנתמכות ב-ListDeliveryVehicles הן על מאפייני רכב (לדוגמה, attributes.<key> = <value> או attributes.<key1> = <value1> AND attributes.<key2> = <value2>). כמו כן, כל המאפיינים מאוחסנים כמחרוזות, כך שההשוואות היחידות שנתמכות למאפיינים הן השוואות של מחרוזות. כדי להשוות לערכים מספריים או לערכים בוליאניים, צריך להוסיף לכל הערכים מירכאות מפורשות כדי שיוגדרו כמחרוזות (לדוגמה, attributes.<key> = "10" או attributes.<key> = "true").

המספר המקסימלי של הגבלות שמותר לכלול בשאילתת סינון הוא 50. הגבלה היא חלק מהשאילתה בפורמט attribute.<KEY> <COMPARATOR> <VALUE>. לדוגמה, attributes.foo = bar היא הגבלה אחת.
viewport

Viewport

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

ListDeliveryVehiclesResponse

הודעת התגובה ListDeliveryVehicles.

שדות
delivery_vehicles[]

DeliveryVehicle

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

string

אפשר להעביר את האסימון הזה ב-ListDeliveryVehiclesRequest כדי להמשיך להציג תוצאות. כשכל התוצאות יחזרו, השדה הזה לא יופיע בתגובה או שהוא יהיה מחרוזת ריקה.
total_size

int64

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

ListTasksRequest

הודעת הבקשה ListTasks.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
parent

string

חובה. הפורמט הנדרש הוא providers/{provider}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.
page_size

int32

זה שינוי אופציונלי. המספר המקסימלי של משימות להחזרה. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים את הערך הזה, השרת קובע את מספר התוצאות שיוחזר.
page_token

string

זה שינוי אופציונלי. אסימון דף שהתקבל משיחה קודמת של ListTasks. אפשר לספק אותו כדי לאחזר את הדף הבא.

כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListTasks חייבים להתאים לקריאה שסיפקה את אסימון הדף.
filter

string

זה שינוי אופציונלי. שאילתת סינון שחלה על רשימת המשימות. דוגמאות לתחביר של מסננים זמינות בכתובת http://aip.dev/160. אם לא מציינים ערך או מסננים לפי מחרוזת ריקה, כל המשימות יוחזרו. מידע על מאפייני המשימות שאפשר לסנן לפיהם זמין במאמר רשימת משימות.

ListTasksResponse

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

שדות
tasks[]

Task

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

string

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

int64

המספר הכולל של המשימות שתואמות לקריטריונים של הבקשה, בכל הדפים.

LocationInfo

מיקום עם מזהים נוספים.

שדות
point

LatLng

הקואורדינטות של המיקום.

משימה

משימה ב-Delivery API מייצגת פעולה אחת למעקב. באופן כללי, יש הבחנה בין משימות שקשורות למשלוח לבין משימות הפסקה. למשלוח יכולות להיות משויכות כמה משימות. לדוגמה, יכולה להיות משימה אחת לאיסוף ומשימה אחת להעברה או להחזרה. בנוסף, משימות שונות של משלוח מסוים יכולות להתבצע על ידי כלי רכב שונים. לדוגמה, רכב אחד יכול לבצע את האיסוף ולספק את המשלוח למרכז, ואילו רכב אחר יכול להעביר את אותו משלוח מהמרכז למיקום המסירה.

הערה: בממשקי ה-API ל-gRPC ול-REST נהוגות מוסכמות שונות למתן שמות לשדות. לדוגמה, השדה Task.journey_sharing_info ב-gRPC API והשדה Task.journeySharingInfo ב-REST API מתייחסים לאותו שדה.

שדות
name

string

הפורמט הנדרש הוא providers/{provider}/tasks/{task}.
type

Type

חובה. לא ניתן לשינוי. הגדרת הסוג של המשימה. לדוגמה, הפסקה או משלוח.
state

State

חובה. מצב הביצוע הנוכחי של המשימה.
task_outcome

TaskOutcome

התוצאה של המשימה.
task_outcome_time

Timestamp

חותמת הזמן שמציינת מתי הספק הגדיר את התוצאה של Task.
task_outcome_location

LocationInfo

המיקום שבו הוגדרה התוצאה של Task. הערך הזה מתעדכן כחלק מ-UpdateTask. אם הספק לא מעדכן את הערך הזה באופן מפורש, מערכת Fleet Engine מאכלסת אותו כברירת מחדל במיקום האחרון הידוע של הרכב (המיקום הגולמי).
task_outcome_location_source

TaskOutcomeLocationSource

מציין מאיפה הגיע הערך של task_outcome_location.
tracking_id

string

לא ניתן לשינוי. השדה הזה מאפשר לשמור מזהה כדי להימנע משימוש במיפוי מורכב. לא ניתן להגדיר את tracking_id למשימות מסוג UNAVAILABLE ו-SCHEDULED_STOP. המזהים האלה כפופים להגבלות הבאות:

  • צריכה להיות מחרוזת Unicode חוקית.
  • האורך המקסימלי הוא 64 תווים.
  • מנורמלים בהתאם לפורמט נירמול C של Unicode.
  • אסור לכלול את תווים ה-ASCII הבאים: '/',‏ ':',‏ '?',‏ ',' או '#'.
delivery_vehicle_id

string

פלט בלבד. המזהה של הרכב שמבצע את המשימה הזו. מזהי כלי רכב להעברה כפופים להגבלות הבאות:

  • צריכה להיות מחרוזת Unicode חוקית.
  • האורך המקסימלי הוא 64 תווים.
  • מנורמלים בהתאם לפורמט נירמול C של Unicode.
  • אסור לכלול את תווים ה-ASCII הבאים: '/',‏ ':',‏ '?',‏ ',' או '#'.
planned_location

LocationInfo

לא ניתן לשינוי. המיקום שבו המשימה תושלם. אופציונלי למשימות UNAVAILABLE, אבל חובה לכל המשימות האחרות.
task_duration

Duration

חובה. לא ניתן לשינוי. הזמן הדרוש לביצוע משימה במיקום הזה.
target_time_window

TimeWindow

חלון הזמן שבו המשימה צריכה להסתיים.
journey_sharing_info

JourneySharingInfo

פלט בלבד. שדות ספציפיים לשיתוף המסלול. השדה לא מאוכלס כשהסטטוס הוא CLOSED.
task_tracking_view_config

TaskTrackingViewConfig

ההגדרה של מעקב המשימות, שמציינת אילו רכיבי נתונים גלויים למשתמשי הקצה ובאילו נסיבות.
attributes[]

TaskAttribute

רשימה של מאפייני משימות מותאמים אישית. לכל מאפיין צריך להיות מפתח ייחודי.

JourneySharingInfo

שדות ספציפיים לשיתוף המסלול.

שדות
remaining_vehicle_journey_segments[]

VehicleJourneySegment

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

הקטע הראשון, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) או Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), מכיל את פרטי המסלול מהמיקום האחרון הידוע של הנהג/ת אל VehicleStop הקרוב. בדרך כלל, פרטי המסלול הנוכחי מגיעים מאפליקציית הנהג, מלבד במקרים מסוימים שמפורטים במסמכי התיעוד של DeliveryVehicle.current_route_segment. הפלחים האחרים ב-Task.journey_sharing_info.remaining_vehicle_journey_segments‏ (gRPC) או ב-Task.journeySharingInfo.remainingVehicleJourneySegments‏ (REST) מאוכלסים על ידי Fleet Engine. הם מספקים מידע על המסלול בין VehicleStops הנותרים.
last_location

DeliveryVehicleLocation

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

bool

מציין אם ניתן להתאים את lastLocation של הרכב ל-current_route_segment. הערך הזה הוא False אם last_location או current_route_segment לא קיימים. הערך הזה מחושב על ידי Fleet Engine. המערכת מתעלמת מעדכונים מהלקוחות.

מדינה

המצב של המשימה. זהו סימן להתקדמות של המשימות.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED ברירת מחדל. משמש לסטטוס משימה לא צוין או לא מזוהה.
OPEN יכול להיות שהמשימה עדיין לא הוקצה לרכב מסירה, או שרכב המסירה עדיין לא עבר את תחנת הרכב שהוקצה ל-Task.
CLOSED כשהרכב עובר את תחנת העצירה של המשימה הזו.

TaskOutcome

התוצאה של ניסיון להריץ משימה. כשהפעולה TaskState סגורה, הערך של TaskOutcome מציין אם היא הושלמה בהצלחה.

טיפוסים בני מנייה (enum)
TASK_OUTCOME_UNSPECIFIED תוצאת המשימה לפני שהערך שלה מוגדר.
SUCCEEDED המשימה הושלמה בהצלחה.
FAILED לא ניתן היה להשלים את המשימה או שהיא בוטלה.

TaskOutcomeLocationSource

הזהות של המקור שאכלס את task_outcome_location.

טיפוסים בני מנייה (enum)
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED תוצאת המשימה לפני שהיא מוגדרת.
PROVIDER הספק ציין את task_outcome_location.
LAST_VEHICLE_LOCATION הספק לא ציין את task_outcome_location, לכן מערכת Fleet Engine השתמשה במיקום האחרון הידוע של הרכב.

סוג

סוג המשימה.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED כברירת מחדל, סוג המשימה לא ידוע.
PICKUP משימה של איסוף היא הפעולה שמתבצעת כדי לאסוף משלוח מלקוח. כשמקבלים הודעות על איסוף כלי רכב במסוף או על איסוף כלי רכב מרכזיים, צריך להשתמש בסוג SCHEDULED_STOP.
DELIVERY משימה של משלוח היא הפעולה שמתבצעת כדי לספק משלוח ללקוח קצה. כדי לציין הורדות של כלי רכב במסוף או של כלי רכב להעברת נוסעים, צריך להשתמש בסוג SCHEDULED_STOP.
SCHEDULED_STOP משימה של עצירה מתוזמנת משמשת למטרות תכנון. לדוגמה, האירוע יכול לייצג איסוף או מסירה של משלוחים מכלי רכב או ממאגרים. אסור להשתמש בו בשביל משלוחים שנאספים או נמסרים על ידי לקוח קצה.
UNAVAILABLE משימה שמציינת שהרכב לא זמין לשירות. לדוגמה, זה יכול לקרות כשהנהג מפסיק לצורך הפסקה או כשהרכב מתדלק.

TaskAttribute

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

שדות
key

string

המפתח של המאפיין. מפתחות לא יכולים להכיל את התו פסיק נקודה (:).
שדה האיחוד task_attribute_value. ערך המאפיין יכול להיות מסוג מחרוזת, bool או double. אם לא מגדירים אף אחד מהם, הערך של string_value ב-TaskAttribute יישמר כמחרוזת הריקה "". הערך של task_attribute_value יכול להיות רק אחד מהערכים הבאים:
string_value

string

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

bool

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

double

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

TaskTrackingInfo

ההודעה TaskTrackingInfo. ההודעה מכילה את פרטי המעקב אחרי המשימה, שישמשו להצגה. אם מזהה מעקב משויך לכמה משימות, מערכת Fleet Engine משתמשת בהיוריסטיקה כדי להחליט איזה TaskTrackingInfo של Task לבחור.

שדות
name

string

חייב להיות בפורמט providers/{provider}/taskTrackingInfo/{tracking}, כאשר tracking מייצג את המזהה לצורכי מעקב.
tracking_id

string

לא ניתן לשינוי. המזהה לצורכי מעקב של משימה. * חייבת להיות מחרוזת Unicode תקינה. * מוגבל לאורך של 64 תווים לכל היותר. * עבר נירמול בהתאם ל-Unicode Normalization Form C. * אסור לכלול את תווי ה-ASCII הבאים: '/',‏ ':',‏ '?',‏ ',' או '#'.
vehicle_location

DeliveryVehicleLocation

המיקום האחרון של הרכב.
route_polyline_points[]

LatLng

רשימה של נקודות שמחוברות זו לזו ויוצרות קו מרובע של המסלול הצפוי של הרכב למיקום של המשימה הזו.
remaining_stop_count

Int32Value

מספר העצירות שנותרו לרכב עד שמגיעים לתחנה של המשימה, כולל התחנה של המשימה. לדוגמה, אם התחנה הבאה של הרכב היא התחנה של המשימה, הערך יהיה 1.
remaining_driving_distance_meters

Int32Value

המרחק הכולל שנותר במטרים עד ל-VehicleStop הרצוי.
estimated_arrival_time

Timestamp

חותמת הזמן שמציינת את זמן ההגעה המשוער לתחנה.
estimated_task_completion_time

Timestamp

חותמת הזמן שמציינת את מועד הסיום המשוער של משימה.
state

State

מצב הביצוע הנוכחי של המשימה.
task_outcome

TaskOutcome

התוצאה של ניסיון להריץ משימה.
task_outcome_time

Timestamp

חותמת הזמן שמציינת מתי הספק הגדיר את התוצאה של המשימה.
planned_location

LocationInfo

לא ניתן לשינוי. המיקום שבו המשימה תושלם.
target_time_window

TimeWindow

חלון הזמן שבו המשימה צריכה להסתיים.
attributes[]

TaskAttribute

המאפיינים המותאמים אישית שהוגדרו במשימה.

TaskTrackingViewConfig

הודעת התצורה שמגדירה מתי רכיב נתונים של משימה צריך להיות גלוי למשתמשי הקצה.

שדות
route_polyline_points_visibility

VisibilityOption

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

VisibilityOption

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

VisibilityOption

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

VisibilityOption

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

VisibilityOption

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

VisibilityOption

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

VisibilityOption

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

שדות
שדה האיחוד visibility_option. אפשרות החשיפה הספציפית שנבחרה. הערך של visibility_option יכול להיות רק אחת מהאפשרויות הבאות:
remaining_stop_count_threshold

int32

רכיב הנתונים הזה גלוי למשתמשי הקצה אם מספר תחנות העצירה שנותרו <= remaining_stop_count_threshold.
duration_until_estimated_arrival_time_threshold

Duration

רכיב הנתונים הזה גלוי למשתמשי הקצה אם זמן ההגעה המשוער לתחנה <= duration_until_estimated_arrival_time_threshold.
remaining_driving_distance_meters_threshold

int32

רכיב הנתונים הזה גלוי למשתמשי הקצה אם מרחק הנסיעה שנותר במטרים <= remaining_driving_distance_meters_threshold.
always

bool

אם הערך מוגדר כ-true, רכיב הנתונים הזה תמיד גלוי למשתמשי הקצה ללא ערכי סף. אי אפשר להגדיר את השדה הזה כ-false.
never

bool

אם הערך מוגדר כ-true, רכיב הנתונים הזה תמיד מוסתר ממשתמשי הקצה ללא ערכי סף. אי אפשר להגדיר את השדה הזה כ-false.

TimeWindow

טווח זמן.

שדות
start_time

Timestamp

חובה. שעת ההתחלה של חלון הזמן (כולל).
end_time

Timestamp

חובה. שעת הסיום של חלון הזמן (כולל).

UpdateDeliveryVehicleRequest

הודעת הבקשה UpdateDeliveryVehicle.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
delivery_vehicle

DeliveryVehicle

חובה. עדכון הישות DeliveryVehicle שרוצים להחיל. הערה: אי אפשר לעדכן את השם של DeliveryVehicle.
update_mask

FieldMask

חובה. אנונימיזציה של שדות שמציינת אילו שדות DeliveryVehicle לעדכן. הערה: השדה update_mask חייב להכיל לפחות שדה אחד.

זוהי רשימה של שמות שדות מוגדרים במלואם, שמופרדים בפסיקים. דוגמה: "remaining_vehicle_journey_segments"

UpdateTaskRequest

הודעת הבקשה UpdateTask.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API.
task

Task

חובה. המשימה שמשויכת לעדכון. השדות הבאים נשמרים על ידי Fleet Engine. אין לעדכן אותם באמצעות Task.update.

  • last_location.
  • last_location_snappable.
  • name.
  • remaining_vehicle_journey_segments.
  • task_outcome_location_source.

הערה: אי אפשר לשנות את הערך של task_outcome אחרי שמגדירים אותו.

אם המשימה הוקצה לרכב מסירה, אל תגדירו את סטטוס המשימה כ'סגורה' באמצעות Task.update. במקום זאת, מסירים את VehicleStop שמכיל את המשימה מכלי התובלה, וכך מגדירים את סטטוס המשימה ל'סגור' באופן אוטומטי.
update_mask

FieldMask

חובה. מסכת השדות שמציינת אילו שדות של משימות לעדכן. הערה: ה-update_mask חייב להכיל לפחות שדה אחד.

זוהי רשימה של שמות שדות מוגדרים במלואם, שמופרדים בפסיקים. דוגמה: "task_outcome,task_outcome_time,task_outcome_location"

VehicleJourneySegment

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

שדות
stop

VehicleStop

מציין את מיקום התחנה, יחד עם הערכים של Task שמשויכים לתחנה. יכול להיות שחלק מהשדות של VehicleStop לא יופיעו אם קטע המסע הזה הוא חלק מ-JourneySharingInfo.
driving_distance_meters

Int32Value

פלט בלבד. מרחק הנסיעה מהתחנה הקודמת לתחנה הזו. אם העצירה הנוכחית היא העצירה הראשונה ברשימת קטעי המסלול, נקודת ההתחלה היא המיקום של הרכב שסומן בזמן שהעצירה הזו נוספה לרשימה. יכול להיות שהשדה הזה לא יופיע אם קטע המסלול הזה הוא חלק מ-JourneySharingInfo.
driving_duration

Duration

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

אם השדה הזה מוגדר בנתיב Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) או Task.remainingVehicleJourneySegments[0].drivingDuration (REST), הוא עשוי להיות מאוכלס בערך מ-DeliveryVehicle.remaining_duration (gRPC) או מ-DeliveryVehicle.remainingDuration (REST). כך מוצגת משך הנסיעה שנותר מהמיקום הידוע האחרון של אפליקציית הנהג, ולא משך הנסיעה מהעצירה הקודמת.
path[]

LatLng

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

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

VehicleStop

תיאור של נקודה שבה הרכב עוצר כדי לבצע Task אחד או יותר.

שדות
planned_location

LocationInfo

חובה. המיקום של התחנה. שימו לב: יכול להיות שהמיקומים ב-Task לא יהיו זהים למיקום הזה, אבל הם יהיו במרחק קצר ממנו. השדה הזה לא יאוכלס בתגובה של קריאה מסוג GetTask.
tasks[]

TaskInfo

רשימת הTask שצריך לבצע בתחנה הזו. השדה הזה לא יאוכלס בתגובה של קריאה מסוג GetTask.
state

State

המצב של VehicleStop. השדה הזה לא יאוכלס בתגובה של קריאה מסוג GetTask.

מדינה

המצב הנוכחי של VehicleStop.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא ידוע.
NEW נוצרו, אבל לא מתבצע ניתוב פעיל שלהם.
ENROUTE הוקצו ונעשה בהן ניתוב פעיל.
ARRIVED הגעה לתחנה. ההנחה היא שכאשר הרכב מקבל מסלול לתחנה הבאה, כל התחנות הקודמות הושלמו.

TaskInfo

מידע נוסף על המשימה שבוצעה בתחנה הזו.

שדות
task_id

string

מזהה המשימה. השדה הזה לא יאוכלס בתגובה של קריאה מסוג GetTask. מזהי המשימות כפופים להגבלות הבאות:

  • צריכה להיות מחרוזת Unicode חוקית.
  • האורך המקסימלי הוא 64 תווים.
  • מנורמלים בהתאם לפורמט נירמול C של Unicode.
  • אסור לכלול את תווים ה-ASCII הבאים: '/',‏ ':',‏ '?',‏ ',' או '#'.
task_duration

Duration

פלט בלבד. הזמן הנדרש לביצוע המשימה.
target_time_window

TimeWindow

פלט בלבד. חלון הזמן שבו המשימה צריכה להסתיים. ההגדרה הזו מוגדרת רק בתגובה להודעה GetDeliveryVehicle.