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 request:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError)
}
שדות
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.

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].

מדינה (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 לפי השם שלו.