Package google.maps.roads.selection.v1

אינדקס

RoadsSelection

הגדרת השירות של Roads Selection API.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

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

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

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

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

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

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

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

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

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

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

BatchCreateSelectedRoutesRequest

בקשה ליצירת מספר SelectedRoute.

שדות
parent

string

אופציונלי. משאב הפרויקט שמשותף לכל המסלולים שנבחרו. פורמט: projects/{project} אם השדה הזה מוגדר, השדה parent בהודעות CreateSelectedRouteRequest חייב להיות ריק או זהה לשדה הזה.
requests[]

CreateSelectedRouteRequest

חובה. הודעת הבקשה שמציינת את המסלול שנבחר ליצירה. אפשר ליצור עד 1,000 מסלולים נבחרים באצווה.

BatchCreateSelectedRoutesResponse

תגובה מיצירה של כמה SelectedRoute.

שדות
selected_routes[]

SelectedRoute

נוצר SelectedRoutes.

CreateSelectedRouteRequest

בקשה ליצירת SelectedRoute.

שדות
parent

string

חובה. הפרויקט שבו ייצור SelectedRoute. פורמט: projects/{project}
selected_route

SelectedRoute

חובה. לוחצים על SelectedRoute כדי ליצור.
selected_route_id

string

אופציונלי. המזהה לשימוש ב-SelectedRoute, שיהפוך לרכיב הסופי של שם המשאב של SelectedRoute.

הערך הזה צריך להיות באורך 4-63 תווים, והתווים התקפים הם: a-z,‏ A-Z,‏ 0-9 או '-'. אם לא מספקים ערך או אם הערך ריק, יווצר UUID אחרי יצירת המשאב.

DeleteSelectedRouteRequest

בקשה למחיקה של SelectedRoute.

שדות
name

string

חובה. השם של SelectedRoute שרוצים למחוק. פורמט: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

בקשה לקבל SelectedRoute.

שדות
name

string

חובה. השם של SelectedRoute שרוצים לאחזר. פורמט: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

בקשה להצגת רשימה של SelectedRoute.

שדות
parent

string

חובה. הפרויקט הראשי, שממנו יתבצעו השאילתות לכל SelectedRoute. פורמט: projects/{project}/selectedRoutes
page_size

int32

אופציונלי. מספר התוצאות שיוחזרו לדף נתון. אם לא מגדירים ערך, ערך ברירת המחדל הוא 100. אם הערך הוא 0, הערך יוגדר כברירת המחדל. הערך המקסימלי הוא 5,000. כל ערך מעל 5,000 יוגדר כ-5,000.
page_token

string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של ListSelectedRoutes.

ListSelectedRoutesResponse

תגובה שמפרטת את SelectedRoutes.

שדות
selected_routes[]

SelectedRoute

דף של SelectedRoutes שמאוחסן בפרויקט שצוין בבקשה.
next_page_token

string

טוקן שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא. אם השדה הזה ריק, אין דפים נוספים.

SelectedRoute

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

שדות
name

string

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

פורמט: projects/{project}/selectedRoutes/{selected_route}
display_name

string

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

Timestamp

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

State

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

map<string, string>

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

DynamicRoute

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

ValidationError

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

DynamicRoute

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

שדות
origin

LatLng

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

LatLng

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

LatLng

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

מדינה

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

טיפוסים בני מנייה (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 השימוש בדרך נמוך (מעט מאוד אנשים עוברים בה).