REST Resource: providers.tasks

المرجع: المهمة

تمثل المهمة في واجهة برمجة تطبيقات التسليم إجراءً واحدًا يجب تتبعه. بشكل عام، هناك فرق بين المهام المتعلقة بالشحن وتعطل المهام. يمكن أن يكون للشحن مهام متعددة مرتبطة بها. على سبيل المثال، قد تكون هناك مهمة واحدة للاستلام ومهمة للتسليم أو النقل. أيضًا، يمكن لمركبات مختلفة التعامل مع المهام المختلفة لشحنة معينة. على سبيل المثال، يمكن لمركبة واحدة تولي عملية الاستلام، وقيادة الشحنة إلى المركز، بينما تقود مركبة أخرى الشحنة نفسها من المركز إلى موقع التسليم.

ملاحظة: تستخدم واجهات برمجة التطبيقات gRPC وREST اصطلاحات تسمية حقول مختلفة. على سبيل المثال، يشير الحقل Task.journey_sharing_info في واجهة برمجة التطبيقات gRPC والحقل Task.journeySharingInfo في واجهة برمجة التطبيقات REST إلى الحقل نفسه.

تمثيل JSON 
{
  "name": string,
  "type": enum (Type),
  "state": enum (State),
  "taskOutcome": enum (TaskOutcome),
  "taskOutcomeTime": string,
  "taskOutcomeLocation": {
    object (LocationInfo)
  },
  "taskOutcomeLocationSource": enum (TaskOutcomeLocationSource),
  "trackingId": string,
  "deliveryVehicleId": string,
  "plannedLocation": {
    object (LocationInfo)
  },
  "taskDuration": string,
  "targetTimeWindow": {
    object (TimeWindow)
  },
  "journeySharingInfo": {
    object (JourneySharingInfo)
  },
  "taskTrackingViewConfig": {
    object (TaskTrackingViewConfig)
  },
  "attributes": [
    {
      object (TaskAttribute)
    }
  ]
}
الحقول
name

string

يجب استخدام التنسيق providers/{provider}/tasks/{task}.
type

enum (Type)

مطلوبة. غير قابل للتغيير. تحدد نوع المهمة. مثل استراحة أو شحنة.
state

enum (State)

مطلوبة. حالة التنفيذ الحالية للمهمة.
taskOutcome

enum (TaskOutcome)

نتيجة المهمة.
taskOutcomeTime

string (Timestamp format)

الطابع الزمني الذي يشير إلى الوقت الذي ضبط فيه مقدّم الخدمة نتيجة Task.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"
taskOutcomeLocation

object (LocationInfo)

تمثّل هذه السمة الموقع الجغرافي الذي تم فيه ضبط نتيجة Task. يتم تعديل هذه القيمة كجزء من "tasks.patch". إذا لم يعدّل مقدّم الخدمة هذه القيمة صراحةً، يعمل Fleet Engine على تعبئتها تلقائيًا بآخر موقع جغرافي معروف للمركبة (الموقع الأول).
taskOutcomeLocationSource

enum (TaskOutcomeLocationSource)

يشير إلى مصدر قيمة taskOutcomeLocation.
trackingId

string

غير قابل للتغيير. يسهّل هذا الحقل تخزين رقم التعريف لتتجنّب استخدام عملية ربط معقّدة. لا يمكنك ضبط trackingId للمهام من النوع UNAVAILABLE وSCHEDULED_STOP. وتخضع هذه المعرّفات للقيود التالية:

  • يجب أن تكون سلسلة Unicode صالحة.
  • تقتصر على 64 حرفًا كحد أقصى.
  • تتم تسويتها وفقًا لنموذج تسوية Unicode.
  • لا يجوز أن يحتوي على أي من أحرف ASCII التالية: '/' أو ':' أو '?' أو ',' أو nofollow.
deliveryVehicleId

string

النتائج فقط. رقم تعريف المركبة التي تنفّذ هذه المهمة. تخضع معرّفات مركبات التسليم للقيود التالية:

  • يجب أن تكون سلسلة Unicode صالحة.
  • تقتصر على 64 حرفًا كحد أقصى.
  • تتم تسويتها وفقًا لنموذج تسوية Unicode.
  • لا يجوز أن يحتوي على أي من أحرف ASCII التالية: '/' أو ':' أو '?' أو ',' أو nofollow.
plannedLocation

object (LocationInfo)

غير قابل للتغيير. الموقع الذي سيتم إنجاز المهمة فيه اختيارية في مهام UNAVAILABLE، ولكنها مطلوبة لجميع المهام الأخرى.
taskDuration

string (Duration format)

مطلوبة. غير قابل للتغيير. الوقت اللازم لتنفيذ مهمة في هذا الموقع الجغرافي.

مدة بالثواني يصل عددها إلى تسعة أرقام كسرية وتنتهي بـ "s". مثال: "3.5s".
targetTimeWindow

object (TimeWindow)

الفترة الزمنية التي يجب إكمال المهمة خلالها.
journeySharingInfo

object (JourneySharingInfo)

النتائج فقط. الحقول الخاصة بمشاركة رحلات البحث. لا تتم تعبئة هذا الحقل عندما تكون الولاية CLOSED.
taskTrackingViewConfig

object (TaskTrackingViewConfig)

إعداد تتبُّع المهام الذي يحدِّد عناصر البيانات التي ستظهر للمستخدمين النهائيين وتحت أي ظروف.
attributes[]

object (TaskAttribute)

قائمة بسمات المهام المخصّصة يجب أن يكون لكل سمة مفتاح فريد.

النوع

نوع المهمة

عمليات التعداد
TYPE_UNSPECIFIED يكون نوع المهمة غير معروف بشكل تلقائي.
PICKUP مهمة الاستلام هي الإجراء المتخذ لاستلام شحنة من العميل. يجب أن تستخدم عمليات استلام المركبات من المستودع أو الخلاصة النوع SCHEDULED_STOP.
DELIVERY مهمة التسليم هي الإجراء المتخذ لتسليم شحنة إلى عميل نهائي. يجب أن تستخدم عمليات الانسحاب من المركبات في المستودع أو الخلاصة النوع SCHEDULED_STOP.
SCHEDULED_STOP يتم استخدام مهمة إيقاف مُجدوَلة لأغراض التخطيط. على سبيل المثال، يمكن أن تمثل استلام الشحنات أو تسليمها من مركبات التغذية أو المستودعات. ويجب عدم استخدامها لأي شحنات يتم استلامها أو تسليمها من عميل نهائي.
UNAVAILABLE مهمة تعني أن المركبة غير متاحة للصيانة. على سبيل المثال، يمكن أن يحدث ذلك عندما يأخذ السائق استراحة أو عندما تتم إعادة تعبئة المركبة.

TaskOutcomeLocationSource

هوية المصدر الذي ملأ taskOutcomeLocation.

عمليات التعداد
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED نتيجة المهمة قبل تعيينها.
PROVIDER حدّد مقدّم الخدمة السمة taskOutcomeLocation.
LAST_VEHICLE_LOCATION لم يحدّد مقدّم الخدمة السمة taskOutcomeLocation، لذلك استخدم محرّك Fleet Engine آخر موقع جغرافي معروف للمركبة.

JourneySharingInfo

حقول مشاركة الرحلة المحدَّدة

تمثيل JSON 
{
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "lastLocationSnappable": boolean
}
الحقول
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

تتبُّع المعلومات الخاصة بالمحطات التي ستجريها المركبة المحددة قبل إكمال هذه "المهمة". تجدر الإشارة إلى أنّ هذه القائمة يمكن أن تحتوي على محطات توقف من المهام الأخرى.

يحتوي الجزء الأول، Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) أو Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST)، على معلومات المسار من آخر موقع جغرافي معروف للسائق حتى VehicleStop القادم. عادةً ما تكون معلومات المسارات الحالية من تطبيق السائق، باستثناء بعض الحالات المذكورة في المستندات الخاصة بـ "DeliveryVehicle.current_route_segment". تتم تعبئة الشرائح الأخرى في Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) أو Task.journeySharingInfo.remainingVehicleJourneySegments (REST) بواسطة Fleet Engine. توفّر معلومات المسار بين VehicleStops المتبقية.
lastLocation

object (DeliveryVehicleLocation)

تشير هذه السمة إلى آخر موقع جغرافي تم الإبلاغ عنه للمركبة المعنية.
lastLocationSnappable

boolean

تشير هذه السمة إلى ما إذا كان يمكن ضبط آخر موقع جغرافي للمركبة على "currentRouteSegment". وتكون هذه القيمة "خطأ" في حال عدم توفّر lastLocation أو currentRouteSegment. يتم احتساب هذه القيمة من قِبل Fleet Engine. ويتم تجاهل التحديثات من العملاء.

TaskTrackingViewConfig

رسالة الضبط التي تحدِّد الوقت الذي يجب أن يظهر فيه عنصر بيانات لمهمة للمستخدمين النهائيين.

تمثيل JSON 
{
  "routePolylinePointsVisibility": {
    object (VisibilityOption)
  },
  "estimatedArrivalTimeVisibility": {
    object (VisibilityOption)
  },
  "estimatedTaskCompletionTimeVisibility": {
    object (VisibilityOption)
  },
  "remainingDrivingDistanceVisibility": {
    object (VisibilityOption)
  },
  "remainingStopCountVisibility": {
    object (VisibilityOption)
  },
  "vehicleLocationVisibility": {
    object (VisibilityOption)
  }
}
الحقول
routePolylinePointsVisibility

object (VisibilityOption)

الحقل الذي يحدِّد متى يمكن أن تكون نقاط الخطوط المتعددة للمسار مرئية. في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات الظهور التلقائية على مستوى المشروع لهذه البيانات.
estimatedArrivalTimeVisibility

object (VisibilityOption)

الحقل الذي يحدِّد الوقت المقدّر للوصول. في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات الظهور التلقائية على مستوى المشروع لهذه البيانات.
estimatedTaskCompletionTimeVisibility

object (VisibilityOption)

الحقل الذي يحدد متى يمكن رؤية الوقت المقدّر لإكمال المهمة في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات الظهور التلقائية على مستوى المشروع لهذه البيانات.
remainingDrivingDistanceVisibility

object (VisibilityOption)

يمكن رؤية الحقل الذي يحدِّد المدة المتبقية للقيادة. في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات الظهور التلقائية على مستوى المشروع لهذه البيانات.
remainingStopCountVisibility

object (VisibilityOption)

يمكن رؤية الحقل الذي يحدِّد عدد محطات التوقف المتبقية. في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات الظهور التلقائية على مستوى المشروع لهذه البيانات.
vehicleLocationVisibility

object (VisibilityOption)

الحقل الذي يحدِّد متى يكون الموقع الجغرافي للمركبة مرئيًا. في حال عدم تحديد هذا الحقل، سيتم استخدام إعدادات الظهور التلقائية على مستوى المشروع لهذه البيانات.

VisibilityOption

يشير ذلك المصطلح إلى رسالة الخيار التي تحدِّد متى يجب أن يكون عنصر البيانات مرئيًا للمستخدمين النهائيين.

تمثيل JSON 
{

  // Union field visibility_option can be only one of the following:
  "remainingStopCountThreshold": integer,
  "durationUntilEstimatedArrivalTimeThreshold": string,
  "remainingDrivingDistanceMetersThreshold": integer,
  "always": boolean,
  "never": boolean
  // End of list of possible types for union field visibility_option.
}
الحقول
حقل الاتحاد visibility_option خيار مستوى الرؤية المحدد الذي تم تحديده. يمكن أن يكون الحقل "visibility_option" واحدًا فقط مما يلي:
remainingStopCountThreshold

integer

يكون عنصر البيانات هذا مرئيًا للمستخدمين النهائيين في حال كان عدد المحطات المتبقية <= pendingStopCountThreshold.
durationUntilEstimatedArrivalTimeThreshold

string (Duration format)

يكون عنصر البيانات هذا مرئيًا للمستخدمين النهائيين إذا كان الوقت المقدّر للوصول عند نقطة التوقف <= durationUntitidArrivalTimeThreshold.

مدة بالثواني يصل عددها إلى تسعة أرقام كسرية وتنتهي بـ "s". مثال: "3.5s".
remainingDrivingDistanceMetersThreshold

integer

يظهر عنصر البيانات هذا للمستخدمين النهائيين إذا كانت مسافة القيادة المتبقية بالمتر <= العثور على ما تبقى من "المسافة المقطوعة".
always

boolean

أمّا في حال ضبطها على "صحيح"، فسيظهر عنصر البيانات هذا دائمًا للمستخدمين النهائيين بدون حدود. لا يمكن ضبط هذا الحقل على "خطأ".
never

boolean

في حال ضبط هذه السياسة على "صحيح"، يتم دائمًا إخفاء عنصر البيانات هذا عن المستخدمين النهائيين بدون أي حدود. لا يمكن ضبط هذا الحقل على "خطأ".

الطُرق

batchCreate

 تنشئ هذه الدالة مجموعة من عناصر Task الجديدة وتعرضها.

create

 ينشئ عنصر Task جديدًا ويعرضه.

get

 الحصول على معلومات عن Task

list

 الحصول على جميع Task التي تستوفي معايير الفلترة المحدّدة.

patch

 لتعديل بيانات "Task"

search
(deprecated)

 مهملة: يمكنك استخدام GetTaskTrackingInfo بدلاً منها.