ShipmentModel を含む OptimizeToursRequest を送信し、ShipmentRoute を含む OptimizeToursResponse を返します。これは、全体的な費用を最小限に抑えるために車両が実行するルートのセットです。
ShipmentModel モデルは、主に実行する必要がある Shipment と、Shipment の輸送に使用できる Vehicle で構成されます。ShipmentRoute は Shipment を Vehicle に割り当てます。具体的には、各車両に一連の Visit を割り当てます。ここで、Visit は VisitRequest に対応します。これは、Shipment の集荷または配達です。
目標は、ShipmentModel で定義された多くのコンポーネントを含む総費用を最小限に抑える Vehicle への ShipmentRoute の割り当てを提供することです。
HTTP リクエスト
POST https://routeoptimization.googleapis.com/v1/{parent=projects/*/locations/*}:optimizeTours
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
| パラメータ | |
|---|---|
parent |
必須。呼び出しを行うターゲット プロジェクトまたはロケーション。 形式:
リージョン |
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
| JSON 表現 |
|---|
{ "timeout": string, "model": { object ( |
| フィールド | |
|---|---|
timeout |
このタイムアウトが設定されている場合、サーバーは、タイムアウト期間が経過するか、同期リクエストのサーバー期限に達するかのいずれか早い方の前にレスポンスを返します。 非同期リクエストの場合、サーバーはタイムアウトが経過する前に(可能であれば)ソリューションを生成します。 |
model |
解決する配送モデル。 |
solvingMode |
デフォルトでは、解決モードは |
searchMode |
リクエストの解決に使用された検索モード。 |
injectedFirstSolutionRoutes[] |
最適化アルゴリズムをガイドして、以前の解に類似した最初の解を見つけます。 モデルは、最初のソリューションが構築されるときに制約されます。ルートで実行されなかった配送は、最初のソリューションでは暗黙的にスキップされますが、後続のソリューションで実行される可能性があります。 このソリューションは、次の基本的な有効性の前提条件を満たす必要があります。
挿入されたソリューションが実行可能でない場合、検証エラーが返されるとは限りません。代わりに、実行不可能であることを示すエラーが返されることがあります。 |
injectedSolutionConstraint |
最適化アルゴリズムを制約して、以前のソリューションに類似した最終的なソリューションを見つけます。たとえば、すでに完了しているルートの一部や、完了する予定だが変更してはならないルートの一部を固定するために使用できます。 挿入されたソリューションが実行可能でない場合、検証エラーが返されるとは限りません。代わりに、実行不可能であることを示すエラーが返されることがあります。 |
refreshDetailsRoutes[] |
空でない場合、指定されたルートは、基になる訪問シーケンスや移動時間を変更せずに更新されます。更新されるのは、その他の詳細のみです。これはモデルを解くものではありません。 2020 年 11 月現在、このフィールドは空でないルートのポリラインのみを対象とし、 渡されたルートの このフィールドは、
|
interpretInjectedSolutionsUsingLabels |
true の場合:
この解釈は、 true の場合、次のカテゴリのラベルは、そのカテゴリに 1 回だけ表示される必要があります。
挿入されたソリューションの 挿入されたソリューションからルート訪問またはルート全体を削除すると、暗黙的な制約に影響する可能性があります。これにより、ソリューションの変更、検証エラー、または実行不能につながる可能性があります。 注: 呼び出し元は、各 |
considerRoadTraffic |
|
populatePolylines |
true の場合、レスポンス |
populateTransitionPolylines |
true の場合、ポリラインとルートトークンがレスポンス |
allowLargeDeadlineDespiteInterruptionRisk |
これを設定すると、リクエストの期限(https://grpc.io/blog/deadlines を参照)を最大 60 分に設定できます。それ以外の場合、最大期限は 30 分です。長時間実行されるリクエストは、中断のリスクが大幅に高くなります(ただし、それでも小さいリスクです)。 |
useGeodesicDistances |
true の場合、移動距離は Google マップの距離ではなく測地線距離を使用して計算され、移動時間は |
label |
このリクエストを識別するために使用できるラベル。 |
geodesicMetersPerSecond |
|
maxValidationErrors |
返される検証エラーの数を切り捨てます。これらのエラーは通常、BadRequest エラーの詳細(https://cloud.google.com/apis/design/errors#error_details))として INVALID_ARGUMENT エラー ペイロードに添付されます。ただし、solvingMode=VALIDATE_ONLY の場合は除きます。 |
レスポンスの本文
成功した場合、レスポンスの本文には OptimizeToursResponse のインスタンスが含まれます。
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/cloud-platform
IAM 権限
parent リソースに対する次の IAM 権限が必要です。
routeoptimization.locations.use
詳細については、IAM のドキュメントをご覧ください。