Method: providers.trips.search

يمكنك الاطّلاع على جميع الرحلات لمركبة معيّنة.

طلب HTTP

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/trips:search

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
parent

string

مطلوب. يجب أن يكون بالتنسيق providers/{provider}. يجب أن يكون مقدّم الخدمة هو رقم تعريف المشروع (مثلاً sample-cloud-project) الخاص بالمشروع على Google Cloud الذي ينتمي إليه حساب الخدمة الذي يجري هذا الاتصال.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "header": {
    object (RequestHeader)
  },
  "vehicleId": string,
  "activeTripsOnly": boolean,
  "pageSize": integer,
  "pageToken": string,
  "minimumStaleness": string
}
الحقول
header

object (RequestHeader)

عنوان طلب Fleet Engine العادي.
vehicleId

string

المركبة المرتبطة بالرحلات في الطلب وفي حال عدم تحديد هذه السمة، لا تتضمّن الرحلات التي تم إرجاعها ما يلي:

  • currentRouteSegment
  • remainingWaypoints
  • remainingDistanceMeters
  • etaToFirstWaypoint
activeTripsOnly

boolean

أمّا في حال ضبطها على "صحيح"، فسيتضمن الرد الرحلات التي تؤثر في مسار السائق.
pageSize

integer

وإذا لم يتم ضبط السياسة، سيقرر الخادم عدد النتائج التي سيتم عرضها.
pageToken

string

اضبط هذه القيمة على قيمة تم عرضها سابقًا في SearchTripsResponse للمتابعة من النتائج السابقة.
minimumStaleness

string (Duration format)

في حال تحديد وقت محدّد، يمكنك إرجاع الرحلات التي لم يتم تعديلها بعد الوقت (current - minimumStaleness).

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

نص الاستجابة

رسالة الاستجابة trips.search

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "trips": [
    {
      object (Trip)
    }
  ],
  "nextPageToken": string
}
الحقول
trips[]

object (Trip)

تعرض هذه السمة قائمة الرحلات للمركبة المطلوبة.
nextPageToken

string

مرر هذا الرمز المميز في SearchTripsRequest إلى صفحة خلال نتائج القائمة. تعرض واجهة برمجة التطبيقات قائمة رحلات عند كل مكالمة، وعندما لا تظهر أي نتائج أخرى، تكون قائمة الرحلات فارغة.