يصف هذا المستند الطرق التي يمكنك من خلالها العثور على معلومات المهمة من أو المتصفح. تتيح Fleet Engine طريقتَين للعثور على المهام:
البحث عن المهام: يمكنك البحث عن المهام من خلال أرقام التعريف التالية:
- رقم تعريف المهمة: يستخدمه المستخدمون، مثل مشغّلي الأسطول الذين يمكنهم الوصول إلى الاطّلاع الكامل على بيانات المهمة.
- رقم تعريف التتبُّع: يستخدمه برنامج العميل لتوفير معلومات محدودة إلى المستخدم النهائي، على سبيل المثال عندما يكون من المتوقع وجود طرد في منزله.
احرص على فهم الفرق بين رقم تعريف المهمة ورقم تعريف تتبُّع المهمة. ولكنهما مختلفان. اطّلِع على حقول المهام الأساسية في دليل المهام المُجدوَلة.
قائمة المهام: إذن وصول واسع النطاق إلى المهام، وهو مخصّص للمستخدمين الموثوق بهم فقط.
البحث عن مهام
يصف هذا القسم كيفية البحث عن المهام حسب رقم تعريف المهمة أو رقم تعريف التتبُّع. تحتوي على المتطلبات التالية:
يجب أن تلتزم عمليات البحث حسب رقم تعريف التتبّع بقواعد مستوى الرؤية الموضّحة في قواعد مستوى الرؤية للكائنات التي يتم تتبّعها.
استخدِم أضيق رمز مميّز ممكن للحدّ من المخاطر الأمنية. على سبيل المثال، إذا استخدام الرمز المميز للمستهلك في التسليم، يتم إرجاع أي مكالمات فقط المعلومات ذات الصلة بذلك المستخدم النهائي، مثل جهة الشحن مستلم الشحنة. تحجب Fleet Engine جميع المعلومات الأخرى في الردود. لمزيد من المعلومات عن الرموز المميّزة، يُرجى الاطّلاع على رموز JSON المميّزة للويب.
البحث عن مهمة حسب معرّف المهمة
يمكنك البحث عن مهمة من خلال معرّف المهمة من بيئة خادم باستخدام gRPC أو راحة. توضّح الأمثلة التالية كيفية استخدام مكتبة Java gRPC أو طلب REST إلى GetTask.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TASK_ID = "task-8597549";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Task request
String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
GetTaskRequest getTaskRequest = GetTaskRequest.newBuilder() // No need for the header
.setName(taskName)
.build();
try {
Task task = deliveryService.getTask(getTaskRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
راحة
GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<taskId>
- <id> هو معرّف فريد للمهمة.
- <taskId> هو معرّف المهمة المطلوب البحث عنها.
- يجب أن يحتوي عنوان الطلب على الحقل Authorize (تفويض) مع القيمة الحامل <token>، حيث يتم إصدار <token> من خلال الخادم وفقًا للإرشادات الموضحة في أدوار حساب الخدمة رموز JSON المميّزة للويب
- يجب أن يكون نص الطلب فارغًا.
- إذا كان البحث ناجحًا، سيحتوي نص الاستجابة على كيان مهمة.
مثال على طلب curl
:
# Set JWT, PROJECT_ID, and TASK_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}"
البحث عن المهام باستخدام رقم تعريف التتبّع
توضِّح الأمثلة التالية كيفية البحث عن المهام حسب معرّف تتبُّع الشحنة
باستخدام gRPC أو طلب HTTP REST إلى GetTaskTrackingInfo
.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TRACKING_ID = "TID-7449w087464x5";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Tasks request
String parent = "providers/" + PROJECT_ID;
GetTaskTrackingInfoRequest getTaskTrackingInfoRequest = GetTaskTrackingInfoRequest.newBuilder() // No need for the header
.setParent(parent)
.setTrackingId(TRACKING_ID)
.build();
try {
TaskTrackingInfo taskTrackingInfo = deliveryService.getTaskTrackingInfo(getTaskTrackingInfoRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
GET https://fleetengine.googleapis.com/v1/providers/<project_id>/taskTrackingInfo/<tracking_id>
<tracking_id> هو رقم تعريف التتبّع المرتبط بالمهمة.
يجب أن يحتوي رأس الطلب على حقل Authorization بالقيمة Bearer <token>، حيث يحمل <token> دور حساب الخدمة الصحيح. راجِع أدوار حسابات الخدمة.
إذا كان البحث ناجحًا، يحتوي نص الاستجابة على عنصر taskTrackingInfo.
مثال على طلب curl
:
# Set JWT, PROJECT_ID, and TRACKING_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/taskTrackingInfo/${TRACKING_ID}"
سرد المهام
تتطلب مهام القوائم وصولاً واسع النطاق إلى المهام. إنّ إدراج المهام مخصّص فقط للمستخدمين الموثوق بهم. استخدِم رمزَي مصادقة "قارئ أسطول التسليم" أو "مشرف التسليم" عند تقديم طلبات المهام القائمة. راجِع أدوار حساب الخدمة لمعرفة المزيد. المعلومات.
قوائم التقسيم على صفحات
يتم تقسيم قوائم المهام إلى صفحات. يمكن تحديد حجم الصفحة في طلبات مهام القائمة. إذا تم تحديد حجم الصفحة، فلن يكون عدد المهام المعروضة أكبر مقارنةً بحجم الصفحة المحدّد في حال عدم توفّر حجم صفحة، يتم استخدام قيمة تلقائية معقولة . إذا تجاوز حجم الصفحة المطلوب قيمة قصوى داخلية، فسيتم استخدام الحد الأقصى الداخلي.
يمكن أن تتضمّن قائمة المهام رمزًا مميّزًا لقراءة الصفحة التالية من النتائج. إلى لاسترداد تلك الصفحة، وإعادة إصدار الطلب نفسه مع الرمز المميز للصفحة. عندما يكون الرمز المميّز للصفحة المعروض فارغًا، لن تتوفّر أي مهام أخرى ل retrieving.
الحقول عند إدراج المهام
تحجب Fleet Engine الحقول التالية عند إدراج المهام:
VehicleStop.planned_location
VehicleStop.state
VehicleStop.TaskInfo.taskId
استخدم تنسيقات الحقول التالية بناءً على اقتراحات تحسين واجهة برمجة تطبيقات Google:
نوع الحقل | التنسيق | مثال |
---|---|---|
الطابع الزمني | RFC-3339 | task_outcome_time = 2022-03-01T11:30:00-08:00 |
المدة | عدد الثواني متبوعًا بـ s |
task_duration = 120s |
Enum | سلسلة | state = CLOSED AND type = PICKUP |
الموقع الجغرافي | point.latitude وpoint.longitude |
planned_location.point.latitude > 36.1 AND planned_location.point.longitude < -122.0 |
فلترة المهام المدرَجة
يمكنك فلترة المهام المدرَجة حسب معظم خصائص المهام. بالنسبة إلى بنية طلب البحث في الفلتر، اطّلِع على AIP-160. في حال عدم تحديد طلب بحث فلترة، يتم إدراج جميع المهام.
يعرض الجدول التالي سمات المهام الصالحة التي يمكنك استخدامها للفلترة:
خصائص المهام لفلترة القوائم | |
---|---|
|
|
اطّلِع على AIP-160 للحصول على قائمة كاملة بعوامل تشغيل طلبات بحث الفلاتر.
أمثلة على المهام المدرَجة
يوضّح المثال التالي كيفية إدراج المهام الخاصة بـ deliveryVehicleId
.
مهمة، سواء من خلال مكتبة gRPC في Java أو من خلال استدعاء HTTP REST إلى
ListTasks
يمكن أن يظل الرد الناجح فارغًا. يشير الرد الفارغ إلى لا
مهام مرتبطة بالنطاق deliveryVehicleId
المقدَّم.
gRPC
static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TRACKING_ID = "TID-7449w087464x5";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Tasks request
String parent = "providers/" + PROJECT_ID;
ListTasksRequest listTasksRequest = ListTasksRequest.newBuilder() // No need for the header
.setParent(parent)
.setFilter("delivery_vehicle_id = 123 AND attributes.foo = true")
.build();
try {
ListTasksResponse listTasksResponse = deliveryService.listTasks(listTasksRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
راحة
GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks
لتطبيق فلتر على المهام المدرَجة، أدرِج مَعلمة عنوان URL "filter" مع طلب بحث فلتر تم تشفيره لعنوان URL كقيمة لها.
يجب أن يحتوي رأس الطلب على حقل Authorization بالقيمة Bearer <token>، حيث يحمل <token> دور حساب العميل الصحيح في الخدمة. يُرجى الاطِّلاع على أدوار حساب الخدمة.
يوفّر البحث الناجح نص استجابة بالبنية التالية:
// JSON representation
{
"tasks": [
{
object (Task)
}
],
"nextPageToken": string,
"totalSize": integer
}
مثال على الطلب curl
:
# Set JWT, PROJECT_ID, and VEHICLE_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?filter=state%20%3D%20OPEN%20AND%20delivery_vehicle_id%20%3D%20${VEHICLE_ID}"