Gibt eine Liste der Fahrzeuge zurück, die den Anfrageoptionen entsprechen.
HTTP-Anfrage
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
parent |
Erforderlich. Muss das Format |
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{ "header": { object ( |
Felder | |
---|---|
header |
Der standardmäßige Fleet Engine-Anfrageheader. |
pickupPoint |
Erforderlich. Der Abholpunkt, in dem gesucht werden soll. |
dropoffPoint |
Der vorgesehene Rückgabeort des Kunden. Das Feld ist erforderlich, wenn |
pickupRadiusMeters |
Erforderlich. Legt den Suchradius des Fahrzeugs um den Abholpunkt fest. Es werden nur Fahrzeuge im Suchradius zurückgegeben. Der Wert muss zwischen 400 und 10.000 Metern (einschließlich) liegen. |
count |
Erforderlich. Gibt die maximale Anzahl der zurückzugebenden Fahrzeuge an. Der Wert muss zwischen 1 und 50 (einschließlich) liegen. |
minimumCapacity |
Erforderlich. Gibt die Anzahl der Fahrgäste 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. |
tripTypes[] |
Erforderlich. Der Typ der vorgeschlagenen Fahrt. Muss genau einen Typ enthalten. |
maximumStaleness |
Beschränkt die Suche auf die Fahrzeuge, die innerhalb des angegebenen Zeitraums Standortaktualisierungen an Fleet Engine gesendet haben. Stehende Fahrzeuge, deren Standort noch übertragen wird, gelten nicht als veraltet. Wenn dieses Feld nicht festgelegt ist, verwendet der Server 5 Minuten als Standardwert. Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „ |
vehicleTypes[] |
Erforderlich. Beschränkt die Suche auf Fahrzeuge mit einem der angegebenen Typen. Es muss mindestens ein Fahrzeugtyp angegeben werden. VehicleTypes der Kategorie |
requiredAttributes[] |
Aufrufer können komplexe logische Operationen mit einer beliebigen Kombination der Felder
Beschränkt die Suche auf Fahrzeuge mit den angegebenen Attributen. Dieses Feld ist eine Konjunktion/UND-Operation. Es sind maximal 50 requiredAttributes zulässig. Das entspricht der maximal für ein Fahrzeug zulässigen Anzahl von Attributen. |
requiredOneOfAttributes[] |
Beschränkt die Suche auf Fahrzeuge mit mindestens einem der angegebenen Attribute in jeder |
requiredOneOfAttributeSets[] |
Ähnlich wie bei
Beschränkt die Suche auf Fahrzeuge mit allen Attributen in einem |
orderBy |
Erforderlich. Gibt das gewünschte Sortierungskriterium für Ergebnisse an. |
includeBackToBack |
Damit wird angegeben, ob Fahrzeuge mit einer einzigen aktiven Fahrt für diese Suche infrage kommen. Dieses Feld wird nur verwendet, wenn Der Standardwert ist |
tripId |
Gibt die mit diesem |
currentTripsPresent |
Damit wird angegeben, ob Fahrzeuge mit aktiven Fahrten für diese Suche infrage kommen. Dieser Wert muss auf einen anderen Wert als |
filter |
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 Dieser Filter fungiert als AND-Klausel mit anderen Einschränkungen wie Es werden nur Suchanfragen für Fahrzeugattribute wie Außerdem werden alle Attribute als Strings gespeichert, sodass nur Stringvergleiche unterstützt werden. 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. |
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von SearchVehiclesResponse
.