- HTTP-Anfrage
- Pfadparameter
- Anfragetext
- Antworttext
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- Wegpunkt
- VehicleMatchType
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 dessen Nähe gesucht werden soll. |
dropoffPoint |
Der beabsichtigte Rückgabeort des Kunden. Das Feld ist erforderlich, wenn |
pickupRadiusMeters |
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. |
count |
Erforderlich. Gibt die maximale Anzahl von Fahrzeugen an, die zurückgegeben werden sollen. Der Wert muss zwischen 1 und 50 (einschließlich) liegen. |
minimumCapacity |
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. |
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, 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 „ |
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 mithilfe 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 erforderliche Attribute zulässig. Das entspricht der maximalen Anzahl von Attributen, die für ein Fahrzeug zulässig sind. |
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 einer |
orderBy |
Erforderlich. Gibt das gewünschte Sortierkriterium 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 funktioniert als AND-Klausel mit anderen Einschränkungen wie Es werden nur Abfragen für Fahrzeugattribute wie 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. |
Antworttext
vehicles.search
-Antwortnachricht.
Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:
JSON-Darstellung |
---|
{
"matches": [
{
object ( |
Felder | |
---|---|
matches[] |
Liste der Fahrzeuge, die den |
VehicleAttributeList
Ein Datentyp „list-of-lists“ für Fahrzeugattribute.
JSON-Darstellung |
---|
{
"attributes": [
{
object ( |
Felder | |
---|---|
attributes[] |
Eine Liste von Attributen in dieser Sammlung. |
VehicleMatchOrder
Gibt die Reihenfolge der in der Antwort übereinstimmenden Fahrzeuge an.
Enums | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Standardeinstellung, wird für nicht angegebene oder nicht erkannte Fahrzeugübereinstimmungen verwendet. |
PICKUP_POINT_ETA |
Aufsteigende Bestellung nach Fahrzeit des Fahrzeugs zum Abholpunkt. |
PICKUP_POINT_DISTANCE |
Aufsteigende Bestellung, bezogen auf die Fahrstrecke des Fahrzeugs zum Abholpunkt. |
DROPOFF_POINT_ETA |
Aufsteigende Reihenfolge nach Fahrzeit des Fahrzeugs bis zur Abgabestelle. Diese Reihenfolge kann nur verwendet werden, wenn der Rückgabepunkt in der Anfrage angegeben ist. |
PICKUP_POINT_STRAIGHT_DISTANCE |
Aufsteigende Bestellung in Luftlinie vom zuletzt gemeldeten Standort des Fahrzeugs zum Abholpunkt. |
COST |
In aufsteigender Reihenfolge nach den konfigurierten Abgleichskosten. Die Abgleichskosten sind definiert als gewichtete Berechnung zwischen linearer Entfernung und voraussichtlicher Ankunftszeit. Die Gewichtungen werden mit Standardwerten festgelegt und können je nach Kunde geändert werden. Wenden Sie sich an den Google-Support, wenn diese Gewichtungen für Ihr Projekt geändert werden müssen. |
CurrentTripsPresent
Gibt die Arten von Einschränkungen für die aktuellen Fahrten eines Fahrzeugs an.
Enums | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
Die Verfügbarkeit von Fahrzeugen mit Fahrten wird im Feld includeBackToBack geregelt. |
NONE |
Fahrzeuge ohne Fahrten können in den Suchergebnissen erscheinen. Wenn dieser Wert verwendet wird, kann includeBackToBack nicht true sein. |
ANY |
Fahrzeuge mit höchstens 5 aktuellen Fahrten und 10 Wegpunkten werden in die Suchergebnisse aufgenommen. Wenn dieser Wert verwendet wird, kann includeBackToBack nicht true sein. |
VehicleMatch
Enthält das Fahrzeug und zugehörige Schätzungen für ein Fahrzeug, die den Punkten aktiver Fahrten für das Fahrzeug SearchVehiclesRequest
entsprechen.
JSON-Darstellung |
---|
{ "vehicle": { object ( |
Felder | |
---|---|
vehicle |
Erforderlich. Ein Fahrzeug, das der Anfrage entspricht. |
vehiclePickupEta |
Die voraussichtliche Ankunftszeit des Fahrzeugs zum Abholpunkt, der in der Anfrage angegeben ist. Ein leerer Wert bedeutet, dass die voraussichtliche Ankunftszeit für das Fahrzeug nicht berechnet werden konnte. Wenn „ Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
vehiclePickupDistanceMeters |
Die Entfernung vom aktuellen Standort des Fahrzeugs bis zu dem in der Anfrage angegebenen Abholpunkt, einschließlich aller Zwischen- oder Absetzpunkte für bestehende Fahrten. Sie setzt sich aus der berechneten Fahrstrecke (Routen-Entfernung) plus der Luftlinie zwischen dem Navigationsendpunkt und dem angeforderten Abholpunkt zusammen. (Die Entfernung zwischen dem Navigationsendpunkt und dem gewünschten Abholpunkt ist in der Regel gering.) Ein leerer Wert weist auf einen Fehler bei der Berechnung der Entfernung hin. |
vehiclePickupStraightLineDistanceMeters |
Erforderlich. Die Luftlinie zwischen dem Fahrzeug und dem in der Anfrage angegebenen Abholpunkt. |
vehicleDropoffEta |
Die voraussichtliche Ankunftszeit des gesamten Fahrzeugs an der in der Anfrage angegebenen Abgabestelle. Die voraussichtliche Ankunftszeit beinhaltet auch einen Halt an jedem Wegpunkt vor dem in der Anfrage angegebenen Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
vehiclePickupToDropoffDistanceMeters |
Die Fahrstrecke des Fahrzeugs (in Metern) vom Abholpunkt bis zu dem in der Anfrage angegebenen Rückgabepunkt. Die Entfernung liegt nur zwischen den beiden Punkten und umfasst weder den Fahrzeugstandort noch andere Punkte, die besichtigt werden müssen, bevor das Fahrzeug den Abhol- oder Absetzpunkt besucht. Der Wert wird nur gefüllt, wenn in der Anfrage ein |
tripType |
Erforderlich. Der Fahrttyp der Anfrage, der zur Berechnung der voraussichtlichen Ankunftszeit bis zum Abholpunkt verwendet wurde. |
vehicleTripsWaypoints[] |
Die sortierte Liste der Wegpunkte, die zur Berechnung der voraussichtliche Ankunftszeit verwendet werden. Die Liste enthält den Fahrzeugstandort, die Abholpunkte der aktiven Fahrten für das Fahrzeug und die in der Anfrage angegebenen Abholpunkte. Eine leere Liste weist auf einen Fehler bei der Berechnung der voraussichtlichen Ankunftszeit für das Fahrzeug hin. |
vehicleMatchType |
Typ des übereinstimmenden Fahrzeugs. |
requestedOrderedBy |
Die Reihenfolge, in der die Fahrzeugübereinstimmungen sortiert werden. |
orderedBy |
Die tatsächliche Bestellung, die für dieses Fahrzeug verwendet wurde. Normalerweise entspricht dies dem Feld "orderBy" aus der Anfrage. Unter bestimmten Umständen, etwa bei einem internen Serverfehler, kann jedoch eine andere Methode verwendet werden (z. B. |
Zwischenstopp
Beschreibt Zwischenpunkte entlang einer Route für einen VehicleMatch
in einem SearchVehiclesResponse
. Dieses Konzept wird in allen anderen Endpunkten als TripWaypoint
dargestellt.
JSON-Darstellung |
---|
{
"latLng": {
object ( |
Felder | |
---|---|
latLng |
Die Position dieses Wegpunkts |
eta |
Die voraussichtliche Ankunftszeit des Fahrzeugs an diesem Wegpunkt. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
VehicleMatchType
Übereinstimmender Fahrzeugtyp.
Enums | |
---|---|
UNKNOWN |
Unbekannter Übereinstimmungstyp des Fahrzeugs |
EXCLUSIVE |
Dem Fahrzeug ist derzeit keine Fahrt zugewiesen und es kann zum Abholpunkt fahren. |
BACK_TO_BACK |
Das Fahrzeug ist derzeit einer Fahrt zugewiesen, kann aber nach Abschluss der laufenden Fahrt zum Abholpunkt fahren. Bei der Berechnung der voraussichtliche Ankunftszeit und der Entfernung wird die vorhandene Fahrt berücksichtigt. |
CARPOOL |
Das Fahrzeug hat genügend Kapazität für eine gemeinsame Fahrt. |
CARPOOL_BACK_TO_BACK |
Das Fahrzeug beendet seine aktuelle, aktive Fahrt, bevor es zum Abholpunkt auffährt. Bei der Berechnung der voraussichtliche Ankunftszeit und der Entfernung wird die vorhandene Fahrt berücksichtigt. |