Method: projects.optimizeTours

• Solicitud HTTP
• Parámetros de ruta de acceso
• Cuerpo de la solicitud
  • Representación JSON
• Cuerpo de la respuesta
• Alcances de la autorización

Envía un OptimizeToursRequest con un ShipmentModel y muestra un OptimizeToursResponse con ShipmentRoute, que son un conjunto de rutas que realizarán los vehículos y que minimizan el costo general.

Un modelo ShipmentModel consta principalmente de Shipment que se deben realizar y Vehicle que se pueden usar para transportar los Shipment. Los ShipmentRoute asignan Shipment a Vehicle. Más concretamente, asigna una serie de elementos Visit a cada vehículo, en los que un Visit corresponde a un VisitRequest, que corresponde al retiro o la entrega de un Shipment.

El objetivo es proporcionar una asignación de ShipmentRoute a Vehicle que minimice el costo total en el que el costo tiene muchos componentes definidos en ShipmentModel.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent	string Obligatorio. Proyecto de destino o ubicación para hacer una llamada. Formato: * projects/{project-id} * projects/{project-id}/locations/{location-id} Si no se especifica una ubicación, se elegirá una automáticamente.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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 }

Campos
timeout	string (Duration format) Si se establece este tiempo de espera, el servidor mostrará una respuesta antes de que finalice el tiempo de espera o de que se alcance el plazo del servidor para las solicitudes síncronas, lo que ocurra primero. Para las solicitudes asíncronas, el servidor generará una solución (si es posible) antes de que haya transcurrido el tiempo de espera. Una duración en segundos con hasta nueve dígitos decimales que terminen en "s". Ejemplo: "3.5s".
model	object (ShipmentModel) Modelo de envío a resolver.
solvingMode	enum (SolvingMode) De forma predeterminada, el modo de resolución es DEFAULT_SOLVE (0).
searchMode	enum (SearchMode) Modo de búsqueda que se usa para resolver la solicitud.
injectedFirstSolutionRoutes[]	object (ShipmentRoute) Guiar al algoritmo de optimización para que encuentre una primera solución similar a una anterior El modelo se ve limitado cuando se compila la primera solución. Cualquier envío que no se realice en una ruta se omitirá implícitamente en la primera solución, pero se podrán realizar en soluciones sucesivas. La solución debe cumplir con algunas suposiciones básicas de validez: para todas las rutas, vehicleIndex debe estar dentro del rango y no estar duplicado. para todas las visitas, shipmentIndex y visitRequestIndex deben estar dentro del rango. solo se puede hacer referencia a un envío en una ruta. el retiro de un envío para retiro debe realizarse antes de la entrega. no se puede realizar más de una alternativa de retiro o entrega a un envío. de todas las rutas, los horarios están aumentando (p.ej., vehicleStartTime <= visits[0].start_time <= visits[1].start_time ... <= vehicleEndTime). un envío solo puede realizarse en un vehículo permitido. Se permite un vehículo si Shipment.allowed_vehicle_indices está vacío o su vehicleIndex se incluye en Shipment.allowed_vehicle_indices. Si la solución inyectada no es factible, no necesariamente se devuelve un error de validación y, en su lugar, se puede mostrar un error que indica inviabilidad.
injectedSolutionConstraint	object (InjectedSolutionConstraint) Restringir el algoritmo de optimización para encontrar una solución final que sea similar a una solución anterior. Por ejemplo, se puede usar para inmovilizar partes de rutas que ya se completaron o que se deben completar, pero que no se deben modificar. Si la solución inyectada no es factible, no necesariamente se devuelve un error de validación y, en su lugar, se puede mostrar un error que indica inviabilidad.
refreshDetailsRoutes[]	object (ShipmentRoute) Si este campo no está vacío, se actualizarán las rutas proporcionadas, sin modificar su secuencia subyacente de visitas o tiempos de viaje: solo se actualizarán otros detalles. Esto no resuelve el modelo. A partir de 2020/11, esto solo propaga las polilíneas de rutas no vacías y requiere que populatePolylines sea verdadero. Es posible que los campos routePolyline de las rutas pasadas no coincidan con la ruta transitions. Este campo no se debe usar junto con injectedFirstSolutionRoutes ni injectedSolutionConstraint. Shipment.ignore y Vehicle.ignore no afectan el comportamiento. Las polilíneas se siguen propagando entre todas las visitas de todas las rutas que no están vacías, independientemente de si se ignoran los envíos o vehículos relacionados.
interpretInjectedSolutionsUsingLabels	boolean Si es verdadero: Usa ShipmentRoute.vehicle_label en lugar de vehicleIndex para hacer coincidir las rutas en una solución insertada con los vehículos de la solicitud. Se reutiliza la asignación del ShipmentRoute.vehicle_index original al ShipmentRoute.vehicle_index nuevo para actualizar ConstraintRelaxation.vehicle_indices si no está vacío, pero la asignación no debe ser ambigua (es decir, varios ShipmentRoute no deben compartir el mismo vehicleIndex original). usa ShipmentRoute.Visit.shipment_label en lugar de shipmentIndex para relacionar las visitas en una solución incorporada con los envíos de la solicitud. usa SkippedShipment.label en lugar de SkippedShipment.index para hacer coincidir los envíos omitidos en la solución insertada con los envíos solicitados. Esta interpretación se aplica a los campos injectedFirstSolutionRoutes, injectedSolutionConstraint y refreshDetailsRoutes. Se puede usar cuando los índices de envío o vehículos en la solicitud cambiaron desde que se creó la solución, quizás porque se quitaron envíos o vehículos de la solicitud o se agregaron a ella. Si es verdadero, las etiquetas de las siguientes categorías deben aparecer como máximo una vez en su categoría: Vehicle.label en la solicitud Shipment.label en la solicitud ShipmentRoute.vehicle_label en la solución inyectada SkippedShipment.label y ShipmentRoute.Visit.shipment_label en la solución inyectada (excepto en los pares de visitas de retiro/entrega, cuyo shipmentLabel debe aparecer dos veces) Si un vehicleLabel en la solución inyectada no corresponde a un vehículo solicitado, la ruta correspondiente se quita de la solución junto con sus visitas. Si un shipmentLabel en la solución inyectada no corresponde al envío de una solicitud, se quita la visita correspondiente de la solución. Si un SkippedShipment.label en la solución insertada no corresponde al envío de una solicitud, se quita el SkippedShipment de la solución. Quitar las visitas a rutas o rutas completas de una solución inyectada puede afectar las restricciones implícitas, lo que puede provocar cambios en la solución, errores de validación o inviabilidad. NOTA: El llamador debe asegurarse de que cada Vehicle.label (resp. Shipment.label) identifica de forma única una entidad de vehículo (envío de respuesta) utilizada en las dos solicitudes relevantes: la solicitud anterior que produjo el OptimizeToursResponse utilizado en la solución inyectada y la solicitud actual que incluye la solución inyectada. Las verificaciones de unicidad descritas anteriormente no son suficientes para garantizar este requisito.
considerRoadTraffic	boolean Considera la estimación del tráfico para calcular los campos ShipmentRoute Transition.travel_duration, Visit.start_time y vehicleEndTime al configurar el campo ShipmentRoute.has_traffic_infeasibilities y al calcular el campo OptimizeToursResponse.total_cost.
populatePolylines	boolean Si es verdadero, las polilíneas se propagarán en ShipmentRoute de respuesta.
populateTransitionPolylines	boolean Si es verdadero, las polilíneas se propagarán en la respuesta ShipmentRoute.transitions.
allowLargeDeadlineDespiteInterruptionRisk	boolean Si se configura, la solicitud puede tener un plazo (consulta https://grpc.io/blog/deadlines) de hasta 60 minutos. De lo contrario, el plazo máximo es solo de 30 minutos. Ten en cuenta que las solicitudes de larga duración tienen un riesgo de interrupción significativamente mayor (pero aún pequeño).
useGeodesicDistances	boolean Si es verdadero, las distancias de viaje se calcularán con distancias geodésicas en lugar de distancias de Google Maps, y los tiempos de viaje se calcularán usando distancias geodésicas con una velocidad definida por geodesicMetersPerSecond.
label	string Etiqueta que puede usarse para identificar esta solicitud, informada en OptimizeToursResponse.request_label.
geodesicMetersPerSecond	number Cuando useGeodesicDistances es verdadero, se debe configurar este campo y se define la velocidad que se aplica para calcular los tiempos de viaje. Su valor debe ser de al menos 1 metros/segundo.
maxValidationErrors	integer Trunca la cantidad de errores de validación que se muestran. Por lo general, estos errores se adjuntan a una carga útil de error INVALID_ formato de error como un detalle de error de BadRequest (https://cloud.google.com/apis/design/errors#error_details), a menos que resolveMode=VALIDATE_ONLY: consulte el campo OptimizeToursResponse.validation_errors. El valor predeterminado es 100 y el límite es 10,000.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de OptimizeToursResponse.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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