Se usó la API de Cloud Translation para traducir esta página.

Method: projects.locations.optimizeTours

Solicitud HTTP
Parámetros de ruta de acceso
Cuerpo de la solicitud
- Representación JSON
Cuerpo de la respuesta
Permisos de autorización
Permisos de IAM

Envía un OptimizeToursRequest que contiene un ShipmentModel y muestra un OptimizeToursResponse que contiene ShipmentRoute, que son un conjunto de rutas que deben realizar los vehículos para minimizar 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 específicamente, asignan una serie de Visit a cada vehículo, donde un Visit corresponde a un VisitRequest, que es una recolección o entrega para 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/*/locations/*}:optimizeTours

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

Parámetros de ruta de acceso

Parámetros

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

parent

string

Obligatorio. Proyecto o ubicación de destino para realizar una llamada.

Formato: * projects/{project-id} * projects/{project-id}/locations/{location-id}

Si no se especifica una ubicación, se elegirá una región automáticamente.

Cuerpo de la solicitud

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

Representación JSON

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 }

{
  "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 muestra una respuesta antes de que transcurra el período de tiempo de espera o se alcance la fecha límite del servidor para las solicitudes síncronas, lo que ocurra primero. En el caso de las solicitudes asíncronas, el servidor generará una solución (si es posible) antes de que transcurra el tiempo de espera. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “`s`”. Ejemplo: `"3.5s"`.
`model`	`object (ShipmentModel)` Modelo de envío para resolver.
`solvingMode`	`enum (SolvingMode)` De forma predeterminada, el modo de resolución es `DEFAULT_SOLVE` (0).
`searchMode`	`enum (SearchMode)` Es el modo de búsqueda que se usa para resolver la solicitud.
`injectedFirstSolutionRoutes[]`	`object (ShipmentRoute)` Guía al algoritmo de optimización para que encuentre una primera solución que sea similar a una solución anterior. El modelo se ve limitado cuando se compila la primera solución. Los envíos que no se realizan en una ruta se omiten de forma implícita en la primera solución, pero se pueden realizar en soluciones sucesivas. La solución debe satisfacer algunas suposiciones básicas de validez: para todas las rutas, `vehicleIndex` debe estar dentro del rango y no debe duplicarse. para todas las visitas, `shipmentIndex` y `visitRequestIndex` deben estar dentro del rango. Solo se puede hacer referencia a un envío en una ruta. La recolección de un envío con recolección y entrega debe realizarse antes de la entrega. No se puede realizar más de una alternativa de retiro o entrega de un envío. para todas las rutas, los tiempos aumentan (es decir, `vehicleStartTime <= visits[0].start_time <= visits[1].start_time ... <= vehicleEndTime`). Los envíos solo se pueden realizar en vehículos permitidos. Se permite un vehículo si `Shipment.allowed_vehicle_indices` está vacío o si su `vehicleIndex` se incluye en `Shipment.allowed_vehicle_indices`. Si la solución insertada no es factible, no se muestra necesariamente un error de validación, sino que se puede mostrar un error que indica que no es factible.
`injectedSolutionConstraint`	`object (InjectedSolutionConstraint)` Limita 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 completarán, pero que no se deben modificar. Si la solución insertada no es factible, no se muestra necesariamente un error de validación, sino que se puede mostrar un error que indica que no es factible.
`refreshDetailsRoutes[]`	`object (ShipmentRoute)` Si no están vacías, se actualizarán las rutas determinadas 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 noviembre de 2020, solo se propagan los polilíneas de las rutas no vacías y se requiere que `populatePolylines` sea verdadero. Es posible que los campos `routePolyline` de las rutas pasadas no sean coherentes con la ruta `transitions`. Este campo no se debe usar junto con `injectedFirstSolutionRoutes` o `injectedSolutionConstraint`. `Shipment.ignore` y `Vehicle.ignore` no tienen efecto en el comportamiento. Las polilíneas se siguen propagando entre todas las visitas en todas las rutas que no están vacías, independientemente de si se ignoran los envíos o los vehículos relacionados.
`interpretInjectedSolutionsUsingLabels`	`boolean` Si es verdadero, haz lo siguiente: Usa `ShipmentRoute.vehicle_label` en lugar de `vehicleIndex` para hacer coincidir las rutas de una solución insertada con los vehículos de la solicitud. Vuelve a usar la asignación de `ShipmentRoute.vehicle_index` original a `ShipmentRoute.vehicle_index` nuevo para actualizar `ConstraintRelaxation.vehicle_indices` si no está vacía, pero la asignación debe ser inequívoca (es decir, varios `ShipmentRoute` no deben compartir el mismo `vehicleIndex` original). usa `ShipmentRoute.Visit.shipment_label` en lugar de `shipmentIndex` para hacer coincidir las visitas en una solución insertada con los envíos en 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 de solicitud. Esta interpretación se aplica a los campos `injectedFirstSolutionRoutes`, `injectedSolutionConstraint` y `refreshDetailsRoutes`. Se puede usar cuando los índices de envíos o vehículos de la solicitud cambiaron desde que se creó la solución, quizás porque se quitaron o agregaron envíos o vehículos a la solicitud. 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 insertada `SkippedShipment.label` y `ShipmentRoute.Visit.shipment_label` en la solución insertada (excepto los pares de visitas de retiro/entrega, cuyo `shipmentLabel` debe aparecer dos veces). Si un `vehicleLabel` en la solución insertada no corresponde a un vehículo de solicitud, la ruta correspondiente se quita de la solución junto con sus visitas. Si un `shipmentLabel` en la solución insertada no corresponde a un envío de solicitud, se quita la visita correspondiente de la solución. Si un `SkippedShipment.label` en la solución inyectada no corresponde a un envío de solicitud, se quita el `SkippedShipment` de la solución. Quitar visitas a rutas o rutas completas de una solución insertada puede tener un efecto en 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 exclusiva una entidad de vehículo (o envío) que se usa en las dos solicitudes relevantes: la solicitud anterior que produjo el `OptimizeToursResponse` que se usa en la solución insertada y la solicitud actual que incluye la solución insertada. Las verificaciones de unicidad que se describieron anteriormente no son suficientes para garantizar este requisito.
`considerRoadTraffic`	`boolean` Ten en cuenta la estimación de tráfico cuando calcules los campos `ShipmentRoute` `Transition.travel_duration`, `Visit.start_time` y `vehicleEndTime`; cuando configures el campo `ShipmentRoute.has_traffic_infeasibilities` y cuando calcules el campo `OptimizeToursResponse.total_cost`.
`populatePolylines`	`boolean` Si es verdadero, se propagarán los polilíneas en las `ShipmentRoute` de respuesta.
`populateTransitionPolylines`	`boolean` Si es verdadero, los polilíneas y los tokens de ruta se propagarán en la respuesta `ShipmentRoute.transitions`.
`allowLargeDeadlineDespiteInterruptionRisk`	`boolean` Si se establece, la solicitud puede tener una fecha límite (consulta https://grpc.io/blog/deadlines) de hasta 60 minutos. De lo contrario, el plazo máximo es de solo 30 minutos. Ten en cuenta que las solicitudes de larga duración tienen un riesgo de interrupción mucho 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 con distancias geodésicas con una velocidad definida por `geodesicMetersPerSecond`.
`label`	`string` Etiqueta que se puede usar para identificar esta solicitud, que se informa en `OptimizeToursResponse.request_label`.
`geodesicMetersPerSecond`	`number` Cuando `useGeodesicDistances` es verdadero, se debe configurar este campo y define la velocidad que se aplica para calcular los tiempos de viaje. Su valor debe ser de al menos 1.0 metros por 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_ARGUMENT como un detalle de error BadRequest (https://cloud.google.com/apis/design/errors#error_details), a menos que solvingMode=VALIDATE_ONLY: consulta el campo `OptimizeToursResponse.validation_errors`. El valor predeterminado es 100 y tiene un límite de 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

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

routeoptimization.locations.use

Para obtener más información, consulta la documentación de IAM.