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 משימות מסוג OPEN.
DeleteTask

rpc DeleteTask(DeleteTaskRequest) returns (Empty)

מחיקת משימה בודדת.

הפונקציה מחזירה FAILED_PRECONDITION אם המשימה היא OPEN והיא מוקצית ל-DeliveryVehicle.
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)

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

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

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

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

כותב נתוני DeliveryVehicle מעודכנים ל-Fleet Engine, ומקצה את Tasks ל-DeliveryVehicle. אי אפשר לעדכן את השם של DeliveryVehicle. אפשר לעדכן את remaining_vehicle_journey_segments, אבל הוא צריך לכלול את כל VehicleJourneySegment כדי שהשינויים יישמרו ב-DeliveryVehicle. מערכת remaining_vehicle_journey_segments מאחזרת את task_id, ומקצה את 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. השדה parent בהודעות 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 תווים.
  • מנורמלים לפי Unicode Normalization Form C.
  • לא יכול להכיל אף אחד מתווי ה-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 תווים.
  • מנורמלים לפי Unicode Normalization Form C.
  • לא יכול להכיל אף אחד מתווי ה-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

הודעת בקשה למחיקת כלי רכב למסירה.

שדות
header

DeliveryRequestHeader

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

string

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

DeleteTaskRequest

הודעת בקשה למחיקת משימה.

שדות
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 של השיחות, רלוונטי רק לערכות Android SDK. דוגמה לערך של שדה: 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 לשיחות הוא Consumer.
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 מאכלס את השדה הזה במסלול מ-VehicleStop האחרון שעבר ועד ל-VehicleStop הבא, כדי להבטיח שלצרכן של השדה הזה יהיה את המידע הטוב ביותר שזמין על הנתיב הנוכחי של רכב המשלוחים.
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. בדרך כלל, השדה הזה מסופק על ידי אפליקציית הנהג, אבל יש נסיבות שבהן 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 אם השדה current_route_segment ריק.
remaining_duration

Duration

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

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

VehicleJourneySegment

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

DeliveryVehicleAttribute

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

DeliveryVehicleType

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

DeliveryVehicleType

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

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

DeliveryVehicleAttribute

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

שדות
key

string

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

string

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

string

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

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

LatLng

המיקום מספק המיקום המשולב של Android.
flp_update_time

Timestamp

עדכון חותמת הזמן של flp_location
flp_latlng_accuracy_meters

DoubleValue

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

Int32Value

הכיוון שבו הרכב נע במעלות, כפי שנקבע על ידי ספק המיקום המשולב. ‫0 מייצג צפון. הטווח התקין הוא [0,360).
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. אם המקור המקורי מתואר על ידי אחד מערכי ה-enum האחרים, צריך להשתמש בערך הזה. מיקומים שמסומנים בערך CUSTOMER_SUPPLIED_LOCATION בדרך כלל מסופקים דרך last_location.supplemental_location_sensor של DeliveryVehicle.
FLEET_ENGINE_LOCATION מיקום שמחושב על ידי Fleet Engine על סמך האותות שזמינים לו. פלט בלבד. אם הערך הזה יתקבל בבקשה, הוא יידחה.
FUSED_LOCATION_PROVIDER ספק המיקום המשולב של Android.
CORE_LOCATION ספק המיקום במערכות הפעלה של אפל.

DeliveryVehicleNavigationStatus

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

טיפוסים בני מנייה (enum)
UNKNOWN_NAVIGATION_STATUS לא צוין סטטוס הניווט.
NO_GUIDANCE הניווט באפליקציית הנהג הוא במצב FREE_NAV.
ENROUTE_TO_DESTINATION הניווט במסלול מפורט זמין, והניווט באפליקציית הנהג עבר למצב 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

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

string

שם המשאב של המקום שמייצג את המיקום הזה. הפורמט הוא places/{place_id}. צריך לציין את point או את place כקלט. אם מציינים את שניהם, המערכת משתמשת ב-point לניתוב וב-place למטא-נתונים. הערך place נכלל בפלט רק אם הוא נכלל בקלט, כלומר לא מתבצע חיפוש של place מתוך LatLng.

זוהי תכונה ניסיונית.
point_location_source

PointSource

פלט בלבד. המקור של השדה point latlng. התכונה הזו ניסיונית.

PointSource

מציין את המקור של הערך LatLng.

טיפוסים בני מנייה (enum)
POINT_SOURCE_UNSPECIFIED לא צוין מקור נקודתי.
POINT_SOURCE_DEVELOPER_PROVIDED המידע על LatLng סופק במפורש על ידי המפתח.
POINT_SOURCE_CALCULATED_FROM_PLACE המרחק 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 תווים.
  • מנורמלים לפי Unicode Normalization Form C.
  • לא יכול להכיל אף אחד מתווי ה-ASCII הבאים: '/',‏ ':',‏ '?',‏ ',' או '#'.
delivery_vehicle_id

string

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

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

LocationInfo

אי אפשר לשנות אותו. המיקום שבו המשימה תושלם. אופציונלי ב-UNAVAILABLE Tasks, אבל חובה בכל שאר המשימות.
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

השדה מציין אם אפשר להצמיד את המיקום האחרון של הרכב 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

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

שדות
key

string

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

string

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

bool

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

double

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

TaskTrackingInfo

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

שדות
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 קטן או שווה לערך של remaining_stop_count_threshold.
duration_until_estimated_arrival_time_threshold

Duration

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

אם המשימה הוקצתה לרכב משלוחים, אל תגדירו את מצב המשימה כ-CLOSED באמצעות 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), יכול להיות שהוא יאוכלס בערך של LatLng שפוענח מ-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 תווים.
  • מנורמלים לפי Unicode Normalization Form C.
  • לא יכול להכיל אף אחד מתווי ה-ASCII הבאים: '/',‏ ':',‏ '?',‏ ',' או '#'.
task_duration

Duration

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

TimeWindow

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