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

اختيارية: الاسم المعروض للمسار هذا حقل اختياري يمكن للعميل استخدامه. ولا يجب أن يكون فريدًا. يجب ألا يتجاوز طوله 100 حرف (يتم احتسابه بقيم مواضع الرموز في Unicode).
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)

اختيارية: السمات المخصّصة للمسار المحدّد وتتيح إضافتها فلترة المسارات أو تجميعها عند استرداد معلومات المسارات السابقة وفي الوقت الفعلي. يمكن استخدام ما يصل إلى 25 سمة لكل مسار. يجب أن يكون كل مفتاح وقيمة عبارة عن سلسلة غير فارغة ويمكن أن يحتوي على ما يصل إلى 100 حرف (يتم احتسابها في قيم مواضع رموز Unicode). يجب ألا تبدأ المفاتيح بـ 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)

اختيارية: مجموعة من النقاط على المسار (باستثناء نقاط النهاية) وهي دائمًا نقاط مرور. يمكن استخدام ما يصل إلى 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

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

get

 تحصل على SelectedRoute كما هو محدّد باسمه.

list

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

patch

 تعديل SelectedRoute كما هو محدّد باسمه