- HTTP-Anfrage
- Pfadparameter
- Anfrageparameter
- Anfragetext
- Antworttext
- Darstellungsbereich
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
Gibt eine paginierte Liste von Fahrzeugen zurück, die einem Anbieter zugeordnet sind und den Anfrageoptionen entsprechen.
HTTP-Anfrage
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
parent |
Erforderlich. Muss das Format |
Abfrageparameter
Parameter | |
---|---|
header |
Der standardmäßige Fleet Engine-Anfrageheader. |
pageSize |
Die maximale Anzahl von Fahrzeugen, die zurückgegeben werden sollen. Standardwert: 100. |
pageToken |
Der Wert von |
minimumCapacity |
Gibt die erforderliche Mindestkapazität des Fahrzeugs an. Der Wert für „ |
tripTypes[] |
Beschränkt die Antwort auf Fahrzeuge, die mindestens einen der angegebenen Fahrttypen unterstützen. |
maximumStaleness |
Beschränkt die Antwort auf Fahrzeuge, die innerhalb des angegebenen Zeitraums Standortupdates an Fleet Engine gesendet haben. Stehende Fahrzeuge, die noch ihren Standort übermitteln, gelten nicht als veraltet. Falls vorhanden, muss die Dauer eine gültige positive Dauer sein. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit " |
vehicleTypeCategories[] |
Erforderlich. Beschränkt die Antwort auf Fahrzeuge mit einer der angegebenen Typkategorien. |
requiredAttributes[] |
Aufrufer können mithilfe einer beliebigen Kombination der Felder
Beschränkt die Antwort 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. Jeder wiederholte String muss das Format „key:value“ haben. |
requiredOneOfAttributes[] |
Beschränkt die Antwort auf Fahrzeuge mit mindestens einem der angegebenen Attribute in jedem |
requiredOneOfAttributeSets[] |
Ähnlich wie bei
Beschränkt die Antwort auf Fahrzeuge, die mit allen Attributen in einem |
vehicleState |
Beschränkt die Antwort auf Fahrzeuge mit diesem Fahrzeugstatus. |
onTripOnly |
Geben Sie nur die Fahrzeuge mit der/n aktuellen Fahrt(en) zurück. |
filter |
Optional. Eine Filterabfrage, die beim Auflisten von 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. |
viewport |
Optional. Ein Filter, der die zurückgegebenen Fahrzeuge auf diejenigen beschränkt, deren letzter bekannter Standort sich in dem vom Darstellungsbereich definierten rechteckigen Bereich befand. |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
vehicles.list
-Antwortnachricht.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{
"vehicles": [
{
object ( |
Felder | |
---|---|
vehicles[] |
Fahrzeuge, die den Kriterien in der Anfrage entsprechen. Die maximale Anzahl der zurückgegebenen Fahrzeuge wird durch das Feld |
nextPageToken |
Token zum Abrufen der nächsten Seite mit Fahrzeugen oder leer, wenn es keine weiteren Fahrzeuge gibt, die die Anfragekriterien erfüllen. |
totalSize |
Erforderlich. Gesamtzahl der Fahrzeuge, die den Anfragekriterien auf allen Seiten entsprechen. |
Darstellungsbereich
Ein Darstellungsbereich für Breiten- und Längengrad, dargestellt als zwei diagonal gegenüberliegende low
- und high
-Punkte Ein Darstellungsbereich gilt als geschlossener Bereich, d.h. er enthält seine Begrenzung. Die Breitengradgrenzen müssen zwischen -90 und einschließlich 90 Grad und die Längengradgrenzen zwischen -180 und 180 Grad liegen. Es gibt verschiedene Fälle:
Wenn
low
=high
, besteht der Darstellungsbereich aus diesem einzelnen Punkt.Wenn
low.longitude
>high.longitude
wird der Längengradbereich umgekehrt (der Darstellungsbereich kreuzt die 180-Grad-Längenlinie).Wenn
low.longitude
= -180 Grad undhigh.longitude
= 180 Grad ist, enthält der Darstellungsbereich alle Längengrade.Wenn
low.longitude
= 180 Grad undhigh.longitude
= -180 Grad ist, ist der Längengradbereich leer.Wenn
low.latitude
>high.latitude
, der Breitengradbereich ist leer.
Sowohl low
als auch high
müssen ausgefüllt werden und das dargestellte Feld darf nicht leer sein (wie in den Definitionen oben angegeben). Ein leerer Darstellungsbereich führt zu einem Fehler.
Dieser Darstellungsbereich schließt beispielsweise New York City vollständig ein:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
JSON-Darstellung |
---|
{ "low": { object ( |
Felder | |
---|---|
low |
Erforderlich. Der Tiefstpunkt des Darstellungsbereichs. |
high |
Erforderlich. Der höchste Punkt des Darstellungsbereichs. |