Method: projects.locations.optimizeToursLongRunning

これは、大きなタイムアウト値での最適化用に設計された locations.optimizeTours メソッドのバリエーションです。数分以上かかる最適化には、locations.optimizeTours メソッドよりも優先して使用する必要があります。

返される long-running operation（LRO）の名前は <parent>/operations/<operation_id> 形式で、計算の進行状況を追跡するために使用できます。metadata フィールドの型は OptimizeToursLongRunningMetadata です。成功した場合、response フィールドの型は OptimizeToursResponse です。

試験運用版: 詳しくは、https://developers.google.com/maps/tt/route-optimization/experimental/otlr/make-request をご覧ください。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。呼び出しを行うターゲット プロジェクトまたはロケーション。

形式:

  • projects/{project-id}
  • projects/{project-id}/locations/{location-id}

ロケーションが指定されていない場合、リージョンが自動的に選択されます。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

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 (Duration format)

このタイムアウトが設定されている場合、サーバーはタイムアウト期間が経過する前、または同期リクエストのサーバーの期限に達する前のいずれか早いほうでレスポンスを返します。

非同期リクエストの場合、サーバーはタイムアウトが経過する前に解決策を生成します（可能な場合）。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
model

object (ShipmentModel)

解決する配送モデル。
solvingMode

enum (SolvingMode)

デフォルトでは、解決モードは DEFAULT_SOLVE（0）です。
searchMode

enum (SearchMode)

リクエストの解決に使用された検索モード。
injectedFirstSolutionRoutes[]

object (ShipmentRoute)

最適化アルゴリズムが以前のソリューションに類似した最初のソリューションを見つけるようにガイドします。

モデルは、最初のソリューションが構築されるときに制約されます。ルートで実行されなかった配送は、最初のソリューションでは暗黙的にスキップされますが、後続のソリューションでは実行される可能性があります。

このソリューションは、基本的な有効性の仮定を満たしている必要があります。

  • すべてのルートで、vehicleIndex は範囲内で重複しないようにする必要があります。
  • すべての訪問について、shipmentIndex と visitRequestIndex は範囲内である必要があります。
  • 1 つの配送は 1 つのルートでのみ参照できます。
  • 集荷配送の荷物の集荷は、配送の前に行う必要があります。
  • 1 回の配送につき、集荷または配送の代替手段を 1 つのみ実施できます。
  • すべてのルートで所要時間が増加している（つまり、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)

空でない場合、指定されたルートが更新されます。基盤となる訪問順序や移動時間は変更されず、その他の詳細のみが更新されます。これはモデルを解決しません。

2020 年 11 月の時点では、この関数は空でないルートのポリラインのみを入力し、populatePolylines が true である必要があります。

渡されたルートの routePolyline フィールドがルート transitions と一致しないことがあります。

このフィールドは、injectedFirstSolutionRoutes または injectedSolutionConstraint と同時に使用できません。

Shipment.ignore と Vehicle.ignore は動作に影響しません。関連する配送や車両が無視されるかどうかに関係なく、空でないすべてのルートのすべての訪問の間にポリラインが入力されます。
interpretInjectedSolutionsUsingLabels

boolean

該当する場合:

この解釈は、injectedFirstSolutionRoutes、injectedSolutionConstraint、refreshDetailsRoutes フィールドに適用されます。これは、リクエスト内の配送または車両のインデックスがソリューションの作成時から変更された場合に使用できます。たとえば、リクエストから配送または車両が削除されたり、リクエストに追加されたりした場合です。

true の場合、次のカテゴリのラベルは、カテゴリ内で 1 回だけ表示されます。

挿入されたソリューションの vehicleLabel がリクエスト車両に対応していない場合、対応するルートとその訪問はソリューションから削除されます。挿入されたソリューションの shipmentLabel がリクエストされた配送に対応していない場合、対応する訪問はソリューションから削除されます。挿入されたソリューションの SkippedShipment.label がリクエストの発送に対応していない場合、SkippedShipment はソリューションから削除されます。

挿入されたソリューションからルートの訪問やルート全体を削除すると、暗黙的な制約に影響する可能性があり、ソリューションの変更、検証エラー、実行不能につながる可能性があります。

注: 呼び出し元は、各 Vehicle.label（または Shipment.label）は、2 つの関連するリクエスト（挿入されたソリューションで使用される 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

返される検証エラーの数を切り捨てます。これらのエラーは通常、solvingMode=VALIDATE_ONLY でない限り、BadRequest エラーの詳細（https://cloud.google.com/apis/design/errors#error_details)として INVALID_ARGUMENT エラー ペイロードに付加されます。OptimizeToursResponse.validation_errors フィールドをご覧ください。デフォルトは 100 で、上限は 10,000 です。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

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

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • routeoptimization.operations.create

詳細については、IAM のドキュメントをご覧ください。