REST Resource: selection.v1.projects.selectedRoutes

משאב: SelectedRoute

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError),
  "dynamicRouting": boolean
}
שדות
name

string

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

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

string

אופציונלי. השם המוצג של המסלול. השדה הזה אופציונלי, והלקוח יכול להשתמש בו. הוא לא חייב להיות ייחודי. האורך מוגבל ל-100 תווים (נספרים במיקומי תווים של Unicode).
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)

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

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

object (DynamicRoute)

הנתיב SelectedRoute הוא נתיב דינמי.
סוף השדות שמוציאים זה את זה.
validationError

enum (ValidationError)

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

boolean

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

DynamicRoute

האובייקט הזה מייצג מסלול עם נקודות ציון (מוצא, יעד ונקודות ביניים). המסלול בפועל יעבור בכל נקודות הדרך. אם המדיניות dynamicRouting מוגדרת לערך false, המסלול בפועל נשאר קבוע בלי קשר למצב התנועה. אחרת, אם dynamicRouting מוגדר ל-true, המסלול בפועל יכול להשתנות בהתאם למצב התנועה.

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

object (LatLng)

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

object (LatLng)

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

object (LatLng)

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

LatLng

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

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

number

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

number

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

מדינה (State)

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

טיפוסים בני מנייה (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

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

batchDelete

 מחיקה של כמה משאבי SelectedRoute בפרויקט שצוין.

batchUpdate

 עדכון של כמה משאבי SelectedRoute לפי השמות שלהם.

create

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

delete

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

get

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

list

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

patch

 עדכון של SelectedRoute לפי השם שלו.