אינדקס
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
שירות המשלוחים האחרון.
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_vehicle_id |
חובה. מזהה רכב המסירה חייב להיות ייחודי וכפוף להגבלות הבאות:
|
delivery_vehicle |
חובה. הישות
הערה: המערכת מתעלמת מהשדה |
CreateTaskRequest
הודעת הבקשה של CreateTask
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה הרגילה של Delivery API. |
parent |
חובה. חייב להיות בפורמט |
task_id |
חובה. מזהה המשימה חייב להיות ייחודי, אבל לא מזהה לצורכי מעקב אחר משלוח. כדי לשמור מזהה לצורכי מעקב, צריך להשתמש בשדה
|
task |
חובה. ישות המשימה שצריך ליצור. כשיוצרים משימה, חובה למלא את השדות הבאים:
הערה: המערכת מתעלמת מהשדה |
DeliveryRequestHeader
RequestHeader מכיל שדות משותפים לכל בקשות RPC למסירה.
שדות | |
---|---|
language_code |
קוד השפה BCP-47, כמו en-US או sr-Latn. מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. אם לא תציינו שם, התשובה יכולה להיות בכל שפה, עם העדפה לאנגלית אם קיים שם כזה. דוגמה לערך בשדה: |
region_code |
חובה. קוד האזור במאגר CLDR של האזור שממנו בוצעה הבקשה. דוגמה לערך בשדה: |
sdk_version |
גרסת ה-SDK לשיחות, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: |
os_version |
הגרסה של מערכת ההפעלה שבה פועל ה-SDK לשיחות. דוגמאות לערכים בשדות: |
device_model |
דגם המכשיר שבו פועל ה-SDK לשיחות. דוגמאות לערכים בשדות: |
sdk_type |
סוג ה-SDK ששולח את הבקשה. |
maps_sdk_version |
גרסת ה-MapSDK שבה ה-SDK של הקריאה תלוי, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: |
nav_sdk_version |
הגרסה של Nav SDK שבה ערכת ה-SDK לשיחות תלויה, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: |
platform |
הפלטפורמה של ה-SDK לשיחות. |
manufacturer |
היצרן של מכשיר Android מה-SDK לשיחות, רלוונטי רק לערכות ה-SDK של Android. דוגמה לערך בשדה: |
android_api_level |
רמת ה-API של Android של ה-SDK לשיחות, רלוונטית רק לערכות ה-SDK ל-Android. דוגמה לערך בשדה: |
trace_id |
מזהה אופציונלי שאפשר לספק למטרות רישום ביומן לצורך זיהוי הבקשה. |
פלטפורמה
הפלטפורמה של ה-SDK לשיחות.
טיפוסים בני מנייה (enum) | |
---|---|
PLATFORM_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה משמש אם הפלטפורמה לא מוצגת. |
ANDROID |
הבקשה מגיעה מ-Android. |
IOS |
הבקשה מגיעה מ-iOS. |
WEB |
הבקשה מגיעה מהאינטרנט. |
SdkType
סוגים אפשריים של SDK.
טיפוסים בני מנייה (enum) | |
---|---|
SDK_TYPE_UNSPECIFIED |
ערך ברירת המחדל. המערכת תשתמש בערך הזה אם לא מציינים את sdk_type . |
CONSUMER |
ה-SDK של הקריאה הוא צרכן. |
DRIVER |
ה-SDK לשיחות הוא של מנהל התקן. |
JAVASCRIPT |
ה-SDK ששולח הוא JavaScript. |
DeliveryVehicle
ההודעה DeliveryVehicle
. רכב משלוחים מוביל משלוחים מנקודת איסוף ליעד משלוחים, ומנקודת איסוף אל תחנת המשלוחים. במקרים מסוימים, רכבי משלוחים מעבירים משלוחים גם ישירות מנקודת האיסוף אל יעד המשלוח.
הערה: ממשקי API ל-gRPC ול-REST משתמשים במוסכמות שונות של מתן שמות לשדות. לדוגמה, השדה DeliveryVehicle.current_route_segment
ב-API ל-gRPC והשדה DeliveryVehicle.currentRouteSegment
ב-API ל-REST מפנים לאותו שדה.
שדות | |
---|---|
name |
השם הייחודי של רכב המשלוחים הזה. הפורמט הוא |
last_location |
המיקום המדווח האחרון של רכב המשלוחים. |
navigation_status |
סטטוס הניווט של רכב המסירה. |
current_route_segment |
הקו הפוליגוני המקודד שמציין את המסלול שהניווט ממליץ לעבור לנקודת הציון הבאה. אפליקציית הנהג מעדכנת את העדכון כשיש עצירה או כשעוברים עצירה וכשהמסלול משנה את הניווט. הפרמטרים האלה מסוג יש כמה מקרים שבהם השדה הזה לא ישמש לאכלוס
במקרים כאלה, מערכת Fleet Engine מאכלסת את השדה הזה במסלול מהרכב האחרון שהועבר אל קרון הרכב הבא כדי להבטיח שלצרכן בשדה הזה יש את המידע שזמין בצורה הטובה ביותר לגבי הנתיב הנוכחי של רכב המסירה. |
current_route_segment_end_point |
המיקום שבו המערכת תתעלם משדה זה בקריאות |
remaining_distance_meters |
מרחק הנסיעה שנותר עבור Fleet Engine מתעלם מהשדה הזה ב- |
remaining_duration |
זמן הנסיעה שנותר ל- Fleet Engine מתעלם מהשדה הזה ב- |
remaining_vehicle_journey_segments[] |
קטעי הנסיעה שהוקצו לרכב המשלוחים הזה, החל מהמיקום האחרון שדווח לגבי הרכב. השדה הזה לא יאוכלס בתשובה של |
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_value |
ערך מאפיין שהוקלד במחרוזת. הערה: השדה הזה זהה לשדה |
bool_value |
ערך מאפיין בוליאני. |
number_value |
ערך המאפיין הוקלד פעמיים. |
DeliveryVehicleLocation
המיקום, המהירות והכיוון של רכב בנקודת זמן מסוימת.
שדות | |
---|---|
location |
המיקום של הרכב. כשהרכב נשלח אל Fleet Engine, מיקום הרכב הוא מיקום לפי GPS. כשאתם מקבלים אותו בתגובה, מיקום הרכב יכול להיות מיקום GPS, מיקום משלים או מיקום משוער אחר. המקור מצוין ב- |
horizontal_accuracy |
הוצא משימוש: במקומו צריך להשתמש ברכיב |
latlng_accuracy |
דיוק של |
heading |
כיוון שהרכב נע במעלות. 0 מייצג את הצפון. הטווח החוקי הוא [0,360). |
bearing_accuracy |
הוצא משימוש: במקומו צריך להשתמש ברכיב |
heading_accuracy |
דיוק של |
altitude |
גובה במטרים מעל WGS84. |
vertical_accuracy |
הוצא משימוש: במקומו צריך להשתמש ברכיב |
altitude_accuracy |
דיוק של |
speed_kmph |
מהירות הרכב בקילומטרים לשעה. הוצא משימוש: במקומו צריך להשתמש ברכיב |
speed |
מהירות הרכב במטרים לשנייה |
speed_accuracy |
דיוק של |
update_time |
השעה שבה דווח על |
server_time |
פלט בלבד. השעה שבה השרת קיבל את פרטי המיקום. |
location_sensor |
ספק של נתוני מיקום (לדוגמה, |
is_road_snapped |
האם |
is_gps_sensor_enabled |
קלט בלבד. מציינת אם חיישן ה-GPS מופעל במכשיר הנייד. |
time_since_update |
קלט בלבד. הזמן (בשניות) שעבר מאז שהמיקום הזה נשלח לראשונה לשרת. בעדכון הראשון הערך יהיה אפס. אם השעה לא ידועה (לדוגמה, כשהאפליקציה מופעלת מחדש), הערך הזה מתאפס. |
num_stale_updates |
קלט בלבד. הוצא משימוש: עכשיו נעשה שימוש באותות אחרים כדי לקבוע אם מיקום מיושן. |
raw_location |
מיקום הרכב הגולמי (לא עבר עיבוד על ידי מתקן חירום). |
raw_location_time |
חותמת הזמן שמשויכת למיקום הגולמי. |
raw_location_sensor |
המקור של המיקום הגולמי. ברירת המחדל היא |
raw_location_accuracy |
דיוק של |
supplemental_location |
מיקום נוסף שסופק על ידי האפליקציה המשולבת. |
supplemental_location_time |
חותמת הזמן שמשויכת למיקום המשלים. |
supplemental_location_sensor |
המקור של המיקום המשלים. ברירת המחדל היא |
supplemental_location_accuracy |
דיוק של |
road_snapped |
הוצא משימוש: במקומו צריך להשתמש ברכיב |
DeliveryVehicleLocationSensor
החיישן או המתודולוגיה ששימשו לקביעת המיקום.
טיפוסים בני מנייה (enum) | |
---|---|
UNKNOWN_SENSOR |
החיישן לא מוגדר או לא ידוע. |
GPS |
GPS או Assist 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_size |
זה שינוי אופציונלי. המספר המקסימלי של כלי רכב שצריך להחזיר. ייתכן שהשירות יחזיר פחות מהמספר הזה. אם לא תציינו את המספר הזה, השרת יקבע את מספר התוצאות שיוחזרו. |
page_token |
זה שינוי אופציונלי. אסימון דף, שהתקבל מקריאה קודמת ב- במהלך החלוקה לדפים, כל שאר הפרמטרים שסופקו ל- |
filter |
זה שינוי אופציונלי. שאילתת סינון שתחול כשמציגים כלי רכב למשלוחים. דוגמאות לתחביר של המסנן: http://aip.dev/160 אם לא מציינים ערך או אם מציינים מחרוזת ריקה למסנן, המערכת מחזירה את כל כלי הרכב למשלוח. לתשומת ליבכם: השאילתות היחידות שנתמכות במאפיין מספר ההגבלות המקסימלי המותר לשאילתת סינון הוא 50. הגבלה היא חלק מהשאילתה בטופס |
viewport |
זה שינוי אופציונלי. מסנן שמגביל את כלי הרכב שמוחזרים בכלי רכב שהמיקום הידוע האחרון שלהם היה באזור המלבני שהוגדר באזור התצוגה. |
ListDeliveryVehiclesResponse
הודעת התשובה ListDeliveryVehicles
.
שדות | |
---|---|
delivery_vehicles[] |
קבוצת כלי המשלוח שעומדים בקריטריונים לסינון הנדרשים. אם לא מוגדר מסנן, הבקשה מחזירה את כל כלי הרכב למשלוח. תגובה מוצלחת יכולה גם להיות ריקה. תגובה ריקה מציינת שלא נמצאו רכבי משלוח שעומדים בקריטריונים של המסנן המבוקש. |
next_page_token |
אפשר להעביר את האסימון הזה ב- |
total_size |
המספר הכולל של רכבי משלוח שתואמים לקריטריונים של הבקשה, בכל הדפים. |
ListTasksRequest
הודעת הבקשה של ListTasks
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה הרגילה של Delivery API. |
parent |
חובה. חייב להיות בפורמט |
page_size |
זה שינוי אופציונלי. המספר המקסימלי של Tasks שצריך להחזיר. ייתכן שהשירות יחזיר פחות מהערך הזה. אם לא מציינים את הערך הזה, השרת קובע את מספר התוצאות שיוחזרו. |
page_token |
זה שינוי אופציונלי. אסימון דף שהתקבל משיחת במהלך החלוקה לדפים, כל שאר הפרמטרים שסופקו ל- |
filter |
זה שינוי אופציונלי. שאילתת סינון שצריך להחיל כשמציגים רשימה של Tasks. בכתובת http://aip.dev/160 תוכלו לראות דוגמאות לתחביר של מסננים. אם לא תציינו ערך, או אם בחרתם לסנן לפי מחרוזת ריקה, כל המשימות יוחזרו. מידע נוסף על המאפיינים של משימות שאפשר לסנן לפיהם מופיע במאמר הצגת רשימת המשימות. |
ListTasksResponse
התשובה ListTasks
שמכילה את קבוצת המשימות שעומדות בקריטריוני הסינון של ListTasksRequest
.
שדות | |
---|---|
tasks[] |
קבוצת המשימות שעומדות בקריטריונים לסינון הנדרשים. אם לא מוגדר מסנן, הבקשה מחזירה את כל המשימות. תגובה מוצלחת יכולה גם להיות ריקה. תגובה ריקה מציינת שלא נמצאו משימות שתואמות לקריטריוני הסינון המבוקשים. |
next_page_token |
צריך להעביר את האסימון הזה ב- |
total_size |
המספר הכולל של משימות שתואמות לקריטריוני הבקשה, בכל הדפים. |
LocationInfo
מיקום עם מזהים נוספים.
שדות | |
---|---|
point |
הקואורדינטות של המיקום. |
משימה
משימה ב-Delivery API מייצגת פעולה יחידה למעקב. באופן כללי, יש הבחנה בין Tasks שקשורות למשלוחים לבין משימות 'הפסקות'. לכל משלוח אפשר לשייך אליו כמה משימות. לדוגמה, יכולה להיות משימה אחת לאיסוף ומשימה אחת לאיסוף או להעברה. בנוסף, כלי רכב שונים יכולים לטפל במשימות שונות לכל משלוח. לדוגמה, רכב אחד יכול לטפל באיסוף עצמי ולהביא את המשלוח למרכז, ורכב אחר מנהל את אותו משלוח מהמרכז אל נקודת ההורדה.
הערה: ממשקי API ל-gRPC ול-REST משתמשים במוסכמות שונות של מתן שמות לשדות. לדוגמה, השדה Task.journey_sharing_info
ב-API ל-gRPC והשדה Task.journeySharingInfo
ב-API ל-REST מפנים לאותו שדה.
שדות | |
---|---|
name |
חייב להיות בפורמט |
type |
חובה. בלתי ניתן לשינוי. משמש להגדרת סוג המשימה. לדוגמה, הפסקה או משלוח. |
state |
חובה. מצב הביצוע הנוכחי של המשימה. |
task_outcome |
התוצאה של המשימה. |
task_outcome_time |
חותמת הזמן שמציינת מתי הספק הגדיר את התוצאה של |
task_outcome_location |
המיקום שבו נקבעה התוצאה של ה |
task_outcome_location_source |
שדה זה מציין מאיפה הגיע הערך של |
tracking_id |
בלתי ניתן לשינוי. השדה הזה מאפשר לשמור את המזהה וכך להימנע משימוש במיפוי מורכב. לא ניתן להגדיר את
|
delivery_vehicle_id |
פלט בלבד. המזהה של הרכב שמבצע את המשימה הזו. מזהי רכבים להעברה כפופים להגבלות הבאות:
|
planned_location |
בלתי ניתן לשינוי. המיקום שבו המשימה תושלם. אופציונלי ל- |
task_duration |
חובה. בלתי ניתן לשינוי. הזמן הדרוש לביצוע משימה במיקום הזה. |
target_time_window |
חלון הזמן שבמהלכו צריך להשלים את המשימה. |
journey_sharing_info |
פלט בלבד. שדות ספציפיים לשיתוף תהליכים. לא מאוכלס כשהמדינה היא |
task_tracking_view_config |
התצורה של מעקב אחר משימות שמציינת אילו רכיבי נתונים יהיו גלויים למשתמשי הקצה ובאילו נסיבות. |
attributes[] |
רשימה של מאפיינים מותאמים אישית למשימה. לכל מאפיין צריך להיות מפתח ייחודי. |
JourneySharingInfo
שיתוף שדות ספציפיים בתהליך.
שדות | |
---|---|
remaining_vehicle_journey_segments[] |
נתוני מעקב של העצירות שבהן הרכב המוקצה יפנה לפני שהמשימה הזו תסתיים. שימו לב שהרשימה הזו יכולה להכיל עצירות ממשימות אחרות. המקטע הראשון, |
last_location |
מציין את המיקום המדווח האחרון של הרכב שהוקצה. |
last_location_snappable |
מציינת אם ניתן להצמיד את המיקום האחרון של הרכב אל |
מדינה
המצב של משימה. הסטטוס הזה מציין את ההתקדמות של Tasks.
טיפוסים בני מנייה (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 . ערך המאפיין יכול להיות מחרוזת, בוליאני או סוג כפול. אם לא מוגדר ערך TaskAttribute string_value, הוא יאוחסן כמחרוזת הריקה "". task_attribute_value יכול להיות רק אחת מהאפשרויות הבאות: |
|
string_value |
ערך מאפיין שהוקלד במחרוזת. |
bool_value |
ערך מאפיין בוליאני. |
number_value |
ערך המאפיין הוקלד פעמיים. |
TaskTrackingInfo
ההודעה TaskTrackingInfo
. ההודעה מכילה פרטי מעקב אחרי המשימה ומוצגת בהם. אם מזהה לצורכי מעקב משויך למספר משימות, Fleet Engine משתמש בשיטה היוריסטית כדי להחליט באיזו משימה משימה של TaskTrackingInfo לבחור.
שדות | |
---|---|
name |
חייב להיות בפורמט |
tracking_id |
בלתי ניתן לשינוי. מזהה המעקב של משימה. * הערך חייב להיות מחרוזת Unicode חוקית. * מוגבל לאורך של 64 תווים לכל היותר. * נורמליזציה בהתאם לטופס נירמול Unicode C. * לא יכול להכיל אף אחד מתווי ASCII הבאים: '/', ':', '?', ' או '#'. |
vehicle_location |
המיקום האחרון של הרכב. |
route_polyline_points[] |
רשימה של נקודות שחיבור שלהן יוצר קו פוליגוני של המסלול הצפוי של הרכב למיקום של המשימה הזו. |
remaining_stop_count |
מציין את מספר התחנות שנותרות ברכב עד לעצירה של המשימה, כולל עצירת המשימה. לדוגמה, אם העצירה הבאה של הרכב היא עצירת המשימה, הערך יהיה 1. |
remaining_driving_distance_meters |
המרחק הכולל שנותר במטרים עד ל- |
estimated_arrival_time |
חותמת הזמן שמציינת את זמן ההגעה המשוער למיקום העצירה. |
estimated_task_completion_time |
חותמת הזמן שמציינת את זמן ההשלמה המשוער של משימה. |
state |
מצב הביצוע הנוכחי של המשימה. |
task_outcome |
התוצאה של הניסיון לבצע משימה. |
task_outcome_time |
חותמת הזמן שמציינת מתי הספק הגדיר את תוצאת המשימה. |
planned_location |
בלתי ניתן לשינוי. המיקום שבו המשימה תושלם. |
target_time_window |
חלון הזמן שבמהלכו צריך להשלים את המשימה. |
attributes[] |
המאפיינים המותאמים אישית שהוגדרו במשימה. |
TaskTrackingViewConfig
הודעת ההגדרה שקובעת מתי רכיב נתונים של משימה יהיה גלוי למשתמשי הקצה.
שדות | |
---|---|
route_polyline_points_visibility |
השדה שמציין מתי נקודות פוליגוניות של נתיב יכולות להיות גלויות. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט. |
estimated_arrival_time_visibility |
השדה שמציין מתי זמן ההגעה המשוער יכול להיות מוצג. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט. |
estimated_task_completion_time_visibility |
השדה שמציין מתי ניתן לראות את הזמן המשוער להשלמת המשימה. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט. |
remaining_driving_distance_visibility |
השדה שמציין מתי מרחק הנסיעה שנותר יכול להיות גלוי. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט. |
remaining_stop_count_visibility |
השדה שמציין מתי אפשר לראות את מספר התחנות שנותרות. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט. |
vehicle_location_visibility |
השדה שמציין מתי ניתן לראות את מיקום הרכב. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט. |
VisibilityOption
הודעת האפשרות שקובעת מתי רכיב נתונים צריך להיות גלוי למשתמשי הקצה.
שדות | |
---|---|
שדה איחוד visibility_option . אפשרות החשיפה הספציפית שנבחרה. visibility_option יכול להיות רק אחת מהאפשרויות הבאות: |
|
remaining_stop_count_threshold |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם מספר העצירה שנותר <= נותרו_stop_count_threshold. |
duration_until_estimated_arrival_time_threshold |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם זמן ההגעה המשוער לעצירה <= duration_until_estimated_arrival_time_threshold. |
remaining_driving_distance_meters_threshold |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם מרחק הנסיעה שנותר במטרים <= left_driving_distance_meters_threshold. |
always |
אם המדיניות מוגדרת כ-True, רכיב הנתונים הזה תמיד גלוי למשתמשי קצה ללא ערכי סף. לא ניתן להגדיר את השדה הזה כ-False. |
never |
אם המדיניות מוגדרת כ-True, רכיב הנתונים הזה תמיד מוסתר ממשתמשי הקצה ללא ערכי סף. לא ניתן להגדיר את השדה הזה כ-False. |
TimeWindow
טווח זמן.
שדות | |
---|---|
start_time |
חובה. שעת ההתחלה של חלון הזמן (כולל). |
end_time |
חובה. שעת הסיום של חלון הזמן (כולל). |
UpdateDeliveryVehicleRequest
הודעת הבקשה של UpdateDeliveryVehicle
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה הרגילה של Delivery API. |
delivery_vehicle |
חובה. עדכון הישות |
update_mask |
חובה. מסכת שדות שמציינת אילו שדות זוהי רשימה מופרדת בפסיקים של שמות שדות מלאים. דוגמה: |
UpdateTaskRequest
הודעת הבקשה של UpdateTask
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה הרגילה של Delivery API. |
task |
חובה. המשימה שמשויכת לעדכון. השדות הבאים מתוחזקים על ידי Fleet Engine. אין לעדכן אותם באמצעות
הערה: לא ניתן לשנות את הערך של אם המשימה הוקצתה לרכב מסירה, אסור להגדיר את מצב המשימה כ'סגור' באמצעות |
update_mask |
חובה. מסיכת השדות שמציינת אילו שדות משימה לעדכן. הערה: זוהי רשימה מופרדת בפסיקים של שמות שדות מלאים. דוגמה: |
VehicleJourneySegment
מייצג את קטע הנסיעה של כלי הרכב – מהתחנה הקודמת שלו ועד לתחנה הנוכחית. אם זו העצירה הפעילה הראשונה, היא מהמיקום הנוכחי של הרכב עד לתחנה הזו.
שדות | |
---|---|
stop |
ההגדרה הזו מציינת את מיקום העצירה, יחד עם ערכי |
driving_distance_meters |
פלט בלבד. מרחק הנסיעה מהתחנה הקודמת עד לתחנה הזו. אם העצירה הנוכחית היא העצירה הראשונה ברשימת קטעי הנסיעה, נקודת ההתחלה היא מיקום הרכב שמתועד בזמן שהעצירה הזו נוספה לרשימה. יכול להיות שהשדה הזה לא יופיע אם קטע התהליך הזה הוא חלק מ- |
driving_duration |
פלט בלבד. זמן הנסיעה מהתחנה הקודמת עד לתחנה הזו. אם העצירה הנוכחית היא העצירה הראשונה ברשימת קטעי הנסיעה, נקודת ההתחלה היא מיקום הרכב שמתועד בזמן שהעצירה הזו נוספה לרשימה. אם השדה הזה מוגדר בנתיב |
path[] |
פלט בלבד. הנתיב מהתחנה הקודמת לתחנה הזו. אם העצירה הנוכחית היא העצירה הראשונה ברשימת קטעי הנסיעה, זהו הנתיב מהמיקום הנוכחי של הרכב לתחנה הזו בזמן שהעצירה נוספה לרשימה. יכול להיות שהשדה הזה לא יופיע אם קטע התהליך הזה הוא חלק מ- אם השדה הזה מוגדר בנתיב |
VehicleStop
מתארת נקודה שבה כלי רכב עוצר כדי לבצע פעולת Task
אחת או יותר.
שדות | |
---|---|
planned_location |
חובה. מיקום העצירה. חשוב לשים לב שהמיקומים ב |
tasks[] |
הרשימה של |
state |
המדינה של |
מדינה
המצב הנוכחי של VehicleStop
.
טיפוסים בני מנייה (enum) | |
---|---|
STATE_UNSPECIFIED |
לא ידוע. |
NEW |
נוצר, אבל לא מתבצע ניתוב באופן פעיל. |
ENROUTE |
מוקצים וניתוב באופן פעיל. |
ARRIVED |
הגיעה לתחנה. בהנחה שכשהרכב עובר לתחנה הבאה, כל העצירות הקודמות הושלמו. |
TaskInfo
מידע נוסף על המשימה שבוצעה בעצירה הזו.
שדות | |
---|---|
task_id |
מזהה המשימה. השדה הזה לא יאוכלס בתגובה לקריאה של
|
task_duration |
פלט בלבד. הזמן שנדרש לביצוע המשימה. |
target_time_window |
פלט בלבד. חלון הזמן שבמהלכו צריך להשלים את המשימה. ההגדרה הזו מוגדרת רק בתשובה ל- |