REST Resource: selection.v1.projects.selectedRoutes

משאב: SelectedRoute

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

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "state": enum (State),
  "routeAttributes": {
    string: string,
    ...
  },

  // Union field route_type can be only one of the following:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of list of possible types for union field route_type.
  "validationError": enum (ValidationError)
}
שדות
name

string

מזהה. שם המשאב של SelectedRoute.

פורמט: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

אופציונלי. השם המוצג של המסלול. זהו שדה אופציונלי שהלקוח יכול להשתמש בו. היא לא חייבת להיות ייחודית.
createTime

string (Timestamp format)

פלט בלבד. השעה שבה המסלול שנבחר נוצר בפעם הראשונה.

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות חלקיות. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
state

enum (State)

פלט בלבד. הסטטוס של המסלול שנבחר.
routeAttributes

map (key: string, value: string)

אופציונלי. המאפיינים המותאמים אישית של המסלול שנבחר. הוספתם מאפשרת לסנן או לקבץ את המסלולים כשמאחזרים מידע היסטורי ומידע בזמן אמת על מסלולים. אפשר להוסיף עד 10 מאפיינים לכל מסלול. כל מפתח וערך צריכים להיות מחרוזת לא ריקה, והאורך שלהם יכול להיות עד 100 תווים. המפתחות לא יכולים להתחיל ב-goog.

אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }
שדה איחוד route_type. בשלב הזה יש תמיכה רק ב-DynamicRoute. הערך route_type יכול להיות רק אחד מהבאים:
dynamicRoute

object (DynamicRoute)

‫SelectedRoute הוא מסלול דינמי.
validationError

enum (ValidationError)

פלט בלבד. שגיאת האימות של המסלול שנבחר כשהמצב הוא STATE_INVALID.

DynamicRoute

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

ייצוג ב-JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
שדות
origin

object (LatLng)

חובה. מיקום המוצא של המסלול.
destination

object (LatLng)

חובה. מיקום הסיום של המסלול.
intermediates[]

object (LatLng)

אופציונלי. קבוצה של נקודות ציון ביניים לאורך המסלול (לא כולל נקודות המוצא והיעד). הם תמיד נקודות חולפות. אפשר להוסיף עד 25 נקודות עצירה. הוספה נכונה של נתונים כאלה יכולה לצמצם את השונות בין המסלול בפועל לבין המסלול המתוכנן.

LatLng

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

ייצוג ב-JSON 
{
  "latitude": number,
  "longitude": number
}
שדות
latitude

number

קו הרוחב במעלות. הערך צריך להיות בטווח [‎-90.0, ‎+90.0].
longitude

number

קו האורך במעלות. הערך חייב להיות בטווח [‎-180.0, ‎+180.0].

מדינה

הסטטוס של המסלול שנבחר.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED המצב של המסלול הזה לא מוגדר.
STATE_SCHEDULING המסלול נוצר והוא בתהליך תזמון.
STATE_RUNNING המסלול נוצר ויש לו לוח זמנים פעיל.
STATE_DELETING המסלול סומן למחיקה.
STATE_VALIDATING המסלול נמצא בתהליך אימות.
STATE_INVALID המסלול לא תקין על סמך אחד מקריטריוני האימות.

ValidationError

שגיאת האימות של המסלול שנבחר.

טיפוסים בני מנייה (enum)
VALIDATION_ERROR_UNSPECIFIED לא מוגדרת שגיאת האימות של המסלול הזה.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION המסלול נמצא מחוץ לתחום השיפוט של הפרויקט.
VALIDATION_ERROR_LOW_ROAD_USAGE השימוש בדרך נמוך (מעט מאוד אנשים עוברים בה).

Methods

batchCreate

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

create

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

delete

 מחיקת SelectedRoute שצוין בפרויקט שצוין.

get

 מקבל SelectedRoute כפי שצוין בשם שלו.

list

 רשימה של כל ה-SelectedRoutes בפרויקט שצוין, עם חלוקה לדפים.