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. Die Abholstelle, in deren Nähe gesucht werden soll.

object (TerminalLocation)

Der beabsichtigte Abgabeort des Kunden. Das Feld ist erforderlich, wenn tripTypes TripType.SHARED enthält.

integer

Erforderlich. Hier wird der Umkreis für die Fahrzeugsuche um den Abholpunkt definiert. Es werden nur Fahrzeuge innerhalb des Suchradius zurückgegeben. Der Wert muss zwischen 400 und 10.000 Metern liegen.

integer

Erforderlich. Gibt die maximale Anzahl der zurückzugebenden Fahrzeuge an. 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 1 sein. Der Treiber wird im Kapazitätswert nicht berücksichtigt.

enum (TripType)

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

string (Duration format)

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

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".

object (VehicleType)

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

object (VehicleAttribute)

Caller können komplexe logische Vorgänge mit einer beliebigen Kombination der Felder requiredAttributes, requiredOneOfAttributes und requiredOneOfAttributeSets bilden.

requiredAttributes ist eine Liste; requiredOneOfAttributes verwendet eine Nachricht, die eine Liste von Listen zulässt. In Kombination ermöglichen die beiden Felder die Zusammensetzung dieses Ausdrucks:

(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/AND-Operation. Es sind maximal 50 erforderliche Attribute zulässig. Dies entspricht der maximal für ein Fahrzeug zulässigen Anzahl von Attributen.

object (VehicleAttributeList)

Die Suche wird auf Fahrzeuge mit mindestens einem der angegebenen Attribute in jeder VehicleAttributeList beschränkt. In jeder Liste muss ein Fahrzeug mit mindestens einem der Attribute übereinstimmen. Dieses Feld ist eine inklusive Disjunktion/OR-Operation in jeder VehicleAttributeList und eine Konjunktion/AND-Operation für die gesamte Sammlung von VehicleAttributeList.

object (VehicleAttributeList)

requiredOneOfAttributeSets bietet zusätzliche Funktionen.

Ähnlich wie bei requiredOneOfAttributes wird bei requiredOneOfAttributeSets eine Nachricht verwendet, die eine Liste von Listen zulässt. So sind Ausdrücke wie dieser möglich:

(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 die Fahrzeuge mit allen Attributen in einem VehicleAttributeList. In jeder Liste muss ein Fahrzeug mit allen Attributen übereinstimmen. Dieses Feld ist eine Konjunktion/AND-Operation in jeder VehicleAttributeList- und inklusiven Disjunktions-/ODER-Operation innerhalb der Sammlung von VehicleAttributeList.

enum (VehicleMatchOrder)

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

boolean

Gibt an, ob Fahrzeuge mit einer einzigen aktiven Fahrt für diese Suche infrage kommen. Dieses Feld wird nur verwendet, wenn currentTripsPresent nicht angegeben wurde. Wenn currentTripsPresent nicht angegeben ist und dieses Feld false ist, werden Fahrzeuge mit zugewiesenen Fahrten aus den Suchergebnissen ausgeschlossen. Wenn currentTripsPresent nicht angegeben ist und dieses Feld den Wert true hat, 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 „wahr“ gesetzt werden.

Der Standardwert ist false.

string

Gibt die Fahrt an, die mit dieser SearchVehicleRequest verknüpft ist.

enum (CurrentTripsPresent)

Gibt an, ob Fahrzeuge mit aktiven Fahrten für diese Suche infrage kommen. Dieser muss auf einen anderen Wert als CURRENT_TRIPS_PRESENT_UNSPECIFIED festgelegt sein, 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 soll die Felder requiredAttributes, requiredOneOfAttributes und required_one_of_attributes_sets ersetzen. 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 fungiert als AND-Klausel mit anderen Einschränkungen wie minimumCapacity oder vehicleTypes.

Es werden nur Abfragen zu Fahrzeugattributen unterstützt (z. B. attributes.<key> = <value> oder attributes.<key1> = <value1> AND attributes.<key2> = <value2>). In einer Filterabfrage sind maximal 50 Einschränkungen zulässig.

Außerdem werden alle Attribute als Strings gespeichert, sodass nur Stringvergleiche für Attribute unterstützt werden. Damit ein Vergleich mit numerischen oder booleschen Werten möglich ist, 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").