- משאב: משימה
- סוג
- TaskOutcomeLocationSource
- JourneySharingInfo
- TaskTrackingViewConfig
- VisibilityOption
- שיטות
משאב: משימה
משימה ב- Delivery API מייצגת פעולה יחידה למעקב. באופן כללי, יש הבחנה בין Tasks שקשורות למשלוח לבין משימות מנותקות. לכל משלוח יכולות להיות כמה משימות. לדוגמה, יכולה להיות משימה אחת לאיסוף ומשימה אחת למסירה או להעברה. כמו כן, כלי רכב שונים יכולים לטפל במשימות שונות במשלוח נתון. לדוגמה, רכב אחד יכול לטפל באיסוף ולהביא את המשלוח למרכז, ורכב אחר יכול לנסוע עם אותו משלוח מהמרכז אל נקודת ההורדה.
הערה: ממשקי API ל-gRPC ו-REST משתמשים במוסכמות שונות של מתן שמות לשדות. לדוגמה, השדה Task.journey_sharing_info
ב-gRPC API והשדה Task.journeySharingInfo
ב-API ל-REST מפנים לאותו שדה.
ייצוג JSON |
---|
{ "name": string, "type": enum ( |
שדות | |
---|---|
name |
חייב להיות בפורמט |
type |
חובה. בלתי משתנה. מגדיר את סוג המשימה. לדוגמה, הפסקה או משלוח. |
state |
חובה. מצב הביצוע הנוכחי של המשימה. |
taskOutcome |
תוצאת המשימה. |
taskOutcomeTime |
חותמת הזמן שמציינת מתי הספק הגדיר את התוצאה של חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
taskOutcomeLocation |
המיקום שבו נקבעה התוצאה של |
taskOutcomeLocationSource |
מציין את מקור הערך של |
trackingId |
בלתי משתנה. בשדה הזה אפשר לשמור מזהה כדי להימנע משימוש במיפוי מורכב. לא ניתן להגדיר את
|
deliveryVehicleId |
פלט בלבד. מזהה הרכב שמבצע את המשימה הזו. מזהי כלי רכב כפופים להגבלות הבאות:
|
plannedLocation |
בלתי משתנה. המיקום שבו המשימה תושלם. אופציונלי ל- |
taskDuration |
חובה. בלתי משתנה. הזמן הדרוש לביצוע משימה במיקום הזה. משך זמן בשניות עם עד תשע ספרות עשרוניות, המסתיים ב-' |
targetTimeWindow |
חלון הזמן שבמהלכו צריך להשלים את המשימה. |
journeySharingInfo |
פלט בלבד. שדות ספציפיים לשיתוף של נסיעות. לא מאוכלס כשהמדינה היא |
taskTrackingViewConfig |
התצורה של מעקב משימות, שמציינת אילו רכיבי נתונים גלויים למשתמשי הקצה ובאילו נסיבות. |
attributes[] |
רשימה של מאפייני משימה בהתאמה אישית. לכל מאפיין צריך להיות מפתח ייחודי. |
סוג
סוג המשימה.
טיפוסים בני מנייה (enums) | |
---|---|
TYPE_UNSPECIFIED |
ברירת המחדל, סוג המשימה לא ידוע. |
PICKUP |
משימה באיסוף עצמי היא הפעולה שננקטת לאיסוף משלוח מלקוח. איסופים בכלי רכב מתחנות הגשה או מתקן האכלה צריכים להיות מסוג SCHEDULED_STOP . |
DELIVERY |
משימת מסירה היא הפעולה שננקטת כדי למסור משלוח ללקוח קצה. ניתוקים מתחנות כוח או מתקן ההאכלה ברכב צריכים להיות מסוג SCHEDULED_STOP . |
SCHEDULED_STOP |
משימה עם עצירה מתוזמנת משמשת למטרות תכנון. לדוגמה, הוא יכול לייצג איסוף או השמטה של משלוחים מכלי רכב או מתחנות הזנה. אין להשתמש בו במשלוחים שנאספים או מוסרים מלקוח קצה. |
UNAVAILABLE |
משימה שבמסגרתה הרכב לא זמין לשירות. לדוגמה, מצב כזה יכול לקרות כשהנהג יוצא להפסקה או בזמן מילוי דלק ברכב. |
TaskOutcomeLocationSource
זהות המקור שהאכלס את taskOutcomeLocation
.
טיפוסים בני מנייה (enums) | |
---|---|
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED |
תוצאת המשימה לפני ההגדרה. |
PROVIDER |
הספק ציין את השדה taskOutcomeLocation . |
LAST_VEHICLE_LOCATION |
הספק לא ציין את השדה taskOutcomeLocation , לכן Fleet Engine השתמש במיקום האחרון הידוע של הרכב. |
JourneySharingInfo
שיתוף של מסע עם שדות ספציפיים.
ייצוג JSON |
---|
{ "remainingVehicleJourneySegments": [ { object ( |
שדות | |
---|---|
remainingVehicleJourneySegments[] |
נתוני מעקב לגבי עצירות שהרכב שהוקצה לו יבצע לפני השלמת המשימה הזו. חשוב לזכור שהרשימה הזו יכולה לכלול עצירות ממשימות אחרות. הקטע הראשון, |
lastLocation |
מציין את המיקום המדווח האחרון של הרכב. |
lastLocationSnappable |
התנאי מציין אם אפשר להצמיד את המיקום האחרון של הרכב אל |
TaskTrackingViewConfig
הודעת התצורה שקובעת מתי רכיב נתונים של משימה צריך להיות גלוי למשתמשי הקצה.
ייצוג JSON |
---|
{ "routePolylinePointsVisibility": { object ( |
שדות | |
---|---|
routePolylinePointsVisibility |
השדה שמציין מתי נקודות קו פוליגוניות של מסלול יכולות להיות גלויות. אם לא מציינים את השדה הזה, המערכת משתמשת בהגדרת ברירת המחדל של הרשאות הגישה ברמת הפרויקט לנתונים האלה. |
estimatedArrivalTimeVisibility |
השדה שמציין מתי ניתן להציג את זמן ההגעה המשוער. אם לא מציינים את השדה הזה, המערכת משתמשת בהגדרת ברירת המחדל של הרשאות הגישה ברמת הפרויקט לנתונים האלה. |
estimatedTaskCompletionTimeVisibility |
השדה שמציין מתי ניתן להציג את זמן ההשלמה המשוער של המשימה. אם לא מציינים את השדה הזה, המערכת משתמשת בהגדרת ברירת המחדל של הרשאות הגישה ברמת הפרויקט לנתונים האלה. |
remainingDrivingDistanceVisibility |
השדה שמציין מתי מרחק הנסיעה שנותר ניתן לראות. אם לא מציינים את השדה הזה, המערכת משתמשת בהגדרת ברירת המחדל של הרשאות הגישה ברמת הפרויקט לנתונים האלה. |
remainingStopCountVisibility |
השדה שמציין מתי ניתן לראות את מספר העצירות שנותרו. אם לא מציינים את השדה הזה, המערכת משתמשת בהגדרת ברירת המחדל של הרשאות הגישה ברמת הפרויקט לנתונים האלה. |
vehicleLocationVisibility |
השדה שמציין מתי ניתן לראות את מיקום הרכב. אם לא מציינים את השדה הזה, המערכת משתמשת בהגדרת ברירת המחדל של הרשאות הגישה ברמת הפרויקט לנתונים האלה. |
VisibilityOption
הודעת האפשרות שקובעת מתי רכיב נתונים צריך להיות גלוי למשתמשי הקצה.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד visibility_option . אפשרות החשיפה הספציפית שנבחרה. visibility_option יכול להיות רק אחד מהבאים: |
|
remainingStopCountThreshold |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם מספר העצירות הנותר <= רשימה שעומדת לפוג. |
durationUntilEstimatedArrivalTimeThreshold |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם זמן ההגעה המשוער עד לעצירה <= durationpendingestimatedArrivalTimeThreshold. משך זמן בשניות עם עד תשע ספרות עשרוניות, המסתיים ב-' |
remainingDrivingDistanceMetersThreshold |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם מרחק הנסיעה שנותר במטרים <= continue לתמונה מרחק מטרים. |
always |
אם הערך מוגדר כ-True, רכיב הנתונים תמיד גלוי למשתמשי הקצה ללא ערכי סף. אי אפשר להגדיר את השדה הזה כ-False. |
never |
אם המדיניות מוגדרת כ-True, רכיב הנתונים הזה תמיד יהיה מוסתר ממשתמשי הקצה ללא ערכי סף. אי אפשר להגדיר את השדה הזה כ-False. |
שיטות |
|
---|---|
|
הפונקציה יוצרת ומחזירה קבוצה של אובייקטים חדשים מסוג Task . |
|
יצירה ומחזירה אובייקט Task חדש. |
|
קבלת מידע על Task . |
|
הפונקציה מקבלת את כל הערכים מסוג Task שעומדים בקריטריונים לסינון. |
|
מתבצע עדכון של הנתונים של Task . |