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 ويستخدم 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

 تنشئ هذه الطريقة عدة كائنات SelectedRoutes وتبدأ جدولاً زمنيًا لاسترداد معلومات ذاكرة التخزين المؤقت بشكل دوري لكل مسار من المسارات.

create

 تنشئ هذه الطريقة SelectedRoute وتبدأ جدولاً زمنيًا لاسترداد معلومات ذاكرة التخزين المؤقت للمسار بشكل دوري.

delete

 تحذف هذه الطريقة SelectedRoute المحدّدة للمشروع المحدّد.

get

 تعرض هذه الطريقة SelectedRoute كما هو محدّد باسمها.

list

 تعرض هذه الطريقة جميع SelectedRoutes للمشروع المحدّد مع تقسيم النتائج إلى صفحات.