- HTTP-запрос
 - Параметры пути
 - Тело запроса
 - Тело ответа
 - Список атрибутов транспортного средства
 - Транспортное средствоМатчЗаказ
 - ТекущееПоездкиНастоящее
 - АвтомобильМатч
 - Путевая точка
 - Тип соответствия транспортного средства
 
Возвращает список транспортных средств, соответствующих параметрам запроса.
HTTP-запрос
 POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
| Параметры | |
|---|---|
 parent |    Необходимый. Должно быть в формате   | 
Тело запроса
Тело запроса содержит данные следующей структуры:
| JSON-представление | 
|---|
{ "header": { object (  | 
| Поля | |
|---|---|
 header |   Стандартный заголовок запроса Fleet Engine.  | 
 pickupPoint |   Необходимый. Пункт выдачи, который нужно искать рядом.  | 
 dropoffPoint |    Предполагаемое место высадки клиента. Поле является обязательным, если   | 
 pickupRadiusMeters |   Необходимый. Определяет радиус поиска автомобиля вокруг точки посадки. Возврату подлежат только транспортные средства, находящиеся в радиусе поиска. Значение должно быть от 400 до 10 000 метров (включительно).  | 
 count |   Необходимый. Указывает максимальное количество возвращаемых транспортных средств. Значение должно находиться в диапазоне от 1 до 50 (включительно).  | 
 minimumCapacity |   Необходимый. Указывает количество пассажиров, рассматриваемых для поездки. Значение должно быть больше или равно единице. Драйвер не учитывается в значении емкости.  | 
 tripTypes[] |    Необходимый. Представляет тип предлагаемой поездки. Должен включать ровно один тип.   | 
 maximumStaleness |   Ограничивает поиск только теми транспортными средствами, которые отправили обновления местоположения в Fleet Engine в течение указанного периода. Стационарные транспортные средства, все еще передающие свое местоположение, не считаются устаревшими. Если это поле не задано, сервер использует пять минут в качестве значения по умолчанию.  Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на «   | 
 vehicleTypes[] |    Необходимый. Ограничивает поиск транспортными средствами одного из указанных типов. Должен быть указан хотя бы один тип транспортного средства. Типы транспортных средств с категорией   | 
 requiredAttributes[] |    Вызывающие программы могут формировать сложные логические операции, используя любую комбинацию полей    Ограничивает поиск только теми транспортными средствами с указанными атрибутами. Это поле представляет собой операцию конъюнкции/И. Допускается максимум 50 обязательных атрибутов. Это соответствует максимальному количеству атрибутов, разрешенных для транспортного средства.  | 
 requiredOneOfAttributes[] |    Ограничивает поиск только теми транспортными средствами, у которых есть хотя бы один из указанных атрибутов в каждом   | 
 requiredOneOfAttributeSets[] |      Подобно   Ограничивает поиск только теми транспортными средствами, которые имеют все атрибуты в   | 
 orderBy |   Необходимый. Указывает желаемый критерий упорядочения результатов.  | 
 includeBackToBack |    Это указывает на то, подходят ли для этого поиска транспортные средства с одной активной поездкой. Это поле используется только в том случае, если значение   Значение по умолчанию —   | 
 tripId |    Указывает поездку, связанную с этим   | 
 currentTripsPresent |    Это указывает на то, подходят ли для этого поиска автомобили с активными поездками. Должно быть установлено значение, отличное от   | 
 filter |   Необязательный. Запрос-фильтр, применяемый при поиске транспортных средств. См. http://aip.dev/160 для примеров синтаксиса фильтра.  Это поле предназначено для замены полей   Этот фильтр работает как предложение AND с другими ограничениями, такими как   Обратите внимание, что поддерживаются только запросы по атрибутам транспортного средства (например,   Кроме того, все атрибуты хранятся в виде строк, поэтому единственным поддерживаемым сравнением атрибутов является сравнение строк. Для сравнения с числовыми или логическими значениями значения должны быть явно заключены в кавычки, чтобы их можно было рассматривать как строки (например,   | 
Тело ответа
 ответное сообщение vehicles.search .
В случае успеха тело ответа содержит данные следующей структуры:
| JSON-представление | 
|---|
{
  "matches": [
    {
      object ( | 
| Поля | |
|---|---|
 matches[] |    Список транспортных средств, соответствующих критериям   | 
Список атрибутов транспортного средства
Тип данных «список списков» для атрибутов транспортного средства.
| JSON-представление | 
|---|
{
  "attributes": [
    {
      object ( | 
| Поля | |
|---|---|
 attributes[] |   Список атрибутов в этой коллекции.  | 
Транспортное средствоМатчЗаказ
Указывает порядок совпадений транспортных средств в ответе.
| Перечисления | |
|---|---|
 UNKNOWN_VEHICLE_MATCH_ORDER | По умолчанию, используется для неуказанного или нераспознанного транспортного средства, соответствующего порядку. | 
 PICKUP_POINT_ETA | В порядке возрастания времени в пути автомобиля до пункта выдачи. | 
 PICKUP_POINT_DISTANCE | В порядке возрастания расстояния проезда автомобиля до пункта выдачи. | 
 DROPOFF_POINT_ETA | В порядке возрастания времени движения автомобиля до точки высадки. Этот заказ можно использовать только в том случае, если в запросе указана точка выдачи. | 
 PICKUP_POINT_STRAIGHT_DISTANCE | В порядке возрастания по расстоянию по прямой от последнего сообщенного местоположения транспортного средства до точки посадки. | 
 COST | В порядке возрастания настроенной стоимости соответствия. Стоимость матча определяется как взвешенный расчет расстояния по прямой и расчетного времени прибытия. Веса устанавливаются со значениями по умолчанию и могут быть изменены для каждого клиента. Если эти веса необходимо изменить для вашего проекта, обратитесь в службу поддержки Google. | 
ТекущееПоездкиНастоящее
Определяет типы ограничений на текущие поездки автомобиля.
| Перечисления | |
|---|---|
 CURRENT_TRIPS_PRESENT_UNSPECIFIED |  Наличие транспортных средств с рейсами регулируется полем includeBackToBack . | 
 NONE |  В результатах поиска могут появиться автомобили без поездок. Когда используется это значение, includeBackToBack не может иметь true . | 
 ANY |  В результаты поиска включаются автомобили, имеющие не более 5 текущих поездок и 10 путевых точек. Когда используется это значение, includeBackToBack не может иметь true .  | 
АвтомобильМатч
 Содержит транспортное средство и связанные с ним оценки, соответствующие точкам активных поездок для транспортного средства SearchVehiclesRequest . 
| JSON-представление | 
|---|
{ "vehicle": { object (  | 
| Поля | |
|---|---|
 vehicle |   Необходимый. Автомобиль, соответствующий запросу.  | 
 vehiclePickupEta |    Время прибытия автомобиля до пункта выдачи, указанного в заявке. Пустое значение указывает на сбой в расчете ETA для транспортного средства. Если   Использует RFC 3339, где генерируемые выходные данные всегда будут нормализованы по Z и используют 0, 3, 6 или 9 дробных цифр. Также принимаются смещения, отличные от «Z». Примеры:   | 
 vehiclePickupDistanceMeters |   Расстояние от текущего местоположения Транспортного средства до точки посадки, указанной в запросе, включая любые промежуточные точки посадки или высадки для существующих поездок. Это расстояние включает в себя рассчитанное расстояние вождения (маршрута) плюс расстояние по прямой между конечной точкой навигации и запрошенной точкой посадки. (Расстояние между конечной точкой навигации и запрошенной точкой посадки обычно невелико.) Пустое значение указывает на ошибку при расчете расстояния.  | 
 vehiclePickupStraightLineDistanceMeters |   Необходимый. Расстояние по прямой от автомобиля до пункта выдачи, указанного в заявке.  | 
 vehicleDropoffEta |    Расчетное время прибытия всего транспортного средства до точки выдачи, указанной в запросе. Расчетное время прибытия включает остановку в любых путевых точках до   Использует RFC 3339, где генерируемые выходные данные всегда будут нормализованы по Z и используют 0, 3, 6 или 9 дробных цифр. Также принимаются смещения, отличные от «Z». Примеры:   | 
 vehiclePickupToDropoffDistanceMeters |    Расстояние проезда автомобиля (в метрах) от точки посадки до точки выдачи, указанной в заявке. Расстояние указывается только между двумя точками и не включает в себя местоположение транспортного средства или любые другие точки, которые необходимо посетить до того, как транспортное средство достигнет пункта посадки или пункта высадки. Значение будет заполнено только в том случае, если в запросе указан   | 
 tripType |   Необходимый. Тип поездки запроса, который использовался для расчета расчетного времени прибытия до точки посадки.  | 
 vehicleTripsWaypoints[] |   Упорядоченный список путевых точек, используемых для расчета расчетного времени прибытия. В списке указывается местоположение транспортного средства, точки получения активных поездок автомобиля, а также точки получения, указанные в запросе. Пустой список указывает на сбой в расчете ETA для автомобиля.  | 
 vehicleMatchType |   Тип автомобиля соответствует.  | 
 requestedOrderedBy |    Запрошенный заказ на сортировку автомобилей соответствует. Эквивалент   | 
 orderedBy |    Запрошенный заказ на сортировку автомобилей соответствует. Эквивалент   | 
Путевая точка
 Описывает промежуточные точки на маршруте для VehicleMatch в SearchVehiclesResponse . Эта концепция представлена как TripWaypoint во всех других конечных точках. 
| JSON-представление | 
|---|
{
  "latLng": {
    object ( | 
| Поля | |
|---|---|
 latLng |   Местоположение этой путевой точки.  | 
 eta |   Расчетное время прибытия транспортного средства в эту точку маршрута.  Использует RFC 3339, где генерируемые выходные данные всегда будут нормализованы по Z и используют 0, 3, 6 или 9 дробных цифр. Также принимаются смещения, отличные от «Z». Примеры:   | 
Тип соответствия транспортного средства
Тип автомобиля соответствует.
| Перечисления | |
|---|---|
 UNKNOWN | Неизвестный тип соответствия транспортного средства | 
 EXCLUSIVE | В настоящее время транспортному средству не назначена поездка, и он может проследовать к месту посадки. | 
 BACK_TO_BACK | Транспортное средство в настоящее время назначено на поездку, но может проследовать к месту посадки после завершения текущей поездки. Расчеты расчетного времени прибытия и расстояния учитывают существующую поездку. | 
 CARPOOL | Автомобиль имеет достаточную вместимость для совместной поездки. | 
 CARPOOL_BACK_TO_BACK | Транспортное средство завершит текущую активную поездку, прежде чем отправиться к месту посадки. Расчеты расчетного времени прибытия и расстояния учитывают существующую поездку. |