Method: providers.deliveryVehicles.list

همه DeliveryVehicle هایی را دریافت می کند که معیارهای فیلتر مشخص شده را دارند.

درخواست HTTP

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

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

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

پارامترها
parent

string

مورد نیاز. باید در قالب providers/{provider} باشد. provider باید شناسه پروژه Google Cloud باشد. به عنوان مثال، sample-cloud-project .

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

پارامترها
header

object ( DeliveryRequestHeader )

اختیاری. هدر درخواست استاندارد Delivery API.

page Size

integer

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

page Token

string

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

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به deliveryVehicles.list باید با فراخوانی که نشانه صفحه را ارائه می کند مطابقت داشته باشد.

filter

string

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

توجه داشته باشید که تنها جستارهایی که برای deliveryVehicles.list پشتیبانی می‌شوند، روی ویژگی‌های خودرو هستند (به عنوان مثال، attributes.<key> = <value> یا attributes.<key1> = <value1> AND attributes.<key2> = <value2> ). همچنین، تمام ویژگی ها به عنوان رشته ذخیره می شوند، بنابراین تنها مقایسه های پشتیبانی شده در برابر ویژگی ها، مقایسه رشته ها هستند. به منظور مقایسه با مقادیر یا مقادیر بولی، مقادیر باید به صراحت نقل قول شوند تا به عنوان رشته در نظر گرفته شوند (به عنوان مثال، attributes.<key> = "10" یا attributes.<key> = "true" ).

حداکثر تعداد محدودیت های مجاز در یک جستار فیلتر 50 است attributes.foo = bar محدودیت بخشی از پرس و جو attribute.<KEY> <COMPARATOR> <VALUE>

viewport

object ( Viewport )

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

درخواست بدن

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

بدن پاسخگو

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

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

نمایندگی JSON 
{
  "deliveryVehicles": [
    {
      object (DeliveryVehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
فیلدها
delivery Vehicles[]

object ( DeliveryVehicle )

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

next Page Token

string

برای ادامه فهرست کردن نتایج، می‌توانید این نشانه را در ListDeliveryVehiclesRequest ارسال کنید. وقتی همه نتایج برگردانده می شوند، این فیلد در پاسخ نخواهد بود یا یک رشته خالی خواهد بود.

total Size

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 )

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