- משאב: משימה
- סוג
- TaskOutcomeLocationSource
- JourneySharingInfo
- TaskTrackingViewConfig
- VisibilityOption
- שיטות
משאב: משימה
משימה ב-Delivery API מייצגת פעולה יחידה למעקב. באופן כללי, יש הבחנה בין Tasks שקשורות למשלוחים לבין משימות 'הפסקות'. לכל משלוח אפשר לשייך אליו כמה משימות. לדוגמה, יכולה להיות משימה אחת לאיסוף ומשימה אחת לאיסוף או להעברה. בנוסף, כלי רכב שונים יכולים לטפל במשימות שונות לכל משלוח. לדוגמה, רכב אחד יכול לטפל באיסוף עצמי ולהביא את המשלוח למרכז, ורכב אחר מנהל את אותו משלוח מהמרכז אל נקודת ההורדה.
הערה: ממשקי API ל-gRPC ול-REST משתמשים במוסכמות שונות של מתן שמות לשדות. לדוגמה, השדה Task.journey_sharing_info
ב-API ל-gRPC והשדה Task.journeySharingInfo
ב-API ל-REST מפנים לאותו שדה.
ייצוג JSON |
---|
{ "name": string, "type": enum ( |
שדות | |
---|---|
name |
חייב להיות בפורמט |
type |
חובה. בלתי ניתן לשינוי. משמש להגדרת סוג המשימה. לדוגמה, הפסקה או משלוח. |
state |
חובה. מצב הביצוע הנוכחי של המשימה. |
taskOutcome |
התוצאה של המשימה. |
taskOutcomeTime |
חותמת הזמן שמציינת מתי הספק הגדיר את התוצאה של חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
taskOutcomeLocation |
המיקום שבו נקבעה התוצאה של ה |
taskOutcomeLocationSource |
שדה זה מציין מאיפה הגיע הערך של |
trackingId |
בלתי ניתן לשינוי. השדה הזה מאפשר לשמור את המזהה וכך להימנע משימוש במיפוי מורכב. לא ניתן להגדיר את
|
deliveryVehicleId |
פלט בלבד. המזהה של הרכב שמבצע את המשימה הזו. מזהי רכבים להעברה כפופים להגבלות הבאות:
|
plannedLocation |
בלתי ניתן לשינוי. המיקום שבו המשימה תושלם. אופציונלי ל- |
taskDuration |
חובה. בלתי ניתן לשינוי. הזמן הדרוש לביצוע משימה במיקום הזה. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-' |
targetTimeWindow |
חלון הזמן שבמהלכו צריך להשלים את המשימה. |
journeySharingInfo |
פלט בלבד. שדות ספציפיים לשיתוף תהליכים. לא מאוכלס כשהמדינה היא |
taskTrackingViewConfig |
התצורה של מעקב אחר משימות שמציינת אילו רכיבי נתונים יהיו גלויים למשתמשי הקצה ובאילו נסיבות. |
attributes[] |
רשימה של מאפיינים מותאמים אישית למשימה. לכל מאפיין צריך להיות מפתח ייחודי. |
סוג
סוג המשימה.
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
כברירת מחדל, סוג המשימה לא ידוע. |
PICKUP |
'משימה לאיסוף' היא הפעולה שננקטה לאיסוף משלוח מהלקוח. באיסוף עצמי או במתקן לאיסוף רכבים, צריך להשתמש בסוג SCHEDULED_STOP . |
DELIVERY |
משימת מסירה היא הפעולה שננקטת בקשר למסירת משלוח ללקוח קצה. הכלי להנחיתות של רכבים בתחנה או בפיד צריך להיות מסוג SCHEDULED_STOP . |
SCHEDULED_STOP |
משימה עם עצירה מתוזמנת משמשת למטרות תכנון. לדוגמה, הוא יכול לייצג איסוף או מסירה של משלוחים מכלי רכב או מתחנות הזנה. אסור להשתמש בו למשלוחים שנאספים או מוסרים מלקוח קצה. |
UNAVAILABLE |
משימה שמציינת שהרכב לא זמין לקבלת שירות. לדוגמה: מצב כזה יכול לקרות כשהנהג יוצא להפסקה או כשיש דלק לרכב. |
TaskOutcomeLocationSource
זהות המקור שאיכלס את taskOutcomeLocation
.
טיפוסים בני מנייה (enum) | |
---|---|
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 |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם מספר העצירה שנותר <={/3}StopCountThreshold. |
durationUntilEstimatedArrivalTimeThreshold |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם זמן ההגעה המשוער עד העצירה <= durationDurationArrivalTimeThreshold. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-' |
remainingDrivingDistanceMetersThreshold |
רכיב הנתונים הזה גלוי למשתמשי הקצה אם מרחק הנסיעה שנותר במטרים <=GmailDistanceMetersThreshold. |
always |
אם המדיניות מוגדרת כ-True, רכיב הנתונים הזה תמיד גלוי למשתמשי קצה ללא ערכי סף. לא ניתן להגדיר את השדה הזה כ-False. |
never |
אם המדיניות מוגדרת כ-True, רכיב הנתונים הזה תמיד מוסתר ממשתמשי הקצה ללא ערכי סף. לא ניתן להגדיר את השדה הזה כ-False. |
שיטות |
|
---|---|
|
יוצרת ומחזירה קבוצה של אובייקטים חדשים מסוג Task . |
|
יצירה ומחזירה של אובייקט Task חדש. |
|
קבלת מידע על Task . |
|
הפונקציה מקבלת את כל הפריטים מסוג 'Task ' שעומדים בקריטריונים לסינון שצוינו. |
|
עדכון הנתונים של Task . |