Method: providers.vehicles.search

{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}

object ( RequestHeader )

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

object ( TerminalLocation )

ضروری. نقطه تحویل برای جستجو در نزدیکی.

object ( TerminalLocation )

محل خروج مورد نظر مشتری اگر tripTypes حاوی TripType.SHARED باشد، فیلد مورد نیاز است.

integer

ضروری. شعاع جستجوی وسیله نقلیه را در اطراف نقطه وانت تعریف می کند. فقط وسایل نقلیه در شعاع جستجو بازگردانده خواهند شد. مقدار باید بین 400 تا 10000 متر (شامل) باشد.

integer

ضروری. حداکثر تعداد وسایل نقلیه برای بازگشت را مشخص می کند. مقدار باید بین 1 تا 50 باشد (شامل).

integer

ضروری. تعداد مسافرانی که برای یک سفر در نظر گرفته شده اند را مشخص می کند. مقدار باید بزرگتر یا مساوی یک باشد. راننده در مقدار ظرفیت در نظر گرفته نمی شود.

enum ( TripType )

ضروری. نشان دهنده نوع سفر پیشنهادی است. باید دقیقاً یک نوع را شامل شود. UNKNOWN_TRIP_TYPE مجاز نیست. جستجو را فقط به وسایل نقلیه‌ای محدود می‌کند که می‌توانند آن نوع سفر را پشتیبانی کنند.

string ( Duration format)

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

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

object ( VehicleType )

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

object ( VehicleAttribute )

تماس گیرندگان می توانند عملیات منطقی پیچیده ای را با استفاده از هر ترکیبی از فیلدهای 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 ویژگی مورد نیاز مجاز است. این با حداکثر تعداد مشخصه های مجاز در یک وسیله نقلیه مطابقت دارد.

object ( VehicleAttributeList )

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

object ( VehicleAttributeList )

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 است.

enum ( VehicleMatchOrder )

ضروری. معیار سفارش مورد نظر را برای نتایج مشخص می کند.

boolean

این نشان می دهد که آیا وسایل نقلیه با یک سفر فعال واجد شرایط این جستجو هستند یا خیر. این فیلد فقط زمانی استفاده می شود که currentTripsPresent مشخص نشده باشد. هنگامی که currentTripsPresent مشخص نشده باشد و این فیلد false باشد، وسایل نقلیه با سفرهای اختصاص داده شده از نتایج جستجو حذف می شوند. هنگامی که currentTripsPresent مشخص نشده باشد و این قسمت true باشد، نتایج جستجو می تواند شامل وسایل نقلیه با یک سفر فعال باشد که وضعیت آن ENROUTE_TO_DROPOFF است. هنگامی که currentTripsPresent مشخص شده است، این فیلد را نمی توان روی true تنظیم کرد.

مقدار پیش فرض false است .

string

نشان دهنده سفر مرتبط با این SearchVehicleRequest است.

enum ( CurrentTripsPresent )

این نشان می دهد که آیا وسایل نقلیه با سفرهای فعال واجد شرایط این جستجو هستند یا خیر. اگر tripType شامل SHARED باشد، باید روی چیزی غیر از CURRENT_TRIPS_PRESENT_UNSPECIFIED تنظیم شود.

string

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

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

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

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

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