דף זה תורגם על ידי Cloud Translation API.

Method: projects.locations.optimizeTours

בקשת HTTP
פרמטרים של נתיב
גוף הבקשה
- ייצוג ב-JSON
גוף התשובה
היקפי הרשאה
הרשאות IAM

הפונקציה שולחת OptimizeToursRequest עם ערך ShipmentModel ומחזירה ערך של OptimizeToursResponse שמכיל ShipmentRoutes, שהם קבוצת מסלולים שכלי רכב יכולים לבצע כדי לצמצם את העלות הכוללת.

מודל ShipmentModel מורכב בעיקר מאובייקטים של Shipment שצריך לבצע ו-Vehicles שאפשר להשתמש בהם כדי להעביר את אובייקטי Shipment. נכסי ShipmentRoute מקצים Shipment ל-Vehicle שנ'. ליתר דיוק, הם מקצים סדרה של Visit לכל רכב, ו-Visit מייצג סדרה של VisitRequest, שמשמעותה איסוף או משלוח עבור Shipment.

המטרה היא להקצות הקצאות של ShipmentRoute ל-Vehicle כדי לצמצם את העלות הכוללת במקרים שבהם לעלות יש רכיבים רבים שמוגדרים בShipmentModel.

בקשת HTTP

POST https://routeoptimization.googleapis.com/v1/{parent=projects/*/locations/*}:optimizeTours

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים

פרמטרים
`parent`	`string` חובה. בוחרים את הפרויקט או המיקום שאליהם רוצים להתקשר. פורמט: * `projects/{project-id}` * `projects/{project-id}/locations/{location-id}` אם לא תציינו מיקום, ייבחר אזור באופן אוטומטי.

parent

string

חובה. בוחרים את הפרויקט או המיקום שאליהם רוצים להתקשר.

פורמט: * projects/{project-id} * projects/{project-id}/locations/{location-id}

אם לא תציינו מיקום, ייבחר אזור באופן אוטומטי.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON

ייצוג ב-JSON
{ "timeout": string, "model": { object (`ShipmentModel`) }, "solvingMode": enum (`SolvingMode`), "searchMode": enum (`SearchMode`), "injectedFirstSolutionRoutes": [ { object (`ShipmentRoute`) } ], "injectedSolutionConstraint": { object (`InjectedSolutionConstraint`) }, "refreshDetailsRoutes": [ { object (`ShipmentRoute`) } ], "interpretInjectedSolutionsUsingLabels": boolean, "considerRoadTraffic": boolean, "populatePolylines": boolean, "populateTransitionPolylines": boolean, "allowLargeDeadlineDespiteInterruptionRisk": boolean, "useGeodesicDistances": boolean, "label": string, "geodesicMetersPerSecond": number, "maxValidationErrors": integer }

{
  "timeout": string,
  "model": {
    object (ShipmentModel)
  },
  "solvingMode": enum (SolvingMode),
  "searchMode": enum (SearchMode),
  "injectedFirstSolutionRoutes": [
    {
      object (ShipmentRoute)
    }
  ],
  "injectedSolutionConstraint": {
    object (InjectedSolutionConstraint)
  },
  "refreshDetailsRoutes": [
    {
      object (ShipmentRoute)
    }
  ],
  "interpretInjectedSolutionsUsingLabels": boolean,
  "considerRoadTraffic": boolean,
  "populatePolylines": boolean,
  "populateTransitionPolylines": boolean,
  "allowLargeDeadlineDespiteInterruptionRisk": boolean,
  "useGeodesicDistances": boolean,
  "label": string,
  "geodesicMetersPerSecond": number,
  "maxValidationErrors": integer
}

שדות
`timeout`	`string (Duration format)` אם מגדירים את הזמן הקצוב הזה, השרת מחזיר תשובה לפני שחלפו פרק הזמן הקצוב או לפני שחלף מועד היעד של השרת לבקשות סינכרוניות, המוקדם מביניהם. עבור בקשות אסינכרוניות, השרת ייצור פתרון (אם אפשר) לפני שיסתיים הזמן הקצוב לתפוגה. משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'`s`'. דוגמה: `"3.5s"`.
`model`	`object (ShipmentModel)` מודל המשלוח לפתרון.
`solvingMode`	`enum (SolvingMode)` כברירת מחדל, מצב הפתרון הוא `DEFAULT_SOLVE` (0).
`searchMode`	`enum (SearchMode)` מצב החיפוש ששימש לפתרון הבקשה.
`injectedFirstSolutionRoutes[]`	`object (ShipmentRoute)` נדריך את אלגוריתם האופטימיזציה כדי למצוא פתרון ראשון שדומה לפתרון קודם. המודל מוגבל בזמן בניית הפתרון הראשון. כל משלוחים שלא בוצעו במסלול מסוים יועברו אוטומטית לשלב הבא בפתרון, אבל יכול להיות שהם יבוצעו בפתרון הבא. הפתרון צריך לעמוד בהנחות בסיסיות לגבי תקינות: בכל המסלולים, `vehicleIndex` חייב להיות בטווח ולא להיות משוכפל. בכל הביקורים, הערכים של `shipmentIndex` ו-`visitRequestIndex` חייבים להיות בטווח. אפשר להפנות למשלוח רק במסלול אחד. איסוף עצמי צריך להתבצע לפני מועד המסירה. מותר לבצע משלוח או יותר מחלופה אחת לאיסוף או למשלוח. בכל המסלולים, הזמנים הולכים וגדלים (כלומר, `vehicleStartTime <= visits[0].start_time <= visits[1].start_time ... <= vehicleEndTime`). מותר לבצע משלוח רק בכלי רכב מורשה. מותר לפרסם רכב אם `Shipment.allowed_vehicle_indices` ריק או אם `vehicleIndex` שלו נכלל בתוך `Shipment.allowed_vehicle_indices`. אם הפתרון שהוזן לא מתאים, לא בהכרח תוחזר שגיאת אימות. יכול להיות שתוחזר שגיאה שמציינת את חוסר ההתאמה.
`injectedSolutionConstraint`	`object (InjectedSolutionConstraint)` להגביל את אלגוריתם האופטימיזציה כדי למצוא פתרון סופי שדומה לפתרון קודם. לדוגמה, אפשר להקפיא חלקים במסלולים שכבר הושלמו או כאלה שצריך להשלים אבל לא לשנות. אם הפתרון שהוזן לא מתאים, לא בהכרח תוחזר שגיאת אימות. יכול להיות שתוחזר שגיאה שמציינת את חוסר ההתאמה.
`refreshDetailsRoutes[]`	`object (ShipmentRoute)` אם המסלולים הנתונים לא ריקים, המערכת תרענן את המסלולים שלהם בלי לשנות את רצף הביקורים או את זמני הנסיעה הבסיסיים שלהם: רק פרטים אחרים יעודכנו. הפעולה הזו לא פותרת את הבעיה במודל. החל מ-11/2020, השדה הזה מאוכלס רק בקווים הפוליגוניים של מסלולים שאינם ריקים, וכדי להשתמש בו צריך שהערך של `populatePolylines` יהיה True. יכול להיות שהשדות `routePolyline` של המסלולים שהועברו לא יהיו עקביים עם המסלול `transitions`. אין להשתמש בשדה הזה יחד עם `injectedFirstSolutionRoutes` או `injectedSolutionConstraint`. ל-`Shipment.ignore` ול-`Vehicle.ignore` אין השפעה על ההתנהגות. קווים פוליגוניים עדיין מאוכלסים בין כל הביקורים בכל המסלולים שאינם ריקים, גם אם המערכת מתעלמת מהמשלוחים או מכלי הרכב הקשורים.
`interpretInjectedSolutionsUsingLabels`	`boolean` אם True: נעשה שימוש ב-`ShipmentRoute.vehicle_label` במקום ב-`vehicleIndex` כדי להתאים מסלולים בתמיסה מוחדרת לרכבים בבקשה; נעשה שימוש חוזר במיפוי של `ShipmentRoute.vehicle_index` המקורי ל-`ShipmentRoute.vehicle_index` חדש כדי לעדכן את `ConstraintRelaxation.vehicle_indices` אם השדה לא ריק, אבל המיפוי חייב להיות חד-משמעי (כלומר, מספר `ShipmentRoute`s לא יכול להיות משותף עם אותו `vehicleIndex` מקורי). משתמשים ב-`ShipmentRoute.Visit.shipment_label` במקום ב-`shipmentIndex` כדי להתאים ביקורים בפתרון שהוזן למשלוחים בבקשה. משתמשת ב-`SkippedShipment.label` במקום ב-`SkippedShipment.index` כדי להתאים בין משלוחים שעליהם דילגת בפתרון שהוחדר לבין בקשות למשלוחים. הפרשנות הזו חלה על השדות `injectedFirstSolutionRoutes`, `injectedSolutionConstraint` ו-`refreshDetailsRoutes`. אפשר להשתמש בה כשהאינדקסים של המשלוחים או הרכבים בבקשה השתנו מאז יצירת הפתרון, אולי כי הוספו או הוסרו משלוחים או רכבים מהבקשה. אם True, התוויות בקטגוריות הבאות חייבות להופיע פעם אחת לכל היותר בקטגוריה שלהן: `Vehicle.label` בבקשה; `Shipment.label` בבקשה; `ShipmentRoute.vehicle_label` בתמיסה ההזרקה; `SkippedShipment.label` ו-`ShipmentRoute.Visit.shipment_label` בפתרון שהוזן (למעט זוגות של ביקורים לאיסוף או למשלוח, שבהם `shipmentLabel` חייב להופיע פעמיים). אם הערך של `vehicleLabel` בפתרון שהוזן לא תואם לרכב של בקשה, המסלול התואם יוסר מהפתרון יחד עם הביקורים שלו. אם הערך של `shipmentLabel` בפתרון שהוזן לא תואם לשליחת בקשה, הביקור התואם יוסר מהפתרון. אם `SkippedShipment.label` בפתרון שהוזן לא תואם לשליחת בקשה, ה-`SkippedShipment` מוסר מהפתרון. הסרה של ביקורים במסלול או מסלולים שלמים מפתרון שהוחדר יכולה להיות השפעה על המגבלות המשתמעות. כתוצאה מכך, ייתכן שיהיו שינויים בפתרון, בשגיאות אימות או בחוסר היתכנות. הערה: המתקשר חייב לוודא שכל `Vehicle.label` (תגובה `Shipment.label`) מזהה באופן ייחודי ישות של רכב (או משלוח) שמופיעה בשתי הבקשות הרלוונטיות: הבקשה הקודמת שהניבה את `OptimizeToursResponse` ששימש בפתרון שהוזן, והבקשה הנוכחית שכוללת את הפתרון שהוזן. בדיקות הייחודיות המתוארות למעלה לא מספיקות כדי להבטיח את העמידה בדרישה הזו.
`considerRoadTraffic`	`boolean` כדאי להביא בחשבון את אומדן התנועה בזמן החישוב של השדות `ShipmentRoute`‏ `Transition.travel_duration`,‏ `Visit.start_time` ו-`vehicleEndTime`, בזמן ההגדרה של השדה `ShipmentRoute.has_traffic_infeasibilities` ובזמן החישוב של השדה `OptimizeToursResponse.total_cost`.
`populatePolylines`	`boolean` אם הערך הוא true, קווים פוליגונליים יאוכלסו בתשובות `ShipmentRoute`.
`populateTransitionPolylines`	`boolean` אם הערך הוא True, קווים פוליגונים ואסימונים של מסלולים יאוכלסו בתגובה `ShipmentRoute.transitions`.
`allowLargeDeadlineDespiteInterruptionRisk`	`boolean` אם היא מוגדרת, ייתכן שתאריך היעד של הבקשה הוא עד 60 דקות (מידע נוסף זמין בכתובת https://grpc.io/blog/deadlines). אחרת, מועד ההגשה האחרון הוא 30 דקות בלבד. חשוב לשים לב שלבקשות לטווח ארוך יש סיכון גבוה יותר באופן משמעותי (אבל עדיין קטן) להפרעה.
`useGeodesicDistances`	`boolean` אם הערך הוא True, מרחקי הנסיעה יחושבו באמצעות מרחקים גיאודזיים במקום מרחקים במפות Google, וזמני הנסיעה יחושבו על סמך מרחקים גיאודזיים שהמהירות שלהם מוגדרת על ידי `geodesicMetersPerSecond`.
`label`	`string` תווית שיכולה לשמש לזיהוי הבקשה הזו, מדווחת ב-`OptimizeToursResponse.request_label`.
`geodesicMetersPerSecond`	`number` אם הערך של `useGeodesicDistances` הוא True, יש להגדיר את השדה הזה ומגדיר את המהירות שחלה על חישוב זמני נסיעה. הערך שלו חייב להיות לפחות 1.0 מטר לשנייה.
`maxValidationErrors`	`integer` מקצר את מספר שגיאות האימות שהוחזרו. השגיאות האלה מצורפות בדרך כלל למטען ייעודי (payload) של שגיאה INVALID_ARGUMENT כפרטי שגיאה של BadRequest (https://cloud.google.com/apis/design/errors#error_details), אלא אם resolveMode=VALIDATE_ONLY: יש לעיין בשדה `OptimizeToursResponse.validation_errors`. ברירת המחדל היא 100, והמגבלה המקסימלית היא 10,000.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של OptimizeToursResponse.

היקפי הרשאה

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

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

הרשאות IAM

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

routeoptimization.locations.use

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

Method: projects.locations.optimizeTours קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.