Method: providers.trips.search

تمام سفرها را برای یک وسیله نقلیه خاص دریافت کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
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.

vehicle Id

string

وسیله نقلیه مرتبط با سفرهای موجود در درخواست. اگر مشخص نشده باشد، سفرهای برگشتی شامل موارد زیر نیست:

  • currentRouteSegment
  • remainingWaypoints
  • remainingDistanceMeters
  • etaToFirstWaypoint
active Trips Only

boolean

اگر روی true تنظیم شود، پاسخ شامل سفرهایی می شود که بر مسیر راننده تأثیر می گذارد.

page Size

integer

اگر تنظیم نشود، سرور تعداد نتایجی را که باید بازگردانده شود، تعیین می کند.

page Token

string

این را روی مقداری تنظیم کنید که قبلاً در SearchTripsResponse برگردانده شده است تا نتایج قبلی را ادامه دهید.

minimum Staleness

string ( Duration format)

اگر مشخص شده باشد، سفرهایی را که بعد از زمان به‌روزرسانی نشده‌اند را برمی‌گرداند (current - minimumStaleness) .

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

بدن پاسخگو

پیام پاسخ trips.search.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "trips": [
    {
      object (Trip)
    }
  ],
  "nextPageToken": string
}
فیلدها
trips[]

object ( Trip )

لیست سفرها برای وسیله نقلیه درخواستی.

next Page Token

string

این نشانه را در SearchTripsRequest به صفحه نتایج فهرست ارسال کنید. API در هر تماس فهرست سفر را برمی‌گرداند و زمانی که نتیجه دیگری باقی نماند، فهرست سفر خالی است.