Method: providers.vehicles.list

فهرست صفحه بندی شده ای از وسایل نقلیه مرتبط با ارائه دهنده ای را برمی گرداند که با گزینه های درخواست مطابقت دارند.

درخواست HTTP

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles

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

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

پارامترها
parent

string

مورد نیاز. باید در قالب providers/{provider} باشد. ارائه‌دهنده باید شناسه پروژه (به عنوان مثال، sample-cloud-project ) پروژه Google Cloud باشد که حساب سرویسی که این تماس را برقرار می‌کند عضوی از آن است.

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

پارامترها
header

object ( RequestHeader )

هدر درخواست استاندارد Fleet Engine.

pageSize

integer

حداکثر تعداد وسایل نقلیه برای بازگشت. مقدار پیش فرض: 100.

pageToken

string

مقدار nextPageToken ارائه شده توسط تماس قبلی با vehicles.list به طوری که شما می توانید از طریق گروه های وسایل نقلیه صفحه بندی کنید. اگر معیارهای فیلتر درخواست با معیارهای فیلتر تماس قبلی با vehicles.list یکسان نباشد، مقدار تعریف نشده است.

minimumCapacity

integer

حداقل ظرفیت مورد نیاز وسیله نقلیه را مشخص می کند. تمام وسایل نقلیه برگشتی دارای maximumCapacity بزرگتر یا مساوی با این مقدار خواهند بود. اگر تنظیم شود، باید بزرگتر یا مساوی 0 باشد.

tripTypes[]

enum ( TripType )

پاسخ به وسایل نقلیه ای را که حداقل یکی از انواع سفرهای مشخص شده را پشتیبانی می کنند، محدود می کند.

maximumStaleness

string ( Duration format)

پاسخ به خودروهایی را که در مدت زمان مشخص شده به‌روزرسانی‌های مکان را به Fleet Engine ارسال کرده‌اند، محدود می‌کند. وسایل نقلیه ثابتی که هنوز مکان خود را مخابره می کنند کهنه در نظر گرفته نمی شوند. در صورت وجود، باید مدت زمان مثبت معتبر باشد.

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

vehicleTypeCategories[]

enum ( Category )

مورد نیاز. پاسخ به وسایل نقلیه با یکی از دسته بندی های نوع مشخص شده را محدود می کند. UNKNOWN مجاز نیست.

requiredAttributes[]

string

تماس گیرندگان می توانند عملیات منطقی پیچیده ای را با استفاده از هر ترکیبی از فیلدهای requiredAttributes ، requiredOneOfAttributes ، و requiredOneOfAttributeSets تشکیل دهند.

requiredAttributes یک لیست است. requiredOneOfAttributes از پیامی استفاده می کند که لیستی از لیست ها را امکان پذیر می کند. در ترکیب، دو فیلد اجازه ترکیب این عبارت را می دهند:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

پاسخ به وسایل نقلیه با ویژگی های مشخص شده را محدود می کند. این فیلد یک عملیات ربط/AND است. حداکثر 50 ویژگی مورد نیاز مجاز است. این با حداکثر تعداد مشخصه های مجاز در یک وسیله نقلیه مطابقت دارد. هر رشته تکرار شده باید با فرمت "key:value" باشد.

requiredOneOfAttributes[]

string

پاسخ به وسایل نقلیه با حداقل یکی از ویژگی های مشخص شده در هر VehicleAttributeList را محدود می کند. در هر فهرست، یک وسیله نقلیه باید حداقل با یکی از ویژگی ها مطابقت داشته باشد. این فیلد یک عملیات تفکیک/OR فراگیر در هر VehicleAttributeList و یک عملیات ربط/AND در مجموعه VehicleAttributeList است. هر رشته تکرار شده باید با فرمت "key1:value1|key2:value2|key3:value3" باشد.

requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets قابلیت های بیشتری را ارائه می دهد.

شبیه به requiredOneOfAttributes ، requiredOneOfAttributeSets از پیامی استفاده می کند که لیستی از لیست ها را مجاز می کند و عباراتی مانند این را مجاز می کند:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

پاسخ را به وسایل نقلیه ای محدود می کند که با تمام ویژگی های یک VehicleAttributeList مطابقت دارند. در هر لیست، یک وسیله نقلیه باید با تمام ویژگی ها مطابقت داشته باشد. این فیلد یک عملیات ربط/و در هر VehicleAttributeList و عملیات تفکیک/OR فراگیر در مجموعه VehicleAttributeList است. هر رشته تکرار شده باید با فرمت "key1:value1|key2:value2|key3:value3" باشد.

vehicleState

enum ( VehicleState )

پاسخ را به خودروهایی که دارای این وضعیت خودرو هستند محدود می کند.

onTripOnly

boolean

فقط وسایل نقلیه با سفر(های) فعلی را برگردانید.

filter

string

اختیاری. یک درخواست فیلتر برای اعمال در هنگام فهرست کردن وسایل نقلیه. برای نمونه هایی از نحو فیلتر http://aip.dev/160 را ببینید.

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

این فیلتر به عنوان یک بند AND با محدودیت های دیگر مانند vehicleState یا onTripOnly عمل می کند.

توجه داشته باشید که تنها جستارهای پشتیبانی شده مربوط به ویژگی های وسیله نقلیه هستند (به عنوان مثال، attributes.<key> = <value> یا attributes.<key1> = <value1> AND attributes.<key2> = <value2> ). حداکثر تعداد محدودیت های مجاز در یک جستار فیلتر 50 است.

همچنین، تمام ویژگی ها به عنوان رشته ذخیره می شوند، بنابراین تنها مقایسه های پشتیبانی شده در برابر ویژگی ها، مقایسه رشته ها هستند. به منظور مقایسه با مقادیر یا مقادیر بولی، مقادیر باید به صراحت نقل قول شوند تا به عنوان رشته در نظر گرفته شوند (به عنوان مثال، attributes.<key> = "10" یا attributes.<key> = "true" ).

viewport

object ( Viewport )

اختیاری. فیلتری که وسایل نقلیه بازگشتی را محدود به خودروهایی می‌کند که آخرین مکان شناخته‌شده‌شان در ناحیه مستطیلی تعریف‌شده توسط viewport بوده است.

درخواست بدن

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

بدن پاسخگو

پیام پاسخ vehicles.list .

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

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

object ( Vehicle )

وسایل نقلیه مطابق با معیارهای موجود در درخواست حداکثر تعداد خودروهای بازگردانده شده توسط قسمت pageSize در درخواست تعیین می شود.

nextPageToken

string

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

totalSize

string ( int64 format)

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

درگاه دید

یک نمای طول و عرض جغرافیایی که به صورت دو نقطه low و high به صورت مورب در مقابل هم نمایش داده می شود. یک viewport یک منطقه بسته در نظر گرفته می شود، یعنی شامل مرز آن می شود. محدوده عرض جغرافیایی باید بین 90- تا 90 درجه باشد و محدوده طول جغرافیایی باید بین 180- تا 180 درجه باشد. موارد مختلف عبارتند از:

  • اگر low = high ، نمای از همان نقطه واحد تشکیل شده است.

  • اگر low.longitude > high.longitude , محدوده طول معکوس می شود (نمایش از خط طول جغرافیایی 180 درجه عبور می کند).

  • اگر low.longitude = -180 درجه و high.longitude = 180 درجه باشد، درگاه دید شامل تمام طول‌های جغرافیایی می‌شود.

  • اگر low.longitude = 180 درجه و high.longitude = -180 درجه باشد، محدوده طول جغرافیایی خالی است.

  • اگر low.latitude > high.latitude ، محدوده عرض جغرافیایی خالی است.

هر دو low و high باید پر شوند و کادر نمایش داده شده نمی تواند خالی باشد (همانطور که در تعاریف بالا مشخص شده است). یک نمای خالی منجر به خطا می شود.

به عنوان مثال، این نما به طور کامل شهر نیویورک را در بر می گیرد:

{ "low": { "Latitude": 40.477398, "Litude": -74.259087 }, "high": { "Latitude": 40.91618, "Latitude": -73.70018 } }

نمایندگی JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
فیلدها
low

object ( LatLng )

مورد نیاز. نقطه پایین دید.

high

object ( LatLng )

مورد نیاز. نقطه اوج دید.