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)

O cabeçalho de solicitação padrão do Fleet Engine.

object (TerminalLocation)

Obrigatório. O ponto de encontro próximo ao qual pesquisar.

object (TerminalLocation)

O local de entrega pretendido do cliente. O campo é obrigatório se tripTypes contiver TripType.SHARED.

integer

Obrigatório. Define o raio de pesquisa do veículo ao redor do ponto de embarque. Somente veículos dentro do raio de pesquisa serão retornados. O valor precisa estar entre 400 e 10.000 metros (inclusive).

integer

Obrigatório. Especifica o número máximo de veículos a serem retornados. O valor precisa estar entre 1 e 50 (inclusive).

integer

Obrigatório. Especifica o número de passageiros considerados para uma viagem. O valor precisa ser maior ou igual a um. O driver não é considerado no valor da capacidade.

enum (TripType)

Obrigatório. Representa o tipo de viagem proposta. Precisa incluir exatamente um tipo. A política UNKNOWN_TRIP_TYPE não é permitida. Restringe a pesquisa apenas aos veículos compatíveis com esse tipo de viagem.

string (Duration format)

Restringe a pesquisa apenas aos veículos que enviaram atualizações de localização ao Fleet Engine no período especificado. Veículos parados que ainda transmitam suas localizações não são considerados desatualizados. Se esse campo não for definido, o servidor usará cinco minutos como valor padrão.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

object (VehicleType)

Obrigatório. Restringe a pesquisa a veículos com um dos tipos especificados. É necessário especificar pelo menos um tipo de veículo. VehicleTypes com uma categoria UNKNOWN não são permitidos.

object (VehicleAttribute)

Os autores da chamada podem formar operações lógicas complexas usando qualquer combinação dos campos requiredAttributes, requiredOneOfAttributes e requiredOneOfAttributeSets.

requiredAttributes é uma lista; O requiredOneOfAttributes usa uma mensagem que permite criar uma lista de listas. Em combinação, os dois campos permitem a composição desta expressão:

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

Restringe a pesquisa apenas aos veículos com os atributos especificados. Esse campo é uma operação de conjunção/E. São permitidos no máximo 50 requiredAttributes. Esse valor corresponde ao número máximo de atributos permitidos em um veículo.

object (VehicleAttributeList)

Restringe a pesquisa apenas aos veículos com pelo menos um dos atributos especificados em cada VehicleAttributeList. Em cada lista, um veículo precisa corresponder a pelo menos um dos atributos. Esse campo é uma operação de disjunção/E inclusiva em cada VehicleAttributeList e uma operação de conjunção/E na coleção de VehicleAttributeList.

object (VehicleAttributeList)

requiredOneOfAttributeSets oferece mais funcionalidades.

Semelhante a requiredOneOfAttributes, requiredOneOfAttributeSets usa uma mensagem que permite uma lista de listas, permitindo expressões como esta:

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

Restringe a pesquisa apenas aos veículos com todos os atributos em uma VehicleAttributeList. Em cada lista, um veículo precisa corresponder a todos os atributos. Esse campo é uma operação de conjunção/E em cada VehicleAttributeList e uma operação inclusiva de disjunção/OU na coleção de VehicleAttributeList.

enum (VehicleMatchOrder)

Obrigatório. Especifica o critério de ordenação desejado para os resultados.

boolean

Indica se veículos com uma única viagem ativa estão qualificados para essa pesquisa. Esse campo só é usado quando currentTripsPresent não é especificado. Quando currentTripsPresent não é especificado e esse campo é false, os veículos com viagens atribuídas são excluídos dos resultados da pesquisa. Quando currentTripsPresent não é especificado e esse campo é true, os resultados da pesquisa podem incluir veículos com uma viagem ativa com status ENROUTE_TO_DROPOFF. Quando currentTripsPresent é especificado, este campo não pode ser definido como verdadeiro.

O valor padrão é false.

string

Indica a viagem associada a este SearchVehicleRequest.

enum (CurrentTripsPresent)

Indica se veículos com viagens ativas estão qualificados para essa pesquisa. Precisa ser definido como algo diferente de CURRENT_TRIPS_PRESENT_UNSPECIFIED se tripType incluir SHARED.

string

Opcional. Uma consulta de filtro para aplicar ao pesquisar veículos. Consulte http://aip.dev/160 para ver exemplos de sintaxe de filtro.

Esse campo foi criado para substituir os campos requiredAttributes, requiredOneOfAttributes e required_one_of_attributes_sets. Se um valor não vazio for especificado aqui, os seguintes campos precisarão estar vazios: requiredAttributes, requiredOneOfAttributes e required_one_of_attributes_sets.

Esse filtro funciona como uma cláusula AND com outras restrições, como minimumCapacity ou vehicleTypes.

As únicas consultas aceitas são nos atributos do veículo (por exemplo, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). O número máximo de restrições permitido em uma consulta de filtro é 50.

Além disso, todos os atributos são armazenados como strings. Portanto, as únicas comparações compatíveis com os atributos são aquelas de strings. Para fazer uma comparação com valores numéricos ou booleanos, os valores precisam estar explicitamente entre aspas para serem tratados como strings (por exemplo, attributes.<key> = "10" ou attributes.<key> = "true").