אינדקס
DeliveryService
(ממשק)BatchCreateTasksRequest
(הודעה)BatchCreateTasksResponse
(הודעה)CreateDeliveryVehicleRequest
(הודעה)CreateTaskRequest
(הודעה)DeliveryRequestHeader
(הודעה)DeliveryRequestHeader.Platform
(טיפוס enum)DeliveryRequestHeader.SdkType
(enum)DeliveryVehicle
(הודעה)DeliveryVehicle.DeliveryVehicleType
(enum)DeliveryVehicleAttribute
(הודעה)DeliveryVehicleLocation
(הודעה)DeliveryVehicleLocationSensor
(enum)DeliveryVehicleNavigationStatus
(טיפוס enum)GetDeliveryVehicleRequest
(הודעה)GetTaskRequest
(הודעה)GetTaskTrackingInfoRequest
(הודעה)ListDeliveryVehiclesRequest
(הודעה)ListDeliveryVehiclesResponse
(הודעה)ListTasksRequest
(הודעה)ListTasksResponse
(הודעה)LocationInfo
(הודעה)Task
(הודעה)Task.JourneySharingInfo
(הודעה)Task.State
(טיפוס enum)Task.TaskOutcome
(enum)Task.TaskOutcomeLocationSource
(enum)Task.Type
(enum)TaskAttribute
(הודעה)TaskTrackingInfo
(הודעה)TaskTrackingViewConfig
(הודעה)TaskTrackingViewConfig.VisibilityOption
(הודעה)TimeWindow
(הודעה)UpdateDeliveryVehicleRequest
(הודעה)UpdateTaskRequest
(הודעה)VehicleJourneySegment
(הודעה)VehicleStop
(הודעה)VehicleStop.State
(enum)VehicleStop.TaskInfo
(הודעה)
DeliveryService
שירות המשלוחים של The Last Mile.
BatchCreateTasks |
---|
יצירת קבוצה של אובייקטים חדשים מסוג |
CreateDeliveryVehicle |
---|
יצירת |
CreateTask |
---|
יצירת אובייקט |
GetDeliveryVehicle |
---|
הפונקציה מחזירה את מופע |
GetTask |
---|
קבלת מידע על |
GetTaskTrackingInfo |
---|
הפונקציה מחזירה את המופע שצוין בשדה |
ListDeliveryVehicles |
---|
הפונקציה מקבלת את כל הערכים של |
ListTasks |
---|
הפונקציה מקבלת את כל הערכים של |
UpdateDeliveryVehicle |
---|
המערכת כותבת את נתוני |
UpdateTask |
---|
עדכון הנתונים של |
BatchCreateTasksRequest
הודעת הבקשה BatchCreateTask
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה הרגילה של Delivery API. הערה: אם מגדירים את השדה הזה, שדה הכותרת בהודעות |
parent |
חובה. משאב ההורה שכל המשימות משתפות. הערך חייב להיות בפורמט |
requests[] |
חובה. הודעת הבקשה שמציינת את המשאבים שרוצים ליצור. הערה: אפשר ליצור עד 500 משימות בבת אחת. |
BatchCreateTasksResponse
הודעת התגובה BatchCreateTask
.
שדות | |
---|---|
tasks[] |
המשימות שנוצרו. |
CreateDeliveryVehicleRequest
הודעת הבקשה CreateDeliveryVehicle
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API. |
parent |
חובה. חייב להיות בפורמט |
delivery_ |
חובה. מזהה כלי הרכב להעברה חייב להיות ייחודי ועונה על ההגבלות הבאות:
|
delivery_ |
חובה. הישות
הערה: המערכת מתעלמת מהשדה |
CreateTaskRequest
הודעת הבקשה CreateTask
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API. |
parent |
חובה. הפורמט הנדרש הוא |
task_ |
חובה. מזהה המשימה חייב להיות ייחודי, אבל לא מזהה לצורכי מעקב אחר משלוח. כדי לשמור מזהה לצורכי מעקב, צריך להשתמש בשדה
|
task |
חובה. ישות המשימה שיוצרים. כשיוצרים משימה, חובה למלא את השדות הבאים:
הערה: המערכת מתעלמת מהשדה |
DeliveryRequestHeader
RequestHeader מכיל שדות שקיימים בכל בקשות ה-RPC של העברת הודעות.
שדות | |
---|---|
language_ |
קוד השפה BCP-47, כמו en-US או sr-Latn. מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. אם לא תציינו שם, התשובה יכולה להיות בכל שפה, עם העדפה לאנגלית אם קיים שם כזה. דוגמה לערך שדה: |
region_ |
חובה. קוד האזור במאגר CLDR של האזור שממנו הגיעה הבקשה. דוגמה לערך שדה: |
sdk_ |
גרסת ה-SDK של מבצע הקריאה, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: |
os_ |
גרסת מערכת ההפעלה שבה פועל ה-SDK הקורא. דוגמאות לערכים בשדות: |
device_ |
הדגם של המכשיר שבו פועלת ערכת ה-SDK של מבצע הקריאה. דוגמאות לערכי שדות: |
sdk_ |
סוג ה-SDK ששולח את הבקשה. |
maps_ |
גרסת ה-MapSDK שבה ה-SDK של הקריאה תלוי, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: |
nav_ |
גרסת NavSDK שעל אחת מהן מבוססת ערכת ה-SDK הקריאה, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: |
platform |
הפלטפורמה של ה-SDK הקורא. |
manufacturer |
היצרן של מכשיר Android מערכת ה-SDK שבה מתבצעת הקריאה, רלוונטי רק לערכות ה-SDK של Android. דוגמה לערך שדה: |
android_ |
רמת ה-API של Android ב-SDK הקורא, רלוונטית רק ל-SDK של Android. דוגמה לערך שדה: |
trace_ |
מזהה אופציונלי שאפשר לספק למטרות רישום ביומן כדי לזהות את הבקשה. |
פלטפורמה
הפלטפורמה של ערכת ה-SDK שקוראת ל-API.
טיפוסים בני מנייה (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 |
השם הייחודי של רכב המשלוחים הזה. הפורמט הוא |
last_ |
המיקום האחרון שדווח על רכב המסירה. |
navigation_ |
סטטוס הניווט של כלי הרכב לצורך מסירה. |
current_ |
הקו הפוליגוני המקודד שמציין את המסלול שהניווט ממליץ לנסוע בו לנקודת הציון הבאה. אפליקציית הנהג מעדכנת את העדכון כשיש עצירה או כשעוברים עצירה וכשהמסלול משנה את הניווט. הפרמטרים האלה מסוג יש כמה מקרים שבהם לא ניתן להשתמש בשדה הזה כדי לאכלס את
במקרים כאלה, מערכת Fleet Engine מאכלסת את השדה הזה במסלול מהעצירה האחרונה של כלי הרכב ועד לעצירה הבאה, כדי להבטיח שלצרכן השדה הזה יהיה את המידע הטוב ביותר שזמין לגבי הנתיב הנוכחי של כלי הרכב לצורכי מסירה. |
current_ |
המיקום שבו המערכת מתעלמת מהשדה הזה בקריאות ל- |
remaining_ |
מרחק הנסיעה שנותר עבור המערכת של Fleet Engine מתעלמת מהשדה הזה ב- |
remaining_ |
משך הנסיעה שנותר ב- Fleet Engine מתעלם מהשדה הזה ב- |
remaining_ |
קטעי המסלול שהוקצו לרכב המסירה הזה, החל מהמיקום האחרון שדווח על הרכב. השדה הזה לא מאוכלס בתגובה של |
attributes[] |
רשימה של מאפיינים מותאמים אישית של כלי מסירה. לרכב מסירה יכולים להיות עד 100 מאפיינים, וכל מאפיין חייב לכלול מפתח ייחודי. |
type |
הסוג של רכב המשלוחים הזה. אם המדיניות לא מוגדרת, ברירת המחדל תהיה |
DeliveryVehicleType
סוג רכב המשלוחים.
טיפוסים בני מנייה (enum) | |
---|---|
DELIVERY_VEHICLE_TYPE_UNSPECIFIED |
לא נעשה שימוש בערך. |
AUTO |
מכונית. |
TWO_WHEELER |
אופנוע, טוסטוס או כלי רכב דו-גלגלי אחר |
BICYCLE |
תחבורה מונעת על ידי אדם. |
PEDESTRIAN |
כלי רכב בני אדם, שבדרך כלל הולכים או רצים, נעשים לאורך שבילים להולכי רגל. |
DeliveryVehicleAttribute
מתאר מאפיין רכב כצמד מפתח/ערך. אורך המחרוזת 'key:value' לא יכול לחרוג מ-256 תווים.
שדות | |
---|---|
key |
המפתח של המאפיין. |
value |
הערך של המאפיין. |
שדה איחוד delivery_vehicle_attribute_value . ערך המאפיין יכול להיות מחרוזת, בוליאני או סוג כפול. delivery_vehicle_attribute_value יכול להיות רק אחת מהאפשרויות הבאות: |
|
string_ |
ערך מאפיין שהוקלד במחרוזת. הערה: השדה הזה זהה לשדה |
bool_ |
ערך מאפיין מסוג בוליאני. |
number_ |
ערך מאפיין מסוג double. |
DeliveryVehicleLocation
המיקום, המהירות והכיוון של רכב בנקודת זמן מסוימת.
שדות | |
---|---|
location |
המיקום של הרכב. כשהמיקום נשלח ל-Fleet Engine, הוא מוגדר כמיקום GPS. כשמקבלים אותו בתגובה, המיקום של הרכב יכול להיות מיקום GPS, מיקום משלים או מיקום משוער אחר. המקור מצוין ב- |
horizontal_accuracy |
האפשרות הזו הוצאה משימוש. במקום זאת, אתם צריכים להשתמש ב- |
latlng_ |
דיוק של |
heading |
כיוון שהרכב נע במעלות. הערך 0 מייצג את הצפון. הטווח החוקי הוא [0,360). |
bearing_accuracy |
האפשרות הזו הוצאה משימוש. במקום זאת, אתם צריכים להשתמש ב- |
heading_ |
דיוק של |
altitude |
גובה במטרים מעל WGS84. |
vertical_accuracy |
האפשרות הזו הוצאה משימוש. במקום זאת, אתם צריכים להשתמש ב- |
altitude_ |
רמת הדיוק היא |
speed_kmph |
מהירות הרכב בקילומטרים לשעה. האפשרות הזו הוצאה משימוש. במקום זאת, אתם צריכים להשתמש ב- |
speed |
מהירות הרכב במטרים לשנייה |
speed_ |
דיוק של |
update_ |
השעה שבה החיישן דיווח על |
server_ |
פלט בלבד. השעה שבה השרת קיבל את פרטי המיקום. |
location_ |
ספק נתוני המיקום (לדוגמה, |
is_ |
האם |
is_ |
קלט בלבד. מציינת אם חיישן ה-GPS מופעל במכשיר הנייד. |
time_ |
קלט בלבד. הזמן (בשניות) שעבר מאז שהמיקום הזה נשלח לראשונה לשרת. בעדכון הראשון הערך יהיה אפס. אם הזמן לא ידוע (לדוגמה, כשהאפליקציה מופעלת מחדש), הערך הזה מתאפס. |
num_stale_updates |
קלט בלבד. הוצא משימוש: עכשיו נעשה שימוש באותות אחרים כדי לקבוע אם מיקום מסוים לא עדכני. |
raw_ |
מיקום הרכב הגולמי (לא עבר עיבוד על ידי road-snapper). |
raw_ |
חותמת הזמן שמשויכת למיקום הגולמי. |
raw_ |
המקור של המיקום הגולמי. ברירת המחדל היא |
raw_ |
רמת הדיוק של |
supplemental_ |
מיקום משלים שמסופק על ידי האפליקציה המשולבת. |
supplemental_ |
חותמת הזמן שמשויכת למיקום המשלים. |
supplemental_ |
המקור של המיקום המשלים. ברירת המחדל היא |
supplemental_ |
רמת הדיוק של |
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 |
ספק המיקום במערכות ההפעלה של Apple. |
GetDeliveryVehicleRequest
הודעת הבקשה GetDeliveryVehicle
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API. |
name |
חובה. הפורמט הנדרש הוא |
GetTaskRequest
הודעת הבקשה GetTask
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API. |
name |
חובה. הפורמט הנדרש הוא |
GetTaskTrackingInfoRequest
הודעת הבקשה GetTaskTrackingInfoRequest
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API. |
name |
חובה. חייב להיות בפורמט |
ListDeliveryVehiclesRequest
הודעת הבקשה ListDeliveryVehicles
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API. |
parent |
חובה. הפורמט הנדרש הוא |
page_ |
זה שינוי אופציונלי. המספר המקסימלי של כלי רכב להחזרה. יכול להיות שהשירות יחזיר פחות מהמספר הזה. אם לא תציינו את המספר הזה, השרת יקבע את מספר התוצאות שיוחזרו. |
page_ |
זה שינוי אופציונלי. אסימון דף, שהתקבל מקריאה קודמת ב- כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל- |
filter |
זה שינוי אופציונלי. שאילתת סינון שתחול כשמציגים כלי רכב למשלוחים. דוגמאות לתחביר של המסנן זמינות בכתובת http://aip.dev/160. אם לא מציינים ערך או אם מציינים מחרוזת ריקה למסנן, מוחזר כל כלי הרכב למשלוח. חשוב לזכור שהשאילתות היחידות שנתמכות ב- המספר המקסימלי של הגבלות שמותר להוסיף לשאילתת סינון הוא 50. הגבלה היא חלק מהשאילתה בפורמט |
viewport |
זה שינוי אופציונלי. מסנן שמגביל את הרכבים שמוחזרים רק לאלה שהמיקום הידוע האחרון שלהם היה באזור המלבני שמוגדר על ידי חלון התצוגה. |
ListDeliveryVehiclesResponse
הודעת התגובה ListDeliveryVehicles
.
שדות | |
---|---|
delivery_ |
קבוצת כלי הרכב להעברה שעומד בקריטריונים המבוקשים לסינון. אם לא מציינים מסנן, הבקשה מחזירה את כל כלי הרכב להעברה. תגובה מוצלחת יכולה גם להיות ריקה. תגובה ריקה מציינת שלא נמצאו כלי רכב להעברת מוצרים שתואמים לקריטריונים המבוקשים של המסנן. |
next_ |
אפשר להעביר את האסימון הזה ב- |
total_ |
המספר הכולל של רכבי משלוח שתואמים לקריטריונים של הבקשה, בכל הדפים. |
ListTasksRequest
הודעת הבקשה ListTasks
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API. |
parent |
חובה. הפורמט הנדרש הוא |
page_ |
זה שינוי אופציונלי. המספר המקסימלי של משימות להחזרה. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים את הערך הזה, השרת קובע את מספר התוצאות שיוחזר. |
page_ |
זה שינוי אופציונלי. אסימון דף שהתקבל משיחה קודמת של כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל- |
filter |
זה שינוי אופציונלי. שאילתת סינון שצריך להחיל כשמציגים רשימה של Tasks. דוגמאות לתחביר של מסננים זמינות בכתובת http://aip.dev/160. אם לא תציינו ערך, או אם בחרתם לסנן לפי מחרוזת ריקה, כל המשימות יוחזרו. מידע על מאפייני המשימות שאפשר לסנן לפיהם זמין במאמר רשימת משימות. |
ListTasksResponse
התשובה ListTasks
שמכילה את קבוצת המשימות שעומדות בקריטריונים לסינון ב-ListTasksRequest
.
שדות | |
---|---|
tasks[] |
קבוצת המשימות שעומדות בקריטריונים המבוקשים לסינון. אם לא מוגדר מסנן, הבקשה מחזירה את כל המשימות. תגובה מוצלחת יכולה גם להיות ריקה. תגובה ריקה מציינת שלא נמצאו משימות שתואמות לקריטריונים המבוקשים של המסנן. |
next_ |
צריך להעביר את האסימון הזה ב- |
total_ |
המספר הכולל של המשימות שתואמות לקריטריונים של הבקשה, בכל הדפים. |
LocationInfo
מיקום עם מזהים נוספים.
שדות | |
---|---|
point |
הקואורדינטות של המיקום. |
משימה
משימה ב-Delivery API מייצגת פעולה אחת למעקב. באופן כללי, יש הבחנה בין Tasks שקשורות למשלוחים לבין משימות 'הפסקות'. למשלוח יכולים להיות משויכים כמה משימות. לדוגמה, יכולה להיות משימה אחת לאיסוף ומשימה אחת להעברה או להחזרה. בנוסף, כלי רכב שונים יכולים לטפל במשימות שונות לכל משלוח. לדוגמה, רכב אחד יכול לבצע את האיסוף ולספק את המשלוח למרכז, ואילו רכב אחר יכול להעביר את אותו המשלוח מהמרכז למיקום המסירה.
הערה: ממשקי API ל-gRPC ול-REST משתמשים במוסכמות שונות של מתן שמות לשדות. לדוגמה, השדה Task.journey_sharing_info
ב-API ל-gRPC והשדה Task.journeySharingInfo
ב-API ל-REST מפנים לאותו שדה.
שדות | |
---|---|
name |
הפורמט הנדרש הוא |
type |
חובה. קבוע. הגדרת הסוג של המשימה. לדוגמה, הפסקה או משלוח. |
state |
חובה. מצב הביצוע הנוכחי של המשימה. |
task_ |
התוצאה של המשימה. |
task_ |
חותמת הזמן שמציינת מתי הספק הגדיר את התוצאה של |
task_ |
המיקום שבו הוגדר התוצאה של |
task_ |
מציין מאיפה הגיע הערך של |
tracking_ |
בלתי ניתן לשינוי. השדה הזה מאפשר לשמור מזהה כדי שתוכלו להימנע משימוש במיפוי מורכב. לא ניתן להגדיר את
|
delivery_ |
פלט בלבד. המזהה של הרכב שמבצע את המשימה הזו. מזהי רכבים להעברה כפופים להגבלות הבאות:
|
planned_ |
קבוע. המיקום שבו המשימה תושלם. אופציונלי למשימות ב- |
task_ |
חובה. קבוע. הזמן הדרוש לביצוע משימה במיקום הזה. |
target_ |
חלון הזמן שבו המשימה צריכה להסתיים. |
journey_ |
פלט בלבד. שדות ספציפיים לשיתוף המסלול. לא מאוכלס כשהמדינה היא |
task_ |
ההגדרה של מעקב המשימות, שמציינת אילו רכיבי נתונים גלויים למשתמשי הקצה ובאילו נסיבות. |
attributes[] |
רשימה של מאפייני משימות מותאמים אישית. לכל מאפיין צריך להיות מפתח ייחודי. |
JourneySharingInfo
שיתוף שדות ספציפיים במסע.
שדות | |
---|---|
remaining_ |
פרטי מעקב של העצירות התחנות שהרכב המוקצה יבצע לפני שהמשימה הזו תסתיים. שימו לב שהרשימה הזו יכולה להכיל עצירות ממשימות אחרות. הקטע הראשון, |
last_ |
מציין את המיקום המדווח האחרון של הרכב שהוקצה. |
last_ |
מציינת אם ניתן להצמיד את המיקום האחרון של הרכב אל |
מדינה
המצב של משימה. זהו סימן להתקדמות של המשימות.
טיפוסים בני מנייה (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 |
המפתח של המאפיין. מפתחות לא יכולים להכיל את התו פסיק נקודה (:). |
שדה האיחוד task_attribute_value . ערך המאפיין יכול להיות מסוג מחרוזת, bool או double. אם לא מוגדרת, TaskAttribute string_value יאוחסן כמחרוזת הריקה "". task_attribute_value יכול להיות רק אחת מהאפשרויות הבאות: |
|
string_ |
ערך מאפיין שהוקלד במחרוזת. |
bool_ |
ערך מאפיין מסוג בוליאני. |
number_ |
ערך מאפיין מסוג double. |
TaskTrackingInfo
ההודעה TaskTrackingInfo
. ההודעה מכילה את פרטי המעקב אחרי המשימה, שישמשו להצגה. אם מזהה לצורכי מעקב משויך למספר משימות, Fleet Engine משתמש בשיטה היוריסטית כדי להחליט באיזו משימה לעקוב (Tasks) בכמה משימות לבחור.
שדות | |
---|---|
name |
חייב להיות בפורמט |
tracking_ |
קבוע. המזהה לצורכי מעקב של משימה. * חייבת להיות מחרוזת Unicode תקינה. * מוגבל לאורך של 64 תווים לכל היותר. * נורמלי לפי Unicode Normalization Form C. * אסור לכלול את תווי ה-ASCII הבאים: '/', ':', '?', ',' או '#'. |
vehicle_ |
המיקום האחרון של הרכב. |
route_ |
רשימה של נקודות, שמחוברות זו לזו ויוצרות קו מרובע של המסלול הצפוי של הרכב למיקום של המשימה הזו. |
remaining_ |
מספר העצירות שנותרו לרכב עד שמגיעים לתחנה של המשימה, כולל התחנה של המשימה. לדוגמה, אם התחנה הבאה של הרכב היא התחנה של המשימה, הערך יהיה 1. |
remaining_ |
המרחק הכולל שנותר במטרים עד ל- |
estimated_ |
חותמת הזמן שמציינת את זמן ההגעה המשוער לתחנה. |
estimated_ |
חותמת הזמן שמציינת את מועד הסיום המשוער של משימה. |
state |
מצב הביצוע הנוכחי של המשימה. |
task_ |
התוצאה של ניסיון להריץ משימה. |
task_ |
חותמת הזמן שמציינת מתי הספק הגדיר את תוצאת המשימה. |
planned_ |
קבוע. המיקום שבו המשימה תושלם. |
target_ |
חלון הזמן שבו המשימה צריכה להסתיים. |
attributes[] |
המאפיינים המותאמים אישית שהוגדרו במשימה. |
TaskTrackingViewConfig
הודעת התצורה שמגדירה מתי רכיב נתונים של משימה צריך להיות גלוי למשתמשי הקצה.
שדות | |
---|---|
route_ |
השדה שמציין מתי נקודות הפוליגון של המסלול יכולות להיות גלויות. אם השדה הזה לא יצוין, המערכת תשתמש בהגדרת ברירת המחדל של רמת הפרויקט לגבי החשיפה של הנתונים האלה. |
estimated_ |
השדה שמציין מתי זמן ההגעה המשוער יכול להיות גלוי. אם השדה הזה לא יצוין, המערכת תשתמש בהגדרת ברירת המחדל של רמת הפרויקט לגבי החשיפה של הנתונים האלה. |
estimated_ |
השדה שמציין מתי ניתן לראות את הזמן המשוער להשלמת המשימה. אם השדה הזה לא יצוין, המערכת תשתמש בהגדרת ברירת המחדל של רמת הפרויקט לגבי החשיפה של הנתונים האלה. |
remaining_ |
השדה שמציין מתי מרחק הנסיעה שנותר יכול להיות גלוי. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט. |
remaining_ |
השדה שמציין מתי אפשר לראות את מספר התחנות שנותרות. אם השדה הזה לא יצוין, המערכת תשתמש בהגדרת ברירת המחדל של רמת הפרויקט לגבי החשיפה של הנתונים האלה. |
vehicle_ |
השדה שמציין מתי מיקום הרכב יכול להיות גלוי. אם השדה הזה לא יצוין, המערכת תשתמש בהגדרת ברירת המחדל של רמת הפרויקט לגבי החשיפה של הנתונים האלה. |
VisibilityOption
הודעת האפשרות שמגדירה מתי רכיב נתונים צריך להיות גלוי למשתמשי הקצה.
שדות | |
---|---|
שדה האיחוד visibility_option . אפשרות החשיפה הספציפית שנבחרה. הערך של visibility_option יכול להיות רק אחת מהאפשרויות הבאות: |
|
remaining_ |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם מספר העצירה שנותר <= נותרו_stop_count_threshold. |
duration_ |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם זמן ההגעה המשוער לתחנה <= duration_until_estimated_arrival_time_threshold. |
remaining_ |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם מרחק הנסיעה שנותר במטרים <= remaining_driving_distance_meters_threshold. |
always |
אם הערך מוגדר כ-true, רכיב הנתונים הזה תמיד גלוי למשתמשי הקצה ללא ערכי סף. אי אפשר להגדיר את השדה הזה כ-false. |
never |
אם המדיניות מוגדרת כ-True, רכיב הנתונים הזה תמיד מוסתר ממשתמשי הקצה ללא ערכי סף. לא ניתן להגדיר את השדה הזה כ-False. |
TimeWindow
טווח זמן.
שדות | |
---|---|
start_ |
חובה. שעת ההתחלה של חלון הזמן (כולל). |
end_ |
חובה. שעת הסיום של חלון הזמן (כולל). |
UpdateDeliveryVehicleRequest
הודעת הבקשה UpdateDeliveryVehicle
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API. |
delivery_ |
חובה. עדכון הישות |
update_ |
חובה. אנונימיזציה של שדות שמציינת אילו שדות זוהי רשימה של שמות שדות מוגדרים במלואם, שמופרדים בפסיקים. דוגמה: |
UpdateTaskRequest
הודעת הבקשה UpdateTask
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. הכותרת הרגילה של בקשה ל-Delivery API. |
task |
חובה. המשימה שמשויכת לעדכון. השדות הבאים נשמרים על ידי Fleet Engine. אין לעדכן אותם באמצעות
הערה: אי אפשר לשנות את הערך של אם המשימה הוקצתה לרכב מסירה, אסור להגדיר את מצב המשימה כ'סגור' באמצעות |
update_ |
חובה. מסכת השדות שמציינת אילו שדות של משימות לעדכן. הערה: ה- זוהי רשימה מופרדת בפסיקים של שמות שדות מלאים. דוגמה: |
VehicleJourneySegment
מייצג את קטע הנסיעה של כלי הרכב – מהתחנה הקודמת שלו ועד לתחנה הנוכחית. אם זו התחנה הפעילה הראשונה, הנסיעה היא מהמיקום הנוכחי של הרכב לתחנה הזו.
שדות | |
---|---|
stop |
מציין את מיקום התחנה, יחד עם הערכים של |
driving_ |
פלט בלבד. מרחק הנסיעה מהתחנה הקודמת לתחנה הזו. אם העצירה הנוכחית היא העצירה הראשונה ברשימת קטעי הנסיעה, נקודת ההתחלה היא מיקום הרכב שמתועד בזמן שהעצירה הזו נוספה לרשימה. יכול להיות שהשדה הזה לא יופיע אם קטע המסלול הזה הוא חלק מ- |
driving_ |
פלט בלבד. זמן הנסיעה מהתחנה הקודמת לתחנה הזו. אם העצירה הנוכחית היא העצירה הראשונה ברשימת קטעי המסלול, נקודת ההתחלה היא המיקום של הרכב שסומן בזמן שהעצירה הזו נוספה לרשימה. אם השדה הזה מוגדר בנתיב |
path[] |
פלט בלבד. הנתיב מהתחנה הקודמת לתחנה הזו. אם העצירה הנוכחית היא העצירה הראשונה ברשימת קטעי הנסיעה, זהו הנתיב מהמיקום הנוכחי של הרכב לתחנה הזו בזמן שהעצירה נוספה לרשימה. יכול להיות שהשדה הזה לא יופיע אם קטע התהליך הזה הוא חלק מ- אם השדה הזה מוגדר בנתיב |
VehicleStop
תיאור של נקודה שבה הרכב עוצר כדי לבצע Task
אחד או יותר.
שדות | |
---|---|
planned_ |
חובה. המיקום של התחנה. שימו לב: יכול להיות שהמיקומים ב- |
tasks[] |
הרשימה של |
state |
המצב של |
מדינה
המצב הנוכחי של VehicleStop
.
טיפוסים בני מנייה (enum) | |
---|---|
STATE_UNSPECIFIED |
לא ידוע. |
NEW |
נוצר, אבל לא מתבצע ניתוב באופן פעיל. |
ENROUTE |
מוקצים וניתוב באופן פעיל. |
ARRIVED |
הגעה לתחנה. ההנחה היא שכאשר הרכב מקבל מסלול לתחנה הבאה, כל התחנות הקודמות הושלמו. |
TaskInfo
מידע נוסף על המשימה שבוצעה בעצירה הזו.
שדות | |
---|---|
task_ |
מזהה המשימה. השדה הזה לא יאוכלס בתגובה של קריאה מסוג
|
task_ |
פלט בלבד. הזמן הנדרש לביצוע המשימה. |
target_ |
פלט בלבד. חלון הזמן שבמהלכו צריך להשלים את המשימה. ההגדרה הזו מוגדרת רק בתגובה להודעה |