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 في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف 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.

DynamicRoute

يمثّل هذا المسار نقاطًا وسيطة (نقطة الانطلاق والوجهة والنقاط الوسيطة). يضمن المسار الفعلي المرور بجميع النقاط الوسيطة، ولكن قد يتغيّر من حين لآخر بسبب اختلاف أحوال حركة المرور.

تمثيل JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
الحقول
origin

object (LatLng)

الحقل مطلوب. نقطة انطلاق المسار.
destination

object (LatLng)

الحقل مطلوب. نقطة نهاية المسار.
intermediates[]

object (LatLng)

اختياريّ. مجموعة من النقاط الوسيطة على طول المسار (باستثناء النقاط الطرفية). وهي دائمًا نقاط مرور. يمكن إضافة ما يصل إلى 25 نقطة وسيطة. يمكن أن يؤدي إضافتها بشكل صحيح إلى تقليل الاختلاف في المسار الفعلي من حين لآخر.

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 كما هو محدّد باسمه.