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 للتنقّل في نتائج القائمة. تعرض واجهة برمجة التطبيقات قائمة رحلات في كل طلب، وعندما لا تتوفّر أي نتائج أخرى، تكون قائمة الرحلات فارغة.