Package google.maps.routeoptimization.v1

فهرست

بهینه‌سازی مسیر

سرویسی برای بهینه‌سازی تورهای خودرویی.

اعتبار انواع خاصی از فیلدها:

  • google.protobuf.Timestamp
    • زمان‌ها به صورت یونیکس هستند: ثانیه از تاریخ 1970-01-01T00:00:00+00:00.
    • ثانیه باید در [0, 253402300799] باشد، یعنی در [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
    • نانوها باید غیرفعال یا روی ۰ تنظیم شوند.
  • google.protobuf.Duration
    • ثانیه باید در [0, 253402300799] باشد، یعنی در [1970-01-01T00:00:00+00:00, 9999-12-31T23:59:59+00:00].
    • نانوها باید غیرفعال یا روی ۰ تنظیم شوند.
  • google.type.LatLng
    • عرض جغرافیایی باید در بازه [-90.0, 90.0] باشد.
    • طول جغرافیایی باید در محدوده [-180.0, 180.0] باشد.
    • حداقل یکی از طول و عرض جغرافیایی باید غیر صفر باشد.
تورهای بهینه سازی دسته ای

rpc BatchOptimizeTours( BatchOptimizeToursRequest ) returns ( Operation )

تورهای خودرو را برای یک یا چند پیام OptimizeToursRequest به صورت دسته‌ای بهینه می‌کند.

این روش یک عملیات طولانی مدت (LRO) است. ورودی‌های بهینه‌سازی (پیام‌های OptimizeToursRequest ) و خروجی‌ها (پیام‌های OptimizeToursResponse ) از Cloud Storage خوانده شده و در قالب مشخص شده توسط کاربر در آن نوشته می‌شوند. مانند روش OptimizeTours ، هر OptimizeToursRequest شامل یک ShipmentModel است و یک OptimizeToursResponse حاوی فیلدهای ShipmentRoute را برمی‌گرداند که مجموعه‌ای از مسیرهایی هستند که باید توسط وسایل نقلیه انجام شوند و هزینه کلی را به حداقل برسانند.

کاربر می‌تواند برای بررسی وضعیت LRO از operations.get نظرسنجی کند:

اگر فیلد done » در LRO نادرست باشد، حداقل یک درخواست هنوز در حال پردازش است. ممکن است درخواست‌های دیگر با موفقیت انجام شده باشند و نتایج آنها در فضای ذخیره‌سازی ابری موجود باشد.

اگر فیلد done مربوط به LRO برابر با true باشد، تمام درخواست‌ها پردازش شده‌اند. نتایج هر درخواستی که با موفقیت پردازش شود، در Cloud Storage قابل دسترسی خواهد بود. نتایج هر درخواستی که با شکست مواجه شود، در Cloud Storage قابل دسترسی نخواهد بود. اگر فیلد error مربوط به LRO تنظیم شده باشد، شامل خطای یکی از درخواست‌های ناموفق خواهد بود.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع parent نیاز دارد:

  • routeoptimization.operations.create

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

بهینه سازی تورها

rpc OptimizeTours( OptimizeToursRequest ) returns ( OptimizeToursResponse )

یک OptimizeToursRequest حاوی یک ShipmentModel ارسال می‌کند و یک OptimizeToursResponse حاوی ShipmentRoute ها برمی‌گرداند، که مجموعه‌ای از مسیرها هستند که باید توسط وسایل نقلیه انجام شوند و هزینه کلی را به حداقل برسانند.

یک مدل ShipmentModel عمدتاً شامل Shipment هایی است که باید انجام شوند و Vehicle هایی که می‌توانند برای حمل Shipment ها استفاده شوند. ShipmentRoute ها، Shipment ها را به Vehicle ها اختصاص می‌دهند. به طور خاص‌تر، آنها مجموعه‌ای از Visit ها را به هر وسیله نقلیه اختصاص می‌دهند، که در آن Visit معادل VisitRequest است که به معنای دریافت یا تحویل Shipment است.

هدف، ارائه تخصیصی از ShipmentRoute ها به Vehicle ها است که در مواردی که cost دارای اجزای زیادی است که در ShipmentModel تعریف شده‌اند، هزینه کل را به حداقل برساند.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع parent نیاز دارد:

  • routeoptimization.locations.use

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

OptimizeToursLongRunning

rpc OptimizeToursLongRunning( OptimizeToursRequest ) returns ( Operation )

این نوعی از روش OptimizeTours است که برای بهینه‌سازی‌هایی با مقادیر timeout بزرگ طراحی شده است. برای بهینه‌سازی‌هایی که بیش از چند دقیقه طول می‌کشند، باید نسبت به روش 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 مراجعه کنید.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع parent نیاز دارد:

  • routeoptimization.operations.create

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

OptimizeToursUri

rpc OptimizeToursUri( OptimizeToursUriRequest ) returns ( Operation )

این نوعی از روش OptimizeToursLongRunning است که برای بهینه‌سازی‌هایی با مقادیر timeout بزرگ و اندازه‌های ورودی/خروجی بزرگ طراحی شده است.

کلاینت، URI مربوط به OptimizeToursRequest ذخیره شده در Google Cloud Storage را مشخص می‌کند و سرور، OptimizeToursResponse را در یک URI مربوط به Google Cloud Storage که توسط کلاینت تعیین شده است، می‌نویسد.

این روش باید نسبت به روش OptimizeTours برای بهینه‌سازی‌هایی که بیش از چند دقیقه طول می‌کشند و اندازه‌های ورودی/خروجی بزرگتر از ۸ مگابایت هستند، ترجیح داده شود، اگرچه می‌توان از آن برای بهینه‌سازی‌های کوتاه‌تر و کوچک‌تر نیز استفاده کرد.

long-running operation (LRO) که برگردانده می‌شود، نامی با فرمت <parent>/operations/<operation_id> خواهد داشت و می‌تواند برای ردیابی پیشرفت محاسبه مورد استفاده قرار گیرد. نوع فیلد metadata OptimizeToursLongRunningMetadata است. نوع فیلد response ، در صورت موفقیت، OptimizeToursUriResponse است.

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/tt/route-optimization/experimental/otlr/make-request مراجعه کنید.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع parent نیاز دارد:

  • routeoptimization.operations.create

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

معیارهای تجمیع‌شده

معیارهای تجمیع‌شده برای ShipmentRoute (به‌عنوان مثال OptimizeToursResponse روی تمام عناصر Transition و/یا Visit (به‌عنوان مثال ShipmentRoute )

فیلدها
performed_shipment_count

int32

تعداد ارسال‌های انجام شده. توجه داشته باشید که یک جفت دریافت و تحویل فقط یک بار حساب می‌شود.

travel_duration

Duration

کل مدت زمان سفر برای یک مسیر یا یک راه حل.

wait_duration

Duration

کل مدت زمان انتظار برای یک مسیر یا یک راه حل.

delay_duration

Duration

کل مدت تأخیر برای یک مسیر یا یک راه‌حل.

break_duration

Duration

کل مدت زمان استراحت برای یک مسیر یا یک راه حل.

visit_duration

Duration

کل مدت زمان بازدید برای یک مسیر یا یک راه حل.

total_duration

Duration

کل مدت زمان باید برابر با مجموع تمام مدت زمان‌های بالا باشد. برای مسیرها، این مقدار همچنین معادل است با:

[ShipmentRoute.vehicle_end_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_end_time] - [ShipmentRoute.vehicle_start_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_start_time]
travel_distance_meters

double

کل مسافت طی شده برای یک مسیر یا یک راه حل.

max_loads

map<string, VehicleLoad >

حداکثر بار حاصل شده در کل مسیر (به جای راه حل)، برای هر یک از مقادیر موجود در این مسیر (به جای راه حل)، که به عنوان حداکثر بار در تمام Transition.vehicle_loads (به جای ShipmentRoute.metrics.max_loads ) محاسبه می‌شود.

performed_mandatory_shipment_count

int32

تعداد محموله‌های اجباری انجام شده.

تجربی: رفتار یا وجود این میدان ممکن است در آینده تغییر کند.

performed_shipment_penalty_cost_sum

double

مجموع Shipment.penalty_cost مربوط به محموله‌های انجام شده.

تجربی: رفتار یا وجود این میدان ممکن است در آینده تغییر کند.

فراداده‌های BatchOptimizeTours

این نوع هیچ فیلدی ندارد.

فراداده‌های عملیاتی برای فراخوانی‌های BatchOptimizeToursRequest .

درخواست دسته‌ای بهینه‌سازی تورها

درخواست برای بهینه‌سازی دسته‌ای تورها به عنوان یک عملیات ناهمزمان. هر فایل ورودی باید شامل یک OptimizeToursRequest و هر فایل خروجی شامل یک OptimizeToursResponse باشد. این درخواست شامل اطلاعاتی برای خواندن/نوشتن و تجزیه فایل‌ها است. همه فایل‌های ورودی و خروجی باید تحت یک پروژه واحد باشند.

فیلدها
parent

string

الزامی. پروژه و مکان مورد نظر برای برقراری تماس.

قالب:

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

اگر هیچ مکانی مشخص نشده باشد، یک منطقه به طور خودکار انتخاب می‌شود.

model_configs[]

AsyncModelConfig

الزامی. اطلاعات ورودی/خروجی برای هر مدل خرید، مانند مسیر فایل‌ها و فرمت‌های داده.

پیکربندی AsyncModel

اطلاعات برای حل یک مدل بهینه‌سازی به صورت غیرهمزمان.

فیلدها
display_name

string

اختیاری. نام مدل تعریف‌شده توسط کاربر، می‌تواند به عنوان نام مستعار توسط کاربران برای پیگیری مدل‌ها استفاده شود.

input_config

InputConfig

الزامی. اطلاعات مربوط به مدل ورودی.

output_config

OutputConfig

الزامی. اطلاعات محل خروجی مورد نظر.

پاسخ دسته‌ای بهینه‌سازی تورها

این نوع هیچ فیلدی ندارد.

پاسخ به درخواست BatchOptimizeToursRequest . این درخواست پس از تکمیل عملیات در Long Running Operation بازگردانده می‌شود.

شکستن قانون

قوانینی برای ایجاد زمان استراحت برای وسیله نقلیه (مثلاً زمان ناهار). استراحت یک دوره زمانی پیوسته است که طی آن وسیله نقلیه در موقعیت فعلی خود بیکار می‌ماند و نمی‌تواند هیچ بازدیدی انجام دهد. استراحت ممکن است رخ دهد:

  • در طول سفر بین دو بازدید (که شامل زمان درست قبل یا درست بعد از یک بازدید می‌شود، اما نه در وسط یک بازدید)، که در این صورت زمان حمل و نقل مربوطه بین بازدیدها را افزایش می‌دهد،
  • یا قبل از روشن شدن خودرو (ممکن است خودرو در وسط استراحت روشن نشود)، که در این صورت تاثیری بر زمان روشن شدن خودرو ندارد.
  • یا بعد از پایان وسیله نقلیه (به همین ترتیب، با زمان پایان وسیله نقلیه).
فیلدها
break_requests[]

BreakRequest

توالی وقفه‌ها. به پیام BreakRequest مراجعه کنید.

frequency_constraints[]

FrequencyConstraint

چندین FrequencyConstraint ممکن است اعمال شود. همه آنها باید توسط BreakRequest های این BreakRule برآورده شوند. به FrequencyConstraint مراجعه کنید.

درخواست وقفه

توالی وقفه‌ها (یعنی تعداد و ترتیب آنها) که برای هر وسیله نقلیه اعمال می‌شود، باید از قبل مشخص باشد. درخواست‌های مکرر BreakRequest آن توالی را به ترتیبی که باید رخ دهند، تعریف می‌کنند. پنجره‌های زمانی آنها ( earliest_start_time / latest_start_time ) ممکن است با هم همپوشانی داشته باشند، اما باید با ترتیب آنها سازگار باشند (این مورد بررسی شده است).

فیلدها
earliest_start_time

Timestamp

الزامی. حد پایین (شامل) در شروع استراحت.

latest_start_time

Timestamp

الزامی. حد بالا (شامل) در شروع استراحت.

min_duration

Duration

الزامی. حداقل مدت زمان استراحت. باید مثبت باشد.

محدودیت فرکانس

می‌توان با اعمال حداقل فرکانس وقفه، مانند «باید هر ۱۲ ساعت حداقل ۱ ساعت وقفه وجود داشته باشد»، فرکانس و مدت زمان وقفه‌های مشخص شده در بالا را بیشتر محدود کرد. با فرض اینکه این عبارت را بتوان به صورت «در هر پنجره زمانی متغیر ۱۲ ساعته، باید حداقل یک وقفه حداقل یک ساعته وجود داشته باشد» تفسیر کرد، این مثال به FrequencyConstraint زیر تبدیل می‌شود:

{
   min_break_duration { seconds: 3600 }         # 1 hour.
   max_inter_break_duration { seconds: 39600 }  # 11 hours (12 - 1 = 11).
}

زمان‌بندی و مدت زمان وقفه‌ها در راه‌حل، علاوه بر پنجره‌های زمانی و حداقل مدت زمان‌های مشخص‌شده در BreakRequest ، تمام این محدودیت‌ها را نیز در نظر خواهد گرفت.

یک FrequencyConstraint ممکن است در عمل برای وقفه‌های غیر متوالی اعمال شود. برای مثال، برنامه زیر مثال "1 ساعت هر 12 ساعت" را رعایت می‌کند:

  04:00 vehicle start
   .. performing travel and visits ..
  09:00 1 hour break
  10:00 end of the break
   .. performing travel and visits ..
  12:00 20-min lunch break
  12:20 end of the break
   .. performing travel and visits ..
  21:00 1 hour break
  22:00 end of the break
   .. performing travel and visits ..
  23:59 vehicle end
فیلدها
min_break_duration

Duration

الزامی. حداقل مدت زمان وقفه برای این محدودیت. غیرمنفی. به توضیحات FrequencyConstraint مراجعه کنید.

max_inter_break_duration

Duration

الزامی. حداکثر طول مجاز هر بازه زمانی در مسیر که حداقل بخشی از آن شامل یک وقفه با duration >= min_break_duration نباشد. باید مثبت باشد.

قالب داده

قالب‌های داده برای فایل‌های ورودی و خروجی

انوم‌ها
DATA_FORMAT_UNSPECIFIED مقدار نامعتبر است، فرمت نباید نامشخص باشد.
JSON نمادگذاری شیء جاوا اسکریپت
PROTO_TEXT قالب متنی Protocol Buffers. به https://protobuf.dev/reference/protobuf/textformat-spec/ مراجعه کنید.

محدودیت فاصله

محدودیتی که حداکثر مسافت قابل پیمایش را تعیین می‌کند. این محدودیت می‌تواند سخت یا نرم باشد.

اگر یک حد نرم تعریف شود، هر دو soft_max_meters و cost_per_kilometer_above_soft_max باید تعریف شده و غیرمنفی باشند.

فیلدها
max_meters

int64

یک حد مشخص که فاصله را حداکثر به max_meters محدود می‌کند. این حد باید غیرمنفی باشد.

soft_max_meters

int64

یک محدودیت نرم که محدودیت حداکثر فاصله را اعمال نمی‌کند، اما در صورت نقض، منجر به هزینه‌ای می‌شود که با سایر هزینه‌های تعریف شده در مدل، با همان واحد، جمع می‌شود.

اگر soft_max_meters تعریف شده باشد، باید کمتر از max_meters باشد و باید غیرمنفی باشد.

cost_per_kilometer_below_soft_max

double

هزینه به ازای هر کیلومتر متحمل شده، که تا soft_max_meters افزایش می‌یابد، با فرمول:

  min(distance_meters, soft_max_meters) / 1000.0 *
  cost_per_kilometer_below_soft_max.

این هزینه در route_distance_limit پشتیبانی نمی‌شود.

cost_per_kilometer_above_soft_max

double

هزینه به ازای هر کیلومتر در صورتی که مسافت بیشتر از حد مجاز soft_max_meters باشد. هزینه اضافی در صورتی که مسافت کمتر از حد مجاز باشد، صفر است، در غیر این صورت فرمول مورد استفاده برای محاسبه هزینه به شرح زیر است:

  (distance_meters - soft_max_meters) / 1000.0 *
  cost_per_kilometer_above_soft_max.

هزینه باید غیرمنفی باشد.

مقصد Gcs

محل ذخیره‌سازی ابری گوگل که فایل(های) خروجی در آن نوشته خواهند شد.

فیلدها
uri

string

الزامی. آدرس اینترنتی فضای ذخیره‌سازی ابری گوگل.

جی سی اس سورس

محل ذخیره‌سازی ابری گوگل که فایل ورودی از آنجا خوانده خواهد شد.

فیلدها
uri

string

الزامی. آدرس اینترنتی (URI) یک شیء ذخیره‌سازی ابری گوگل با فرمت gs://bucket/path/to/object .

محدودیت راه‌حل تزریق‌شده

راهکار تزریق‌شده در درخواست، شامل اطلاعاتی در مورد اینکه کدام بازدیدها باید محدود شوند و نحوه‌ی محدود کردن آنها.

فیلدها
routes[]

ShipmentRoute

مسیرهای راه حل برای تزریق. برخی از مسیرها ممکن است از راه حل اصلی حذف شوند. مسیرها و محموله‌های از قلم افتاده باید فرضیات اعتبار اساسی ذکر شده برای injected_first_solution_routes را برآورده کنند.

skipped_shipments[]

SkippedShipment

محموله‌های محلول برای تزریق نادیده گرفته شده‌اند. برخی ممکن است از محلول اصلی حذف شده باشند. به فیلد routes مراجعه کنید.

constraint_relaxations[]

ConstraintRelaxation

برای صفر یا چند گروه از وسایل نقلیه، مشخص می‌کند که چه زمانی و چقدر محدودیت‌ها را کاهش دهید. اگر این فیلد خالی باشد، تمام مسیرهای وسایل نقلیه غیر خالی کاملاً محدود می‌شوند.

محدودیت-آرامش

برای گروهی از وسایل نقلیه، مشخص می‌کند که در چه آستانه(هایی) محدودیت‌های بازدیدها برداشته می‌شوند و در چه سطحی. محموله‌های فهرست‌شده در فیلد skipped_shipment محدود به رد شدن هستند؛ یعنی نمی‌توان آنها را انجام داد.

فیلدها
relaxations[]

Relaxation

تمام محدودیت‌های بازدید که برای بازدیدهای مسیرهایی با وسایل نقلیه در vehicle_indices اعمال می‌شوند.

vehicle_indices[]

int32

شاخص‌های وسیله نقلیه‌ای را مشخص می‌کند که relaxations بازدید برای آنها اعمال می‌شود. اگر خالی باشد، این پیش‌فرض در نظر گرفته می‌شود و relaxations اعمال شده برای همه وسایل نقلیه‌ای که در سایر constraint_relaxations مشخص نشده‌اند، اعمال می‌شود. حداکثر یک پیش‌فرض می‌تواند وجود داشته باشد، یعنی حداکثر یک فیلد محدودیت مجاز است vehicle_indices خالی باشد. شاخص وسیله نقلیه فقط می‌تواند یک بار فهرست شود، حتی در چندین constraint_relaxations .

اگر interpret_injected_solutions_using_labels برابر با true باشد (به توضیحات fields مراجعه کنید)، یک شاخص وسیله نقلیه همانند ShipmentRoute.vehicle_index نگاشت می‌شود.

آرامش

اگر relaxations خالی باشد، زمان شروع و توالی تمام بازدیدها در routes کاملاً محدود شده و هیچ بازدید جدیدی نمی‌تواند به آن مسیرها اضافه یا ثبت شود. همچنین، زمان شروع و پایان یک وسیله نقلیه در routes کاملاً محدود شده است، مگر اینکه وسیله نقلیه خالی باشد (یعنی هیچ بازدیدی نداشته باشد و used_if_route_is_empty در مدل روی false تنظیم شده باشد).

relaxations(i).level سطح آزادسازی محدودیت اعمال شده بر روی بازدید #j را که شرایط زیر را برآورده می‌کند، مشخص می‌کند:

  • route.visits(j).start_time >= relaxations(i).threshold_time AND
  • j + 1 >= relaxations(i).threshold_visit_count

به طور مشابه، اگر شرایط زیر را برآورده کند، استارت خودرو تا relaxations(i).level آرام می‌شود:

  • vehicle_start_time >= relaxations(i).threshold_time و
  • relaxations(i).threshold_visit_count == 0 و انتهای وسیله نقلیه در صورت برآورده شدن موارد زیر، به relaxations(i).level کاهش می‌یابد:
  • vehicle_end_time >= relaxations(i).threshold_time AND
  • route.visits_size() + 1 >= relaxations(i).threshold_visit_count

برای اعمال سطح آرامش در صورتی که یک بازدید به threshold_visit_count یا threshold_time برسد، دو relaxations با همان level را اضافه کنید: یکی فقط با مجموعه threshold_visit_count و دیگری فقط با مجموعه threshold_time . اگر یک بازدید شرایط چندین relaxations برآورده کند، سطح آرامش بیشتر اعمال می‌شود. در نتیجه، از شروع وسیله نقلیه تا بازدیدهای مسیر به سمت انتهای وسیله نقلیه، سطح آرامش آرام‌تر می‌شود: یعنی سطح آرامش با پیشرفت مسیر کاهش نمی‌یابد.

زمان‌بندی و توالی بازدیدهای مسیری که شرایط آستانه هیچ گونه relaxations برآورده نمی‌کنند، کاملاً محدود شده‌اند و هیچ بازدیدی نمی‌تواند در این توالی‌ها قرار گیرد. همچنین، اگر شروع یا پایان وسیله نقلیه شرایط هیچ گونه تسهیلی را برآورده نکند، زمان ثابت است، مگر اینکه وسیله نقلیه خالی باشد.

فیلدها
level

Level

سطح آزادسازی محدودیت که زمانی اعمال می‌شود که شرایط در threshold_time یا بعد از آن و حداقل threshold_visit_count برقرار باشند.

threshold_time

Timestamp

زمانی که در آن یا پس از آن می‌توان level آرامش را اعمال کرد.

threshold_visit_count

int32

تعداد بازدیدهایی که در زمان یا پس از آن level تخفیف اعمال می‌شود. اگر threshold_visit_count برابر با ۰ باشد (یا تنظیم نشده باشد)، level می‌تواند مستقیماً در زمان شروع وسیله نقلیه اعمال شود.

اگر route.visits_size() + 1 باشد، level فقط می‌تواند به انتهای وسیله نقلیه اعمال شود. اگر بیشتر از route.visits_size() + 1 باشد، level به هیچ وجه برای آن مسیر اعمال نمی‌شود.

سطح

سطوح مختلف آزادسازی قید را بیان می‌کند، که برای یک بازدید اعمال می‌شوند و مواردی که پس از برآورده شدن شرایط آستانه اعمال می‌شوند.

فهرست زیر به ترتیب افزایش آرامش است.

انوم‌ها
LEVEL_UNSPECIFIED

سطح پیش‌فرض ضمنیِ آزادسازی: هیچ قیدی آزاد نمی‌شود، یعنی همه بازدیدها کاملاً محدود شده‌اند.

این مقدار نباید به صراحت در level استفاده شود.

RELAX_VISIT_TIMES_AFTER_THRESHOLD زمان شروع بازدید و زمان شروع/پایان وسیله نقلیه کاهش می‌یابد، اما هر بازدید محدود به همان وسیله نقلیه باقی می‌ماند و توالی بازدید باید رعایت شود: هیچ بازدیدی نمی‌تواند بین آنها یا قبل از آنها قرار گیرد.
RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD همانند RELAX_VISIT_TIMES_AFTER_THRESHOLD است، اما توالی بازدیدها نیز ساده‌تر شده است: بازدیدها فقط می‌توانند توسط این وسیله نقلیه انجام شوند، اما می‌توانند به طور بالقوه انجام نشوند.
RELAX_ALL_AFTER_THRESHOLD همانند RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD است، اما وسیله نقلیه نیز آرام می‌شود: بازدیدها در زمان آستانه یا بعد از آن کاملاً رایگان هستند و می‌توانند به طور بالقوه انجام نشوند.

پیکربندی ورودی

یک ورودی برای [BatchOptimizeTours][google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours] مشخص کنید.

فیلدها
data_format

DataFormat

الزامی. قالب داده ورودی.

فیلد source ) الزامی است. source فقط می‌تواند یکی از موارد زیر باشد:
gcs_source

GcsSource

یک مکان ذخیره‌سازی ابری گوگل. این مکان باید یک شیء (فایل) واحد باشد.

مکان

یک مکان (یک نقطه جغرافیایی و یک عنوان اختیاری) را در بر می‌گیرد.

فیلدها
lat_lng

LatLng

مختصات جغرافیایی محل مورد نظر.

heading

int32

جهت قطب‌نما که با جهت جریان ترافیک مرتبط است. این مقدار برای مشخص کردن سمت جاده برای سوار و پیاده کردن استفاده می‌شود. مقادیر جهت می‌توانند از ۰ تا ۳۶۰ باشند، که در آن ۰ جهت شمال، ۹۰ جهت شرق و غیره را مشخص می‌کند.

OptimizeToursLongRunningفراداده

این نوع هیچ فیلدی ندارد.

فراداده‌های عملیاتی برای فراخوانی‌های OptimizeToursLongRunning .

درخواست تورهای بهینه سازی

درخواست داده شدن به یک حل‌کننده بهینه‌سازی تور که مدل حمل و نقل مورد نظر برای حل و همچنین پارامترهای بهینه‌سازی را تعریف می‌کند.

فیلدها
parent

string

الزامی. پروژه یا مکان مورد نظر برای برقراری تماس.

قالب:

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

اگر هیچ مکانی مشخص نشده باشد، یک منطقه به طور خودکار انتخاب می‌شود.

timeout

Duration

اگر این مهلت زمانی تنظیم شود، سرور قبل از اتمام دوره مهلت زمانی یا رسیدن به مهلت سرور برای درخواست‌های همزمان، هر کدام که زودتر باشد، پاسخی را برمی‌گرداند.

برای درخواست‌های ناهمزمان، سرور (در صورت امکان) قبل از اتمام مهلت زمانی، یک راه‌حل ایجاد می‌کند.

model

ShipmentModel

مدل حمل و نقل برای حل.

solving_mode

SolvingMode

به طور پیش‌فرض، حالت حل DEFAULT_SOLVE (0) است.

search_mode

SearchMode

حالت جستجو برای حل درخواست استفاده می‌شود.

injected_first_solution_routes[]

ShipmentRoute

الگوریتم بهینه‌سازی را در یافتن اولین راه‌حلی که مشابه راه‌حل قبلی است، هدایت کنید.

این مدل هنگام ساخت اولین راه‌حل، محدود می‌شود. هر محموله‌ای که در یک مسیر انجام نشود، به طور ضمنی در راه‌حل اول نادیده گرفته می‌شود، اما ممکن است در راه‌حل‌های متوالی انجام شود.

راه حل باید برخی از فرضیات اعتبار اساسی را برآورده کند:

  • برای همه مسیرها، vehicle_index باید در محدوده باشد و تکراری نباشد.
  • برای همه بازدیدها، shipment_index و visit_request_index باید در محدوده باشند.
  • یک محموله فقط می‌تواند در یک مسیر ارجاع داده شود.
  • دریافت محموله‌ی تحویلی-تحویلی باید قبل از تحویل انجام شود.
  • بیش از یک گزینه برای تحویل یا دریافت محموله نمی‌توان انجام داد.
  • برای همه مسیرها، زمان‌ها در حال افزایش هستند (یعنی، vehicle_start_time <= visits[0].start_time <= visits[1].start_time ... <= vehicle_end_time ).
  • یک حمل و نقل فقط می‌تواند روی وسیله نقلیه‌ای که مجاز است انجام شود. یک وسیله نقلیه در صورتی مجاز است که Shipment.allowed_vehicle_indices خالی باشد یا vehicle_index آن در Shipment.allowed_vehicle_indices گنجانده شده باشد.

اگر راه‌حل تزریق‌شده عملی نباشد، لزوماً خطای اعتبارسنجی برگردانده نمی‌شود و ممکن است به جای آن خطایی مبنی بر غیرممکن بودن برگردانده شود.

injected_solution_constraint

InjectedSolutionConstraint

الگوریتم بهینه‌سازی را محدود کنید تا یک راه‌حل نهایی پیدا کند که مشابه راه‌حل قبلی باشد. برای مثال، این می‌تواند برای ثابت کردن بخش‌هایی از مسیرها که قبلاً تکمیل شده‌اند یا قرار است تکمیل شوند اما نباید اصلاح شوند، استفاده شود.

اگر راه‌حل تزریق‌شده عملی نباشد، لزوماً خطای اعتبارسنجی برگردانده نمی‌شود و ممکن است به جای آن خطایی مبنی بر غیرممکن بودن برگردانده شود.

refresh_details_routes[]

ShipmentRoute

اگر خالی نباشد، مسیرهای داده شده بدون تغییر توالی بازدیدها یا زمان‌های سفر مربوطه، به‌روزرسانی می‌شوند: فقط سایر جزئیات به‌روزرسانی می‌شوند. این کار مدل را حل نمی‌کند.

از تاریخ ۲۰۲۰/۱۱، این فقط خطوط چندخطی مسیرهای غیرخالی را پر می‌کند و مستلزم آن است که populate_polylines برابر با true باشد.

فیلدهای route_polyline مسیرهای ارسالی ممکن است با transitions مسیرها سازگار نباشند.

این فیلد نباید همراه با injected_first_solution_routes یا injected_solution_constraint استفاده شود.

Shipment.ignore و Vehicle.ignore هیچ تاثیری بر رفتار ندارند. خطوط چندخطی همچنان بین تمام بازدیدها در تمام مسیرهای غیر خالی، صرف نظر از اینکه محموله‌ها یا وسایل نقلیه مرتبط نادیده گرفته شوند یا خیر، پر می‌شوند.

interpret_injected_solutions_using_labels

bool

اگر درست باشد:

  • از ShipmentRoute.vehicle_label به جای vehicle_index برای تطبیق مسیرها در یک راه‌حل تزریق‌شده با وسایل نقلیه در درخواست استفاده می‌کند؛ از نگاشت ShipmentRoute.vehicle_index اصلی به ShipmentRoute.vehicle_index جدید برای به‌روزرسانی ConstraintRelaxation.vehicle_indices در صورت خالی نبودن، استفاده مجدد می‌کند، اما نگاشت باید بدون ابهام باشد (یعنی چندین ShipmentRoute نباید vehicle_index اصلی یکسانی را به اشتراک بگذارند).
  • از ShipmentRoute.Visit.shipment_label به جای shipment_index برای تطبیق بازدیدها در یک راه‌حل تزریق‌شده با محموله‌های موجود در درخواست استفاده می‌کند؛
  • از SkippedShipment.label به جای SkippedShipment.index برای تطبیق محموله‌های نادیده گرفته شده در محلول تزریق شده با محموله‌های درخواستی استفاده می‌کند.

این تفسیر در مورد فیلدهای injected_first_solution_routes ، injected_solution_constraint و refresh_details_routes اعمال می‌شود. این تفسیر می‌تواند زمانی استفاده شود که شاخص‌های حمل و نقل یا وسیله نقلیه در درخواست از زمان ایجاد راه‌حل تغییر کرده باشند، شاید به این دلیل که محموله‌ها یا وسایل نقلیه از درخواست حذف یا به آن اضافه شده‌اند.

اگر درست باشد، برچسب‌های موجود در دسته‌های زیر باید حداکثر یک بار در دسته خود ظاهر شوند:

اگر یک vehicle_label در راه‌حل تزریق‌شده با یک وسیله نقلیه درخواست مطابقت نداشته باشد، مسیر مربوطه به همراه بازدیدهای آن از راه‌حل حذف می‌شود. اگر یک shipment_label در راه‌حل تزریق‌شده با یک محموله درخواست مطابقت نداشته باشد، بازدید مربوطه از راه‌حل حذف می‌شود. اگر یک SkippedShipment.label در راه‌حل تزریق‌شده با یک محموله درخواست مطابقت نداشته باشد، SkippedShipment از راه‌حل حذف می‌شود.

حذف بازدیدهای مسیر یا کل مسیرها از یک راه‌حل تزریق‌شده ممکن است بر محدودیت‌های ضمنی تأثیر بگذارد، که ممکن است منجر به تغییر در راه‌حل، خطاهای اعتبارسنجی یا عدم امکان‌سنجی شود.

نکته: فراخواننده باید اطمینان حاصل کند که هر Vehicle.label (به نام Shipment.label ) به طور منحصر به فرد یک موجودیت vehicle (به نام shipping) را که در دو درخواست مربوطه استفاده می‌شود، شناسایی می‌کند: درخواست قبلی که OptimizeToursResponse مورد استفاده در راه‌حل تزریق شده را تولید کرده است و درخواست فعلی که شامل راه‌حل تزریق شده است. بررسی‌های منحصر به فرد بودن که در بالا توضیح داده شد، برای تضمین این الزام کافی نیستند.

consider_road_traffic

bool

تخمین ترافیک را در محاسبه فیلدهای Transition.travel_duration ، Visit.start_time و vehicle_end_time ShipmentRoute و در تنظیم فیلد ShipmentRoute.has_traffic_infeasibilities و در محاسبه فیلد OptimizeToursResponse.total_cost در نظر بگیرید.

populate_polylines

bool

اگر درست باشد، چندخطی‌ها در ShipmentRoute های پاسخ قرار می‌گیرند.

populate_transition_polylines

bool

اگر درست باشد، چندخطی‌ها و توکن‌های مسیر در پاسخ ShipmentRoute.transitions قرار داده می‌شوند.

allow_large_deadline_despite_interruption_risk

bool

اگر این تنظیم شده باشد، درخواست می‌تواند مهلتی (به https://grpc.io/blog/deadlines مراجعه کنید) تا ۶۰ دقیقه داشته باشد. در غیر این صورت، حداکثر مهلت فقط ۳۰ دقیقه است. توجه داشته باشید که درخواست‌های طولانی مدت، خطر وقفه بسیار بیشتری (اما همچنان کم) دارند.

use_geodesic_distances

bool

اگر درست باشد، مسافت‌های سفر به جای مسافت‌های نقشه‌های گوگل، با استفاده از مسافت‌های ژئودزیک محاسبه می‌شوند و زمان‌های سفر با استفاده از مسافت‌های ژئودزیک با سرعتی که توسط geodesic_meters_per_second تعریف می‌شود، محاسبه می‌شوند.

label

string

برچسبی که ممکن است برای شناسایی این درخواست استفاده شود، در OptimizeToursResponse.request_label گزارش شده است.

geodesic_meters_per_second

double

وقتی use_geodesic_distances با true باشد، این فیلد باید تنظیم شود و سرعت اعمال شده برای محاسبه زمان سفر را تعریف کند. مقدار آن باید حداقل ۱.۰ متر بر ثانیه باشد.

max_validation_errors

int32

تعداد خطاهای اعتبارسنجی برگشتی را کوتاه می‌کند. این خطاها معمولاً به عنوان جزئیات خطای BadRequest ( https://cloud.google.com/apis/design/errors#error_details ) به یک payload خطای INVALID_ARGUMENT پیوست می‌شوند، مگر اینکه solving_mode=VALIDATE_ONLY باشد: به فیلد OptimizeToursResponse.validation_errors مراجعه کنید. این مقدار به طور پیش‌فرض ۱۰۰ است و حداکثر ۱۰۰۰۰ است.

حالت جستجو

حالتی که رفتار جستجو را تعریف می‌کند و تأخیر را در مقابل کیفیت راه‌حل متعادل می‌کند. در همه حالت‌ها، مهلت درخواست سراسری اعمال می‌شود.

انوم‌ها
SEARCH_MODE_UNSPECIFIED حالت جستجوی نامشخص، معادل RETURN_FAST .
RETURN_FAST پس از یافتن اولین راه حل خوب، جستجو را متوقف کنید.
CONSUME_ALL_AVAILABLE_TIME تمام وقت موجود را صرف جستجوی راه‌حل‌های بهتر کنید.

حالت حل

نحوه‌ی مدیریت درخواست توسط حل‌کننده را تعریف می‌کند. در تمام حالت‌ها به جز VALIDATE_ONLY ، اگر درخواست نامعتبر باشد، خطای INVALID_REQUEST دریافت خواهید کرد. برای تعیین حداکثر تعداد خطاهای برگشتی، به max_validation_errors مراجعه کنید.

انوم‌ها
DEFAULT_SOLVE مدل را حل کنید. ممکن است هشدارهایی در [OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors] صادر شود.
VALIDATE_ONLY فقط مدل را بدون حل آن اعتبارسنجی می‌کند: تا حد امکان OptimizeToursResponse.validation_errors پر می‌کند.
DETECT_SOME_INFEASIBLE_SHIPMENTS

فقط OptimizeToursResponse.validation_errors یا OptimizeToursResponse.skipped_shipments را پر می‌کند و در واقع بقیه درخواست را حل نمی‌کند ( status و routes در پاسخ تنظیم نشده‌اند). اگر عدم امکان در مسیرهای injected_solution_constraint شناسایی شود، در فیلد OptimizeToursResponse.validation_errors پر می‌شود و OptimizeToursResponse.skipped_shipments خالی می‌ماند.

مهم : همه محموله‌های غیرقابل اجرا در اینجا بازگردانده نمی‌شوند، بلکه فقط آن‌هایی که در طول پیش‌پردازش غیرقابل اجرا تشخیص داده شده‌اند، بازگردانده می‌شوند.

TRANSFORM_AND_RETURN_REQUEST

این حالت فقط در صورتی کار می‌کند که ShipmentModel.objectives خالی نباشد. درخواست حل نمی‌شود. فقط اعتبارسنجی شده و با هزینه‌های مربوط به اهداف داده شده پر می‌شود. همچنین به مستندات ShipmentModel.objectives مراجعه کنید. درخواست حاصل به صورت OptimizeToursResponse.processed_request برگردانده می‌شود.

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request مراجعه کنید.

OptimizeToursResponse

پاسخ پس از حل یک مسئله بهینه‌سازی تور شامل مسیرهایی که هر وسیله نقلیه طی می‌کند، محموله‌هایی که از آنها صرف نظر شده است و هزینه کلی راه‌حل.

فیلدها
routes[]

ShipmentRoute

مسیرهای محاسبه‌شده برای هر وسیله نقلیه؛ مسیر iام مربوط به iام وسیله نقلیه در مدل است.

request_label

string

کپی از OptimizeToursRequest.label ، در صورتی که برچسبی در درخواست مشخص شده باشد.

skipped_shipments[]

SkippedShipment

لیست تمام محموله‌ها از قلم افتاد.

validation_errors[]

OptimizeToursValidationError

فهرست تمام خطاهای اعتبارسنجی که توانستیم به‌طور مستقل تشخیص دهیم. برای پیام OptimizeToursValidationError به توضیح «خطاهای چندگانه» مراجعه کنید. به جای خطاها، این شامل هشدارهایی در حالتی می‌شود که solving_mode DEFAULT_SOLVE باشد.

processed_request

OptimizeToursRequest

در برخی موارد، ما درخواست ورودی را قبل از حل آن اصلاح می‌کنیم، یعنی هزینه‌ها را اضافه می‌کنیم. اگر solving_mode == TRANSFORM_AND_RETURN_REQUEST باشد، درخواست اصلاح‌شده در اینجا بازگردانده می‌شود.

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request مراجعه کنید.

metrics

Metrics

معیارهای مدت زمان، مسافت و میزان استفاده برای این راهکار.

معیارها

معیارهای کلی، که در تمام مسیرها تجمیع شده‌اند.

فیلدها
aggregated_route_metrics

AggregatedMetrics

روی مسیرها تجمیع شده است. هر معیار، مجموع (یا حداکثر، برای بارها) روی تمام فیلدهای ShipmentRoute.metrics با نام یکسان است.

skipped_mandatory_shipment_count

int32

تعداد محموله‌های اجباری که از آنها صرف نظر شده است.

used_vehicle_count

int32

تعداد وسایل نقلیه استفاده شده. توجه: اگر مسیر یک وسیله نقلیه خالی باشد و Vehicle.used_if_route_is_empty مقدار true داشته باشد، وسیله نقلیه استفاده شده در نظر گرفته می‌شود.

earliest_vehicle_start_time

Timestamp

زودترین زمان شروع برای یک وسیله نقلیه دست دوم، که به عنوان حداقل زمان برای همه وسایل نقلیه دست دوم ShipmentRoute.vehicle_start_time محاسبه می‌شود.

latest_vehicle_end_time

Timestamp

دیرترین زمان پایان برای یک وسیله نقلیه دست دوم، که به عنوان حداکثر زمان برای همه وسایل نقلیه دست دوم ShipmentRoute.vehicle_end_time محاسبه می‌شود.

costs

map<string, double>

هزینه راه‌حل، تفکیک‌شده بر اساس فیلدهای درخواست مرتبط با هزینه. کلیدها مسیرهای اولیه، نسبت به ورودی OptimizeToursRequest هستند، مثلاً "model.shipments.pickups.cost"، و مقادیر، کل هزینه تولید شده توسط فیلد هزینه مربوطه هستند که در کل راه‌حل تجمیع شده‌اند. به عبارت دیگر، costs["model.shipments.pickups.cost"] مجموع تمام هزینه‌های جمع‌آوری در راه‌حل است. تمام هزینه‌های تعریف‌شده در مدل در اینجا با جزئیات گزارش شده‌اند، به استثنای هزینه‌های مربوط به TransitionAttributes که فقط از تاریخ 2022/01 به صورت تجمیع‌شده گزارش شده‌اند.

total_cost

double

هزینه کل راه‌حل. مجموع تمام مقادیر موجود در نقشه هزینه‌ها.

OptimizeToursUriفراداده

این نوع هیچ فیلدی ندارد.

فراداده‌های عملیاتی برای فراخوانی‌های OptimizeToursUri .

OptimizeToursUriدرخواست

درخواستی که توسط متد OptimizeToursUri استفاده می‌شود.

فیلدها
parent

string

الزامی. پروژه یا مکان مورد نظر برای برقراری تماس.

قالب:

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

اگر هیچ مکانی مشخص نشده باشد، یک منطقه به طور خودکار انتخاب می‌شود.

input

Uri

الزامی. آدرس اینترنتی (URI) شیء Cloud Storage که شامل OptimizeToursRequest است.

output

Uri

الزامی. آدرس اینترنتی (URI) شیء ذخیره‌سازی ابری که شامل OptimizeToursResponse خواهد بود.

OptimizeToursUriResponse

پاسخی که توسط متد OptimizeToursUri برگردانده می‌شود.

فیلدها
output

Uri

اختیاری. URI شیء Cloud Storage که حاوی OptimizeToursResponse است که به صورت JSON یا textproto کدگذاری شده است. اگر شیء به صورت JSON کدگذاری شده باشد، پسوند نام شیء .json خواهد بود. اگر شیء به صورت textproto کدگذاری شده باشد، پسوند نام شیء .txtpb خواهد بود.

می‌توان از crc32_checksum مربوط به منبع برای تأیید عدم تغییر محتوای آن استفاده کرد.

خطای اعتبارسنجی OptimizeTours

خطا یا هشداری را توصیف می‌کند که هنگام اعتبارسنجی یک OptimizeToursRequest با آن مواجه می‌شویم.

فیلدها
code

int32

یک خطای اعتبارسنجی توسط جفت ( code ، display_name ) که همیشه وجود دارند، تعریف می‌شود.

فیلدهای بعد از این بخش، اطلاعات بیشتری در مورد خطا ارائه می‌دهند.

MULTIPLE ERRORS : When there are multiple errors, the validation process tries to output several of them. Much like a compiler, this is an imperfect process. Some validation errors will be "fatal", meaning that they stop the entire validation process. This is the case for display_name="UNSPECIFIED" errors, among others. Some errors may cause the validation process to skip other errors.

STABILITY : code and display_name should be very stable. But new codes and display names may appear over time, which may cause a given (invalid) request to yield a different ( code , display_name ) pair because the new error hid the old one. For example, see "MULTIPLE ERRORS".

display_name

string

The error display name.

fields[]

FieldReference

An error context may involve 0, 1 (most of the time) or more fields. For example, referring to vehicle #4 and shipment #2's first pickup can be done as follows:

fields { name: "vehicles" index: 4}
fields { name: "shipments" index: 2 sub_field {name: "pickups" index: 0} }

Note, however, that the cardinality of fields should not change for a given error code.

error_message

string

Human-readable string describing the error. There is a 1:1 mapping between code and error_message (when code != "UNSPECIFIED").

STABILITY : Not stable: the error message associated to a given code may change (hopefully to clarify it) over time. Please rely on the display_name and code instead.

offending_values

string

May contain the value(s) of the field(s). This is not always available. You should absolutely not rely on it and use it only for manual model debugging.

FieldReference

Specifies a context for the validation error. A FieldReference always refers to a given field in this file and follows the same hierarchical structure. For example, we may specify element #2 of start_time_windows of vehicle #5 using:

name: "vehicles" index: 5 sub_field { name: "end_time_windows" index: 2 }

We however omit top-level entities such as OptimizeToursRequest or ShipmentModel to avoid crowding the message.

فیلدها
name

string

Name of the field, eg, "vehicles".

sub_field

FieldReference

Recursively nested sub-field, if needed.

Union field index_or_key .

index_or_key can be only one of the following:

index

int32

Index of the field if repeated.

key

string

Key if the field is a map.

OutputConfig

Specify a destination for [BatchOptimizeTours][google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours] results.

فیلدها
data_format

DataFormat

Required. The output data format.

Union field destination . Required. destination can be only one of the following:
gcs_destination

GcsDestination

The Google Cloud Storage location to write the output to.

RouteModifiers

Encapsulates a set of optional conditions to satisfy when calculating vehicle routes. This is similar to RouteModifiers in the Google Maps Platform Routes Preferred API; see: https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteModifiers .

فیلدها
avoid_tolls

bool

Specifies whether to avoid toll roads where reasonable. Preference will be given to routes not containing toll roads. Applies only to motorized travel modes.

avoid_highways

bool

Specifies whether to avoid highways where reasonable. Preference will be given to routes not containing highways. Applies only to motorized travel modes.

avoid_ferries

bool

Specifies whether to avoid ferries where reasonable. Preference will be given to routes not containing travel by ferries. Applies only to motorized travel modes.

avoid_indoor

bool

Optional. Specifies whether to avoid navigating indoors where reasonable. Preference will be given to routes not containing indoor navigation. Applies only to the WALKING travel mode.

حمل و نقل

The shipment of a single item, from one of its pickups to one of its deliveries. For the shipment to be considered as performed, a unique vehicle must visit one of its pickup locations (and decrease its spare capacities accordingly), then visit one of its delivery locations later on (and therefore re-increase its spare capacities accordingly).

فیلدها
display_name

string

The user-defined display name of the shipment. It can be up to 63 characters long and may use UTF-8 characters.

pickups[]

VisitRequest

Set of pickup alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the deliveries.

deliveries[]

VisitRequest

Set of delivery alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the pickups.

load_demands

map<string, Load >

Load demands of the shipment (for example weight, volume, number of pallets etc). The keys in the map should be identifiers describing the type of the corresponding load, ideally also including the units. For example: "weight_kg", "volume_gallons", "pallet_count", etc. If a given key does not appear in the map, the corresponding load is considered as null.

allowed_vehicle_indices[]

int32

The set of vehicles that may perform this shipment. If empty, all vehicles may perform it. Vehicles are given by their index in the ShipmentModel 's vehicles list.

costs_per_vehicle[]

double

Specifies the cost that is incurred when this shipment is delivered by each vehicle. If specified, it must have EITHER:

  • the same number of elements as costs_per_vehicle_indices . costs_per_vehicle[i] corresponds to vehicle costs_per_vehicle_indices[i] of the model.
  • the same number of elements as there are vehicles in the model. The i-th element corresponds to vehicle #i of the model.

These costs must be in the same unit as penalty_cost and must not be negative. Leave this field empty, if there are no such costs.

costs_per_vehicle_indices[]

int32

Indices of the vehicles to which costs_per_vehicle applies. If non-empty, it must have the same number of elements as costs_per_vehicle . A vehicle index may not be specified more than once. If a vehicle is excluded from costs_per_vehicle_indices , its cost is zero.

pickup_to_delivery_absolute_detour_limit

Duration

Specifies the maximum absolute detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery.

For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting pickup_to_delivery_absolute_detour_limit enforces:

start_time(delivery) - start_time(pickup) <=
t + pickup_to_delivery_absolute_detour_limit

If both relative and absolute limits are specified on the same shipment, the more constraining limit is used for each possible pickup/delivery pair. As of 2017/10, detours are only supported when travel durations do not depend on vehicles.

pickup_to_delivery_time_limit

Duration

Specifies the maximum duration from start of pickup to start of delivery of a shipment. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. This does not depend on which alternatives are selected for pickup and delivery, nor on vehicle speed. This can be specified alongside maximum detour constraints: the solution will respect both specifications.

shipment_type

string

Non-empty string specifying a "type" for this shipment. This feature can be used to define incompatibilities or requirements between shipment_types (see shipment_type_incompatibilities and shipment_type_requirements in ShipmentModel ).

Differs from visit_types which is specified for a single visit: All pickup/deliveries belonging to the same shipment share the same shipment_type .

label

string

Specifies a label for this shipment. This label is reported in the response in the shipment_label of the corresponding ShipmentRoute.Visit .

ignore

bool

If true, skip this shipment, but don't apply a penalty_cost .

Ignoring a shipment results in a validation error when there are any shipment_type_requirements in the model.

Ignoring a shipment that is performed in injected_first_solution_routes or injected_solution_constraint is permitted; the solver removes the related pickup/delivery visits from the performing route. precedence_rules that reference ignored shipments will also be ignored.

penalty_cost

double

If the shipment is not completed, this penalty is added to the overall cost of the routes. A shipment is considered completed if one of its pickup and delivery alternatives is visited. The cost may be expressed in the same unit used for all other cost-related fields in the model and must be positive.

IMPORTANT : If this penalty is not specified, it is considered infinite, ie the shipment must be completed.

pickup_to_delivery_relative_detour_limit

double

Specifies the maximum relative detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery.

For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting pickup_to_delivery_relative_detour_limit enforces:

start_time(delivery) - start_time(pickup) <=
std::ceil(t * (1.0 + pickup_to_delivery_relative_detour_limit))

If both relative and absolute limits are specified on the same shipment, the more constraining limit is used for each possible pickup/delivery pair. As of 2017/10, detours are only supported when travel durations do not depend on vehicles.

بار

When performing a visit, a predefined amount may be added to the vehicle load if it's a pickup, or subtracted if it's a delivery. This message defines such amount. See load_demands .

فیلدها
amount

int64

The amount by which the load of the vehicle performing the corresponding visit will vary. Since it is an integer, users are advised to choose an appropriate unit to avoid loss of precision. Must be ≥ 0.

VisitRequest

Request for a visit which can be done by a vehicle: it has a geo-location (or two, see below), opening and closing times represented by time windows, and a service duration time (time spent by the vehicle once it has arrived to pickup or drop off goods).

فیلدها
arrival_location

LatLng

The geo-location where the vehicle arrives when performing this VisitRequest . If the shipment model has duration distance matrices, arrival_location must not be specified.

arrival_waypoint

Waypoint

The waypoint where the vehicle arrives when performing this VisitRequest . If the shipment model has duration distance matrices, arrival_waypoint must not be specified.

departure_location

LatLng

The geo-location where the vehicle departs after completing this VisitRequest . Can be omitted if it is the same as arrival_location . If the shipment model has duration distance matrices, departure_location must not be specified.

departure_waypoint

Waypoint

The waypoint where the vehicle departs after completing this VisitRequest . Can be omitted if it is the same as arrival_waypoint . If the shipment model has duration distance matrices, departure_waypoint must not be specified.

tags[]

string

Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.

time_windows[]

TimeWindow

Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, ie arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before TimeWindow.start_time .

The absence of TimeWindow means that the vehicle can perform this visit at any time.

Time windows must be disjoint, ie no time window must overlap with or be adjacent to another, and they must be in increasing order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

duration

Duration

Duration of the visit, ie time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see time_windows ).

cost

double

Cost to service this visit request on a vehicle route. This can be used to pay different costs for each alternative pickup or delivery of a shipment. This cost must be in the same unit as Shipment.penalty_cost and must not be negative.

load_demands

map<string, Load >

Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment . The demands listed here are added to the demands listed in Shipment.load_demands .

visit_types[]

string

Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type ).

A type can only appear once.

label

string

Specifies a label for this VisitRequest . This label is reported in the response as visit_label in the corresponding ShipmentRoute.Visit .

avoid_u_turns

bool

Specifies whether U-turns should be avoided in driving routes at this location. U-turn avoidance is best effort and complete avoidance is not guaranteed. This is an experimental feature and behavior is subject to change.

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/u-turn-avoidance/make-request for more details.

ShipmentModel

A shipment model contains a set of shipments which must be performed by a set of vehicles, while minimizing the overall cost, which is the sum of:

  • the cost of routing the vehicles (sum of cost per total time, cost per travel time, and fixed cost over all vehicles).
  • the unperformed shipment penalties.
  • the cost of the global duration of the shipments
فیلدها
shipments[]

Shipment

Set of shipments which must be performed in the model.

vehicles[]

Vehicle

Set of vehicles which can be used to perform visits.

objectives[]

Objective

The set of objectives for this model, that we will transform into costs. If not empty, the input model has to be costless. To obtain the modified request, please use solving_mode = TRANSFORM_AND_RETURN_REQUEST. Note that the request will not be solved in this case. See corresponding documentation.

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request for more details.

global_start_time

Timestamp

Global start and end time of the model: no times outside of this range can be considered valid.

The model's time span must be less than a year, ie the global_end_time and the global_start_time must be within 31536000 seconds of each other.

When using cost_per_*hour fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (ie seconds: 0, nanos: 0) is used as default.

global_end_time

Timestamp

If unset, 00:00:00 UTC, January 1, 1971 (ie seconds: 31536000, nanos: 0) is used as default.

global_duration_cost_per_hour

double

The "global duration" of the overall plan is the difference between the earliest effective start time and the latest effective end time of all vehicles. Users can assign a cost per hour to that quantity to try and optimize for earliest job completion, for example. This cost must be in the same unit as Shipment.penalty_cost .

duration_distance_matrices[]

DurationDistanceMatrix

Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the use_geodesic_distances field. If it is not empty, use_geodesic_distances cannot be true and neither duration_distance_matrix_src_tags nor duration_distance_matrix_dst_tags can be empty.

Usage examples:

  • There are two locations: locA and locB.
  • 1 vehicle starting its route at locA and ending it at locA.
  • 1 pickup visit request at locB. 
model {
  vehicles { start_tags: "locA"  end_tags: "locA" }
  shipments { pickups { tags: "locB" } }
  duration_distance_matrix_src_tags: "locA"
  duration_distance_matrix_src_tags: "locB"
  duration_distance_matrix_dst_tags: "locA"
  duration_distance_matrix_dst_tags: "locB"
  duration_distance_matrices {
    rows {  # from: locA
      durations { seconds: 0 }   meters: 0    # to: locA
      durations { seconds: 100 } meters: 1000 # to: locB
    }
    rows {  # from: locB
      durations { seconds: 102 } meters: 990 # to: locA
      durations { seconds: 0 }   meters: 0   # to: locB
    }
  }
}
  • There are three locations: locA, locB and locC.
  • 1 vehicle starting its route at locA and ending it at locB, using matrix "fast".
  • 1 vehicle starting its route at locB and ending it at locB, using matrix "slow".
  • 1 vehicle starting its route at locB and ending it at locB, using matrix "fast".
  • 1 pickup visit request at locC. 
model {
  vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" }
  vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" }
  vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" }
  shipments { pickups { tags: "locC" } }
  duration_distance_matrix_src_tags: "locA"
  duration_distance_matrix_src_tags: "locB"
  duration_distance_matrix_src_tags: "locC"
  duration_distance_matrix_dst_tags: "locB"
  duration_distance_matrix_dst_tags: "locC"
  duration_distance_matrices {
    vehicle_start_tag: "fast"
    rows {  # from: locA
      durations { seconds: 1000 } meters: 2000 # to: locB
      durations { seconds: 600 }  meters: 1000 # to: locC
    }
    rows {  # from: locB
      durations { seconds: 0 }   meters: 0    # to: locB
      durations { seconds: 700 } meters: 1200 # to: locC
    }
    rows {  # from: locC
      durations { seconds: 702 } meters: 1190 # to: locB
      durations { seconds: 0 }   meters: 0    # to: locC
    }
  }
  duration_distance_matrices {
    vehicle_start_tag: "slow"
    rows {  # from: locA
      durations { seconds: 1800 } meters: 2001 # to: locB
      durations { seconds: 900 }  meters: 1002 # to: locC
    }
    rows {  # from: locB
      durations { seconds: 0 }    meters: 0    # to: locB
      durations { seconds: 1000 } meters: 1202 # to: locC
    }
    rows {  # from: locC
      durations { seconds: 1001 } meters: 1195 # to: locB
      durations { seconds: 0 }    meters: 0    # to: locC
    }
  }
}
duration_distance_matrix_src_tags[]

string

Tags defining the sources of the duration and distance matrices; duration_distance_matrices(i).rows(j) defines durations and distances from visits with tag duration_distance_matrix_src_tags(j) to other visits in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags . A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle 's source, destination and matrix tags may be the same; similarly a VisitRequest 's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

duration_distance_matrix_dst_tags[]

string

Tags defining the destinations of the duration and distance matrices; duration_distance_matrices(i).rows(j).durations(k) (resp. duration_distance_matrices(i).rows(j).meters(k)) defines the duration (resp. the distance) of the travel from visits with tag duration_distance_matrix_src_tags(j) to visits with tag duration_distance_matrix_dst_tags(k) in matrix i.

Tags correspond to VisitRequest.tags or Vehicle.start_tags . A given VisitRequest or Vehicle must match exactly one tag in this field. Note that a Vehicle 's source, destination and matrix tags may be the same; similarly a VisitRequest 's source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then duration_distance_matrices must not be empty.

transition_attributes[]

TransitionAttributes

Transition attributes added to the model.

shipment_type_incompatibilities[]

ShipmentTypeIncompatibility

Sets of incompatible shipment_types (see ShipmentTypeIncompatibility ).

shipment_type_requirements[]

ShipmentTypeRequirement

Sets of shipment_type requirements (see ShipmentTypeRequirement ).

precedence_rules[]

PrecedenceRule

Set of precedence rules which must be enforced in the model.

IMPORTANT : Use of precedence rules limits the size of problem that can be optimized. Requests using precedence rules that include many shipments may be rejected.

max_active_vehicles

int32

Constrains the maximum number of active vehicles. A vehicle is active if its route performs at least one shipment. This can be used to limit the number of routes in the case where there are fewer drivers than vehicles and that the fleet of vehicles is heterogeneous. The optimization will then select the best subset of vehicles to use. Must be strictly positive.

DurationDistanceMatrix

Specifies a duration and distance matrix from visit and vehicle start locations to visit and vehicle end locations.

فیلدها
rows[]

Row

Specifies the rows of the duration and distance matrix. It must have as many elements as ShipmentModel.duration_distance_matrix_src_tags .

vehicle_start_tag

string

Tag defining to which vehicles this duration and distance matrix applies. If empty, this applies to all vehicles, and there can only be a single matrix.

Each vehicle start must match exactly one matrix, ie exactly one of their start_tags field must match the vehicle_start_tag of a matrix (and of that matrix only).

All matrices must have a different vehicle_start_tag .

ردیف

Specifies a row of the duration and distance matrix.

فیلدها
durations[]

Duration

Duration values for a given row. It must have as many elements as ShipmentModel.duration_distance_matrix_dst_tags .

meters[]

double

Distance values for a given row. If no costs or constraints refer to distances in the model, this can be left empty; otherwise it must have as many elements as durations .

Objective

Objectives replace the cost model completely, and are therefore incompatible with pre-existing costs. Each objective maps to a number of pre-defined costs for, eg, vehicles, shipments or transition attributes.

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request for more details.

فیلدها
type

Type

The type of the objective.

weight

double

How much this objective should count relatively to the others. This can be any non-negative number, weights do not have to sum to 1. Weights default to 1.0.

نوع

The objective type that will be mapped to a set of costs.

انوم‌ها
DEFAULT A default set of costs will be used, to ensure a reasonable solution. Note: this objective can be used on its own, but will also always be added with weight 1.0, as a baseline, to the objectives specified by the user, if it's not already present.
MIN_DISTANCE "MIN" objectives. Minimize the total distance traveled.
MIN_WORKING_TIME Minimize the total working time, summed over all vehicles.
MIN_TRAVEL_TIME Same as above but focusing on travel time only.
MIN_NUM_VEHICLES Minimize the number of vehicles used.

PrecedenceRule

A precedence rule between two events (each event is the pickup or the delivery of a shipment): the "second" event has to start at least offset_duration after "first" has started.

Several precedences can refer to the same (or related) events, eg, "pickup of B happens after delivery of A" and "pickup of C happens after pickup of B".

Furthermore, precedences only apply when both shipments are performed and are otherwise ignored.

فیلدها
first_is_delivery

bool

Indicates if the "first" event is a delivery.

second_is_delivery

bool

Indicates if the "second" event is a delivery.

offset_duration

Duration

The offset between the "first" and "second" event. It can be negative.

first_index

int32

Shipment index of the "first" event. This field must be specified.

second_index

int32

Shipment index of the "second" event. This field must be specified.

ShipmentRoute

A vehicle's route can be decomposed, along the time axis, like this (we assume there are n visits): 

  |            |            |          |       |  T[2], |        |      |
  | Transition |  Visit #0  |          |       |  V[2], |        |      |
  |     #0     |    aka     |   T[1]   |  V[1] |  ...   | V[n-1] | T[n] |
  |  aka T[0]  |    V[0]    |          |       | V[n-2],|        |      |
  |            |            |          |       | T[n-1] |        |      |
  ^            ^            ^          ^       ^        ^        ^      ^
vehicle    V[0].start   V[0].end     V[1].   V[1].    V[n].    V[n]. vehicle
 start     (arrival)   (departure)   start   end      start    end     end

Note that we make a difference between:

  • "punctual events", such as the vehicle start and end and each visit's start and end (aka arrival and departure). They happen at a given second.
  • "time intervals", such as the visits themselves, and the transition between visits. Though time intervals can sometimes have zero duration, ie start and end at the same second, they often have a positive duration.

Invariants:

  • If there are n visits, there are n+1 transitions.
  • A visit is always surrounded by a transition before it (same index) and a transition after it (index + 1).
  • The vehicle start is always followed by transition #0.
  • The vehicle end is always preceded by transition #n.

Zooming in, here is what happens during a Transition and a Visit : 

---+-------------------------------------+-----------------------------+-->
   |           TRANSITION[i]             |           VISIT[i]          |
   |                                     |                             |
   |  * TRAVEL: the vehicle moves from   |      PERFORM the visit:     |
   |    VISIT[i-1].departure_location to |                             |
   |    VISIT[i].arrival_location, which |  * Spend some time:         |
   |    takes a given travel duration    |    the "visit duration".    |
   |    and distance                     |                             |
   |                                     |  * Load or unload           |
   |  * BREAKS: the driver may have      |    some quantities from the |
   |    breaks (e.g. lunch break).       |    vehicle: the "demand".   |
   |                                     |                             |
   |  * WAIT: the driver/vehicle does    |                             |
   |    nothing. This can happen for     |                             |
   |    many reasons, for example when   |                             |
   |    the vehicle reaches the next     |                             |
   |    event's destination before the   |                             |
   |    start of its time window         |                             |
   |                                     |                             |
   |  * DELAY: *right before* the next   |                             |
   |    arrival. E.g. the vehicle and/or |                             |
   |    driver spends time unloading.    |                             |
   |                                     |                             |
---+-------------------------------------+-----------------------------+-->
   ^                                     ^                             ^
V[i-1].end                           V[i].start                    V[i].end

Lastly, here is how the TRAVEL, BREAKS, DELAY and WAIT can be arranged during a transition.

  • They don't overlap.
  • The DELAY is unique and must be a contiguous period of time right before the next visit (or vehicle end). Thus, it suffice to know the delay duration to know its start and end time.
  • The BREAKS are contiguous, non-overlapping periods of time. The response specifies the start time and duration of each break.
  • TRAVEL and WAIT are "preemptable": they can be interrupted several times during this transition. Clients can assume that travel happens "as soon as possible" and that "wait" fills the remaining time.

A (complex) example: 

                               TRANSITION[i]
--++-----+-----------------------------------------------------------++-->
  ||     |       |           |       |           |         |         ||
  ||  T  |   B   |     T     |       |     B     |         |    D    ||
  ||  r  |   r   |     r     |   W   |     r     |    W    |    e    ||
  ||  a  |   e   |     a     |   a   |     e     |    a    |    l    ||
  ||  v  |   a   |     v     |   i   |     a     |    i    |    a    ||
  ||  e  |   k   |     e     |   t   |     k     |    t    |    y    ||
  ||  l  |       |     l     |       |           |         |         ||
  ||     |       |           |       |           |         |         ||
--++-----------------------------------------------------------------++-->
فیلدها
vehicle_index

int32

Vehicle performing the route, identified by its index in the source ShipmentModel .

vehicle_label

string

Label of the vehicle performing this route, equal to ShipmentModel.vehicles(vehicle_index).label , if specified.

vehicle_start_time

Timestamp

Time at which the vehicle starts its route.

vehicle_end_time

Timestamp

Time at which the vehicle finishes its route.

visits[]

Visit

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

transitions[]

Transition

Ordered list of transitions for the route.

has_traffic_infeasibilities

bool

When OptimizeToursRequest.consider_road_traffic , is set to true, this field indicates that inconsistencies in route timings are predicted using traffic-based travel duration estimates. There may be insufficient time to complete traffic-adjusted travel, delays, and breaks between visits, before the first visit, or after the last visit, while still satisfying the visit and vehicle time windows. For example, 

  start_time(previous_visit) + duration(previous_visit) +
  travel_duration(previous_visit, next_visit) > start_time(next_visit)

Arrival at next_visit will likely happen later than its current time window due the increased estimate of travel time travel_duration(previous_visit, next_visit) due to traffic. Also, a break may be forced to overlap with a visit due to an increase in travel time estimates and visit or break time window restrictions.

route_polyline

EncodedPolyline

The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.

breaks[]

Break

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

metrics

AggregatedMetrics

Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits , depending on the context.

vehicle_fullness

VehicleFullness

VehicleFullness field for computing how close the capped metrics are to their respective vehicle limits. Its fields are ratios between a capped metric field (eg AggregatedMetrics.travel_distance_meters ) and the related vehicle limit (eg Vehicle.route_distance_limit ).

Experimental: This field's behavior or existence may change in future.

route_costs

map<string, double>

Cost of the route, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, eg "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole route. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the route. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

route_total_cost

double

Total cost of the route. The sum of all costs in the cost map.

شکستن

Data representing the execution of a break.

فیلدها
start_time

Timestamp

Start time of a break.

duration

Duration

Duration of a break.

EncodedPolyline

The encoded representation of a polyline. More information on polyline encoding can be found here: https://developers.google.com/maps/documentation/utilities/polylinealgorithm https://developers.google.com/maps/documentation/javascript/reference/geometry#encoding .

فیلدها
points

string

String representing encoded points of the polyline.

گذار

Transition between two events on the route. See the description of ShipmentRoute .

If the vehicle does not have a start_location and/or end_location , the corresponding travel metrics are 0.

فیلدها
travel_duration

Duration

Travel duration during this transition.

travel_distance_meters

double

Distance traveled during the transition.

traffic_info_unavailable

bool

When traffic is requested via OptimizeToursRequest.consider_road_traffic , and the traffic info couldn't be retrieved for a Transition , this boolean is set to true. This may be temporary (rare hiccup in the realtime traffic servers) or permanent (no data for this location).

delay_duration

Duration

Sum of the delay durations applied to this transition. If any, the delay starts exactly delay_duration seconds before the next event (visit or vehicle end). See TransitionAttributes.delay .

break_duration

Duration

Sum of the duration of the breaks occurring during this transition, if any. Details about each break's start time and duration are stored in ShipmentRoute.breaks .

wait_duration

Duration

Time spent waiting during this transition. Wait duration corresponds to idle time and does not include break time. Also note that this wait time may be split into several non-contiguous intervals.

total_duration

Duration

Total duration of the transition, provided for convenience. It is equal to:

  • next visit start_time (or vehicle_end_time if this is the last transition) - this transition's start_time ;
  • if ShipmentRoute.has_traffic_infeasibilities is false, the following additionally holds: `total_duration = travel_duration + delay_duration
  • break_duration + wait_duration`.
start_time

Timestamp

Start time of this transition.

route_polyline

EncodedPolyline

The encoded polyline representation of the route followed during the transition. This field is only populated if populate_transition_polylines is set to true.

route_token

string

Output only. An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route. This field is only populated if populate_transition_polylines is set to true.

vehicle_loads

map<string, VehicleLoad >

Vehicle loads during this transition, for each type that either appears in this vehicle's Vehicle.load_limits , or that have non-zero Shipment.load_demands on some shipment performed on this route.

The loads during the first transition are the starting loads of the vehicle route. Then, after each visit, the visit's load_demands are either added or subtracted to get the next transition's loads, depending on whether the visit was a pickup or a delivery.

VehicleLoad

Reports the actual load of the vehicle at some point along the route, for a given type (see Transition.vehicle_loads ).

فیلدها
amount

int64

The amount of load on the vehicle, for the given type. The unit of load is usually indicated by the type. See Transition.vehicle_loads .

بازدید

A visit performed during a route. This visit corresponds to a pickup or a delivery of a Shipment .

فیلدها
shipment_index

int32

Index of the shipments field in the source ShipmentModel .

is_pickup

bool

If true the visit corresponds to a pickup of a Shipment . Otherwise, it corresponds to a delivery.

visit_request_index

int32

Index of VisitRequest in either the pickup or delivery field of the Shipment (see is_pickup ).

start_time

Timestamp

Time at which the visit starts. Note that the vehicle may arrive earlier than this at the visit location. Times are consistent with the ShipmentModel .

load_demands

map<string, Load >

Total visit load demand as the sum of the shipment and the visit request load_demands . The values are negative if the visit is a delivery. Demands are reported for the same types as the Transition.loads (see this field).

detour

Duration

Extra detour time due to the shipments visited on the route before the visit and to the potential waiting time induced by time windows. If the visit is a delivery, the detour is computed from the corresponding pickup visit and is equal to: 

start_time(delivery) - start_time(pickup)
- (duration(pickup) + travel duration from the pickup location
to the delivery location).

Otherwise, it is computed from the vehicle start_location and is equal to: 

start_time - vehicle_start_time - travel duration from
the vehicle's `start_location` to the visit.
shipment_label

string

Copy of the corresponding Shipment.label , if specified in the Shipment .

visit_label

string

Copy of the corresponding VisitRequest.label , if specified in the VisitRequest .

injected_solution_location_token

int32

An opaque token representing information about a visit location.

This field may be populated in the result routes' visits when VisitRequest.avoid_u_turns was set to true for this visit or if ShipmentModel.avoid_u_turns was set to true in the request OptimizeToursRequest .

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/u-turn-avoidance/make-request for more details.

ShipmentTypeIncompatibility

Specifies incompatibilties between shipments depending on their shipment_type. The appearance of incompatible shipments on the same route is restricted based on the incompatibility mode.

فیلدها
types[]

string

List of incompatible types. Two shipments having different shipment_types among those listed are "incompatible".

incompatibility_mode

IncompatibilityMode

Mode applied to the incompatibility.

IncompatibilityMode

Modes defining how the appearance of incompatible shipments are restricted on the same route.

انوم‌ها
INCOMPATIBILITY_MODE_UNSPECIFIED Unspecified incompatibility mode. This value should never be used.
NOT_PERFORMED_BY_SAME_VEHICLE In this mode, two shipments with incompatible types can never share the same vehicle.
NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY

In this mode, two shipments with incompatible types can never be on the same vehicle at the same time:

  • They can share the same vehicle only if one is delivered before the other is picked up.
  • When both shipments are pickups-only (no deliveries) or deliveries-only (no pickups), they can't share the same vehicle at all.

ShipmentTypeRequirement

Specifies requirements between shipments based on their shipment_type. The specifics of the requirement are defined by the requirement mode.

فیلدها
required_shipment_type_alternatives[]

string

List of alternative shipment types required by the dependent_shipment_types .

dependent_shipment_types[]

string

All shipments with a type in the dependent_shipment_types field require at least one shipment of type required_shipment_type_alternatives to be visited on the same route.

NOTE: Chains of requirements such that a shipment_type depends on itself are not allowed.

requirement_mode

RequirementMode

Mode applied to the requirement.

RequirementMode

Modes defining the appearance of dependent shipments on a route.

انوم‌ها
REQUIREMENT_MODE_UNSPECIFIED Unspecified requirement mode. This value should never be used.
PERFORMED_BY_SAME_VEHICLE In this mode, all "dependent" shipments must share the same vehicle as at least one of their "required" shipments.
IN_SAME_VEHICLE_AT_PICKUP_TIME

With the IN_SAME_VEHICLE_AT_PICKUP_TIME mode, all "dependent" shipments need to have at least one "required" shipment on their vehicle at the time of their pickup.

A "dependent" shipment pickup must therefore have either:

  • A delivery-only "required" shipment delivered on the route after, or
  • A "required" shipment picked up on the route before it, and if the "required" shipment has a delivery, this delivery must be performed after the "dependent" shipment's pickup.
IN_SAME_VEHICLE_AT_DELIVERY_TIME Same as before, except the "dependent" shipments need to have a "required" shipment on their vehicle at the time of their delivery .

SkippedShipment

Specifies details of unperformed shipments in a solution. For trivial cases and/or if we are able to identify the cause for skipping, we report the reason here.

فیلدها
index

int32

The index corresponds to the index of the shipment in the source ShipmentModel .

label

string

Copy of the corresponding Shipment.label , if specified in the Shipment .

reasons[]

Reason

A list of reasons that explain why the shipment was skipped. See comment above Reason . If we are unable to understand why a shipment was skipped, reasons will not be set.

penalty_cost

double

This is a copy of the Shipment.penalty_cost , included here to make it easier to see the severity of a skipped shipment.

Experimental: This field's behavior or existence may change in future.

estimated_incompatible_vehicle_ratio

double

Estimated ratio of vehicles that cannot perform this shipment for at least one of the reasons below. Note: this is only filled when reasons involve a vehicle.

Experimental: This field's behavior or existence may change in future.

دلیل

If we can explain why the shipment was skipped, reasons will be listed here. If the reason is not the same for all vehicles, reason will have more than 1 element. A skipped shipment cannot have duplicate reasons, ie where all fields are the same except for example_vehicle_index . Example: 

reasons {
  code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
  example_vehicle_index: 1
  example_exceeded_capacity_type: "Apples"
}
reasons {
  code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
  example_vehicle_index: 3
  example_exceeded_capacity_type: "Pears"
}
reasons {
  code: CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT
  example_vehicle_index: 1
}

The skipped shipment is incompatible with all vehicles. The reasons may be different for all vehicles but at least one vehicle's "Apples" capacity would be exceeded (including vehicle 1), at least one vehicle's "Pears" capacity would be exceeded (including vehicle 3) and at least one vehicle's distance limit would be exceeded (including vehicle 1).

فیلدها
code

Code

Refer to the comments of Code.

example_vehicle_indices[]

int32

Same as example_vehicle_index except that we provide the list of multiple identified vehicles. This list is not necessarily exhaustive. This is only filled if [fill_example_vehicle_indices_in_skipped_reasons][] is true.

Experimental: This field's behavior or existence may change in future.

example_exceeded_capacity_type

string

If the reason code is DEMAND_EXCEEDS_VEHICLE_CAPACITY , documents one capacity type that is exceeded.

example_vehicle_index

int32

If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.

کد

Code identifying the reason type. The order here is meaningless. In particular, it gives no indication of whether a given reason will appear before another in the solution, if both apply.

انوم‌ها
CODE_UNSPECIFIED This should never be used.
NO_VEHICLE There is no vehicle in the model making all shipments infeasible.
DEMAND_EXCEEDS_VEHICLE_CAPACITY The demand of the shipment exceeds a vehicle's capacity for some capacity types, one of which is example_exceeded_capacity_type .
CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT

The minimum distance necessary to perform this shipment, ie from the vehicle's start_location to the shipment's pickup and/or delivery locations and to the vehicle's end location exceeds the vehicle's route_distance_limit .

Note that for this computation we use the geodesic distances.

CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT

The minimum time necessary to perform this shipment, including travel time, wait time and service time exceeds the vehicle's route_duration_limit .

Note: travel time is computed in the best-case scenario, namely as geodesic distance x 36 m/s (roughly 130 km/hour).

CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT Same as above but we only compare minimum travel time and the vehicle's travel_duration_limit .
CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS The vehicle cannot perform this shipment in the best-case scenario (see CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT for time computation) if it starts at its earliest start time: the total time would make the vehicle end after its latest end time.
VEHICLE_NOT_ALLOWED The allowed_vehicle_indices field of the shipment is not empty and this vehicle does not belong to it.
VEHICLE_IGNORED

The vehicle's ignore field is true.

Experimental: This field's behavior or existence may change in future.

SHIPMENT_IGNORED

The shipment's ignore field is true.

Experimental: This field's behavior or existence may change in future.

SKIPPED_IN_INJECTED_SOLUTION_CONSTRAINT

The shipment is skipped in the injected_solution_constraint .

Experimental: This field's behavior or existence may change in future.

VEHICLE_ROUTE_IS_FULLY_SEQUENCE_CONSTRAINED

The vehicle route relaxation specified in the injected_solution_constraint doesn't permit any visit to be inserted.

Experimental: This field's behavior or existence may change in future.

ZERO_PENALTY_COST

The shipment has a zero penalty cost. While this can be useful as an advanced modelling choice, it may also explain after the fact why a shipment was skipped.

Experimental: This field's behavior or existence may change in future.

TimeWindow

Time windows constrain the time of an event, such as the arrival time at a visit, or the start and end time of a vehicle.

Hard time window bounds, start_time and end_time , enforce the earliest and latest time of the event, such that start_time <= event_time <= end_time . The soft time window lower bound, soft_start_time , expresses a preference for the event to happen at or after soft_start_time by incurring a cost proportional to how long before soft_start_time the event occurs. The soft time window upper bound, soft_end_time , expresses a preference for the event to happen at or before soft_end_time by incurring a cost proportional to how long after soft_end_time the event occurs. start_time , end_time , soft_start_time and soft_end_time should be within the global time limits (see ShipmentModel.global_start_time and ShipmentModel.global_end_time ) and should respect: 

  0 <= `start_time` <= `end_time` and
  0 <= `start_time` <= `soft_start_time` and
  0 <= `soft_end_time` <= `end_time`.
فیلدها
start_time

Timestamp

The hard time window start time. If unspecified it will be set to ShipmentModel.global_start_time .

end_time

Timestamp

The hard time window end time. If unspecified it will be set to ShipmentModel.global_end_time .

soft_start_time

Timestamp

The soft start time of the time window.

soft_end_time

Timestamp

The soft end time of the time window.

cost_per_hour_before_soft_start_time

double

A cost per hour added to other costs in the model if the event occurs before soft_start_time, computed as: 

   max(0, soft_start_time - t.seconds)
                          * cost_per_hour_before_soft_start_time / 3600,
t being the time of the event.

This cost must be positive, and the field can only be set if soft_start_time has been set.

cost_per_hour_after_soft_end_time

double

A cost per hour added to other costs in the model if the event occurs after soft_end_time , computed as: 

   max(0, t.seconds - soft_end_time.seconds)
                    * cost_per_hour_after_soft_end_time / 3600,
t being the time of the event.

This cost must be positive, and the field can only be set if soft_end_time has been set.

TransitionAttributes

Specifies attributes of transitions between two consecutive visits on a route. Several TransitionAttributes may apply to the same transition: in that case, all extra costs add up and the strictest constraint or limit applies (following natural "AND" semantics).

فیلدها
src_tag

string

Tags defining the set of (src->dst) transitions these attributes apply to.

A source visit or vehicle start matches iff its VisitRequest.tags or Vehicle.start_tags either contains src_tag or does not contain excluded_src_tag (depending on which of these two fields is non-empty).

excluded_src_tag

string

See src_tag . Exactly one of src_tag and excluded_src_tag must be non-empty.

dst_tag

string

A destination visit or vehicle end matches iff its VisitRequest.tags or Vehicle.end_tags either contains dst_tag or does not contain excluded_dst_tag (depending on which of these two fields is non-empty).

excluded_dst_tag

string

See dst_tag . Exactly one of dst_tag and excluded_dst_tag must be non-empty.

cost

double

Specifies a cost for performing this transition. This is in the same unit as all other costs in the model and must not be negative. It is applied on top of all other existing costs.

cost_per_kilometer

double

Specifies a cost per kilometer applied to the distance traveled while performing this transition. It adds up to any Vehicle.cost_per_kilometer specified on vehicles.

distance_limit

DistanceLimit

Specifies a limit on the distance traveled while performing this transition.

As of 2021/06, only soft limits are supported.

delay

Duration

Specifies a delay incurred when performing this transition.

This delay always occurs after finishing the source visit and before starting the destination visit.

اوری

A Universal Resource Identifier that points to a resource that can be read and written by the Route Optimization API.

فیلدها
uri

string

The URI of the resource. The resource may not yet exist.

The contents of the resource are encoded as either JSON or textproto. Only Google Cloud Storage resources are supported. If the resource is encoded as JSON, the resource name must be suffixed with .json . If the resource is encoded as textproto, the resource name must be suffixed with .txtpb . For example, a Google Cloud Storage URI to a JSON encoded file might look like: gs://bucket/path/input/object.json .

وسیله نقلیه

Models a vehicle in a shipment problem. Solving a shipment problem will build a route starting from start_location and ending at end_location for this vehicle. A route is a sequence of visits (see ShipmentRoute ).

فیلدها
display_name

string

The user-defined display name of the vehicle. It can be up to 63 characters long and may use UTF-8 characters.

travel_mode

TravelMode

The travel mode which affects the roads usable by the vehicle and its speed. See also travel_duration_multiple .

route_modifiers

RouteModifiers

A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.

start_location

LatLng

Geographic location where the vehicle starts before picking up any shipments. If not specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, start_location must not be specified.

start_waypoint

Waypoint

Waypoint representing a geographic location where the vehicle starts before picking up any shipments. If neither start_waypoint nor start_location is specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, start_waypoint must not be specified.

end_location

LatLng

Geographic location where the vehicle ends after it has completed its last VisitRequest . If not specified the vehicle's ShipmentRoute ends immediately when it completes its last VisitRequest . If the shipment model has duration and distance matrices, end_location must not be specified.

end_waypoint

Waypoint

Waypoint representing a geographic location where the vehicle ends after it has completed its last VisitRequest . If neither end_waypoint nor end_location is specified, the vehicle's ShipmentRoute ends immediately when it completes its last VisitRequest . If the shipment model has duration and distance matrices, end_waypoint must not be specified.

start_tags[]

string

Specifies tags attached to the start of the vehicle's route.

Empty or duplicate strings are not allowed.

end_tags[]

string

Specifies tags attached to the end of the vehicle's route.

Empty or duplicate strings are not allowed.

start_time_windows[]

TimeWindow

Time windows during which the vehicle may depart its start location. They must be within the global time limits (see ShipmentModel.global_* fields). If unspecified, there is no limitation besides those global time limits.

Time windows belonging to the same repeated field must be disjoint, ie no time window can overlap with or be adjacent to another, and they must be in chronological order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

end_time_windows[]

TimeWindow

Time windows during which the vehicle may arrive at its end location. They must be within the global time limits (see ShipmentModel.global_* fields). If unspecified, there is no limitation besides those global time limits.

Time windows belonging to the same repeated field must be disjoint, ie no time window can overlap with or be adjacent to another, and they must be in chronological order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

unloading_policy

UnloadingPolicy

Unloading policy enforced on the vehicle.

load_limits

map<string, LoadLimit >

Capacities of the vehicle (weight, volume, # of pallets for example). The keys in the map are the identifiers of the type of load, consistent with the keys of the Shipment.load_demands field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.

cost_per_hour

double

Vehicle costs: all costs add up and must be in the same unit as Shipment.penalty_cost .

Cost per hour of the vehicle route. This cost is applied to the total time taken by the route, and includes travel time, waiting time, and visit time. Using cost_per_hour instead of just cost_per_traveled_hour may result in additional latency.

cost_per_traveled_hour

double

Cost per traveled hour of the vehicle route. This cost is applied only to travel time taken by the route (ie, that reported in ShipmentRoute.transitions ), and excludes waiting time and visit time.

cost_per_kilometer

double

Cost per kilometer of the vehicle route. This cost is applied to the distance reported in the ShipmentRoute.transitions and does not apply to any distance implicitly traveled from the arrival_location to the departure_location of a single VisitRequest .

fixed_cost

double

Fixed cost applied if this vehicle is used to handle a shipment.

used_if_route_is_empty

bool

This field only applies to vehicles when their route does not serve any shipments. It indicates if the vehicle should be considered as used or not in this case.

If true, the vehicle goes from its start to its end location even if it doesn't serve any shipments, and time and distance costs resulting from its start --> end travel are taken into account.

Otherwise, it doesn't travel from its start to its end location, and no break_rule or delay (from TransitionAttributes ) are scheduled for this vehicle. In this case, the vehicle's ShipmentRoute doesn't contain any information except for the vehicle index and label.

route_duration_limit

DurationLimit

Limit applied to the total duration of the vehicle's route. In a given OptimizeToursResponse , the route duration of a vehicle is the difference between its vehicle_end_time and vehicle_start_time .

travel_duration_limit

DurationLimit

Limit applied to the travel duration of the vehicle's route. In a given OptimizeToursResponse , the route travel duration is the sum of all its transitions.travel_duration .

route_distance_limit

DistanceLimit

Limit applied to the total distance of the vehicle's route. In a given OptimizeToursResponse , the route distance is the sum of all its transitions.travel_distance_meters .

extra_visit_duration_for_visit_type

map<string, Duration >

Specifies a map from visit_types strings to durations. The duration is time in addition to VisitRequest.duration to be taken at visits with the specified visit_types . This extra visit duration adds cost if cost_per_hour is specified. Keys (ie visit_types ) cannot be empty strings.

If a visit request has multiple types, a duration will be added for each type in the map.

break_rule

BreakRule

Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle.

label

string

Specifies a label for this vehicle. This label is reported in the response as the vehicle_label of the corresponding ShipmentRoute .

ignore

bool

If true, used_if_route_is_empty must be false, and this vehicle will remain unused.

If a shipment is performed by an ignored vehicle in injected_first_solution_routes , it is skipped in the first solution but is free to be performed in the response.

If a shipment is performed by an ignored vehicle in injected_solution_constraint and any related pickup/delivery is constrained to remain on the vehicle (ie, not relaxed to level RELAX_ALL_AFTER_THRESHOLD ), it is skipped in the response. If a shipment has a non-empty allowed_vehicle_indices field and all of the allowed vehicles are ignored, it is skipped in the response.

travel_duration_multiple

double

Specifies a multiplicative factor that can be used to increase or decrease travel times of this vehicle. For example, setting this to 2.0 means that this vehicle is slower and has travel times that are twice what they are for standard vehicles. This multiple does not affect visit durations. It does affect cost if cost_per_hour or cost_per_traveled_hour are specified. This must be in the range [0.001, 1000.0]. If unset, the vehicle is standard, and this multiple is considered 1.0.

WARNING: Travel times will be rounded to the nearest second after this multiple is applied but before performing any numerical operations, thus, a small multiple may result in a loss of precision.

See also extra_visit_duration_for_visit_type below.

DurationLimit

A limit defining a maximum duration of the route of a vehicle. It can be either hard or soft.

When a soft limit field is defined, both the soft max threshold and its associated cost must be defined together.

فیلدها
max_duration

Duration

A hard limit constraining the duration to be at most max_duration.

soft_max_duration

Duration

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit.

If defined, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

quadratic_soft_max_duration

Duration

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit.

If defined, quadratic_soft_max_duration must be nonnegative. If max_duration is also defined, quadratic_soft_max_duration must be less than max_duration , and the difference must be no larger than one day:

max_duration - quadratic_soft_max_duration <= 86400 seconds

cost_per_hour_after_soft_max

double

Cost per hour incurred if the soft_max_duration threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows: 

  cost_per_hour_after_soft_max * (duration - soft_max_duration)

The cost must be nonnegative.

cost_per_square_hour_after_quadratic_soft_max

double

Cost per square hour incurred if the quadratic_soft_max_duration threshold is violated.

The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows: 

  cost_per_square_hour_after_quadratic_soft_max *
  (duration - quadratic_soft_max_duration)^2

The cost must be nonnegative.

LoadLimit

Defines a load limit applying to a vehicle, eg "this truck may only carry up to 3500 kg". See load_limits .

فیلدها
soft_max_load

int64

A soft limit of the load. See cost_per_unit_above_soft_max .

cost_per_unit_above_soft_max

double

If the load ever exceeds soft_max_load along this vehicle's route, the following cost penalty applies (only once per vehicle): (load - soft_max_load ) * cost_per_unit_above_soft_max . All costs add up and must be in the same unit as Shipment.penalty_cost . Soft limits may only be defined on types that apply to either pickups only or deliveries only throughout the model.

start_load_interval

Interval

The acceptable load interval of the vehicle at the start of the route.

end_load_interval

Interval

The acceptable load interval of the vehicle at the end of the route.

max_load

int64

The maximum acceptable amount of load.

cost_per_kilometer

LoadCost

Cost of moving one unit of load over one kilometer for this vehicle. This can be used as a proxy for fuel consumption: if the load is a weight (in Newtons), then load*kilometer has the dimension of an energy.

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/load-cost/make-request for more details.

cost_per_traveled_hour

LoadCost

Cost of traveling with a unit of load during one hour for this vehicle.

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/load-cost/make-request for more details.

فاصله

Interval of acceptable load amounts.

فیلدها
min

int64

A minimum acceptable load. Must be ≥ 0. If they're both specified, min must be ≤ max .

max

int64

A maximum acceptable load. Must be ≥ 0. If unspecified, the maximum load is unrestricted by this message. If they're both specified, min must be ≤ max .

LoadCost

Cost of moving one unit of load during a Transition . For a given load, the cost is the sum of two parts:

  • min(load, load_threshold ) * cost_per_unit_below_threshold
  • max(0, load - load_threshold ) * cost_per_unit_above_threshold

With this cost, solutions prefer to deliver high demands first, or equivalently pickup high demands last. For example, if a vehicle has 

load_limit {
  key: "weight"
  value {
    cost_per_kilometer {
      load_threshold: 15
      cost_per_unit_below_threshold: 2.0
      cost_per_unit_above_threshold: 10.0
    }
  }
}

and its route is start,pickup,pickup,delivery,delivery,end with transitions: 

transition { vehicle_load['weight'] { amount: 0 }
             travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 10 }
             travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 20 }
             travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 10 }
             travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 0 }
             travel_distance_meters: 1000.0 }

then the cost incurred by this LoadCost is (cost_below * load_below * kilometers + cost_above * load_above * kms)

  • transition 0: 0.0
  • transition 1: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
  • transition 2: 2.0 * 15 * 1.0 + 10.0 * (20 - 15) * 1.0 = 80.0
  • transition 3: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
  • transition 4: 0.0

So the LoadCost over the route is 120.0.

However, if the route is start,pickup,delivery,pickup,delivery,end with transitions: 

transition { vehicle_load['weight'] { amount: 0 }
             travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 10 }
             travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 0 }
             travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 10 }
             travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 0 }
             travel_distance_meters: 1000.0 }

then the cost incurred by this LoadCost is

  • transition 0: 0.0
  • transition 1: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
  • transition 2: 0.0
  • transition 3: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
  • transition 4: 0.0

Here the LoadCost over the route is 40.0.

LoadCost makes solutions with heavy-loaded transitions more expensive.

Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/load-cost/make-request for more details.

فیلدها
load_threshold

int64

Amount of load above which the cost of moving a unit of load changes from cost_per_unit_below_threshold to cost_per_unit_above_threshold. Must be >= 0.

cost_per_unit_below_threshold

double

Cost of moving a unit of load, for each unit between 0 and threshold. Must be a finite value, and >= 0.

cost_per_unit_above_threshold

double

Cost of moving a unit of load, for each unit above threshold. In the special case threshold = 0, this is a fixed cost per unit. Must be a finite value, and >= 0.

TravelMode

Travel modes which can be used by vehicles.

These should be a subset of the Google Maps Platform Routes API travel modes, see: https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteTravelMode

Note: WALKING routes are in beta and might sometimes be missing clear sidewalks or pedestrian paths. You must display this warning to the user for all walking routes that you display in your app.

انوم‌ها
TRAVEL_MODE_UNSPECIFIED Unspecified travel mode, equivalent to DRIVING .
DRIVING Travel mode corresponding to driving directions (car, ...).
WALKING Travel mode corresponding to walking directions.

UnloadingPolicy

Policy on how a vehicle can be unloaded. Applies only to shipments having both a pickup and a delivery.

Other shipments are free to occur anywhere on the route independent of unloading_policy .

انوم‌ها
UNLOADING_POLICY_UNSPECIFIED Unspecified unloading policy; deliveries must just occur after their corresponding pickups.
LAST_IN_FIRST_OUT Deliveries must occur in reverse order of pickups
FIRST_IN_FIRST_OUT Deliveries must occur in the same order as pickups

VehicleFullness

VehicleFullness is a metric which computes how full a vehicle is. Each VehicleFullness field is between 0 and 1, computed as the ratio between a capped metric field (eg AggregatedMetrics.travel_distance_meters ) and its related vehicle limit (eg Vehicle.route_distance_limit ), if it exists. Otherwise the fullness ratio stays unset. If the limit is 0, the field is set to 1. Note: when a route is subject to traffic infeasibilities, some raw fullness ratios might exceed 1.0, eg the vehicle might exceed its distance limit. In these cases, we cap the fullness values at 1.0.

فیلدها
max_fullness

double

Maximum of all other fields in this message.

distance

double

The ratio between AggregatedMetrics.travel_distance_meters and Vehicle.route_distance_limit . If Vehicle.route_distance_limit is unset, this field will be unset.

travel_duration

double

The ratio between [AggregatedMetrics.travel_duration_seconds][] and Vehicle.travel_duration_limit . If Vehicle.travel_duration_limit is unset, this field will be unset.

active_duration

double

The ratio between [AggregatedMetrics.total_duration_seconds][] and Vehicle.route_duration_limit . If Vehicle.route_duration_limit is unset, this field will be unset.

max_load

double

The maximum ratio among all types of [AggregatedMetrics.max_load][] and their respective Vehicle.load_limits . If all Vehicle.load_limits fields are unset, this field will be unset.

active_span

double

The ratio (vehicle_end_time - vehicle_start_time) / (latest_vehicle_end_time - earliest_vehicle_start_time) for a given vehicle. If the denominator is not present, it uses ( ShipmentModel.global_end_time - ShipmentModel.global_start_time ) instead.

نقطه مسیر

Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles.

فیلدها
side_of_road

bool

Optional. Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option doesn't work for the 'WALKING' travel mode.

vehicle_stopover

bool

Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pick up or drop off. This option works only for the 'DRIVING' travel mode, and when the 'location_type' is 'location'.

Experimental: This field's behavior or existence may change in future.

Union field location_type . Different ways to represent a location. location_type can be only one of the following:
location

Location

A point specified using geographic coordinates, including an optional heading.

place_id

string

The POI place ID associated with the waypoint.

When using a place ID to specify arrival or departure location of a VisitRequest, use a place ID that is specific enough to determine a LatLng location for navigation to the place. For example, a place ID representing a building is suitable, but a place ID representing a road is discouraged.