Ruft alle DeliveryVehicle
s ab, die die angegebenen Filterkriterien erfüllen.
HTTP-Anfrage
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
parent |
Erforderlich. Muss das Format |
Suchparameter
Parameter | |
---|---|
header |
Optional. Der Standard-Anfrageheader der Delivery API. |
pageSize |
Optional. Die maximale Anzahl der zurückzugebenden Fahrzeuge. Der Dienst gibt möglicherweise weniger als diese Zahl zurück. Wenn Sie diese Zahl nicht angeben, bestimmt der Server die Anzahl der zurückzugebenden Ergebnisse. |
pageToken |
Optional. Ein Seitentoken, das von einem vorherigen Beim Paginieren müssen alle anderen für |
filter |
Optional. Eine Filterabfrage, die beim Auflisten von Lieferfahrzeugen angewendet werden soll. Beispiele für die Filtersyntax finden Sie unter http://aip.dev/160. Wenn Sie keinen Wert oder einen leeren String für den Filter angeben, werden alle Lieferfahrzeuge zurückgegeben. Beachten Sie, dass für In einer Filterabfrage sind maximal 50 Einschränkungen zulässig. Eine Einschränkung ist Teil der Abfrage der Form |
viewport |
Optional. Ein Filter, mit dem die zurückgegebenen Fahrzeuge auf diejenigen eingeschränkt werden, deren letzter bekannter Standort sich in dem durch den Darstellungsbereich definierten rechteckigen Bereich befand. |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Die deliveryVehicles.list
-Antwortnachricht.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{
"deliveryVehicles": [
{
object ( |
Felder | |
---|---|
deliveryVehicles[] |
Die Lieferfahrzeuge, die die angeforderten Filterkriterien erfüllen. Wenn kein Filter angegeben ist, werden bei der Anfrage alle Lieferfahrzeuge zurückgegeben. Eine erfolgreiche Antwort kann auch leer sein. Eine leere Antwort bedeutet, dass keine Lieferfahrzeuge gefunden wurden, die den angeforderten Filterkriterien entsprechen. |
nextPageToken |
Sie können dieses Token in der |
totalSize |
Die Gesamtzahl der Lieferfahrzeuge, die den Anfragekriterien entsprechen, auf allen Seiten. |
Darstellungsbereich
Ein Darstellungsbereich mit Breiten- und Längengrad, der als zwei diagonal gegenüberliegende low
- und high
-Punkte dargestellt wird. Ein Darstellungsbereich wird als geschlossener Bereich betrachtet, d.h. er enthält seine Begrenzung. Die Breitengradgrenzen müssen zwischen -90 und 90 Grad (einschließlich) und die Längengradgrenzen zwischen -180 und 180 Grad liegen. Verschiedene Fälle:
Wenn
low
=high
ist, besteht der Darstellungsbereich aus diesem einzelnen Punkt.Wenn
low.longitude
>high.longitude
ist, ist der Längengradbereich invertiert, d. h., der Darstellungsbereich kreuzt die 180-Grad-Längengradlinie.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
ist, ist der Breitengradbereich 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 umfasst beispielsweise New York City:
{ "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. |