REST Resource: selection.v1.projects.selectedRoutes

منبع: SelectedRoute

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

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

  // Union field route_type can be only one of the following:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of list of possible types for union field route_type.
  "validationError": enum (ValidationError)
}
فیلدها
name

string

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

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

displayName

string

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

createTime

string ( Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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)

اختیاری. ویژگی‌های سفارشی برای مسیر انتخاب شده. اضافه کردن آنها امکان فیلتر کردن یا گروه‌بندی مسیرها را هنگام بازیابی اطلاعات مسیرهای تاریخی و بلادرنگ فراهم می‌کند. حداکثر 10 ویژگی برای هر مسیر پشتیبانی می‌شود. هر کلید و مقدار باید یک رشته غیر خالی باشد و می‌تواند تا 100 کاراکتر داشته باشد. کلیدها نباید با goog شروع شوند.

یک شیء شامل لیستی از جفت‌های "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

فیلد route_type از نوع اتحادیه. در حال حاضر فقط DynamicRoute پشتیبانی می‌شود. route_type فقط می‌تواند یکی از موارد زیر باشد:
dynamicRoute

object ( DynamicRoute )

SelectedRoute یک مسیر پویا است.

validationError

enum ( ValidationError )

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

مسیر پویا

این نشان دهنده مسیری با نقاط مسیر (مبدا، مقصد و واسطه‌ها) است. تضمین می‌شود که مسیر واقعی از تمام نقاط مسیر عبور کند، اما می‌تواند به دلیل شرایط ترافیکی متغیر، هر از گاهی تغییر کند.

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

object ( LatLng )

الزامی. محل مبدا مسیر.

destination

object ( LatLng )

الزامی. محل پایان مسیر.

intermediates[]

object ( LatLng )

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

لات‌لنگ

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

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

number

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

longitude

number

طول جغرافیایی بر حسب درجه. باید در محدوده [-۱۸۰.۰، +۱۸۰.۰] باشد.

ایالت

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

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

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

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

انوم‌ها
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 را مطابق با نامش به‌روزرسانی می‌کند.