REST Resource: selection.v1.projects.selectedRoutes

منبع: SelectedRoute

SelectedRoute نشان‌دهنده مسیر خاصی است که مشتری می‌خواهد به‌طور دوره‌ای اطلاعات (مثلاً مدت‌زمان) آن را برای موارد استفاده قراردادی بازیابی کند.

نمایش JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "state": enum (State),
  "routeAttributes": {
    string: string,
    ...
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError),
  "dynamicRouting": boolean
}
فیلدها
name

string

شناسه. نام منبع SelectedRoute.

قالب: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

اختیاری. نام نمایشی مسیر. این فیلد اختیاری است و مشتری می‌تواند از آن استفاده کند. لازم نیست منحصربه‌فرد باشد. طول آن به ۱۰۰ نویسه (شمرده‌شده در نقاط کد یونی‌کد) محدود است.
createTime

string (Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌شده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".
state

enum (State)

فقط خروجی. وضعیت مسیر انتخاب‌شده.
routeAttributes

map (key: string, value: string)

اختیاری. مشخصه‌های سفارشی برای مسیر انتخاب‌شده. افزودن آن‌ها امکان فیلتر کردن یا گروه‌بندی مسیرها را هنگام بازیابی اطلاعات مسیرهای هم‌زمان و قدیمی فراهم می‌کند. حداکثر ۲۵ مشخصه برای هر مسیر پشتیبانی می‌شود. هر کلید و مقدار باید رشته‌ای غیرخالی باشد و می‌تواند حداکثر ۱۰۰ نویسه داشته باشد (که در نقاط کد یونی‌کد شمارش می‌شود). کلیدها نباید با goog شروع شود.

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
فقط از DynamicRoute پشتیبانی می‌شود. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
dynamicRoute

object (DynamicRoute)

SelectedRoute مسیری پویا است.
پایان فیلدهای متقابلاً انحصاری.
validationError

enum (ValidationError)

فقط خروجی. خطای اعتبارسنجی برای مسیر انتخاب‌شده وقتی وضعیت STATE_INVALID است.
dynamicRouting

boolean

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

DynamicRoute

این نشان‌دهنده مسیری با نقطه‌مسیرها (مبدأ، مقصد، و نقاط میانی) است. تضمین می‌شود که مسیر واقعی از همه نقطه‌مسیرها عبور کند. اگر dynamicRouting روی false تنظیم شده باشد، مسیر واقعی بدون توجه به شرایط ترافیک ثابت می‌ماند. درغیراین‌صورت، اگر dynamicRouting روی true تنظیم شده باشد، مسیر واقعی می‌تواند براساس شرایط ترافیک تغییر کند.

نمایش JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
فیلدها
origin

object (LatLng)

الزامی. مکان اصلی مسیر.
destination

object (LatLng)

الزامی. مکان پایان مسیر.
intermediates[]

object (LatLng)

اختیاری. مجموعه‌ای از نقاط‌مسیر میانی درطول مسیر (به‌استثنای نقاط پایانی). این نقاط همیشه نقاط گذری هستند. حداکثر ۲۵ نقطه‌مسیر میانی پشتیبانی می‌شود. افزودن صحیح آن‌ها می‌تواند تفاوت مسیر واقعی را در زمان‌های مختلف کاهش دهد.

LatLng

شیئی که نشان‌دهنده جفت عرض جغرافیایی/طول جغرافیایی است. این مقدار به‌صورت جفت عدد اعشاری با دقت مضاعف بیان می‌شود که نشان‌دهنده درجه عرض جغرافیایی و درجه طول جغرافیایی است. مگر اینکه خلاف آن مشخص شده باشد، این شیء باید با استاندارد WGS84 مطابقت داشته باشد. مقادیر باید در محدوده نرمال‌شده باشد.

نمایش JSON 
{
  "latitude": number,
  "longitude": number
}
فیلدها
latitude

number

عرض جغرافیایی به درجه. باید در محدوده [-90.0, +90.0] باشد.
longitude

number

طول جغرافیایی برحسب درجه. باید در محدوده [-180.0, +180.0] باشد.

ایالت

وضعیت مسیر انتخاب‌شده.

شمارشی‌ها
STATE_UNSPECIFIED وضعیت این مسیر تنظیم نشده است.
STATE_SCHEDULING مسیر ایجاد شده است و درحال زمان‌بندی است.
STATE_RUNNING مسیر ایجاد شده است و زمان‌بندی فعال دارد.
STATE_DELETING مسیر برای حذف علامت‌گذاری شده است.
STATE_VALIDATING مسیر درحال اعتبارسنجی است.
STATE_INVALID مسیر براساس یکی از معیارهای اعتبارسنجی نامعتبر است.

ValidationError

خطای اعتبارسنجی برای مسیر انتخاب‌شده.

شمارشی‌ها
VALIDATION_ERROR_UNSPECIFIED خطای اعتبارسنجی این مسیر تنظیم نشده است.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION مسیر خارج از حوزه قضایی پروژه است.
VALIDATION_ERROR_LOW_ROAD_USAGE مسیر استفاده جاده‌ای کمی دارد (افراد بسیار کمی از آن عبور می‌کنند).

روش‌ها

batchCreate

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

batchDelete

 چند منبع SelectedRoute را برای پروژه مشخص‌شده حذف می‌کند.

batchUpdate

 چند منبع SelectedRoute را همان‌طور که با نامشان مشخص شده است به‌روز می‌کند.

create

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

delete

 SelectedRoute مشخص‌شده را برای پروژه مشخص‌شده حذف می‌کند.

get

 SelectedRoute را همان‌طور که با نامش مشخص شده است دریافت می‌کند.

list

 همه منابع SelectedRoute را برای پروژه مشخص‌شده با صفحه‌بندی فهرست می‌کند.

patch

 SelectedRoute را همان‌طور که با نامش مشخص شده است به‌روز می‌کند.