فهرستی از وسایل نقلیه را برمیگرداند که با گزینههای درخواست مطابقت دارند.
درخواست HTTP
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
parent | ضروری. باید در قالب |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "header": { object ( |
زمینه های | |
---|---|
header | هدر درخواست استاندارد Fleet Engine. |
pickupPoint | ضروری. نقطه تحویل برای جستجو در نزدیکی. |
dropoffPoint | محل خروج مورد نظر مشتری اگر |
pickupRadiusMeters | ضروری. شعاع جستجوی وسیله نقلیه را در اطراف نقطه وانت تعریف می کند. فقط وسایل نقلیه در شعاع جستجو بازگردانده خواهند شد. مقدار باید بین 400 تا 10000 متر (شامل) باشد. |
count | ضروری. حداکثر تعداد وسایل نقلیه برای بازگشت را مشخص می کند. مقدار باید بین 1 تا 50 باشد (شامل). |
minimumCapacity | ضروری. تعداد مسافرانی که برای یک سفر در نظر گرفته شده اند را مشخص می کند. مقدار باید بزرگتر یا مساوی یک باشد. راننده در مقدار ظرفیت در نظر گرفته نمی شود. |
tripTypes[] | ضروری. نشان دهنده نوع سفر پیشنهادی است. باید دقیقاً یک نوع را شامل شود. |
maximumStaleness | جستجو را فقط به وسایل نقلیهای محدود میکند که در مدت زمان مشخص شده بهروزرسانیهای مکان را به Fleet Engine ارسال کردهاند. وسایل نقلیه ثابتی که هنوز مکان خود را مخابره می کنند کهنه در نظر گرفته نمی شوند. اگر این فیلد تنظیم نشده باشد، سرور از پنج دقیقه به عنوان مقدار پیش فرض استفاده می کند. مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' |
vehicleTypes[] | ضروری. جستجو را به خودروهایی با یکی از انواع مشخص شده محدود می کند. حداقل یک نوع وسیله نقلیه باید مشخص شود. انواع خودرو با دسته |
requiredAttributes[] | تماس گیرندگان می توانند عملیات منطقی پیچیده ای را با استفاده از هر ترکیبی از فیلدهای
جستجو را فقط به خودروهایی با ویژگیهای مشخص شده محدود میکند. این فیلد یک عملیات ربط/AND است. حداکثر 50 ویژگی مورد نیاز مجاز است. این با حداکثر تعداد مشخصه های مجاز در یک وسیله نقلیه مطابقت دارد. |
requiredOneOfAttributes[] | جستجو را فقط به آن دسته از وسایل نقلیه با حداقل یکی از ویژگی های مشخص شده در هر |
requiredOneOfAttributeSets[] | شبیه به
جستجو را فقط به آن دسته از وسایل نقلیه با تمام ویژگیهای یک |
orderBy | ضروری. معیار سفارش مورد نظر را برای نتایج مشخص می کند. |
includeBackToBack | این نشان می دهد که آیا وسایل نقلیه با یک سفر فعال واجد شرایط این جستجو هستند یا خیر. این فیلد فقط زمانی استفاده می شود که مقدار پیش فرض |
tripId | نشان دهنده سفر مرتبط با این |
currentTripsPresent | این نشان می دهد که آیا وسایل نقلیه با سفرهای فعال واجد شرایط این جستجو هستند یا خیر. اگر |
filter | اختیاری. یک درخواست فیلتر برای اعمال هنگام جستجوی وسایل نقلیه. برای نمونه هایی از نحو فیلتر http://aip.dev/160 را ببینید. این فیلد به گونه ای طراحی شده است که جایگزین فیلدهای این فیلتر به عنوان یک AND با محدودیت های دیگر مانند توجه داشته باشید که تنها جستارهای پشتیبانی شده مربوط به ویژگی های خودرو هستند (به عنوان مثال، همچنین، تمام ویژگی ها به عنوان رشته ذخیره می شوند، بنابراین تنها مقایسه های پشتیبانی شده در برابر ویژگی ها، مقایسه رشته ها هستند. به منظور مقایسه با مقادیر یا مقادیر بولی، مقادیر باید به طور صریح نقل قول شوند تا به عنوان رشته در نظر گرفته شوند (به عنوان مثال، |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک نمونه از SearchVehiclesResponse
است.