- HTTP-Anfrage
- Pfadparameter
- Anfrageparameter
- Anfragetext
- Antworttext
- Darstellungsbereich
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
Ruft alle DeliveryVehicle
s ab, die den angegebenen Filterkriterien entsprechen.
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 standardmäßige Anfrageheader der Delivery API |
pageSize |
Optional. Die maximale Anzahl von Fahrzeugen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diese Anzahl 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, 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
Die Antwortnachricht deliveryVehicles.list
.
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, gibt die Anfrage alle Lieferfahrzeuge zurück. Eine erfolgreiche Antwort kann auch leer sein. Eine leere Antwort bedeutet, dass keine Lieferfahrzeuge gefunden wurden, die die angeforderten Filterkriterien erfüllen. |
nextPageToken |
Sie können dieses Token im |
totalSize |
Die Gesamtzahl der Auslieferungsfahrzeuge, 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. |