Method: providers.vehicles.list

Eine paginaierte Liste der Fahrzeuge, die mit einem Anbieter verknüpft 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

string

Erforderlich. Muss das Format providers/{provider} haben. Der Anbieter muss die Projekt-ID des Google Cloud-Projekts sein, zu dem das Dienstkonto, das diesen Aufruf durchführt, gehört (z. B. sample-cloud-project).

Abfrageparameter

Parameter
header

object (RequestHeader)

Der Standard-Anfrageheader von Fleet Engine.

pageSize

integer

Die maximale Anzahl von Fahrzeugen, die zurückgegeben werden sollen. Standardwert: 100.

pageToken

string

Der Wert von nextPageToken, der durch einen vorherigen Aufruf von vehicles.list bereitgestellt wurde, damit Sie durch Fahrzeuggruppen paginieren können. Der Wert ist nicht definiert, wenn die Filterkriterien der Anfrage nicht mit den Filterkriterien für den vorherigen Aufruf von vehicles.list übereinstimmen.

minimumCapacity

integer

Gibt die erforderliche Mindestkapazität des Fahrzeugs an. Der Wert für „maximumCapacity“ aller zurückgegebenen Fahrzeuge ist größer oder gleich diesem Wert. Muss, falls festgelegt, größer oder gleich 0 sein.

tripTypes[]

enum (TripType)

Die Antwort wird auf Fahrzeuge beschränkt, die mindestens einen der angegebenen Fahrttypen unterstützen.

maximumStaleness

string (Duration format)

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 es sich um eine gültige positive Dauer handeln.

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

vehicleTypeCategories[]

enum (Category)

Erforderlich. Beschränkt die Antwort auf Fahrzeuge mit einer der angegebenen Typkategorien. UNKNOWN ist nicht zulässig.

requiredAttributes[]

string

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 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[]

string

Beschränkt die Antwort auf Fahrzeuge mit mindestens einem der angegebenen Attribute in jedem VehicleAttributeList. 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. Jeder wiederholte String muss das Format „Schlüssel1:Wert1|Schlüssel2:Wert2|Schlüssel3:Wert3“ haben.

requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets bietet zusätzliche Funktionen.

Ähnlich wie bei requiredOneOfAttributes verwendet requiredOneOfAttributeSets eine Nachricht, die eine Liste von Listen zulässt und Ausdrücke wie diese zulässt:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

Die Antwort wird auf Fahrzeuge beschränkt, die mit allen Attributen in einem VehicleAttributeList übereinstimmen. 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. Jeder wiederholte String muss das Format „Schlüssel1:Wert1|Schlüssel2:Wert2|Schlüssel3:Wert3“ haben.

vehicleState

enum (VehicleState)

Beschränkt die Antwort auf Fahrzeuge mit diesem Fahrzeugstatus.

onTripOnly

boolean

Geben Sie nur die Fahrzeuge mit der/den aktuellen Fahrt(en) zurück.

filter

string

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 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 vehicleState oder onTripOnly.

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. Daher sind nur Stringvergleiche zulässig. 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. attributes.<key> = "10" oder attributes.<key> = "true").

viewport

object (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 (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Felder
vehicles[]

object (Vehicle)

Fahrzeuge, die den Kriterien in der Anfrage entsprechen. Die maximale Anzahl der zurückgegebenen Fahrzeuge wird durch das Feld pageSize in der Anfrage bestimmt.

nextPageToken

string

Token zum Abrufen der nächsten Seite mit Fahrzeugen. Leer, wenn keine weiteren Fahrzeuge die Anfragekriterien erfüllen.

totalSize

string (int64 format)

Erforderlich. Gesamtzahl der Fahrzeuge, die auf allen Seiten den Anfragekriterien entsprechen.

Darstellungsbereich

Ein Breiten- und Längengrad-Darstellungsbereich, dargestellt als zwei diagonal gegenüberliegende Punkte low und high. Ein Darstellungsbereich gilt als geschlossener Bereich, d.h. er enthält seine Begrenzung. Die Breitengradgrenzen müssen zwischen -90 und 90 Grad liegen und die Längengradgrenzen zwischen -180 und 180 Grad. Beispiele für verschiedene Fälle:

  • Wenn low = high, besteht der Darstellungsbereich aus diesem einzelnen Punkt.

  • Wenn low.longitude > high.longitude ist, wird der Längengradbereich umgekehrt (der Darstellungsbereich kreuzt die 180-Grad-Längenlinie).

  • Wenn low.longitude = -180 Grad und high.longitude = 180 Grad ist, enthält der Darstellungsbereich alle Längengrade.

  • Wenn low.longitude = 180 Grad und high.longitude = -180 Grad ist, ist der Längengradbereich leer.

  • Wenn low.latitude > high.latitude ist, ist der Breitengradbereich leer.

Sowohl low als auch high müssen ausgefüllt sein und das dargestellte Feld darf nicht leer sein (wie in den Definitionen oben angegeben). Ein leerer Darstellungsbereich führt zu einem Fehler.

Dieser Ansichtsbereich umschließt beispielsweise vollständig New York City:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

JSON-Darstellung
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Felder
low

object (LatLng)

Erforderlich. Der Tiefstpunkt des Darstellungsbereichs.

high

object (LatLng)

Erforderlich. Der höchste Punkt des Darstellungsbereichs.