אינדקס
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
(הודעה)SearchTasksRequest
(הודעה) (הוצאה משימוש)SearchTasksResponse
(הודעה) (הוצאה משימוש)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 |
---|
הפונקציה מקבלת את כל הערכים מסוג |
SearchTasks |
---|
הוצא משימוש: יש להשתמש במקום זאת ב- |
UpdateDeliveryVehicle |
---|
כתיבת נתונים מעודכנים של |
UpdateTask |
---|
מתבצע עדכון של הנתונים של |
BatchCreateTasksRequest
הודעת הבקשה BatchCreateTask
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה. הערה: אם מגדירים את השדה הזה, שדה הכותרת בהודעות |
parent |
חובה. משאב ההורה שמשותף לכל המשימות. הערך הזה חייב להיות בפורמט |
requests[] |
חובה. הודעת הבקשה שמציינת את המשאבים שיש ליצור. הערה: אפשר ליצור עד 500 משימות בבת אחת. |
BatchCreateTasksResponse
הודעת התשובה BatchCreateTask
.
שדות | |
---|---|
tasks[] |
המשימות שנוצרו. |
CreateDeliveryVehicleRequest
הודעת הבקשה CreateDeliveryVehicle
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה. |
parent |
חובה. חייב להיות בפורמט |
delivery_vehicle_id |
חובה. מזהה הרכב למשלוח צריך להיות ייחודי בכפוף להגבלות הבאות:
|
delivery_vehicle |
חובה. הישות
הערה: המערכת מתעלמת מהשדה |
CreateTaskRequest
הודעת הבקשה CreateTask
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה. |
parent |
חובה. חייב להיות בפורמט |
task_id |
חובה. מזהה המשימה חייב להיות ייחודי, אבל הוא לא יכול להיות מזהה לצורכי מעקב אחר משלוחים. כדי לאחסן מזהה לצורכי מעקב אחר משלוח, משתמשים בשדה
|
task |
חובה. הישות של המשימה שצריך ליצור. כשיוצרים משימה, צריך למלא את השדות הבאים:
הערה: המערכת מתעלמת מהשדה |
DeliveryRequestHeader
כותרת בקשה מכילה שדות שמשותפים לכל הבקשות ל-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 |
גרסת ה-NavSDK שעליה תלוי ה-SDK לשיחות, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: |
platform |
הפלטפורמה של ה-SDK לשיחות. |
manufacturer |
היצרן של מכשיר Android מה-SDK לשיחות. רלוונטי רק לערכות ה-SDK ל-Android. דוגמה לערך בשדה: |
android_api_level |
רמת ה-API של Android של ה-SDK לשיחות. רלוונטית רק לערכות ה-SDK ל-Android. דוגמה לערך בשדה: |
trace_id |
מזהה אופציונלי שאפשר לספק למטרות רישום ביומן כדי לזהות את הבקשה. |
פלטפורמה
הפלטפורמה של ה-SDK לשיחות.
טיפוסים בני מנייה (enums) | |
---|---|
PLATFORM_UNSPECIFIED |
ערך ברירת המחדל. ייעשה שימוש בערך הזה אם לא תציינו את הפלטפורמה. |
ANDROID |
הבקשה מגיעה מ-Android. |
IOS |
הבקשה מגיעה מ-iOS. |
WEB |
הבקשה מגיעה מהאינטרנט. |
SdkType
סוגים אפשריים של SDK.
טיפוסים בני מנייה (enums) | |
---|---|
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
ב-API ל-REST מפנים לאותו שדה.
שדות | |
---|---|
name |
השם הייחודי של הרכב הזה. הפורמט הוא |
last_location |
המיקום המדווח האחרון של כלי המשלוח. |
navigation_status |
סטטוס הניווט של כלי הרכב. |
current_route_segment |
הקו הפוליגוני המקודד שמציין את המסלול שהניווט ממליץ לעבור לנקודת הדרך הבאה. אפליקציית הנהגים מעדכנת את המידע הזה כשמגיעה או חולפת מתחנה וכשהניווט משתנה. ערכי ה- יש כמה מקרים שבהם השדה הזה לא ישמש לאכלוס
במקרים כאלה, Fleet Engine מאכלס את השדה הזה במסלול מהתחנה האחרונה של כלי הרכב, עד לתחנה האחרונה של VehicleStop, כדי להבטיח שלצרכן של השדה הזה יש את המידע הזמין הטוב ביותר לגבי הנתיב הנוכחי של כלי הרכב. |
current_route_segment_end_point |
המיקום שבו המערכת מתעלמת מהשדה הזה ב- |
remaining_distance_meters |
מרחק הנסיעה הנותר של Fleet Engine מתעלם מהשדה הזה ב- |
remaining_duration |
זמן הנסיעה הנותר של Fleet Engine מתעלם מהשדה הזה ב- |
remaining_vehicle_journey_segments[] |
קטעי הנסיעה שהוקצו לרכב הזה, החל מהמיקום האחרון שדווח על הרכב. השדה הזה לא יאוכלס בתשובה של |
attributes[] |
רשימה של מאפיינים מותאמים אישית של כלי רכב למשלוח. לרכב מסירה יכול להיות לכל היותר 100 מאפיינים, ולכל מאפיין צריך להיות מפתח ייחודי. |
type |
הסוג של כלי המשלוח הזה. אם המדיניות לא מוגדרת, ברירת המחדל תהיה |
DeliveryVehicleType
הסוג של כלי הרכב.
טיפוסים בני מנייה (enums) | |
---|---|
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
החיישן או המתודולוגיה ששימשה לקביעת המיקום.
טיפוסים בני מנייה (enums) | |
---|---|
UNKNOWN_SENSOR |
החיישן לא צוין או לא ידוע. |
GPS |
GPS או 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 |
זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה. |
name |
חובה. חייב להיות בפורמט |
GetTaskRequest
הודעת הבקשה GetTask
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה. |
name |
חובה. חייב להיות בפורמט |
GetTaskTrackingInfoRequest
הודעת הבקשה GetTaskTrackingInfoRequest
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה. |
name |
חובה. חייב להיות בפורמט |
ListDeliveryVehiclesRequest
הודעת הבקשה ListDeliveryVehicles
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה של ה-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 |
זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה. |
parent |
חובה. חייב להיות בפורמט |
page_size |
זה שינוי אופציונלי. המספר המקסימלי של משימות שצריך להחזיר. השירות עשוי להחזיר פחות מהערך הזה. אם לא תציינו את הערך הזה, השרת יקבע את מספר התוצאות שיוחזרו. |
page_token |
זה שינוי אופציונלי. אסימון דף שהתקבל מקריאה קודמת של במהלך העימוד, כל הפרמטרים האחרים שצוינו ל- |
filter |
זה שינוי אופציונלי. שאילתת סינון שצריך להחיל כשיוצרים רשימה של Tasks. בכתובת http://aip.dev/160 אפשר לראות דוגמאות לתחביר של מסננים. אם לא מציינים ערך או אם מסננים לפי מחרוזת ריקה, המערכת מחזירה את כל המשימות. מידע נוסף על מאפייני המשימות שאפשר לסנן לפיהם זמין במאמר רשימת משימות. |
ListTasksResponse
התשובה ListTasks
שמכילה את קבוצת המשימות שעומדות בקריטריוני הסינון בListTasksRequest
.
שדות | |
---|---|
tasks[] |
קבוצת המשימות שעומדות בקריטריוני הסינון המבוקשים. אם לא צוין מסנן, הבקשה תחזיר את כל המשימות. גם תשובה מוצלחת יכולה להיות ריקה. אם התשובה ריקה, לא נמצאו משימות שתואמות לקריטריונים של הסינון המבוקש. |
next_page_token |
כדי להמשיך להציג את התוצאות, צריך להעביר את האסימון הזה ב- |
total_size |
המספר הכולל של משימות שתואמות לקריטריונים של הבקשה, בכל הדפים. |
LocationInfo
מיקום עם מזהים נוספים, אם יש.
שדות | |
---|---|
point |
הקואורדינטות של המיקום. |
SearchTasksRequest
הוצא משימוש: גיליון GetTaskTrackingInfoRequest
s עד GetTaskTrackingInfo
במקום זאת.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה. |
parent |
חובה. חייב להיות בפורמט |
tracking_id |
חובה. המזהה של קבוצת המשימות הקשורות שהתבקשו. מזהים לצורכי מעקב כפופים להגבלות הבאות:
|
page_size |
זה שינוי אופציונלי. המספר המקסימלי של משימות שצריך להחזיר. השירות עשוי להחזיר פחות מהערך הזה. אם לא תציינו את הערך הזה, השרת יקבע את מספר התוצאות שיוחזרו. |
page_token |
זה שינוי אופציונלי. אסימון דף שהתקבל מקריאה קודמת של במהלך העימוד, כל הפרמטרים האחרים שצוינו ל- |
SearchTasksResponse
התגובה SearchTasks
. היא מכילה את קבוצת המשימות שעומדות בקריטריונים לחיפוש ב-SearchTasksRequest
.
שדות | |
---|---|
tasks[] |
קבוצת המשימות עבור |
next_page_token |
כדי להמשיך להציג את התוצאות, צריך להעביר את האסימון הזה ב- |
משימה
משימה ב- Delivery API מייצגת פעולה יחידה למעקב. באופן כללי, יש הבחנה בין Tasks שקשורות למשלוח לבין משימות מנותקות. לכל משלוח יכולות להיות כמה משימות. לדוגמה, יכולה להיות משימה אחת לאיסוף ומשימה אחת למסירה או להעברה. כמו כן, כלי רכב שונים יכולים לטפל במשימות שונות במשלוח נתון. לדוגמה, רכב אחד יכול לטפל באיסוף ולהביא את המשלוח למרכז, ורכב אחר יכול לנסוע עם אותו משלוח מהמרכז אל נקודת ההורדה.
הערה: ממשקי API ל-gRPC ו-REST משתמשים במוסכמות שונות של מתן שמות לשדות. לדוגמה, השדה Task.journey_sharing_info
ב-gRPC API והשדה 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.
טיפוסים בני מנייה (enums) | |
---|---|
STATE_UNSPECIFIED |
ברירת מחדל. משמש למצב המשימה לא צוין או לא מזוהה. |
OPEN |
יכול להיות שהמשימה עדיין לא הוקצתה לרכב מסירה, או שהרכב עוד לא עבר את תחנת העצירה שהוקצתה לTask . |
CLOSED |
כשהרכב עובר עם עצירת הרכב במשימה הזו. |
TaskOutcome
התוצאה של ניסיון לבצע משימה. כשהיעד TaskState
סגור, הערך TaskOutcome
מציין אם הפעולה הושלמה בהצלחה.
טיפוסים בני מנייה (enums) | |
---|---|
TASK_OUTCOME_UNSPECIFIED |
תוצאת המשימה לפני שהערך שלה הוגדר. |
SUCCEEDED |
המשימה הושלמה. |
FAILED |
יכול להיות שלא ניתן היה להשלים את המשימה או שהיא בוטלה. |
TaskOutcomeLocationSource
זהות המקור שהאכלס את task_outcome_location
.
טיפוסים בני מנייה (enums) | |
---|---|
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED |
תוצאת המשימה לפני ההגדרה. |
PROVIDER |
הספק ציין את השדה task_outcome_location . |
LAST_VEHICLE_LOCATION |
הספק לא ציין את השדה task_outcome_location , לכן Fleet Engine השתמש במיקום האחרון הידוע של הרכב. |
סוג
סוג המשימה.
טיפוסים בני מנייה (enums) | |
---|---|
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 |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם מספר העצירה שנותר <= left_stop_count_threshold. |
duration_until_estimated_arrival_time_threshold |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם זמן ההגעה המשוער עד לעצירה <= duration_until_estimated_arrival_time_threshold. |
remaining_driving_distance_meters_threshold |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם מרחק הנסיעה שנותר במטרים הוא במטרים <= still_driving_distance_meters_threshold. |
always |
אם הערך מוגדר כ-True, רכיב הנתונים תמיד גלוי למשתמשי הקצה ללא ערכי סף. אי אפשר להגדיר את השדה הזה כ-False. |
never |
אם המדיניות מוגדרת כ-True, רכיב הנתונים הזה תמיד יהיה מוסתר ממשתמשי הקצה ללא ערכי סף. אי אפשר להגדיר את השדה הזה כ-False. |
TimeWindow
טווח זמן.
שדות | |
---|---|
start_time |
חובה. שעת ההתחלה של חלון הזמן (כולל). |
end_time |
חובה. שעת הסיום של חלון הזמן (כולל). |
UpdateDeliveryVehicleRequest
הודעת הבקשה UpdateDeliveryVehicle
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה. |
delivery_vehicle |
חובה. עדכון הישות |
update_mask |
חובה. אנונימיזציה של שדות שמציינת אילו שדות של זוהי רשימה מופרדת בפסיקים של שמות מלאים של שדות. דוגמה: |
UpdateTaskRequest
הודעת הבקשה UpdateTask
.
שדות | |
---|---|
header |
זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה. |
task |
חובה. המשימה שמשויכת לעדכון. השדות הבאים מנוהלים על ידי Fleet Engine. אין לעדכן אותם באמצעות
הערה: לא ניתן לשנות את הערך של אם המשימה הוקצתה לרכב מסירה, אין להגדיר את מצב המשימה כ'סגורה' באמצעות |
update_mask |
חובה. אנונימיזציה של השדות שמציינת אילו שדות של המשימות צריך לעדכן. הערה: השדה זוהי רשימה מופרדת בפסיקים של שמות מלאים של שדות. דוגמה: |
VehicleJourneySegment
מייצג את מקטע הנסיעה של הרכב – מהתחנה הקודמת ועד לתחנה הנוכחית. אם זו העצירה הפעילה הראשונה, המשמעות היא מהמיקום הנוכחי של הרכב לתחנה הזו.
שדות | |
---|---|
stop |
מציין את מיקום העצירה, עם סימני ה- |
driving_distance_meters |
פלט בלבד. מרחק הנסיעה מהתחנה הקודמת אל התחנה הזו. אם העצירה הנוכחית היא העצירה הראשונה ברשימה של קטעי הנסיעה, נקודת ההתחלה היא מיקום הרכב שמתועד בזמן ההוספה של העצירה הזו לרשימה. יכול להיות שהשדה הזה לא יהיה קיים אם קטע התהליך הזה הוא חלק מ- |
driving_duration |
פלט בלבד. זמן הנסיעה מהתחנה הקודמת אל התחנה הזו. אם העצירה הנוכחית היא העצירה הראשונה ברשימה של קטעי הנסיעה, נקודת ההתחלה היא המיקום של הרכב שתועד בזמן ההוספה של העצירה הזו לרשימה. אם השדה הזה מוגדר בנתיב |
path[] |
פלט בלבד. הנתיב מהתחנה הקודמת אל התחנה הזו. אם העצירה הנוכחית היא העצירה הראשונה ברשימה של קטעי הנסיעה, זו תהיה הדרך מהמיקום הנוכחי של הרכב לתחנה הזו בזמן הוספת העצירה לרשימה. יכול להיות שהשדה הזה לא יהיה קיים אם קטע התהליך הזה הוא חלק מ- אם השדה הזה מוגדר בנתיב |
VehicleStop
מתארת נקודה שבה הרכב עוצר כדי לבצע שנייה אחת או יותר של Task
.
שדות | |
---|---|
planned_location |
חובה. מיקום התחנה. לתשומת ליבך: ייתכן שהמיקומים ב |
tasks[] |
רשימת ה |
state |
המדינה של |
ארץ
המצב הנוכחי של VehicleStop
.
טיפוסים בני מנייה (enums) | |
---|---|
STATE_UNSPECIFIED |
לא ידוע. |
NEW |
הניתוב נוצר, אבל לא הניתוב באופן פעיל. |
ENROUTE |
הוקצתה וניתוב באופן פעיל. |
ARRIVED |
הגעת לעצירה. ההנחה היא שכשהרכב במסלול לתחנה הבאה, כל העצירות הקודמות הושלמו. |
TaskInfo
מידע נוסף על המשימה שבוצעה בעצירה הזו.
שדות | |
---|---|
task_id |
מזהה המשימה. השדה הזה לא יאוכלס בתגובה של
|
task_duration |
פלט בלבד. הזמן הנדרש לביצוע המשימה. |
target_time_window |
פלט בלבד. חלון הזמן שבמהלכו צריך להשלים את המשימה. ערך זה מוגדר רק בתגובה ל- |