Method: projects.locations.optimizeTours

Wysyła OptimizeToursRequest zawierający ShipmentModel i zwraca OptimizeToursResponse zawierający ShipmentRoute, czyli zestaw tras, które mają wykonać pojazdy minimalizujące całkowity koszt.

Model ShipmentModel składa się głównie z Shipment, które trzeba wykonać, oraz z Vehicle, które można wykorzystać do transportu Shipment. Elementy typu ShipmentRoute przypiszą elementy Shipment do elementów Vehicle. W szczególności przypisują do każdego pojazdu serię Visit, gdzie Visit odpowiada VisitRequest, czyli odbiór lub dostawę dla Shipment.

Celem jest przypisanie zasobów typu ShipmentRoute do komponentów typu Vehicle, co minimalizuje całkowity koszt, gdy koszt ma wiele komponentów zdefiniowanych w tabeli ShipmentModel.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagane. Wybierz projekt lub lokalizację, do których chcesz zadzwonić.

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

Jeśli nie określisz lokalizacji, region zostanie wybrany automatycznie.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis 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
}
Pola
timeout

string (Duration format)

Jeśli ten czas oczekiwania jest ustawiony, serwer zwraca odpowiedź, zanim upłynie czas oczekiwania lub termin serwera dla żądań synchronicznych, w zależności od tego, co nastąpi wcześniej.

W przypadku żądań asynchronicznych serwer wygeneruje rozwiązanie (jeśli będzie to możliwe) przed upływem czasu oczekiwania.

Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku i kończący się „s”. Przykład: "3.5s".
model

object (ShipmentModel)

Model dostawy do rozwiązania.
solvingMode

enum (SolvingMode)

Domyślnie ustawiony jest tryb zadań DEFAULT_SOLVE (0).
searchMode

enum (SearchMode)

Tryb wyszukiwania użyty do rozwiązania żądania.
injectedFirstSolutionRoutes[]

object (ShipmentRoute)

Pomaganie algorytmu optymalizacji w znalezieniu pierwszego rozwiązania podobnego do poprzedniego.

Model jest ograniczony podczas tworzenia pierwszego rozwiązania. W pierwszym rozwiązaniu wszystkie przesyłki, które nie zostały zrealizowane na trasie, są domyślnie pomijane, ale mogą być realizowane w kolejnych rozwiązaniach.

Rozwiązanie musi spełniać pewne podstawowe założenia dotyczące poprawności:

  • w przypadku wszystkich tras vehicleIndex musi należeć do zakresu i nie może być duplikatem.
  • w przypadku wszystkich wizyt wartości shipmentIndex i visitRequestIndex muszą mieścić się w zakresie.
  • dostawa może być wskazana tylko na jednej trasie.
  • odbiór przesyłki z odbiorem i dostawą musi zostać wykonany przed dostawą.
  • nie można wykonać więcej niż 1 alternatywy odbioru lub dostawy przesyłki;
  • na wszystkich trasach czasy przejazdu wydłużają się (tzn. vehicleStartTime <= visits[0].start_time <= visits[1].start_time ... <= vehicleEndTime).
  • wysyłka może zostać zrealizowana wyłącznie za pomocą dozwolonego pojazdu. Pojazd jest dozwolony, jeśli pole Shipment.allowed_vehicle_indices jest puste lub jego vehicleIndex jest uwzględniony w: Shipment.allowed_vehicle_indices.

Jeśli wstrzyknięty kod nie jest wykonalny, niekoniecznie zwracany jest błąd weryfikacji. Zamiast tego może zostać zwrócony błąd wskazujący na brak możliwości wykonania.
injectedSolutionConstraint

object (InjectedSolutionConstraint)

Ogranicz algorytm optymalizacji, aby znaleźć ostateczne rozwiązanie podobne do poprzedniego. Można go na przykład użyć do zamrożenia części tras, które zostały już ukończone lub mają zostać ukończone, ale nie mogą być modyfikowane.

Jeśli wstrzyknięte rozwiązanie nie jest możliwe, błąd weryfikacji nie musi być zwracany i zamiast niego może pojawić się błąd wskazujący na niewykonalność.
refreshDetailsRoutes[]

object (ShipmentRoute)

Jeśli nie jest pusty, dane trasy zostaną odświeżone bez zmiany ich sekwencji wizyt lub czasu podróży: zostaną zaktualizowane tylko inne szczegóły. Nie rozwiązuje to problemów z modelem.

Od listopada 2020 r. wypełnia to tylko linie wielokątów na niepustych trasach i wymaga, aby parametr populatePolylines miał wartość Prawda.

Pola routePolyline w przekazanych trasach mogą być niezgodne z trasą transitions.

Nie można używać tego pola razem z polem injectedFirstSolutionRoutes ani injectedSolutionConstraint.

Shipment.ignore i Vehicle.ignore nie mają wpływu na sposób działania. Linie łamane są nadal wypełniane dla wszystkich wizyt na wszystkich niepustych trasach niezależnie od tego, czy powiązane dostawy lub pojazdy są ignorowane.
interpretInjectedSolutionsUsingLabels

boolean

Jeśli to prawda:

Ta interpretacja ma zastosowanie do pól injectedFirstSolutionRoutes, injectedSolutionConstraint i refreshDetailsRoutes. Można go użyć, gdy indeksy przesyłek lub pojazdów w prośbie uległy zmianie od czasu utworzenia rozwiązania, np. dlatego, że przesyłki lub pojazdy zostały usunięte z prośby lub dodane do niej.

Jeśli ma wartość true, etykiety w tych kategoriach mogą się pojawiać maksymalnie raz w danej kategorii:

Jeśli wartość vehicleLabel we wstrzykiwanym roztworze nie odpowiada pojazdowi, którego dotyczy żądanie, odpowiednia trasa jest usuwana z rozwiązania razem z wizytami. Jeśli shipmentLabel w wstrzykniętym rozwiązaniu nie odpowiada wysyłce żądania, odpowiednia wizyta zostaje usunięta z rozwiązania. Jeśli SkippedShipment.label w roztworze wstrzykniętym do rozwiązania nie odpowiada wysyłce żądania, SkippedShipment zostaje usunięty z roztworu.

Usunięcie wizyt na trasie lub całych tras z wstrzykiwanego rozwiązania może mieć wpływ na domniemane ograniczenia, co może prowadzić do zmiany rozwiązania, błędów weryfikacji lub niewykonalności.

UWAGA: rozmówca musi upewnić się, że każde Vehicle.label (odp. Shipment.label) jednoznacznie identyfikuje pojazd (odpowiedź do przesyłki) użyty w 2 odpowiednich żądaniach: wcześniejsze żądanie, które spowodowało wygenerowanie kodu OptimizeToursResponse użytego we wstrzykiwanym roztworze, oraz bieżące żądanie, które obejmuje wstrzykiwany roztwór. Opisane powyżej kontrole unikalnych treści nie wystarczają do spełnienia tego wymagania.
considerRoadTraffic

boolean

Warto uwzględnić prognozę ruchu podczas obliczania pól ShipmentRoute Transition.travel_duration, Visit.start_time i vehicleEndTime, ustawiania pola ShipmentRoute.has_traffic_infeasibilities oraz obliczania pola OptimizeToursResponse.total_cost.
populatePolylines

boolean

Jeśli ma wartość Prawda, w odpowiedzi ShipmentRoute zostaną wypełnione ścieżki poliliniowe.
populateTransitionPolylines

boolean

Jeśli ma wartość true (prawda), linie łamane i tokeny trasy zostaną wypełnione w odpowiedzi ShipmentRoute.transitions.
allowLargeDeadlineDespiteInterruptionRisk

boolean

Jeśli ta wartość jest ustawiona, termin żądania (patrz https://grpc.io/blog/deadlines) może wynosić maksymalnie 60 minut. W przeciwnym razie maksymalny termin to tylko 30 minut. Pamiętaj, że w przypadku długotrwałych żądań występuje znacznie większe (choć nadal niewielkie) ryzyko przerwania.
useGeodesicDistances

boolean

Jeśli wartość to prawda, odległości będą obliczane na podstawie odległości geodezyjnych zamiast z Map Google, a czasy podróży będą obliczane na podstawie odległości geodezyjnych z prędkością określoną przez geodesicMetersPerSecond.
label

string

Etykieta, która może służyć do identyfikowania tego żądania, zgłoszonego w formularzu OptimizeToursResponse.request_label.
geodesicMetersPerSecond

number

Jeśli useGeodesicDistances ma wartość true (prawda), to pole musi być skonfigurowane i określa prędkość używaną do obliczania czasu podróży. Jego wartość musi wynosić co najmniej 1,0 m/s.
maxValidationErrors

integer

Obcina zwracaną liczbę błędów weryfikacji. Te błędy są zwykle dołączane do ładunku błędu INVALID_ARGUMENT jako szczegóły błędu BadRequest (https://cloud.google.com/apis/design/errors#error_details), chyba że parametr solvingMode=VALIDATE_ONLY: patrz pole OptimizeToursResponse.validation_errors. Domyślna wartość to 100,a limit jest ograniczony do 10 000.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu OptimizeToursResponse.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Uprawnienia

Wymaga tych uprawnień IAM do zasobu parent:

  • routeoptimization.locations.use

Więcej informacji znajdziesz w dokumentacji uprawnień.