Package google.maps.roads.selection.v1

الفهرس

RoadsSelection

تعريف الخدمة لواجهة برمجة التطبيقات Roads Selection API

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

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

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

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

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

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

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

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

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

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

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

BatchCreateSelectedRoutesRequest

طلب إنشاء عدة SelectedRoute

الحقول
parent

string

اختياريّ. تمثّل هذه السمة مورد المشروع الذي تشترك فيه جميع الطرق المحدّدة. التنسيق: projects/{project} في حال ضبط هذا الحقل، يجب أن يكون الحقل الأصل في رسائل CreateSelectedRouteRequest فارغًا أو مطابقًا لهذا الحقل.
requests[]

CreateSelectedRouteRequest

مطلوب. رسالة الطلب التي تحدّد المسار المحدّد المطلوب إنشاؤه يمكن إنشاء 1,000 مسار محدّد كحدّ أقصى في حزمة واحدة.

BatchCreateSelectedRoutesResponse

الردّ من إنشاء عدة SelectedRoute.

الحقول
selected_routes[]

SelectedRoute

تم إنشاء SelectedRoutes.

CreateSelectedRouteRequest

طلب إنشاء SelectedRoute

الحقول
parent

string

مطلوب. المشروع الذي سيتم إنشاء SelectedRoute ضمنه التنسيق: projects/{project}
selected_route

SelectedRoute

مطلوب. SelectedRoute المطلوب إنشاؤه
selected_route_id

string

اختياريّ. المعرّف الذي سيتم استخدامه في SelectedRoute، والذي سيصبح المكوّن الأخير من اسم المورد SelectedRoute.

يجب أن تتراوح هذه القيمة بين 4 و63 حرفًا، ويجب أن تكون الأحرف صالحة، أي "a-z" أو "A-Z" أو "0-9" أو "-". وفي حال عدم توفيرها أو كانت فارغة، سيتم إنشاء معرّف فريد عالميًا (UUID) بعد إنشاء المورد.

DeleteSelectedRouteRequest

طلب حذف SelectedRoute

الحقول
name

string

مطلوب. اسم SelectedRoute المطلوب حذفه. التنسيق: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

طلب الحصول على SelectedRoute

الحقول
name

string

مطلوب. تمثّل هذه السمة اسم SelectedRoute المطلوب استرداده. التنسيق: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

طلب إدراج SelectedRoute

الحقول
parent

string

مطلوب. العنصر الرئيسي، وهو المشروع الذي سيتم البحث فيه عن جميع SelectedRoute. التنسيق: projects/{project}/selectedRoutes
page_size

int32

اختياريّ. عدد النتائج التي يجب عرضها لصفحة معيّنة. إذا لم يتم ضبط القيمة، ستكون القيمة التلقائية 100. عند إدخال القيمة 0، سيتم ضبط القيمة على القيمة التلقائية. الحد الأقصى للقيمة هو 5,000، وسيتم ضبط أي قيمة أعلى من 5,000 على 5,000.
page_token

string

اختياريّ. رمز مميز للصفحة تم تلقّيه من طلب ListSelectedRoutes سابق.

ListSelectedRoutesResponse

ردّ يتضمّن قائمة SelectedRoute.

الحقول
selected_routes[]

SelectedRoute

صفحة SelectedRoutes مخزّنة في المشروع المحدّد في الطلب
next_page_token

string

الرمز المميّز الذي يمكن إرساله كـ page_token لاسترداد الصفحة التالية. إذا كان هذا الحقل فارغًا، يعني ذلك أنّه لا توجد صفحات لاحقة.

SelectedRoute

يمثّل SelectedRoute مسارًا محدّدًا يريد العميل استرداد المعلومات منه بشكل دوري (مثل المدة) لحالات الاستخدام المتفق عليها.

الحقول
name

string

المعرّف اسم المورد SelectedRoute.

التنسيق: projects/{project}/selectedRoutes/{selected_route}
display_name

string

اختياريّ. الاسم المعروض للمسار هذا حقل اختياري يمكن للعميل استخدامه. ليس من الضروري أن يكون فريدًا.
create_time

Timestamp

النتائج فقط. الوقت الذي تم فيه إنشاء المسار المحدّد لأول مرة
state

State

النتائج فقط. حالة المسار المحدّد
route_attributes

map<string, string>

اختياريّ. السمات المخصّصة للمسار المحدّد يسمح إضافتها بتصفية المسارات أو تجميعها عند استرداد معلومات المسارات السابقة وفي الوقت الفعلي. يمكن إضافة ما يصل إلى 10 سمات لكل مسار. يجب أن يكون كل مفتاح وقيمة عبارة عن سلسلة غير فارغة ويمكن أن تحتوي على ما يصل إلى 100 حرف. يجب ألا تبدأ المفاتيح بـ "goog".
حقل الدمج route_type لا تتوفّر حاليًا سوى القيمة DynamicRoute. يمكن أن تكون route_type إحدى القيم التالية فقط:
dynamic_route

DynamicRoute

‫SelectedRoute هو مسار ديناميكي.
validation_error

ValidationError

النتائج فقط. خطأ التحقّق من الصحة للمسار المحدّد عندما تكون الحالة STATE_INVALID

DynamicRoute

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

الحقول
origin

LatLng

مطلوب. الموقع الجغرافي لنقطة انطلاق المسار
destination

LatLng

مطلوب. الموقع الجغرافي النهائي للمسار
intermediates[]

LatLng

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

الحالة

حالة المسار المحدّد

عمليات التعداد
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 المسار لا يشهد حركة مرور كبيرة (يمرّ به عدد قليل جدًا من الأشخاص).