Package google.maps.roads.selection.v1

אינדקס

RoadsSelection

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

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • roads.selectedRoutes.batchCreate

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
BatchDeleteSelectedRoutes

rpc BatchDeleteSelectedRoutes(BatchDeleteSelectedRoutesRequest) returns (Empty)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • roads.selectedRoutes.batchDelete

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
BatchUpdateSelectedRoutes

rpc BatchUpdateSelectedRoutes(BatchUpdateSelectedRoutesRequest) returns (BatchUpdateSelectedRoutesResponse)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • roads.selectedRoutes.batchUpdate

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • roads.selectedRoutes.create

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • roads.selectedRoutes.delete

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • roads.selectedRoutes.get

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • roads.selectedRoutes.list

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
UpdateSelectedRoute

rpc UpdateSelectedRoute(UpdateSelectedRouteRequest) returns (SelectedRoute)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • roads.selectedRoutes.update

מידע נוסף מופיע במאמרי העזרה בנושא IAM.

BatchCreateSelectedRoutesRequest

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

שדות
parent

string

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

CreateSelectedRouteRequest

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

BatchCreateSelectedRoutesResponse

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

שדות
selected_routes[]

SelectedRoute

נוצרו SelectedRoute משאבים.

BatchDeleteSelectedRoutesRequest

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

שדות
parent

string

חובה. משאב הפרויקט שמשותף לכל המסלולים שנבחרו למחיקה. המאפיין הזה נדרש כי בקשת Batch תומכת רק ב-parent אחד. פורמט: projects/{project}
names[]

string

חובה. השמות של המסלולים שנבחרו למחיקה. אפשר למחוק עד 1,000 מסלולים נבחרים בבת אחת. פורמט: projects/{project}/selectedRoutes/{selected_route}

BatchUpdateSelectedRoutesRequest

בקשה לעדכון של כמה SelectedRoute.

שדות
parent

string

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

UpdateSelectedRouteRequest

חובה. הודעת הבקשה שמציינת את המסלול שנבחר לעדכון. אפשר לעדכן עד 1,000 מסלולים נבחרים בבת אחת. המשאב ברמה העליונה של כל בקשה צריך להיות ריק או זהה ל-parent.
update_mask

FieldMask

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

נתיבי השדות הם יחסיים ל-SelectedRoute. צריך לעדכן רק את display_name,‏ route_attributes וdynamic_route (כולל origin,‏ destination וintermediates).

דוגמה: "display_name,route_attributes,dynamic_route"

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

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

BatchUpdateSelectedRoutesResponse

תגובה לעדכון של כמה SelectedRoute.

שדות
selected_routes[]

SelectedRoute

עודכנו SelectedRoute משאבים.

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

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

int32

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

string

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

ListSelectedRoutesResponse

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

שדות
selected_routes[]

SelectedRoute

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

string

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

SelectedRoute

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

שדות
name

string

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

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

string

אופציונלי. השם המוצג של המסלול. זהו שדה אופציונלי שהלקוח יכול להשתמש בו. היא לא חייבת להיות ייחודית. האורך מוגבל ל-100 תווים (נספר בנקודות קוד של Unicode).
create_time

Timestamp

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

State

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

map<string, string>

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

DynamicRoute

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

ValidationError

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

DynamicRoute

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

שדות
origin

LatLng

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

LatLng

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

LatLng

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

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

UpdateSelectedRouteRequest

בקשה לעדכן SelectedRoute.

שדות
selected_route

SelectedRoute

חובה. הגרסה של SelectedRoute שצריך לעדכן. השדה name של המסלול משמש לזיהוי המסלול לעדכון. פורמט: projects/{project}/selectedRoutes/{selected_route}
update_mask

FieldMask

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

נתיבי השדות הם יחסיים ל-SelectedRoute. צריך לעדכן רק את display_name,‏ route_attributes וdynamic_route (כולל origin,‏ destination וintermediates).

דוגמה: "display_name,route_attributes,dynamic_route"

אם מציינים את *, מתבצעת החלפה מלאה של כל השדות שניתנים לעדכון.

אם לא מציינים את update_mask, כל השדות שאפשר לעדכן שאוכלסו ב-selected_route יעדכנו.