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)

Der standardmäßige Fleet Engine-Anfrageheader.

object (TerminalLocation)

Erforderlich. Der Abholpunkt, in dessen Nähe gesucht werden soll.

object (TerminalLocation)

Der beabsichtigte Rückgabeort des Kunden. Das Feld ist erforderlich, wenn tripTypes „TripType.SHARED“ enthält.

integer

Erforderlich. Definiert den Suchradius des Fahrzeugs um den Abholpunkt. Es werden nur Fahrzeuge innerhalb des Suchradius zurückgegeben. Der Wert muss zwischen 400 und 10.000 Metern (einschließlich) liegen.

integer

Erforderlich. Gibt die maximale Anzahl von Fahrzeugen an, die zurückgegeben werden sollen. Der Wert muss zwischen 1 und 50 (einschließlich) liegen.

integer

Erforderlich. Gibt die Anzahl der Passagiere an, die für eine Fahrt berücksichtigt werden. Der Wert muss größer oder gleich eins sein. Der Treiber wird beim Kapazitätswert nicht berücksichtigt.

enum (TripType)

Erforderlich. Der Typ der vorgeschlagenen Fahrt. Muss genau einen Typ enthalten. UNKNOWN_TRIP_TYPE ist nicht zulässig. Beschränkt die Suche auf die Fahrzeuge, die diesen Fahrttyp unterstützen.

string (Duration format)

Beschränkt die Suche auf die Fahrzeuge, die innerhalb des angegebenen Zeitraums Standortaktualisierungen an Fleet Engine gesendet haben. Stehende Fahrzeuge, die ihren Standort noch übertragen, gelten nicht als veraltet. Wenn dieses Feld nicht festgelegt ist, verwendet der Server fünf Minuten als Standardwert.

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. Beispiel: "3.5s".

object (VehicleType)

Erforderlich. Beschränkt die Suche auf Fahrzeuge mit einem der angegebenen Typen. Es muss mindestens ein Fahrzeugtyp angegeben werden. VehicleTypes der Kategorie UNKNOWN sind nicht zulässig.

object (VehicleAttribute)

Aufrufer können mithilfe einer beliebigen Kombination der Felder requiredAttributes, requiredOneOfAttributes und requiredOneOfAttributeSets komplexe logische Operationen bilden.

requiredAttributes ist eine Liste; requiredOneOfAttributes verwendet eine Nachricht, die eine Liste von Listen zulässt. In Kombination können die beiden Felder den Ausdruck zusammensetzen:

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

Beschränkt die Suche auf Fahrzeuge mit den angegebenen Attributen. Dieses Feld ist eine Konjunktion/UND-Operation. Es sind maximal 50 erforderliche Attribute zulässig. Das entspricht der maximalen Anzahl von Attributen, die für ein Fahrzeug zulässig sind.

object (VehicleAttributeList)

Beschränkt die Suche auf Fahrzeuge mit mindestens einem der angegebenen Attribute in jeder VehicleAttributeList. In jeder Liste muss ein Fahrzeug mit mindestens einem der Attribute übereinstimmen. Dieses Feld ist eine einschließende Disjunktions-/ODER-Operation für jeden VehicleAttributeList und eine Konjunktion/UND-Operation für die gesamte Sammlung von VehicleAttributeList.

object (VehicleAttributeList)

requiredOneOfAttributeSets bietet zusätzliche Funktionen.

Ähnlich wie bei requiredOneOfAttributes wird in requiredOneOfAttributeSets eine Nachricht verwendet, die eine Liste von Listen zulässt, wobei Ausdrücke wie diese zugelassen werden:

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

Beschränkt die Suche auf Fahrzeuge mit allen Attributen in einer VehicleAttributeList. In jeder Liste muss ein Fahrzeug mit allen Attributen übereinstimmen. Dieses Feld ist eine Konjunktion/UND-Operation für jeden VehicleAttributeList- und alle einschließenden Disjunktions-/ODER-Vorgang in der Sammlung von VehicleAttributeList.

enum (VehicleMatchOrder)

Erforderlich. Gibt das gewünschte Sortierkriterium für Ergebnisse an.

boolean

Damit wird angegeben, ob Fahrzeuge mit einer einzigen aktiven Fahrt für diese Suche infrage kommen. Dieses Feld wird nur verwendet, wenn currentTripsPresent nicht angegeben ist. Wenn currentTripsPresent nicht angegeben und dieses Feld auf false gesetzt ist, werden Fahrzeuge mit zugewiesenen Fahrten aus den Suchergebnissen ausgeschlossen. Wenn currentTripsPresent nicht angegeben und dieses Feld auf true gesetzt ist, können die Suchergebnisse Fahrzeuge mit einer aktiven Fahrt mit dem Status ENROUTE_TO_DROPOFF enthalten. Wenn currentTripsPresent angegeben ist, kann dieses Feld nicht auf „true“ gesetzt werden.

Der Standardwert ist false.

string

Gibt die mit diesem SearchVehicleRequest verknüpfte Fahrt an.

enum (CurrentTripsPresent)

Damit wird angegeben, ob Fahrzeuge mit aktiven Fahrten für diese Suche infrage kommen. Dieser Wert muss auf einen anderen Wert als CURRENT_TRIPS_PRESENT_UNSPECIFIED festgelegt werden, wenn tripType SHARED enthält.

string

Optional. Eine Filterabfrage, die bei der Suche nach Fahrzeugen angewendet werden soll. Beispiele für die Filtersyntax finden Sie unter http://aip.dev/160.

Dieses Feld ersetzt die Felder requiredAttributes, requiredOneOfAttributes und required_one_of_attributes_sets. Wenn hier ein nicht leerer Wert angegeben wird, müssen die folgenden Felder leer sein: requiredAttributes, requiredOneOfAttributes und required_one_of_attributes_sets.

Dieser Filter funktioniert als AND-Klausel mit anderen Einschränkungen wie minimumCapacity oder vehicleTypes.

Es werden nur Abfragen für Fahrzeugattribute wie attributes.<key> = <value> oder attributes.<key1> = <value1> AND attributes.<key2> = <value2> unterstützt. In einer Filterabfrage sind maximal 50 Einschränkungen zulässig.

Da alle Attribute als Strings gespeichert werden, werden Vergleiche mit Attributen nur unterstützt. Für einen Vergleich mit Zahlen- oder booleschen Werten müssen die Werte explizit in Anführungszeichen gesetzt werden, damit sie als Strings behandelt werden (z. B. attributes.<key> = "10" oder attributes.<key> = "true").