- HTTP-Anfrage
- Pfadparameter
- Anfragetext
- Antworttext
- VehicleAttributeList
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Wegpunkt
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- VehicleMatchType
Gibt eine Liste von Fahrzeugen 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 Abholort, in dessen Nähe gesucht werden soll. |
dropoffPoint |
Der vom Kunden beabsichtigte Abgabeort. 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 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 in Betracht gezogen werden. Der Wert muss größer oder gleich eins sein. Der Treiber wird im 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 Standortupdates 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 " |
vehicleTypes[] |
Erforderlich. Beschränkt die Suche auf Fahrzeuge mit einem der angegebenen Typen. Es muss mindestens ein Fahrzeugtyp angegeben werden. Fahrzeugtypen 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/AND-Operation. Es sind maximal 50 erforderliche Attribute zulässig. Dies entspricht der maximal für ein Fahrzeug zulässigen Anzahl von Attributen. |
requiredOneOfAttributes[] |
Beschränkt die Suche auf die Fahrzeuge mit mindestens einem der angegebenen Attribute in jeder |
requiredOneOfAttributeSets[] |
Ähnlich wie bei
Beschränkt die Suche auf die Fahrzeuge mit allen Attributen in einem |
orderBy |
Erforderlich. Gibt das gewünschte Sortierkriterium für Ergebnisse an. |
includeBackToBack |
Gibt an, 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 Fahrt an, die mit dieser |
currentTripsPresent |
Gibt an, ob Fahrzeuge mit aktiven Fahrten für diese Suche infrage kommen. Wenn |
filter |
Optional. Eine Filterabfrage, die beim Suchen 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 Beachten Sie, dass nur Anfragen für Fahrzeugattribute unterstützt werden, z. B. Außerdem werden alle Attribute als Strings gespeichert, sodass nur Stringvergleiche für Attribute unterstützt werden. Für den 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.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{
"matches": [
{
object ( |
Felder | |
---|---|
matches[] |
Liste der Fahrzeuge, die die |
VehicleAttributeList
Ein Datentyp „List-of-lists“ für Fahrzeugattribute.
JSON-Darstellung |
---|
{
"attributes": [
{
object ( |
Felder | |
---|---|
attributes[] |
Eine Liste der Attribute in dieser Sammlung. |
VehicleMatchOrder
Gibt die Reihenfolge der Fahrzeugübereinstimmungen in der Antwort an.
Enums | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
Standardeinstellung; wird für die Reihenfolge von nicht angegebenen oder nicht erkannten Fahrzeugübereinstimmungen verwendet. |
PICKUP_POINT_ETA |
Aufsteigende Reihenfolge nach Fahrzeit des Fahrzeugs zum Abholpunkt. |
PICKUP_POINT_DISTANCE |
Aufsteigende Reihenfolge nach Entfernung des Fahrzeugs zum Abholort. |
DROPOFF_POINT_ETA |
Aufsteigende Reihenfolge nach Fahrzeit des Fahrzeugs bis zur Abgabestelle. Diese Reihenfolge kann nur verwendet werden, wenn in der Anfrage die Abgabestelle angegeben ist. |
PICKUP_POINT_STRAIGHT_DISTANCE |
Aufsteigende Reihenfolge nach der Luftlinie zwischen dem letzten gemeldeten Standort des Fahrzeugs und dem Abholort. |
COST |
Aufsteigende Reihenfolge nach den konfigurierten Übereinstimmungskosten. Die Angleichungskosten sind definiert als gewichtete Berechnung zwischen der direkten Entfernung und der voraussichtlichen Ankunftszeit. 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 durch das Feld includeBackToBack geregelt. |
NONE |
Fahrzeuge ohne Fahrten können in den Suchergebnissen erscheinen. Wenn dieser Wert verwendet wird, darf includeBackToBack nicht true sein. |
ANY |
In den Suchergebnissen sind Fahrzeuge mit höchstens 5 aktuellen Fahrten und 10 Wegpunkten enthalten. Wenn dieser Wert verwendet wird, darf includeBackToBack nicht true sein. |
VehicleMatch
Enthält das Fahrzeug und die zugehörigen Schätzungen für ein Fahrzeug, die mit den Punkten aktiver Fahrten für das Fahrzeug SearchVehiclesRequest
übereinstimmen.
JSON-Darstellung |
---|
{ "vehicle": { object ( |
Felder | |
---|---|
vehicle |
Erforderlich. Ein Fahrzeug, das der Anfrage entspricht. |
vehiclePickupEta |
Das Fahrzeug fährt die voraussichtliche Ankunftszeit zum Abholort, der in der Anfrage angegeben ist. Ein leerer Wert bedeutet, dass bei der Berechnung der voraussichtlichen Ankunftszeit für das Fahrzeug ein Fehler aufgetreten ist. 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 zum in der Anfrage angegebenen Abholort, einschließlich aller Zwischen- oder Absetzpunkte für bestehende Fahrten. Sie setzt sich aus der berechneten Fahrtstrecke (Routenstrecke) plus der Luftlinienentfernung zwischen dem Navigationsendpunkt und dem angeforderten Startpunkt zusammen. (Der Abstand zwischen dem Navigationsendpunkt und dem angeforderten 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 vollständigen Fahrzeugs bis zur in der Anfrage angegebenen Abgabestelle. Die ETA umfasst auch das Anhalten an Wegpunkten vor der 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 Entfernung des Fahrzeugs (in Metern) vom Abholpunkt bis zur Abgabestelle, die in der Anfrage angegeben ist. Die Entfernung bezieht sich nur zwischen den beiden Punkten und umfasst nicht den Fahrzeugstandort oder andere Punkte, die besucht werden müssen, bevor das Fahrzeug den Abhol- oder Abgabeort erreicht. Der Wert wird nur ausgefüllt, wenn in der Anfrage eine |
tripType |
Erforderlich. Die Art der Fahrt, die zur Berechnung der voraussichtlichen Ankunftszeit für den Abholpunkt verwendet wurde. |
vehicleTripsWaypoints[] |
Die sortierte Liste von Wegpunkten, die zur Berechnung der voraussichtlichen Ankunftszeit verwendet werden. Die Liste enthält den Fahrzeugstandort, die Abholpunkte aktiver Fahrten für das Fahrzeug und die in der Anfrage angegebenen Abholpunkte. Eine leere Liste bedeutet, dass bei der Berechnung der voraussichtlichen Ankunftszeit für das Fahrzeug ein Fehler aufgetreten ist. |
vehicleMatchType |
Der passende Fahrzeugtyp. |
requestedOrderedBy |
Die Reihenfolge, in der Fahrzeugübereinstimmungen sortiert werden sollen. |
orderedBy |
Die tatsächliche Bestellung, die für dieses Fahrzeug verwendet wurde. Normalerweise entspricht dies dem Wert aus der Anfrage. Unter bestimmten Umständen, z. B. bei einem internen Serverfehler, kann jedoch eine andere Methode verwendet werden (z. B. |
Zwischenstopp
Beschreibt Zwischenpunkte entlang einer Route für ein VehicleMatch
in einem SearchVehiclesResponse
. Dieses Konzept wird an allen anderen Endpunkten als TripWaypoint
dargestellt.
JSON-Darstellung |
---|
{
"latLng": {
object ( |
Felder | |
---|---|
latLng |
Die Position dieses Wegpunkts. |
eta |
Die geschätzte 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
Fahrzeugtyp stimmt überein.
Enums | |
---|---|
UNKNOWN |
Unbekannter Übereinstimmungstyp für Fahrzeuge |
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 voraussichtlichen Ankunftszeit und der Entfernung wird die vorhandene Fahrt berücksichtigt. |
CARPOOL |
Das Fahrzeug hat genügend Kapazität für eine gemeinsam genutzte Fahrt. |
CARPOOL_BACK_TO_BACK |
Das Fahrzeug beendet seine aktuelle, aktive Fahrt, bevor es zur Abholstelle weiterfährt. Bei der Berechnung der voraussichtlichen Ankunftszeit und der Entfernung wird die vorhandene Fahrt berücksichtigt. |