TaskLog

היומן של משאב המשימה ב-Deliveries API.

ייצוג JSON
{
  "name": string,
  "type": enum (TaskTypeLog),
  "state": enum (TaskStateLog),
  "taskOutcome": enum (TaskOutcomeLog),
  "taskOutcomeTime": string,
  "taskOutcomeLocation": {
    object (LocationInfoLog)
  },
  "taskOutcomeLocationSource": enum (TaskOutcomeLocationSourceLog),
  "trackingId": string,
  "deliveryVehicleId": string,
  "plannedLocation": {
    object (LocationInfoLog)
  },
  "taskDuration": string,
  "targetTimeWindow": {
    object (TimeWindowLog)
  },
  "journeySharingInfo": {
    object (JourneySharingInfoLog)
  },
  "taskTrackingViewConfig": {
    object (TaskTrackingViewConfigLog)
  },
  "attributes": [
    {
      object (TaskAttributeLog)
    }
  ]
}
שדות
name

string

שם משאב המשימה בפורמט providers/{providerId}/tasks/{taskId}.

type

enum (TaskTypeLog)

סוג המשימה.

state

enum (TaskStateLog)

המצב של משימה שמציינת את ההתקדמות שלה.

taskOutcome

enum (TaskOutcomeLog)

התוצאה של הניסיון לבצע משימה. כאשר TaskState סגור, מציין אם הפעולה הושלמה בהצלחה.

taskOutcomeTime

string (Timestamp format)

חותמת הזמן של המועד שבו נקבעה תוצאת המשימה (מהספק).

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

taskOutcomeLocation

object (LocationInfoLog)

המיקום שבו הוגדרה תוצאת המשימה.

taskOutcomeLocationSource

enum (TaskOutcomeLocationSourceLog)

שדה זה מציין מאיפה הגיע הערך של taskOutcomeLocation.

trackingId

string

השדה הזה מאפשר לשמור את המזהה של הלקוח כדי למנוע מיפוי מיותר או מורכב.

deliveryVehicleId

string

המזהה של הרכב שמבצע את המשימה הזו.

plannedLocation

object (LocationInfoLog)

המיקום שבו המשימה הושלמה.

taskDuration

string (Duration format)

זמן נוסף לביצוע פעולה במיקום הזה.

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. לדוגמה: "3.5s".

targetTimeWindow

object (TimeWindowLog)

חלון הזמן שבמהלכו צריך להשלים את המשימה.

journeySharingInfo

object (JourneySharingInfoLog)

שיתוף שדות ספציפיים בתהליך.

taskTrackingViewConfig

object (TaskTrackingViewConfigLog)

התצורה של מעקב אחר משימות שמציינת אילו רכיבי נתונים יהיו גלויים למשתמשי הקצה ובאילו נסיבות.

attributes[]

object (TaskAttributeLog)

רשימה של מאפיינים מותאמים אישית למשימה. לכל מאפיין צריך להיות מפתח ייחודי.

JourneySharingInfoLog

שיתוף שדות ספציפיים בתהליך.

ייצוג JSON
{
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegmentLog)
    }
  ],
  "lastLocation": {
    object (DeliveryVehicleLocationLog)
  },
  "lastLocationSnappable": boolean
}
שדות
remainingVehicleJourneySegments[]

object (VehicleJourneySegmentLog)

פרטי המעקב של כל תחנה שאליה ייסע הרכב שהוקצה לה לפני השלמת המשימה הזו. יכול להיות שהרשימה הזו מכילה עצירות ממשימות אחרות.

lastLocation

object (DeliveryVehicleLocationLog)

המיקום האחרון המדווח של הרכב.

lastLocationSnappable

boolean

מציינת אם ניתן להצמיד את lastLocation של הרכב אל currentRouteSegment. False אם lastLocation או currentRouteSegment לא קיימים.

TaskTrackingViewConfigLog

הודעת ההגדרה שקובעת מתי רכיב נתונים של משימה יהיה גלוי למשתמשי הקצה.

ייצוג JSON
{
  "routePolylinePointsVisibility": {
    object (VisibilityOptionLog)
  },
  "estimatedArrivalTimeVisibility": {
    object (VisibilityOptionLog)
  },
  "estimatedTaskCompletionTimeVisibility": {
    object (VisibilityOptionLog)
  },
  "remainingDrivingDistanceVisibility": {
    object (VisibilityOptionLog)
  },
  "remainingStopCountVisibility": {
    object (VisibilityOptionLog)
  },
  "vehicleLocationVisibility": {
    object (VisibilityOptionLog)
  }
}
שדות
routePolylinePointsVisibility

object (VisibilityOptionLog)

השדה שמציין מתי נקודות פוליגוניות של נתיב יכולות להיות גלויות. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט.

estimatedArrivalTimeVisibility

object (VisibilityOptionLog)

השדה שמציין מתי זמן ההגעה המשוער יכול להיות מוצג. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט.

estimatedTaskCompletionTimeVisibility

object (VisibilityOptionLog)

השדה שמציין מתי ניתן לראות את הזמן המשוער להשלמת המשימה. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט.

remainingDrivingDistanceVisibility

object (VisibilityOptionLog)

השדה שמציין מתי מרחק הנסיעה שנותר יכול להיות גלוי. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט.

remainingStopCountVisibility

object (VisibilityOptionLog)

השדה שמציין מתי אפשר לראות את מספר התחנות שנותרות. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט.

vehicleLocationVisibility

object (VisibilityOptionLog)

השדה שמציין מתי ניתן לראות את מיקום הרכב. אם השדה הזה לא מצוין, המערכת תשתמש בהגדרות ברירת המחדל של הרשאות הגישה לנתונים האלה ברמת הפרויקט.

VisibilityOptionLog

הודעת האפשרות שקובעת מתי רכיב נתונים צריך להיות גלוי למשתמשי הקצה.

ייצוג JSON
{

  // Union field visibility_option can be only one of the following:
  "remainingStopCountThreshold": integer,
  "durationUntilEstimatedArrivalTimeThreshold": string,
  "remainingDrivingDistanceMetersThreshold": integer,
  "always": boolean,
  "never": boolean
  // End of list of possible types for union field visibility_option.
}
שדות

שדה איחוד visibility_option.

visibility_option יכול להיות רק אחת מהאפשרויות הבאות:

remainingStopCountThreshold

integer

רכיב הנתונים הזה גלוי למשתמשי הקצה אם מספר העצירה שנותר <={/3}StopCountThreshold.

durationUntilEstimatedArrivalTimeThreshold

string (Duration format)

רכיב הנתונים הזה גלוי למשתמשי הקצה אם זמן ההגעה המשוער עד העצירה <= durationDurationArrivalTimeThreshold.

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. לדוגמה: "3.5s".

remainingDrivingDistanceMetersThreshold

integer

רכיב הנתונים הזה גלוי למשתמשי הקצה אם מרחק הנסיעה שנותר במטרים <=GmailDistanceMetersThreshold.

always

boolean

אם המדיניות מוגדרת כ-True, רכיב הנתונים הזה תמיד גלוי למשתמשי קצה ללא ערכי סף.

never

boolean

אם המדיניות מוגדרת כ-True, רכיב הנתונים הזה תמיד מוסתר ממשתמשי הקצה ללא ערכי סף.

TaskAttributeLog

מתאר מאפיין משימה כצמד מפתח/ערך. העמודה "key:value" המחרוזת יכולה להיות באורך של עד 256 תווים.

ייצוג JSON
{
  "key": string,

  // Union field task_attribute_value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field task_attribute_value.
}
שדות
key

string

המַּפתח של המאפיין. אסור שמפתחות יכילו את תו הנקודתיים (:).

שדה איחוד task_attribute_value. ערך המאפיין יכול להיות מחרוזת, בוליאני או סוג כפול. אם לא מוגדר ערך TaskAttribute string_value, הוא יאוחסן כמחרוזת הריקה "". task_attribute_value יכול להיות רק אחת מהאפשרויות הבאות:
stringValue

string

ערך מאפיין שהוקלד במחרוזת.

boolValue

boolean

ערך מאפיין בוליאני.

numberValue

number

ערך המאפיין הוקלד פעמיים.