الفهرس
DeliveryService
(واجهة)BatchCreateTasksRequest
(رسالة)BatchCreateTasksResponse
(رسالة)CreateDeliveryVehicleRequest
(رسالة)CreateTaskRequest
(رسالة)DeleteDeliveryVehicleRequest
(رسالة)DeleteTaskRequest
(رسالة)DeliveryRequestHeader
(رسالة)DeliveryRequestHeader.Platform
(تعداد)DeliveryRequestHeader.SdkType
(تعداد)DeliveryVehicle
(رسالة)DeliveryVehicle.DeliveryVehicleType
(تعداد)DeliveryVehicleAttribute
(رسالة)DeliveryVehicleLocation
(رسالة)DeliveryVehicleLocationSensor
(تعداد)DeliveryVehicleNavigationStatus
(تعداد)GetDeliveryVehicleRequest
(رسالة)GetTaskRequest
(رسالة)GetTaskTrackingInfoRequest
(رسالة)ListDeliveryVehiclesRequest
(رسالة)ListDeliveryVehiclesResponse
(رسالة)ListTasksRequest
(رسالة)ListTasksResponse
(رسالة)LocationInfo
(رسالة)LocationInfo.PointSource
(تعداد)Task
(رسالة)Task.JourneySharingInfo
(رسالة)Task.State
(تعداد)Task.TaskOutcome
(تعداد)Task.TaskOutcomeLocationSource
(تعداد)Task.Type
(تعداد)TaskAttribute
(رسالة)TaskTrackingInfo
(رسالة)TaskTrackingViewConfig
(رسالة)TaskTrackingViewConfig.VisibilityOption
(رسالة)TimeWindow
(رسالة)UpdateDeliveryVehicleRequest
(رسالة)UpdateTaskRequest
(رسالة)VehicleJourneySegment
(رسالة)VehicleStop
(رسالة)VehicleStop.State
(تعداد)VehicleStop.TaskInfo
(رسالة)
DeliveryService
خدمة توصيل الميل الأخير
BatchCreateTasks |
---|
تنشئ هذه الطريقة مجموعة من عناصر |
CreateDeliveryVehicle |
---|
تنشئ هذه الطريقة |
CreateTask |
---|
تنشئ هذه الدالة كائن |
DeleteDeliveryVehicle |
---|
تحذف هذه الطريقة DeliveryVehicle من Fleet Engine. تعرض هذه الحالة FAILED_PRECONDITION إذا كانت DeliveryVehicle تتضمّن مهام OPEN تم تعيينها لها. |
DeleteTask |
---|
تحذف هذه الطريقة مهمة واحدة. تعرض FAILED_PRECONDITION إذا كانت المهمة OPEN وتم تعيينها إلى DeliveryVehicle. |
GetDeliveryVehicle |
---|
تعرض هذه الدالة مثيل |
GetTask |
---|
تعرض هذه الطريقة معلومات حول |
GetTaskTrackingInfo |
---|
تعرض هذه الدالة مثيل |
ListDeliveryVehicles |
---|
تعرض هذه الطريقة جميع |
ListTasks |
---|
تعرض هذه الطريقة جميع |
UpdateDeliveryVehicle |
---|
يكتب هذا الإذن بيانات |
UpdateTask |
---|
تعديل بيانات |
BatchCreateTasksRequest
رسالة طلب BatchCreateTask
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي ملاحظة: في حال ضبط هذا الحقل، يجب أن يكون حقل العنوان في رسائل |
parent |
مطلوب. المورد الرئيسي الذي تشترك فيه جميع المهام يجب أن تكون هذه القيمة بالتنسيق |
requests[] |
مطلوب. رسالة الطلب التي تحدّد الموارد المطلوب إنشاؤها. ملاحظة: يمكنك إنشاء 500 مهمة كحد أقصى في دفعة واحدة. |
BatchCreateTasksResponse
رسالة الرد BatchCreateTask
الحقول | |
---|---|
tasks[] |
المهام التي تم إنشاؤها |
CreateDeliveryVehicleRequest
رسالة طلب CreateDeliveryVehicle
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي |
parent |
مطلوب. يجب أن يكون بالتنسيق |
delivery_vehicle_id |
مطلوب. يجب أن يكون معرّف مركبة التوصيل فريدًا ويخضع للقيود التالية:
|
delivery_vehicle |
مطلوب. تمثّل هذه السمة عنصر
ملاحظة: يتم تجاهل الحقل |
CreateTaskRequest
رسالة طلب CreateTask
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي |
parent |
مطلوب. يجب أن يكون بالتنسيق |
task_id |
مطلوب. يجب أن يكون معرّف المهمة فريدًا، ولكن يجب ألا يكون معرّف تتبُّع شحنة. لتخزين رقم تعريف تتبُّع شحنة، استخدِم الحقل
|
task |
مطلوب. تمثّل هذه السمة مهمة سيتم إنشاؤها. عند إنشاء مهمة، يجب ملء الحقول التالية:
يمكن ضبط الحقول التالية بشكل اختياري:
ملاحظة: يتم تجاهل الحقل |
DeleteDeliveryVehicleRequest
رسالة طلب DeleteDeliveryVehicle
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي |
name |
مطلوب. يجب أن يكون بالتنسيق |
DeleteTaskRequest
رسالة طلب DeleteTask
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي |
name |
مطلوب. يجب أن يكون بالتنسيق |
DeliveryRequestHeader
يحتوي RequestHeader على حقول مشتركة بين جميع طلبات Delivery RPC.
الحقول | |
---|---|
language_code |
تمثّل هذه السمة رمز اللغة وفق معيار BCP-47، مثل en-US أو sr-Latn. لمزيد من المعلومات، يُرجى الانتقال إلى http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. في حال عدم تحديد أي لغة، قد يكون الرد بأي لغة، مع تفضيل اللغة الإنجليزية إذا كان الاسم متوفّرًا بها. مثال على قيمة الحقل: |
region_code |
مطلوب. رمز CLDR للمنطقة التي ينشأ منها الطلب مثال على قيمة الحقل: |
sdk_version |
تمثّل هذه السمة إصدار حزمة تطوير البرامج (SDK) الخاصة بالمكالمات، إذا كان ذلك منطبقًا. تنسيق الإصدار هو "major.minor.patch"، مثال: |
os_version |
إصدار نظام التشغيل الذي تعمل عليه حزمة تطوير البرامج (SDK) الخاصة بالمكالمات أمثلة على قيم الحقول: |
device_model |
طراز الجهاز الذي يتم تشغيل حزمة تطوير البرامج (SDK) الخاصة بالمكالمات عليه أمثلة على قيم الحقول: |
sdk_type |
نوع حزمة SDK التي ترسل الطلب |
maps_sdk_version |
تمثّل هذه السمة إصدار MapSDK الذي تعتمد عليه حزمة SDK التي يتم استدعاؤها، إذا كان ذلك منطبقًا. تنسيق الإصدار هو "major.minor.patch"، مثال: |
nav_sdk_version |
إصدار NavSDK الذي تعتمد عليه حزمة SDK التي يتم استدعاؤها، إذا كان ذلك منطبقًا تنسيق الإصدار هو "major.minor.patch"، مثال: |
platform |
النظام الأساسي لحزمة تطوير البرامج (SDK) التي يتم استدعاؤها |
manufacturer |
الشركة المصنّعة لجهاز Android الذي يتم إرسال الطلب منه إلى حزمة SDK، وينطبق ذلك فقط على حِزم SDK لنظام Android. مثال على قيمة الحقل: |
android_api_level |
مستوى واجهة برمجة تطبيقات Android لحزمة SDK التي يتم استدعاؤها، وينطبق ذلك فقط على حِزم Android SDK. مثال على قيمة الحقل: |
trace_id |
معرّف اختياري يمكن تقديمه لأغراض التسجيل من أجل تحديد الطلب. |
النظام الأساسي
النظام الأساسي لحزمة SDK التي يتم استدعاؤها
عمليات التعداد | |
---|---|
PLATFORM_UNSPECIFIED |
القيمة التلقائية يتم استخدام هذه القيمة إذا تم استبعاد المنصة. |
ANDROID |
الطلب وارد من جهاز Android. |
IOS |
الطلب صادر من جهاز iOS. |
WEB |
الطلب وارد من الويب. |
SdkType
الأنواع المحتملة لحِزم تطوير البرامج (SDK)
عمليات التعداد | |
---|---|
SDK_TYPE_UNSPECIFIED |
القيمة التلقائية يتم استخدام هذه القيمة في حال حذف sdk_type . |
CONSUMER |
حزمة تطوير البرامج (SDK) الخاصة بالمكالمات هي Consumer. |
DRIVER |
حزمة تطوير البرامج (SDK) التي يتم استدعاؤها هي Driver. |
JAVASCRIPT |
حزمة تطوير البرامج (SDK) المستخدَمة في الاتصال هي JavaScript. |
DeliveryVehicle
رسالة DeliveryVehicle
تنقل مركبة التسليم الشحنات من مستودع إلى موقع التسليم، ومن موقع الاستلام إلى المستودع. في بعض الحالات، تنقل مركبات التسليم أيضًا الشحنات مباشرةً من موقع الاستلام إلى موقع التسليم.
ملاحظة: تستخدم واجهات برمجة التطبيقات gRPC وREST قواعد تسمية مختلفة للحقول. على سبيل المثال، يشير الحقل DeliveryVehicle.current_route_segment
في gRPC API والحقل DeliveryVehicle.currentRouteSegment
في REST API إلى الحقل نفسه.
الحقول | |
---|---|
name |
الاسم الفريد لمركبة التوصيل هذه. التنسيق هو |
last_location |
آخر موقع جغرافي تم الإبلاغ عنه لمركبة التوصيل |
past_locations[] |
الإدخال فقط المواقع الجغرافية التي كانت فيها "مركبة التوصيل" هذه في السابق ولم يتم إبلاغ Fleet Engine بها بعد يتم استخدام هذا الحقل في |
navigation_status |
حالة التنقّل لمركبة التوصيل |
current_route_segment |
الخط المتعدد المشفّر الذي يحدّد المسار الذي تنصح خدمة التنقّل باتّباعه للوصول إلى نقطة الطريق التالية. يعدّل تطبيق السائق هذه المعلومات عند الوصول إلى محطة أو تجاوزها، وعندما يتم تغيير مسار التنقّل. يتم عرض هناك بعض الحالات التي قد لا يتم فيها استخدام هذا الحقل لتعبئة
في هذه الحالات، تملأ Fleet Engine هذا الحقل بمسار من VehicleStop الذي تمّت زيارته مؤخرًا إلى VehicleStop القادم لضمان حصول مستهلك هذا الحقل على أفضل المعلومات المتاحة عن المسار الحالي لـ "مركبة التوصيل". |
current_route_segment_end_point |
تمثّل هذه السمة الموقع الجغرافي الذي تنتهي عنده يتم تجاهل هذا الحقل في طلبات |
remaining_distance_meters |
المسافة المتبقية للقيادة في يتجاهل Fleet Engine هذا الحقل في |
remaining_duration |
الوقت المتبقي للقيادة في يتجاهل Fleet Engine هذا الحقل في |
remaining_vehicle_journey_segments[] |
شرائح الرحلة المخصّصة لمركبة التوصيل هذه، بدءًا من آخر موقع جغرافي تم الإبلاغ عنه للمركبة لن تتم تعبئة هذا الحقل في ردّ |
attributes[] |
قائمة بسمات مركبة التوصيل المخصّصة. يمكن أن تحتوي "مركبة التوصيل" على 100 سمة كحدّ أقصى، ويجب أن تحتوي كل سمة على مفتاح فريد. |
type |
تمثّل هذه السمة نوع مركبة التوصيل. إذا لم يتم ضبط هذا الخيار، سيتم ضبطه تلقائيًا على |
DeliveryVehicleType
نوع مركبة التوصيل
عمليات التعداد | |
---|---|
DELIVERY_VEHICLE_TYPE_UNSPECIFIED |
القيمة غير مستخدَمة. |
AUTO |
سيارة |
TWO_WHEELER |
دراجة نارية أو دراجة بخارية أو أي مركبة أخرى ذات عجلتين |
BICYCLE |
وسائل النقل التي تعمل بالطاقة البشرية |
PEDESTRIAN |
هي وسيلة نقل بشرية، وعادةً ما تكون عبارة عن شخص يمشي أو يركض على طول ممرات المشاة. |
DeliveryVehicleAttribute
تصف هذه السمة إحدى سمات المركبة كزوج من المفتاح والقيمة. يجب ألا يتجاوز طول السلسلة "key:value" 256 حرفًا.
الحقول | |
---|---|
key |
مفتاح السمة |
value |
قيمة السمة |
حقل الدمج delivery_vehicle_attribute_value يمكن أن تكون قيمة السمة من النوع string أو bool أو double. يمكن أن تكون delivery_vehicle_attribute_value إحدى القيم التالية فقط: |
|
string_value |
قيمة السمة من النوع "سلسلة" ملاحظة: هذا الحقل مطابق للحقل |
bool_value |
قيمة السمة من النوع المنطقي |
number_value |
قيمة السمة من النوع Double |
DeliveryVehicleLocation
الموقع الجغرافي والسرعة والاتجاه لمركبة في وقت معيّن
الحقول | |
---|---|
location |
تمثّل هذه السمة الموقع الجغرافي للمركبة. عند إرسالها إلى Fleet Engine، يكون الموقع الجغرافي للمركبة هو موقع جغرافي لنظام تحديد المواقع العالمي (GPS). عندما تتلقّى الموقع الجغرافي للمركبة في ردّ، يمكن أن يكون الموقع الجغرافي إما موقعًا جغرافيًا لنظام تحديد المواقع العالمي (GPS) أو موقعًا جغرافيًا إضافيًا أو موقعًا جغرافيًا مقدَّرًا آخر. يتم تحديد المصدر في |
horizontal_accuracy |
تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة |
latlng_accuracy |
دقة |
heading |
اتجاه تحرّك المركبة بالدرجات يمثّل الرقم 0 الشمال. النطاق الصالح هو [0,360). |
bearing_accuracy |
تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة |
heading_accuracy |
دقة |
altitude |
الارتفاع بالأمتار فوق نظام WGS84 |
vertical_accuracy |
تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة |
altitude_accuracy |
دقة تبلغ |
speed_kmph |
تمثّل هذه السمة سرعة المركبة بالكيلومتر في الساعة. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة |
speed |
سرعة المركبة بالمتر في الثانية |
speed_accuracy |
دقة |
update_time |
الوقت الذي سجّله جهاز الاستشعار |
server_time |
النتائج فقط. الوقت الذي تلقّى فيه الخادم معلومات الموقع الجغرافي |
location_sensor |
مزوّد بيانات الموقع الجغرافي (مثل |
is_road_snapped |
تُستخدَم لتحديد ما إذا كان |
is_gps_sensor_enabled |
الإدخال فقط يشير إلى ما إذا كان مستشعر نظام تحديد المواقع العالمي (GPS) مفعَّلاً على الجهاز الجوّال. |
time_since_update |
الإدخال فقط الوقت (بالثواني) منذ أن تم إرسال هذا الموقع الجغرافي إلى الخادم لأول مرة. سيكون هذا الرقم صفرًا عند إجراء التحديث الأول. إذا كان الوقت غير معروف (على سبيل المثال، عند إعادة تشغيل التطبيق)، تتم إعادة ضبط هذه القيمة إلى صفر. |
num_stale_updates |
الإدخال فقط تم إيقافها نهائيًا: يتم الآن استخدام إشارات أخرى لتحديد ما إذا كان الموقع الجغرافي قديمًا. |
raw_location |
الموقع الجغرافي الأولي للمركبة (لم تتم معالجته بواسطة أداة ربط المواقع الجغرافية بالطرق) |
raw_location_time |
الطابع الزمني المرتبط بالموقع الجغرافي الأوّلي |
raw_location_sensor |
مصدر الموقع الجغرافي الأوّلي القيمة التلقائية هي |
raw_location_accuracy |
تمثّل هذه السمة دقة |
flp_location |
الموقع الجغرافي من ميزة "موفِّر الموقع المدمج" من Android |
flp_update_time |
الطابع الزمني لتعديل |
flp_latlng_accuracy_meters |
دقة |
flp_heading_degrees |
الاتجاه الذي تتحرّك فيه المركبة بالدرجات، كما يحدّده "موفِّر الموقع المدمج" يمثّل الرقم 0 الشمال. النطاق الصالح هو [0,360). |
supplemental_location |
الموقع الجغرافي التكميلي الذي يوفّره التطبيق المتكامل |
supplemental_location_time |
الطابع الزمني المرتبط بالموقع الجغرافي الإضافي |
supplemental_location_sensor |
مصدر الموقع الجغرافي الإضافي القيمة التلقائية هي |
supplemental_location_accuracy |
تمثّل هذه السمة دقة |
road_snapped |
تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة |
DeliveryVehicleLocationSensor
أداة الاستشعار أو المنهجية المستخدَمة لتحديد الموقع الجغرافي
عمليات التعداد | |
---|---|
UNKNOWN_SENSOR |
جهاز الاستشعار غير محدّد أو غير معروف. |
GPS |
نظام تحديد المواقع العالمي (GPS) أو نظام GPS المساعد |
NETWORK |
نظام تحديد المواقع العالمي (GPS) بمساعدة الأقمار الصناعية أو رقم تعريف برج الاتصالات أو نقطة وصول Wi-Fi |
PASSIVE |
معرّف برج خلوي أو نقطة وصول Wi-Fi |
ROAD_SNAPPED_LOCATION_PROVIDER |
موقع جغرافي يحدّده الجهاز الجوّال ليكون الموضع الأرجح على الطريق. |
CUSTOMER_SUPPLIED_LOCATION |
موقع جغرافي يقدّمه العميل من مصدر مستقل يتم عادةً استخدام هذه القيمة للموقع الجغرافي المقدَّم من مصادر أخرى غير الجهاز الجوّال الذي يتم تشغيل Driver SDK عليه. إذا كان المصدر الأصلي موصوفًا بإحدى قيم التعداد الأخرى، استخدِم تلك القيمة. يتم عادةً توفير المواقع الجغرافية التي تحمل العلامة CUSTOMER_SUPPLIED_LOCATION من خلال last_location.supplemental_location_sensor في DeliveryVehicle. |
FLEET_ENGINE_LOCATION |
موقع جغرافي تحسبه Fleet Engine استنادًا إلى الإشارات المتاحة لها. النتائج فقط. سيتم رفض هذه القيمة إذا تم تلقّيها في طلب. |
FUSED_LOCATION_PROVIDER |
ميزة "موفِّر الموقع المدمج" من Android |
CORE_LOCATION |
مقدّم خدمة تحديد الموقع الجغرافي على أنظمة تشغيل Apple |
GetDeliveryVehicleRequest
رسالة طلب GetDeliveryVehicle
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي |
name |
مطلوب. يجب أن يكون بالتنسيق |
GetTaskRequest
رسالة طلب GetTask
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي |
name |
مطلوب. يجب أن يكون بالتنسيق |
GetTaskTrackingInfoRequest
رسالة طلب GetTaskTrackingInfoRequest
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي |
name |
مطلوب. يجب أن يكون بالتنسيق |
ListDeliveryVehiclesRequest
رسالة طلب ListDeliveryVehicles
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي |
parent |
مطلوب. يجب أن يكون بالتنسيق |
page_size |
اختياريّ. الحدّ الأقصى لعدد المركبات المطلوب عرضه. قد تعرض الخدمة عددًا أقل من هذا الرقم. إذا لم تحدّد هذا الرقم، سيحدّد الخادم عدد النتائج التي سيتم عرضها. |
page_token |
اختياريّ. رمز مميز للصفحة تم تلقّيه من طلب عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى |
filter |
اختياريّ. طلب بحث فلتر يتم تطبيقه عند عرض قائمة بمركبات التوصيل. يمكنك الاطّلاع على http://aip.dev/160 للحصول على أمثلة على بنية الفلتر. إذا لم تحدّد قيمة، أو إذا حدّدت سلسلة فارغة للفلتر، سيتم عرض جميع وسائل النقل. يُرجى العِلم أنّ طلبات البحث الوحيدة المتوافقة مع الحدّ الأقصى لعدد القيود المسموح بها في طلب فلترة هو 50. القيد هو جزء من طلب البحث بالتنسيق |
viewport |
اختياريّ. فلتر يقتصر على المركبات التي كان آخر موقع جغرافي معروف لها في المنطقة المستطيلة المحدّدة بواسطة إطار العرض. |
ListDeliveryVehiclesResponse
رسالة الرد ListDeliveryVehicles
الحقول | |
---|---|
delivery_vehicles[] |
مجموعة مركبات التوصيل التي تستوفي معايير الفلترة المطلوبة. عند عدم تحديد أي فلتر، يعرض الطلب جميع مركبات التوصيل. يمكن أن تكون الاستجابة الناجحة فارغة أيضًا. تشير الاستجابة الفارغة إلى أنّه لم يتم العثور على أي مركبات توصيل تستوفي معايير الفلتر المطلوبة. |
next_page_token |
يمكنك تمرير الرمز المميّز في |
total_size |
العدد الإجمالي لمركبات التوصيل التي تتطابق مع معايير الطلب، وذلك على مستوى جميع الصفحات |
ListTasksRequest
رسالة طلب ListTasks
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي |
parent |
مطلوب. يجب أن يكون بالتنسيق |
page_size |
اختياريّ. الحدّ الأقصى لعدد المهام المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم تحدّد هذه القيمة، سيحدّد الخادم عدد النتائج المطلوب عرضها. |
page_token |
اختياريّ. رمز مميز للصفحة تم تلقّيه من طلب عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى |
filter |
اختياريّ. طلب فلترة يتم تطبيقه عند إدراج المهام. يمكنك الاطّلاع على http://aip.dev/160 للحصول على أمثلة على بنية الفلتر. إذا لم تحدّد قيمة، أو إذا كنت تريد الفلترة حسب سلسلة فارغة، سيتم عرض جميع المهام. للحصول على معلومات حول خصائص "مهام Google" التي يمكنك الفلترة حسبها، اطّلِع على عرض قائمة بالمهام. |
ListTasksResponse
الاستجابة ListTasks
التي تحتوي على مجموعة المهام التي تستوفي معايير الفلتر في ListTasksRequest
الحقول | |
---|---|
tasks[] |
مجموعة المهام التي تستوفي معايير الفلترة المطلوبة. عند عدم تحديد أي فلتر، يعرض الطلب جميع المهام. يمكن أن تكون الاستجابة الناجحة فارغة أيضًا. تشير الاستجابة الفارغة إلى أنّه لم يتم العثور على أي مهام تستوفي معايير الفلتر المطلوبة. |
next_page_token |
يجب تمرير الرمز المميّز في |
total_size |
العدد الإجمالي للمهام التي تتطابق مع معايير الطلب، وذلك على مستوى جميع الصفحات |
LocationInfo
موقع جغرافي يتضمّن أي معرّفات إضافية
الحقول | |
---|---|
point |
تمثّل هذه السمة إحداثيات الموقع الجغرافي. يجب تحديد |
place |
اسم مصدر المكان الذي يمثّل هذا الموقع الجغرافي. التنسيق هو هذه ميزة تجريبية. |
point_location_source |
النتائج فقط. مصدر الحقل latlng |
PointSource
تشير هذه السمة إلى مصدر LatLng
.
عمليات التعداد | |
---|---|
POINT_SOURCE_UNSPECIFIED |
لم يتم تحديد مصدر النقطة. |
POINT_SOURCE_DEVELOPER_PROVIDED |
تم تقديم LatLng بشكل صريح من قِبل المطوّر. |
POINT_SOURCE_CALCULATED_FROM_PLACE |
تم احتساب LatLng من المكان المقدَّم. |
المهمة
تمثّل المهمة في Delivery API إجراءً واحدًا يجب تتبُّعه. بشكل عام، هناك فرق بين المهام المرتبطة بالشحنات ومهام الاستراحة. يمكن أن تتضمّن الشحنة مهام متعددة مرتبطة بها. على سبيل المثال، يمكن أن تكون هناك مهمة واحدة للاستلام وأخرى للتسليم أو النقل. بالإضافة إلى ذلك، يمكن أن تتولّى مركبات مختلفة تنفيذ مهام مختلفة لشحنة معيّنة. على سبيل المثال، يمكن أن تتولّى مركبة واحدة عملية الاستلام ونقل الشحنة إلى المركز، بينما تتولّى مركبة أخرى نقل الشحنة نفسها من المركز إلى موقع التسليم.
ملاحظة: تستخدم واجهات برمجة التطبيقات gRPC وREST قواعد تسمية مختلفة للحقول. على سبيل المثال، يشير الحقل Task.journey_sharing_info
في gRPC API والحقل Task.journeySharingInfo
في REST API إلى الحقل نفسه.
الحقول | |
---|---|
name |
يجب أن يكون بالتنسيق |
type |
مطلوب. غير قابل للتغيير تحدّد هذه السمة نوع المهمة. على سبيل المثال، استراحة أو شحنة. |
state |
مطلوب. تمثّل هذه السمة حالة التنفيذ الحالية للمَهمّة. |
task_outcome |
نتيجة المهمة |
task_outcome_time |
الطابع الزمني الذي يشير إلى وقت ضبط نتيجة |
task_outcome_location |
تمثّل هذه السمة الموقع الجغرافي الذي تم فيه ضبط نتيجة |
task_outcome_location_source |
تشير إلى مصدر قيمة |
tracking_id |
غير قابل للتغيير يسهّل هذا الحقل تخزين معرّف حتى تتمكّن من تجنُّب استخدام عملية ربط معقّدة. لا يمكنك ضبط
|
delivery_vehicle_id |
النتائج فقط. معرّف المركبة التي تنفّذ هذه المهمة تخضع معرّفات مركبات التوصيل للقيود التالية:
|
planned_location |
غير قابل للتغيير الموقع الجغرافي الذي سيتم فيه إكمال المهمة اختيارية في |
task_duration |
مطلوب. غير قابل للتغيير الوقت اللازم لتنفيذ مهمة في هذا الموقع الجغرافي |
target_time_window |
الفترة الزمنية التي يجب إكمال المهمة خلالها |
journey_sharing_info |
النتائج فقط. الحقول الخاصة بميزة "مشاركة الرحلات" لا تتم تعبئة هذا الحقل عندما تكون الحالة |
task_tracking_view_config |
إعدادات تتبُّع المهام التي تحدّد عناصر البيانات المرئية للمستخدمين النهائيين في ظلّ ظروف معيّنة |
attributes[] |
قائمة بسمات المهام المخصّصة. يجب أن تتضمّن كل سمة مفتاحًا فريدًا. |
JourneySharingInfo
الحقول المحدّدة لميزة "مشاركة الرحلة"
الحقول | |
---|---|
remaining_vehicle_journey_segments[] |
معلومات التتبُّع للمحطات التي ستتوقف عندها المركبة المخصّصة قبل إكمال هذه المهمة يُرجى العِلم أنّ هذه القائمة يمكن أن تحتوي على محطات من مهام أخرى. يحتوي الجزء الأول، |
last_location |
تشير هذه السمة إلى آخر موقع جغرافي تم الإبلاغ عنه للمركبة المخصّصة. |
last_location_snappable |
توضّح هذه السمة ما إذا كان يمكن ضبط آخر موقع جغرافي للمركبة على |
الحالة
تمثّل هذه السمة حالة المهمة. تشير هذه السمة إلى مستوى تقدّم المهمة.
عمليات التعداد | |
---|---|
STATE_UNSPECIFIED |
تلقائي: تُستخدَم لحالة مهمة غير محدَّدة أو غير معروفة. |
OPEN |
إما أنّ المهمة لم يتم تعيينها بعد إلى مركبة توصيل، أو أنّ مركبة التوصيل لم تتجاوز بعد محطة المركبة المخصّصة Task . |
CLOSED |
عندما تمرّ المركبة بموقف المركبات لهذه المهمة |
TaskOutcome
نتيجة محاولة تنفيذ مهمة. عندما تكون قيمة TaskState
هي "خطأ"، تشير TaskOutcome
إلى ما إذا كان قد تمّ إكمال المستوى بنجاح أم لا.
عمليات التعداد | |
---|---|
TASK_OUTCOME_UNSPECIFIED |
نتيجة المهمة قبل ضبط قيمتها |
SUCCEEDED |
اكتملت المهمة بنجاح. |
FAILED |
تعذّر إكمال المهمة أو تم إلغاؤها. |
TaskOutcomeLocationSource
تمثّل هذه السمة هوية المصدر الذي تمّت منه تعبئة task_outcome_location
.
عمليات التعداد | |
---|---|
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED |
نتيجة المهمة قبل ضبطها |
PROVIDER |
حدّد موفِّر الخدمة task_outcome_location . |
LAST_VEHICLE_LOCATION |
لم يحدّد مقدّم الخدمة قيمة task_outcome_location ، لذا استخدمت Fleet Engine آخر موقع جغرافي معروف للمركبة. |
النوع
نوع المهمة.
عمليات التعداد | |
---|---|
TYPE_UNSPECIFIED |
تكون قيمة نوع المهمة تلقائيًا غير معروفة. |
PICKUP |
مهمة الاستلام هي الإجراء المتّخذ لاستلام شحنة من عميل. يجب استخدام النوع SCHEDULED_STOP لعمليات الاستلام من المستودع أو مركبة التوصيل. |
DELIVERY |
مهمة التسليم هي الإجراء المتّخذ لتسليم شحنة إلى عميل نهائي. يجب استخدام النوع SCHEDULED_STOP لعمليات التسليم في المستودعات أو المركبات المزوّدة. |
SCHEDULED_STOP |
يتم استخدام مهمة التوقف المُجدوَلة لأغراض التخطيط. على سبيل المثال، يمكن أن يمثّل استلام الشحنات أو تسليمها من مركبات أو مستودعات التغذية. يجب عدم استخدامها لأي شحنات يتم استلامها أو تسليمها من عميل نهائي. |
UNAVAILABLE |
مهمة تعني أنّ المركبة غير متاحة للخدمة على سبيل المثال، يمكن أن يحدث ذلك عندما يأخذ السائق استراحة أو عندما يتم تزويد المركبة بالوقود. |
TaskAttribute
تصف هذه السمة سمة مهمة كزوج مفتاح/قيمة. يجب ألا يتجاوز طول السلسلة "key:value" 256 حرفًا.
الحقول | |
---|---|
key |
مفتاح السمة يجب ألا تحتوي المفاتيح على رمز النقطتين الرأسيتين (:). |
حقل الدمج task_attribute_value يمكن أن تكون قيمة السمة من النوع string أو bool أو double. إذا لم يتم ضبط أي منها، سيتم تخزين TaskAttribute string_value كسلسلة فارغة "". يمكن أن يكون task_attribute_value أحد ما يلي فقط: |
|
string_value |
قيمة السمة من النوع "سلسلة" |
bool_value |
قيمة السمة من النوع المنطقي |
number_value |
قيمة السمة من النوع Double |
TaskTrackingInfo
رسالة TaskTrackingInfo
تحتوي الرسالة على معلومات تتبُّع المهام التي سيتم استخدامها للعرض. إذا كان معرّف التتبُّع مرتبطًا بمهام متعددة، تستخدم Fleet Engine طريقة إرشادية لتحديد TaskTrackingInfo التي يجب اختيارها.
الحقول | |
---|---|
name |
يجب أن يكون بالتنسيق |
tracking_id |
غير قابل للتغيير رقم تعريف التتبّع الخاص بمهمة. * يجب أن تكون سلسلة Unicode صالحة. * يجب ألا يتجاوز طولها 64 حرفًا. * تمّت تسويته وفقًا لنموذج التسوية C في Unicode. * يجب ألّا يحتوي على أي من أحرف ASCII التالية: "/" أو ":" أو "؟" أو "," أو "#". |
vehicle_location |
تمثّل هذه السمة آخر موقع جغرافي للمركبة. |
route_polyline_points[] |
قائمة بالنقاط التي تشكّل عند ربطها خطًا متعدد الأضلاع يمثّل المسار المتوقّع للمركبة إلى الموقع الجغرافي لهذه المهمة. |
remaining_stop_count |
تشير إلى عدد المحطات المتبقية للمركبة إلى أن يتم الوصول إلى محطة المهمة، بما في ذلك محطة المهمة. على سبيل المثال، إذا كانت المحطة التالية للمركبة هي محطة المهمة، ستكون القيمة 1. |
remaining_driving_distance_meters |
إجمالي المسافة المتبقية بالأمتار إلى |
estimated_arrival_time |
الطابع الزمني الذي يشير إلى الوقت المقدَّر للوصول إلى موقع المحطة |
estimated_task_completion_time |
الطابع الزمني الذي يشير إلى الوقت المُقدَّر لإكمال مهمة. |
state |
تمثّل هذه السمة حالة التنفيذ الحالية للمَهمّة. |
task_outcome |
نتيجة محاولة تنفيذ مهمة. |
task_outcome_time |
الطابع الزمني الذي يشير إلى وقت تحديد نتيجة المهمة من قِبل مقدّم الخدمة |
planned_location |
غير قابل للتغيير الموقع الجغرافي الذي سيتم فيه إكمال المهمة |
target_time_window |
الفترة الزمنية التي يجب إكمال المهمة خلالها |
attributes[] |
السمات المخصّصة التي تم ضبطها على المهمة |
TaskTrackingViewConfig
رسالة الإعداد التي تحدّد الوقت الذي يجب أن يكون فيه عنصر بيانات "المهمة" مرئيًا للمستخدمين النهائيين.
الحقول | |
---|---|
route_polyline_points_visibility |
الحقل الذي يحدّد متى يمكن أن تظهر نقاط الخط المتعدد للمسار. في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات مستوى العرض التلقائي على مستوى المشروع لهذه البيانات. |
estimated_arrival_time_visibility |
الحقل الذي يحدّد الوقت الذي يمكن فيه عرض الوقت المقدَّر للوصول في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات مستوى العرض التلقائي على مستوى المشروع لهذه البيانات. |
estimated_task_completion_time_visibility |
الحقل الذي يحدّد الوقت الذي يمكن فيه عرض الوقت المقدَّر لإنجاز المهمة في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات مستوى العرض التلقائي على مستوى المشروع لهذه البيانات. |
remaining_driving_distance_visibility |
الحقل الذي يحدّد متى يمكن عرض مسافة القيادة المتبقية. في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات مستوى العرض التلقائي على مستوى المشروع لهذه البيانات. |
remaining_stop_count_visibility |
الحقل الذي يحدّد وقت إمكانية ظهور عدد المحطات المتبقية. في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات مستوى العرض التلقائي على مستوى المشروع لهذه البيانات. |
vehicle_location_visibility |
الحقل الذي يحدّد متى يمكن أن يظهر الموقع الجغرافي للمركبة في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات مستوى العرض التلقائي على مستوى المشروع لهذه البيانات. |
VisibilityOption
رسالة الخيار التي تحدّد متى يجب أن يكون عنصر البيانات مرئيًا للمستخدمين النهائيين.
الحقول | |
---|---|
حقل الدمج visibility_option خيار مستوى العرض المحدّد يمكن أن تكون visibility_option إحدى القيم التالية فقط: |
|
remaining_stop_count_threshold |
يكون عنصر البيانات هذا مرئيًا للمستخدمين النهائيين إذا كان عدد المحطات المتبقية <= remaining_stop_count_threshold. |
duration_until_estimated_arrival_time_threshold |
يكون عنصر البيانات هذا مرئيًا للمستخدمين النهائيين إذا كان الوقت المقدَّر للوصول إلى المحطة <= duration_until_estimated_arrival_time_threshold. |
remaining_driving_distance_meters_threshold |
يكون عنصر البيانات هذا مرئيًا للمستخدمين النهائيين إذا كانت مسافة القيادة المتبقية بالمتر <= remaining_driving_distance_meters_threshold. |
always |
في حال ضبطها على "صحيح"، يكون عنصر البيانات هذا مرئيًا دائمًا للمستخدمين النهائيين بدون أي حدود دنيا. لا يمكن ضبط قيمة هذا الحقل على "خطأ". |
never |
في حال ضبطها على "صحيح"، يتم دائمًا إخفاء عنصر البيانات هذا عن المستخدمين النهائيين بدون أي حدود. لا يمكن ضبط قيمة هذا الحقل على "خطأ". |
TimeWindow
نطاق زمني
الحقول | |
---|---|
start_time |
مطلوب. تمثّل هذه السمة وقت بدء الفترة الزمنية (شامل). |
end_time |
مطلوب. وقت انتهاء الفترة الزمنية (شامل) |
UpdateDeliveryVehicleRequest
رسالة طلب UpdateDeliveryVehicle
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي |
delivery_vehicle |
مطلوب. تعديل العنصر |
update_mask |
مطلوب. قناع حقل يشير إلى حقول هذه قائمة مفصولة بفواصل تتضمّن الأسماء المؤهَّلة بالكامل للحقول. مثال: |
UpdateTaskRequest
رسالة طلب UpdateTask
الحقول | |
---|---|
header |
اختياريّ. عنوان طلب Delivery API العادي |
task |
مطلوب. المهمة المرتبطة بالتعديل تحتفظ Fleet Engine بالحقول التالية. لا تعدِّلها باستخدام
ملاحظة: لا يمكنك تغيير قيمة إذا تم تعيين المهمة لمركبة توصيل، لا تضبط حالة المهمة على CLOSED باستخدام |
update_mask |
مطلوب. قناع الحقل الذي يشير إلى حقول "المهمة" المطلوب تعديلها. ملاحظة: يجب أن يحتوي هذه قائمة مفصولة بفواصل تتضمّن الأسماء المؤهَّلة بالكامل للحقول. مثال: |
VehicleJourneySegment
تمثّل هذه السمة جزءًا من رحلة المركبة، أي من محطتها السابقة إلى محطتها الحالية. إذا كانت المحطة هي الأولى النشطة، يكون المسار من الموقع الجغرافي الحالي للمركبة إلى هذه المحطة.
الحقول | |
---|---|
stop |
تحدّد هذه السمة موقع التوقف، بالإضافة إلى |
driving_distance_meters |
النتائج فقط. تمثّل هذه السمة مسافة التنقّل من المحطة السابقة إلى هذه المحطة. إذا كانت المحطة الحالية هي المحطة الأولى في قائمة أجزاء الرحلة، ستكون نقطة البداية هي الموقع الجغرافي للمركبة الذي تم تسجيله عند إضافة هذه المحطة إلى القائمة. قد لا يكون هذا الحقل متوفّرًا إذا كانت شريحة رحلة المستخدم هذه جزءًا من |
driving_duration |
النتائج فقط. تمثّل هذه السمة مدة السفر من المحطة السابقة إلى هذه المحطة. إذا كانت المحطة الحالية هي المحطة الأولى في قائمة أجزاء الرحلة، ستكون نقطة البداية هي الموقع الجغرافي للمركبة الذي تم تسجيله عند إضافة هذه المحطة إلى القائمة. إذا تم تحديد هذا الحقل في المسار |
path[] |
النتائج فقط. المسار من المحطة السابقة إلى هذه المحطة إذا كانت المحطة الحالية هي المحطة الأولى في قائمة أجزاء الرحلة، فهذا هو المسار من الموقع الجغرافي الحالي للمركبة إلى هذه المحطة في الوقت الذي تمت فيه إضافة المحطة إلى القائمة. قد لا يكون هذا الحقل متوفّرًا إذا كانت شريحة رحلة المستخدم هذه جزءًا من إذا تم تحديد هذا الحقل في المسار |
VehicleStop
تصف هذه السمة نقطة تتوقف فيها المركبة لتنفيذ عملية واحدة أو أكثر من عمليات Task
.
الحقول | |
---|---|
planned_location |
مطلوب. تمثّل هذه السمة الموقع الجغرافي للمحطة. يُرجى العلم أنّ المواقع الجغرافية في |
tasks[] |
قائمة |
state |
تمثّل هذه السمة حالة |
الحالة
تمثّل هذه السمة الحالة الحالية لـ VehicleStop
.
عمليات التعداد | |
---|---|
STATE_UNSPECIFIED |
غير معروف. |
NEW |
تم إنشاؤه، ولكن لا يتم التوجيه بنشاط. |
ENROUTE |
تم تعيينها ويتم توجيهها بنشاط. |
ARRIVED |
تم الوصول إلى المحطة. يفترض هذا الحقل أنّه عند توجيه المركبة إلى المحطة التالية، تكون جميع المحطات السابقة قد اكتملت. |
TaskInfo
معلومات إضافية حول المهمة التي تم تنفيذها في هذه المحطة
الحقول | |
---|---|
task_id |
معرّف المهمة لن تتم تعبئة هذا الحقل في ردّ مكالمة
|
task_duration |
النتائج فقط. الوقت المطلوب لتنفيذ المهمة |
target_time_window |
النتائج فقط. الفترة الزمنية التي يجب إكمال المهمة خلالها يتم ضبط هذه السمة في الردّ على |