Package maps.fleetengine.delivery.v1

Index

DeliveryService

Last Mile Delivery Service

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

Erstellt einen Batch neuer Task-Objekte und gibt ihn zurück.

CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

Erstellt ein neues DeliveryVehicle-Objekt und gibt es zurück.

CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

Erstellt ein neues Task-Objekt und gibt es zurück.

GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

Gibt die angegebene DeliveryVehicle-Instanz zurück.

GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Ruft Informationen zu Task ab.

GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

Gibt die angegebene TaskTrackingInfo-Instanz zurück.

ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

Ruft alle DeliveryVehicles ab, die die angegebenen Filterkriterien erfüllen.

ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

Ruft alle Tasks ab, die die angegebenen Filterkriterien erfüllen.

SearchTasks

rpc SearchTasks(SearchTasksRequest) returns (SearchTasksResponse)

Eingestellt: Verwenden Sie stattdessen GetTaskTrackingInfo.

UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Schreibt aktualisierte DeliveryVehicle-Daten in Fleet Engine und weist der DeliveryVehicle Tasks zu. Der Name von DeliveryVehicle kann nicht aktualisiert werden. Du kannst zwar remaining_vehicle_journey_segments aktualisieren, aber sie muss alle VehicleJourneySegments enthalten, die derzeit in DeliveryVehicle verwendet werden. Die task_ids werden aus remaining_vehicle_journey_segments abgerufen. Die zugehörigen Tasks werden DeliveryVehicle zugewiesen, wenn sie noch nicht zugewiesen wurden.

UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Aktualisiert Task-Daten.

BatchCreateTasksRequest

Die BatchCreateTask-Anfragenachricht.

Felder
header

DeliveryRequestHeader

Optional. Der standardmäßige Delivery API-Anfrageheader. Hinweis: Wenn Sie dieses Feld festlegen, muss das Headerfeld in den CreateTaskRequest-Nachrichten entweder leer oder mit diesem Feld übereinstimmen.

parent

string

Erforderlich. Die übergeordnete Ressource, die von allen Aufgaben gemeinsam genutzt wird. Dieser Wert muss das Format providers/{provider} haben. Die provider muss die Google Cloud-Projekt-ID sein. Beispiel: sample-cloud-project Das übergeordnete Feld in den CreateTaskRequest-Nachrichten muss entweder leer oder mit diesem Feld übereinstimmen.

requests[]

CreateTaskRequest

Erforderlich. Die Anfragenachricht, die die zu erstellenden Ressourcen angibt. Hinweis: Sie können in einem Batch maximal 500 Aufgaben erstellen.

BatchCreateTasksResponse

Die BatchCreateTask-Antwortnachricht.

Felder
tasks[]

Task

Die erstellten Tasks

CreateDeliveryVehicleRequest

Die CreateDeliveryVehicle-Anfragenachricht.

Felder
header

DeliveryRequestHeader

Optional. Der standardmäßige Delivery API-Anfrageheader.

parent

string

Erforderlich. Muss das Format providers/{provider} haben. Der Anbieter muss die Google Cloud-Projekt-ID sein. Beispiel: sample-cloud-project.

delivery_vehicle_id

string

Erforderlich. Die Lieferfahrzeug-ID muss eindeutig sein und unterliegt den folgenden Einschränkungen:

  • Muss ein gültiger Unicode-String sein.
  • Er ist auf maximal 64 Zeichen begrenzt.
  • Normalisiert nach der Unicode-Normalisierungsform C.
  • Darf keine der folgenden ASCII-Zeichen enthalten: „/“, „:“, „?“, „,“ oder „#“.
delivery_vehicle

DeliveryVehicle

Erforderlich. Die DeliveryVehicle-Entität, die erstellt werden soll. Beim Erstellen eines neuen Lieferfahrzeugs können Sie die folgenden optionalen Felder festlegen:

  • last_location
  • Attribute

Hinweis: Das Feld name des Lieferfahrzeugs wird ignoriert. Alle anderen „DeliveryVehicle“-Felder dürfen nicht festgelegt werden, da andernfalls ein Fehler zurückgegeben wird.

CreateTaskRequest

Die CreateTask-Anfragenachricht.

Felder
header

DeliveryRequestHeader

Optional. Der standardmäßige Delivery API-Anfrageheader.

parent

string

Erforderlich. Muss das Format providers/{provider} haben. Die provider muss die Google Cloud-Projekt-ID sein. Beispiel: sample-cloud-project

task_id

string

Erforderlich. Die Aufgaben-ID muss eindeutig sein, sollte jedoch keine Sendungsverfolgungs-ID sein. Verwenden Sie das Feld tracking_id, um eine Sendungsverfolgungs-ID zu speichern. Mehrere Aufgaben können dieselbe tracking_id haben. Aufgaben-IDs unterliegen den folgenden Einschränkungen:

  • Muss ein gültiger Unicode-String sein.
  • Er ist auf maximal 64 Zeichen begrenzt.
  • Normalisiert nach der Unicode-Normalisierungsform C.
  • Darf keine der folgenden ASCII-Zeichen enthalten: „/“, „:“, „?“, „,“ oder „#“.
task

Task

Erforderlich. Die Task-Entität, die erstellt werden soll. Beim Erstellen einer Aufgabe sind die folgenden Felder erforderlich:

  • type
  • state (muss auf OPEN festgelegt sein)
  • tracking_id (darf nicht für UNAVAILABLE- oder SCHEDULED_STOP-Aufgaben festgelegt werden, ist aber für alle anderen Aufgabentypen erforderlich)
  • planned_location (optional für UNAVAILABLE Aufgaben)
  • task_duration

Hinweis: Das Feld name der Aufgabe wird ignoriert. Alle anderen „Task“-Felder dürfen nicht festgelegt werden, da andernfalls ein Fehler zurückgegeben wird.

DeliveryRequestHeader

Ein RequestHeader enthält Felder, die für alle Delivery-RPC-Anfragen gelten.

Felder
language_code

string

Der BCP-47-Sprachcode, z. B. en-US oder sr-Latn. Weitere Informationen finden Sie unter http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Wenn keiner angegeben ist, kann die Antwort in einer beliebigen Sprache vorliegen, wobei Englisch bevorzugt wird, sofern ein solcher Name vorhanden ist. Beispiel für Feldwert: en-US.

region_code

string

Erforderlich. CLDR-Regionscode der Region, aus der die Anfrage stammt. Beispiel für Feldwert: US.

sdk_version

string

Version des aufrufenden SDK, falls zutreffend. Das Versionsformat ist „major.minor.patch“, Beispiel: 1.1.2.

os_version

string

Version des Betriebssystems, auf dem das aufrufende SDK ausgeführt wird. Beispiele für Feldwerte: 4.4.1, 12.1.

device_model

string

Modell des Geräts, auf dem das aufrufende SDK ausgeführt wird. Beispiele für Feldwerte: iPhone12,1, SM-G920F.

sdk_type

SdkType

Der SDK-Typ, von dem die Anfrage gesendet wird.

maps_sdk_version

string

Version des MapSDK, von dem das aufrufende SDK abhängig ist (falls zutreffend). Das Versionsformat ist „major.minor.patch“, Beispiel: 5.2.1.

nav_sdk_version

string

Version des NavSDK, von dem das aufrufende SDK abhängt, sofern zutreffend. Das Versionsformat ist „major.minor.patch“, Beispiel: 2.1.0.

platform

Platform

Plattform des aufrufenden SDK

manufacturer

string

Hersteller des Android-Geräts über das aufrufende SDK; gilt nur für die Android SDKs. Beispiel für Feldwert: Samsung.

android_api_level

int32

Android API-Level des aufrufenden SDKs, gilt nur für die Android SDKs. Beispiel für Feldwert: 23.

trace_id

string

Optionale ID, die für Protokollierungszwecke angegeben werden kann, um die Anfrage zu identifizieren.

Plattform

Die Plattform des aufrufenden SDK.

Enums
PLATFORM_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn der Bahnsteig ausgelassen wird.
ANDROID Die Anfrage kommt von Android.
IOS Die Anfrage stammt von iOS.
WEB Die Anfrage kommt aus dem Web.

SdkType

Mögliche SDK-Typen.

Enums
SDK_TYPE_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn sdk_type weggelassen wird.
CONSUMER Das aufrufende SDK ist „Consumer“.
DRIVER Das aufrufende SDK ist „Treiber“.
JAVASCRIPT Das aufrufende SDK ist JavaScript.

DeliveryVehicle

Die DeliveryVehicle-Nachricht. Ein Lieferfahrzeug transportiert Sendungen von einem Depot zu einem Lieferort und von einem Abholort zum Depot. In einigen Fällen befördern Lieferfahrzeuge Sendungen auch direkt vom Abholort zum Lieferort.

Hinweis: gRPC und REST APIs verwenden unterschiedliche Namenskonventionen für Felder. Beispielsweise beziehen sich das Feld DeliveryVehicle.current_route_segment in der gRPC API und das Feld DeliveryVehicle.currentRouteSegment in der REST API auf dasselbe Feld.

Felder
name

string

Der eindeutige Name dieses Lieferfahrzeugs. Das Format dafür ist providers/{provider}/deliveryVehicles/{vehicle}.

last_location

DeliveryVehicleLocation

Der letzte gemeldete Standort des Lieferfahrzeugs.

navigation_status

DeliveryVehicleNavigationStatus

Navigationsstatus des Lieferfahrzeugs.

current_route_segment

bytes

Die codierte Polylinie zur Angabe der Route zum nächsten Wegpunkt, die von der Navigation empfohlen wird. Diese Information wird von deiner Fahrer-App aktualisiert, wenn eine Haltestelle erreicht oder vorbeigegangen ist und die Route neu berechnet wird. Diese LatLngs werden in Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) oder Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) für alle aktiven Tasks zurückgegeben, die dem Fahrzeug zugewiesen sind.

Es gibt einige Fälle, in denen dieses Feld nicht zum Ausfüllen von Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) oder Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) verwendet wird:

  • Der Endpunkt von current_route_segment stimmt nicht mit DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) oder DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST) überein.

  • Die Treiber-App hat ihren Standort in letzter Zeit nicht aktualisiert. Daher ist der letzte aktualisierte Wert für dieses Feld möglicherweise veraltet.

  • Die Fahrer-App hat vor Kurzem ihren Standort aktualisiert, aber das current_route_segment ist veraltet und verweist auf eine frühere Fahrzeughaltestelle.

In diesen Fällen füllt Fleet Engine dieses Feld mit einer Route von der zuletzt übergebenen VehicleStop bis zur anstehenden VehicleStop, um dafür zu sorgen, dass der Nutzer dieses Felds die besten verfügbaren Informationen zum aktuellen Pfad des Lieferfahrzeugs hat.

current_route_segment_end_point

LatLng

Der Ort, an dem das current_route_segment endet. Sie wird derzeit nicht von der Treiber-App ausgefüllt, kann aber bei UpdateDeliveryVehicle-Aufrufen bereitgestellt werden. Es ist entweder der LatLng der nächsten Haltestelle des Fahrzeugs oder der letzte LatLng des current_route_segment. Fleet Engine versucht dann, in eine tatsächliche VehicleStop zu interpolieren.

Dieses Feld wird in UpdateDeliveryVehicle-Aufrufen ignoriert, wenn das Feld current_route_segment leer ist.

remaining_distance_meters

Int32Value

Die verbleibende Fahrstrecke für den current_route_segment. Die Treiber-App stellt dieses Feld in der Regel bereit. Unter bestimmten Umständen überschreibt Fleet Engine jedoch den von der App gesendeten Wert. Weitere Informationen finden Sie unter DeliveryVehicle.current_route_segment. Dieses Feld wird in Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) oder Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) für alle aktiven Tasks zurückgegeben, die dem Lieferfahrzeug zugewiesen sind.

Fleet Engine ignoriert dieses Feld in UpdateDeliveryVehicleRequest, wenn das Feld current_route_segment leer ist.

remaining_duration

Duration

Die verbleibende Fahrzeit für den current_route_segment. Die Treiber-App stellt dieses Feld in der Regel bereit. Unter bestimmten Umständen überschreibt Fleet Engine jedoch den von der App gesendeten Wert. Weitere Informationen finden Sie unter DeliveryVehicle.current_route_segment. Dieses Feld wird in Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) oder Task.remainingVehicleJourneySegments[0].drivingDuration (REST) für alle aktiven Aufgaben zurückgegeben, die dem Lieferfahrzeug zugewiesen sind.

Fleet Engine ignoriert dieses Feld in UpdateDeliveryVehicleRequest, wenn das Feld current_route_segment leer ist.

remaining_vehicle_journey_segments[]

VehicleJourneySegment

Die Fahrtsegmente, die diesem Lieferfahrzeug zugewiesen sind, beginnend mit dem zuletzt gemeldeten Standort des Fahrzeugs. Dieses Feld wird in der Antwort von ListDeliveryVehicles nicht ausgefüllt.

attributes[]

DeliveryVehicleAttribute

Eine Liste benutzerdefinierter Attribute für Lieferfahrzeuge. Ein Lieferfahrzeug kann maximal 100 Attribute haben, wobei jedes Attribut einen eindeutigen Schlüssel haben muss.

type

DeliveryVehicleType

Der Typ dieses Lieferfahrzeugs. Wenn die Richtlinie nicht konfiguriert ist, wird standardmäßig AUTO verwendet.

DeliveryVehicleType

Die Art des Lieferfahrzeugs.

Enums
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Der Wert wird nicht verwendet.
AUTO Ein Auto.
TWO_WHEELER Motorrad, Moped oder anderes zweirädriges Fahrzeug
BICYCLE Von Menschen angetriebene Fahrzeuge.
PEDESTRIAN Ein Personentransporter, der in der Regel zu Fuß oder joggt und Fußgängerwege entlangfährt.

DeliveryVehicleAttribute

Beschreibt ein Fahrzeugattribut als Schlüssel/Wert-Paar. Der String „key:value“ darf nicht länger als 256 Zeichen sein.

Felder
key

string

Der Schlüssel des Attributs.

value

string

Der Wert des Attributs.

Union-Feld delivery_vehicle_attribute_value. Der Wert des Attributs kann als String, boolescher oder doppelter Typ angegeben werden. Für delivery_vehicle_attribute_value ist nur einer der folgenden Werte zulässig:
string_value

string

Attributwert vom Typ „String“.

Hinweis: Dies ist mit dem Feld value identisch, das letztendlich verworfen wird. Bei Erstellungs- oder Aktualisierungsmethoden kann jedes Feld verwendet werden. Es wird jedoch dringend empfohlen, string_value zu verwenden. Wenn sowohl string_value als auch value festgelegt sind, müssen sie identisch sein. Andernfalls wird ein Fehler ausgegeben. Beide Felder werden in den Antworten ausgefüllt.

bool_value

bool

Boolescher Attributwert.

number_value

double

Doppelt eingegebener Attributwert.

DeliveryVehicleLocation

Standort, Geschwindigkeit und Fahrtrichtung eines Fahrzeugs zu einem bestimmten Zeitpunkt

Felder
location

LatLng

Der Standort des Fahrzeugs. Wenn es an Fleet Engine gesendet wird, ist der Standort des Fahrzeugs ein GPS-Standort. Wenn Sie diese als Antwort erhalten, kann der Standort des Fahrzeugs entweder ein GPS-Standort, ein zusätzlicher Standort oder ein anderer ungefährer Standort sein. Die Quelle wird in location_sensor angegeben.

horizontal_accuracy
(deprecated)

DoubleValue

Eingestellt: Verwenden Sie stattdessen latlng_accuracy.

latlng_accuracy

DoubleValue

Genauigkeit von location in Metern als Radius.

heading

Int32Value

Richtung des Fahrzeugs in Grad. 0 steht für Norden. Der gültige Bereich ist [0,360).

bearing_accuracy
(deprecated)

DoubleValue

Eingestellt: Verwenden Sie stattdessen heading_accuracy.

heading_accuracy

DoubleValue

Genauigkeit von heading Grad.

altitude

DoubleValue

Höhe in Metern über WGS 84

vertical_accuracy
(deprecated)

DoubleValue

Eingestellt: Verwenden Sie stattdessen altitude_accuracy.

altitude_accuracy

DoubleValue

Genauigkeit von altitude in Metern.

speed_kmph
(deprecated)

Int32Value

Geschwindigkeit des Fahrzeugs in Kilometern pro Stunde. Eingestellt: Verwenden Sie stattdessen speed.

speed

DoubleValue

Geschwindigkeit des Fahrzeugs in Metern/Sekunde

speed_accuracy

DoubleValue

Genauigkeit von speed in Metern/Sekunde.

update_time

Timestamp

Die Zeit, zu der location vom Sensor gemäß der Uhr des Sensors gemeldet wurde.

server_time

Timestamp

Nur Ausgabe. Der Zeitpunkt, zu dem der Server die Standortinformationen erhalten hat.

location_sensor

DeliveryVehicleLocationSensor

Anbieter der Standortdaten (z. B. GPS).

is_road_snapped

BoolValue

Gibt an, ob location an eine Straße angedockt ist.

is_gps_sensor_enabled

BoolValue

Nur Eingabe. Gibt an, ob der GPS-Sensor auf dem Mobilgerät aktiviert ist.

time_since_update

Int32Value

Nur Eingabe. Zeit (in Sekunden), seit dieser Standort zum ersten Mal an den Server gesendet wurde Bei der ersten Aktualisierung ist der Wert null. Wenn die Uhrzeit unbekannt ist, z. B. wenn die App neu gestartet wird, wird dieser Wert auf null zurückgesetzt.

num_stale_updates
(deprecated)

Int32Value

Nur Eingabe. Eingestellt: Es werden jetzt andere Signale verwendet, um festzustellen, ob ein Standort veraltet ist.

raw_location

LatLng

Unbearbeiteter Standort des Fahrzeugs (nicht verarbeitet von Snapper)

raw_location_time

Timestamp

Zeitstempel, der dem Rohstandort zugeordnet ist.

raw_location_sensor

DeliveryVehicleLocationSensor

Quelle des unformatierten Speicherorts. Die Standardeinstellung ist GPS.

raw_location_accuracy

DoubleValue

Genauigkeit von raw_location als Radius in Metern.

supplemental_location

LatLng

Zusätzlicher Standort, der von der integrierten App bereitgestellt wird.

supplemental_location_time

Timestamp

Zeitstempel, der dem zusätzlichen Standort zugeordnet ist.

supplemental_location_sensor

DeliveryVehicleLocationSensor

Quelle des zusätzlichen Standorts. Die Standardeinstellung ist CUSTOMER_SUPPLIED_LOCATION.

supplemental_location_accuracy

DoubleValue

Genauigkeit von supplemental_location als Radius in Metern.

road_snapped
(deprecated)

bool

Eingestellt: Verwenden Sie stattdessen is_road_snapped.

DeliveryVehicleLocationSensor

Der zur Standortbestimmung verwendete Sensor oder die Methode.

Enums
UNKNOWN_SENSOR Der Sensor ist nicht angegeben oder unbekannt.
GPS GPS oder unterstütztes GPS.
NETWORK Unterstütztes GPS, Mobilfunkmast-ID oder WLAN-Zugangspunkt.
PASSIVE Mobilfunkmast-ID oder WLAN-Zugangspunkt
ROAD_SNAPPED_LOCATION_PROVIDER Ein Standort, der vom Mobilgerät als wahrscheinlichste Straßenposition bestimmt wird.
CUSTOMER_SUPPLIED_LOCATION Ein vom Kunden bereitgestellter Standort aus einer unabhängigen Quelle. In der Regel wird dieser Wert für einen Standort verwendet, der aus anderen Quellen als dem Mobilgerät bereitgestellt wird, auf dem das Driver SDK ausgeführt wird. Wenn die ursprüngliche Quelle durch einen der anderen enum-Werte beschrieben wird, verwenden Sie diesen Wert. Mit CUSTOMER_SUPPLIED_LOCATION gekennzeichnete Standorte werden in der Regel über die last_location.supplemental_location_sensor eines DeliveryVehicles zur Verfügung gestellt.
FLEET_ENGINE_LOCATION Ein Standort, der von Fleet Engine anhand der verfügbaren Signale berechnet wird. Nur Ausgabe. Dieser Wert wird in einer Anfrage abgelehnt.
FUSED_LOCATION_PROVIDER Fused Location Provider von Android.
CORE_LOCATION Der Standortanbieter unter Apple-Betriebssystemen.

DeliveryVehicleNavigationStatus

Der Navigationsstatus des Fahrzeugs.

Enums
UNKNOWN_NAVIGATION_STATUS Navigationsstatus nicht angegeben.
NO_GUIDANCE Die Navigation der Driver App befindet sich im FREE_NAV-Modus.
ENROUTE_TO_DESTINATION Die detaillierte Routenführung ist verfügbar und die Navigation der Fahrer-App befindet sich im GUIDED_NAV-Modus.
OFF_ROUTE Das Fahrzeug hat die vorgeschlagene Route verlassen.
ARRIVED_AT_DESTINATION Das Fahrzeug befindet sich im Umkreis von etwa 50 m um den Zielort.

GetDeliveryVehicleRequest

Die GetDeliveryVehicle-Anfragenachricht.

Felder
header

DeliveryRequestHeader

Optional. Der standardmäßige Delivery API-Anfrageheader.

name

string

Erforderlich. Muss das Format providers/{provider}/deliveryVehicles/{delivery_vehicle} haben. Die provider muss die Google Cloud-Projekt-ID sein. Beispiel: sample-cloud-project

GetTaskRequest

Die GetTask-Anfragenachricht.

Felder
header

DeliveryRequestHeader

Optional. Der standardmäßige Delivery API-Anfrageheader.

name

string

Erforderlich. Muss das Format providers/{provider}/tasks/{task} haben. Die provider muss die Google Cloud-Projekt-ID sein. Beispiel: sample-cloud-project

GetTaskTrackingInfoRequest

Die GetTaskTrackingInfoRequest-Anfragenachricht.

Felder
header

DeliveryRequestHeader

Optional. Der standardmäßige Delivery API-Anfrageheader.

name

string

Erforderlich. Muss das Format providers/{provider}/taskTrackingInfo/{tracking_id} haben. Die provider muss die Google Cloud-Projekt-ID und die tracking_id die Tracking-ID sein, die der Aufgabe zugeordnet ist. Ein Beispielname kann providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id sein.

ListDeliveryVehiclesRequest

Die ListDeliveryVehicles-Anfragenachricht.

Felder
header

DeliveryRequestHeader

Optional. Der standardmäßige Delivery API-Anfrageheader.

parent

string

Erforderlich. Muss das Format providers/{provider} haben. Die provider muss die Google Cloud-Projekt-ID sein. Beispiel: sample-cloud-project

page_size

int32

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.

page_token

string

Optional. Ein Seitentoken, das von einem vorherigen ListDeliveryVehicles-Aufruf empfangen wurde. Sie müssen sie angeben, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListDeliveryVehicles bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

filter

string

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 ListDeliveryVehicles nur Abfragen für Fahrzeugattribute wie attributes.<key> = <value> oder attributes.<key1> = <value1> AND attributes.<key2> = <value2> unterstützt werden. Da alle Attribute als Strings gespeichert werden, werden nur Stringvergleiche unterstützt. Für einen 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").

Pro Filterabfrage sind maximal 50 Einschränkungen zulässig. Eine Einschränkung ist Teil der Abfrage des Formats attribute.<KEY> <COMPARATOR> <VALUE>, z. B. hat attributes.foo = bar den Wert „1“.

viewport

Viewport

Optional. Filter, der die zurückgegebenen Fahrzeuge auf diejenigen beschränkt, deren letzter bekannter Standort sich in dem rechteckigen Bereich befand, der vom Darstellungsbereich definiert wurde.

ListDeliveryVehiclesResponse

Die ListDeliveryVehicles-Antwortnachricht.

Felder
delivery_vehicles[]

DeliveryVehicle

Die Lieferfahrzeuge, die den angeforderten Filterkriterien entsprechen. 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 die angeforderten Filterkriterien erfüllen.

next_page_token

string

Sie können dieses Token in der ListDeliveryVehiclesRequest übergeben, um mit dem Auflisten von Ergebnissen fortzufahren. Wenn alle Ergebnisse zurückgegeben werden, ist dieses Feld nicht in der Antwort enthalten oder es ist ein leerer String.

total_size

int64

Die Gesamtzahl der Lieferfahrzeuge, die den Anfragekriterien entsprechen, auf allen Seiten.

ListTasksRequest

Die ListTasks-Anfragenachricht.

Felder
header

DeliveryRequestHeader

Optional. Der standardmäßige Delivery API-Anfrageheader.

parent

string

Erforderlich. Muss das Format providers/{provider} haben. Die provider muss die Google Cloud-Projekt-ID sein. Beispiel: sample-cloud-project

page_size

int32

Optional. Die maximale Anzahl von Aufgaben, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn Sie diesen Wert nicht angeben, bestimmt der Server die Anzahl der zurückzugebenden Ergebnisse.

page_token

string

Optional. Ein Seitentoken von einem vorherigen ListTasks-Aufruf. Sie können sie angeben, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListTasks bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

filter

string

Optional. Eine Filterabfrage, die beim Auflisten von Aufgaben angewendet werden soll. Beispiele für die Filtersyntax finden Sie unter http://aip.dev/160. Wenn Sie keinen Wert angeben oder nach einem leeren String filtern, werden alle Aufgaben zurückgegeben. Informationen zu den Aufgabenattributen, nach denen Sie filtern können, finden Sie unter Aufgaben auflisten.

ListTasksResponse

Die ListTasks-Antwort mit den Aufgaben, die die Filterkriterien in ListTasksRequest erfüllen.

Felder
tasks[]

Task

Die Gruppe von Aufgaben, die die angeforderten Filterkriterien erfüllen. Wenn kein Filter angegeben ist, gibt die Anfrage alle Aufgaben zurück. Eine erfolgreiche Antwort kann auch leer sein. Eine leere Antwort bedeutet, dass keine Aufgaben gefunden wurden, die die angeforderten Filterkriterien erfüllen.

next_page_token

string

Übergeben Sie dieses Token in der ListTasksRequest, um mit der Ergebnisliste fortzufahren. Wenn alle Ergebnisse zurückgegeben wurden, ist dieses Feld entweder ein leerer String oder es erscheint nicht in der Antwort.

total_size

int64

Die Gesamtzahl der Aufgaben, die den Anfragekriterien entsprechen, auf allen Seiten.

LocationInfo

Ein Standort mit zusätzlichen Kennungen.

Felder
point

LatLng

Die Koordinaten des Ortes.

SearchTasksRequest

Eingestellt: Gib stattdessen GetTaskTrackingInfoRequests in GetTaskTrackingInfo aus.

Felder
header

DeliveryRequestHeader

Optional. Der standardmäßige Delivery API-Anfrageheader.

parent

string

Erforderlich. Muss das Format providers/{provider} haben. Der Anbieter muss die Google Cloud-Projekt-ID sein. Beispiel: sample-cloud-project.

tracking_id

string

Erforderlich. Die ID der Gruppe zusammengehöriger Aufgaben, die angefordert werden. Tracking-IDs unterliegen den folgenden Einschränkungen:

  • Muss ein gültiger Unicode-String sein.
  • Er ist auf maximal 64 Zeichen begrenzt.
  • Normalisiert nach der Unicode-Normalisierungsform C.
  • Darf keine der folgenden ASCII-Zeichen enthalten: „/“, „:“, „?“, „,“ oder „#“.
page_size

int32

Optional. Die maximale Anzahl von Aufgaben, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn Sie diesen Wert nicht angeben, bestimmt der Server die Anzahl der zurückzugebenden Ergebnisse.

page_token

string

Optional. Ein Seitentoken, das von einem vorherigen SearchTasks-Aufruf empfangen wurde. Sie müssen diesen Wert angeben, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für SearchTasks bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

SearchTasksResponse

Die SearchTasks-Antwort. Sie enthält die Aufgaben, die den Suchkriterien in SearchTasksRequest entsprechen.

Felder
tasks[]

Task

Die Gruppe von Tasks für die angeforderte tracking_id. Eine erfolgreiche Antwort kann auch leer sein. Eine leere Antwort bedeutet, dass dem bereitgestellten tracking_id keine Aufgaben zugeordnet sind.

next_page_token

string

Übergeben Sie dieses Token in der SearchTasksRequest, um mit der Ergebnisliste fortzufahren. Wenn alle Ergebnisse zurückgegeben wurden, ist dieses Feld entweder ein leerer String oder es erscheint nicht in der Antwort.

Aufgabe

Eine Aufgabe in der Delivery API stellt eine einzelne zu verfolgende Aktion dar. Im Allgemeinen wird zwischen lieferungsbezogenen Aufgaben und nicht funktionsfähigen Aufgaben unterschieden. Einer Sendung können mehrere Tasks zugeordnet sein. Zum Beispiel könnte es eine Aufgabe für den Abholvorgang und eine für das Einsteigen oder Umsteigen geben. Außerdem können unterschiedliche Aufgaben für eine bestimmte Sendung von verschiedenen Fahrzeugen abgewickelt werden. Zum Beispiel könnte ein Fahrzeug die Abholung erledigen und die Sendung zum Hub leiten, während ein anderes Fahrzeug dieselbe Sendung vom Hub an die Abgabestelle fährt.

Hinweis: gRPC und REST APIs verwenden unterschiedliche Namenskonventionen für Felder. Beispielsweise beziehen sich das Feld Task.journey_sharing_info in der gRPC API und das Feld Task.journeySharingInfo in der REST API auf dasselbe Feld.

Felder
name

string

Muss das Format providers/{provider}/tasks/{task} haben.

type

Type

Erforderlich. Nicht veränderbar. Definiert den Aufgabentyp. Dies kann beispielsweise eine Pause oder eine Sendung sein.

state

State

Erforderlich. Der aktuelle Ausführungsstatus der Aufgabe.

task_outcome

TaskOutcome

Das Ergebnis der Aufgabe.

task_outcome_time

Timestamp

Der Zeitstempel, der angibt, wann das Ergebnis des Task vom Anbieter festgelegt wurde.

task_outcome_location

LocationInfo

Der Ort, an dem das Ergebnis des Task festgelegt wurde. Dieser Wert wird im Rahmen von UpdateTask aktualisiert. Wenn dieser Wert nicht explizit vom Anbieter aktualisiert wird, fügt Fleet Engine standardmäßig den letzten bekannten Fahrzeugstandort (den rohen Standort) ein.

task_outcome_location_source

TaskOutcomeLocationSource

Gibt an, woher der Wert für task_outcome_location stammt.

tracking_id

string

Nicht veränderbar. Dieses Feld erleichtert das Speichern einer ID, sodass Sie eine komplizierte Zuordnung vermeiden können. Sie können tracking_id nicht für Tasks vom Typ UNAVAILABLE und SCHEDULED_STOP festlegen. Diese IDs unterliegen den folgenden Einschränkungen:

  • Muss ein gültiger Unicode-String sein.
  • Er ist auf maximal 64 Zeichen begrenzt.
  • Normalisiert nach der Unicode-Normalisierungsform C.
  • Darf keine der folgenden ASCII-Zeichen enthalten: „/“, „:“, „?“, „,“ oder „#“.
delivery_vehicle_id

string

Nur Ausgabe. Die ID des Fahrzeugs, das diese Task ausführt. Für Lieferfahrzeug-IDs gelten die folgenden Einschränkungen:

  • Muss ein gültiger Unicode-String sein.
  • Er ist auf maximal 64 Zeichen begrenzt.
  • Normalisiert nach der Unicode-Normalisierungsform C.
  • Darf keine der folgenden ASCII-Zeichen enthalten: „/“, „:“, „?“, „,“ oder „#“.
planned_location

LocationInfo

Nicht veränderbar. Der Ort, an dem die Aufgabe erledigt wird. Optional für UNAVAILABLE-Aufgaben, aber für alle anderen Tasks erforderlich.

task_duration

Duration

Erforderlich. Nicht veränderbar. Die Zeit, die zum Ausführen einer Aufgabe an diesem Standort benötigt wird.

target_time_window

TimeWindow

Das Zeitfenster, in dem die Aufgabe abgeschlossen werden soll.

journey_sharing_info

JourneySharingInfo

Nur Ausgabe. Spezifische Felder für die Kursfreigabe. Wird nicht gefüllt, wenn der Status CLOSED ist.

task_tracking_view_config

TaskTrackingViewConfig

Die Konfiguration für das Aufgaben-Tracking, die angibt, welche Datenelemente unter welchen Umständen für die Endnutzer sichtbar sind.

attributes[]

TaskAttribute

Eine Liste benutzerdefinierter Aufgabenattribute. Jedes Attribut muss einen eindeutigen Schlüssel haben.

JourneySharingInfo

Spezielle Felder der Onlinerecherche

Felder
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Tracking-Informationen für die Haltestellen, die das zugewiesene Fahrzeug machen wird, bevor es diese Aufgabe abschließt. Beachten Sie, dass diese Liste Haltestellen von anderen Aufgaben enthalten kann.

Das erste Segment, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) oder Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), enthält Routeninformationen vom letzten bekannten Standort des Fahrers zum nächsten VehicleStop. Die aktuellen Routeninformationen stammen normalerweise aus der Fahrer-App, mit Ausnahme von Fällen, die in der Dokumentation zu DeliveryVehicle.current_route_segment angegeben sind. Die anderen Segmente in Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) oder Task.journeySharingInfo.remainingVehicleJourneySegments (REST) werden von Fleet Engine ausgefüllt. Sie liefern Routeninformationen zwischen den verbleibenden VehicleStops.

last_location

DeliveryVehicleLocation

Gibt den letzten gemeldeten Standort des zugewiesenen Fahrzeugs an.

last_location_snappable

bool

Gibt an, ob der letzteStandort des Fahrzeugs an current_route_segment angedockt werden kann. Dieser Wert ist „False“, wenn entweder last_location oder current_route_segment nicht vorhanden ist. Dieser Wert wird von Fleet Engine berechnet. Aktualisierungen von Clients werden ignoriert.

Status

Der Status einer Aufgabe. Dies zeigt den Fortschritt des Tasks an.

Enums
STATE_UNSPECIFIED Standard. Wird für einen nicht angegebenen oder nicht erkannten Aufgabenstatus verwendet.
OPEN Entweder wurde die Aufgabe noch keinem Lieferfahrzeug zugewiesen oder das Lieferfahrzeug hat die dem Task zugewiesene Fahrzeughaltestelle noch nicht bestanden.
CLOSED Wenn das Fahrzeug für diese Aufgabe die Fahrzeughaltestelle passiert.

TaskOutcome

Das Ergebnis des Versuchs, eine Aufgabe auszuführen. Wenn TaskState geschlossen ist, zeigt TaskOutcome an, ob der Vorgang erfolgreich abgeschlossen wurde.

Enums
TASK_OUTCOME_UNSPECIFIED Das Aufgabenergebnis, bevor sein Wert festgelegt wird.
SUCCEEDED Die Aufgabe wurde erfolgreich abgeschlossen.
FAILED Entweder konnte die Aufgabe nicht abgeschlossen werden oder sie wurde abgebrochen.

TaskOutcomeLocationSource

Die Identität der Quelle, die task_outcome_location ausgefüllt hat.

Enums
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Das Ergebnis der Aufgabe, bevor es festgelegt wird.
PROVIDER Der Anbieter hat task_outcome_location angegeben.
LAST_VEHICLE_LOCATION Der Anbieter hat task_outcome_location nicht angegeben, sodass Fleet Engine den letzten bekannten Fahrzeugstandort verwendet hat.

Typ

Die Art der Aufgabe.

Enums
TYPE_UNSPECIFIED Standardmäßig ist der Aufgabentyp unbekannt.
PICKUP Eine Abholaufgabe ist die Aktion, bei der eine Lieferung von einem Kunden abgeholt wird. Für Abholer in Depots oder Zubringern muss der Typ SCHEDULED_STOP verwendet werden.
DELIVERY Eine Lieferaufgabe ist die Aktion, die für die Lieferung einer Sendung an einen Endkunden ergriffen wird. Für Abgaben von Depots oder Zubringern sollte der Typ SCHEDULED_STOP verwendet werden.
SCHEDULED_STOP Eine Aufgabe für geplante Stopps wird zu Planungszwecken verwendet. Dabei kann es sich zum Beispiel um das Abholen oder Ausgeben von Lieferungen in Zubringern oder Depots handeln. Es sollte nicht für Sendungen verwendet werden, die von einem Endkunden abgeholt oder abgegeben werden.
UNAVAILABLE Eine Aufgabe, bei der das Fahrzeug nicht verfügbar ist. Das kann beispielsweise passieren, wenn der Fahrer eine Pause macht oder wenn das Fahrzeug aufgetankt wird.

TaskAttribute

Beschreibt ein Aufgabenattribut als Schlüssel/Wert-Paar. Der String „key:value“ darf nicht länger als 256 Zeichen sein.

Felder
key

string

Der Schlüssel des Attributs. Schlüssel dürfen keinen Doppelpunkt (:) enthalten.

Union-Feld task_attribute_value. Der Wert des Attributs kann als String, boolescher oder doppelter Typ angegeben werden. Wenn keine festgelegt sind, wird der „string_value“ des TaskAttributes als leerer String „“ gespeichert. Für task_attribute_value ist nur einer der folgenden Werte zulässig:
string_value

string

Attributwert vom Typ „String“.

bool_value

bool

Boolescher Attributwert.

number_value

double

Doppelt eingegebener Attributwert.

TaskTrackingInfo

Die TaskTrackingInfo-Nachricht. Die Nachricht enthält Informationen zur Aufgabenverfolgung, die angezeigt werden. Wenn eine Tracking-ID mit mehreren Aufgaben verknüpft ist, verwendet Fleet Engine eine Heuristik, um zu entscheiden, für welche Aufgabe die TaskTrackingInfo-Informationen ausgewählt werden.

Felder
name

string

Er muss das Format providers/{provider}/taskTrackingInfo/{tracking} haben, wobei tracking für die Tracking-ID steht.

tracking_id

string

Nicht veränderbar. Die Tracking-ID einer Aufgabe. * Muss ein gültiger Unicode-String sein. * Dies ist auf eine maximale Länge von 64 Zeichen begrenzt. * Nach der Unicode-Normalisierungsform C normalisiert. * Darf keine der folgenden ASCII-Zeichen enthalten: „/“, „:“, „?“, „,“ oder „#“.

vehicle_location

DeliveryVehicleLocation

Der letzte Standort des Fahrzeugs.

route_polyline_points[]

LatLng

Eine Liste von Punkten, die, wenn sie miteinander verbunden sind, eine Polylinie der erwarteten Route des Fahrzeugs zum Standort dieser Aufgabe bilden.

remaining_stop_count

Int32Value

Gibt die Anzahl der verbleibenden Haltestellen des Fahrzeugs an, bis die Taskhaltestelle erreicht ist, einschließlich der Taskhaltestelle. Wenn die nächste Haltestelle des Fahrzeugs beispielsweise die Taskhaltestelle ist, ist der Wert „1“.

remaining_driving_distance_meters

Int32Value

Die gesamte verbleibende Entfernung in Metern zum gewünschten VehicleStop.

estimated_arrival_time

Timestamp

Der Zeitstempel, der die voraussichtliche Ankunftszeit an der Haltestelle angibt.

estimated_task_completion_time

Timestamp

Der Zeitstempel, der die geschätzte Abschlusszeit einer Aufgabe angibt.

state

State

Der aktuelle Ausführungsstatus der Aufgabe.

task_outcome

TaskOutcome

Das Ergebnis des Versuchs, eine Aufgabe auszuführen.

task_outcome_time

Timestamp

Der Zeitstempel, der angibt, wann das Ergebnis der Aufgabe vom Anbieter festgelegt wurde.

planned_location

LocationInfo

Nicht veränderbar. Der Ort, an dem die Aufgabe erledigt wird.

target_time_window

TimeWindow

Das Zeitfenster, in dem die Aufgabe abgeschlossen werden soll.

attributes[]

TaskAttribute

Die benutzerdefinierten Attribute, die für die Aufgabe festgelegt wurden.

TaskTrackingViewConfig

Die Konfigurationsnachricht, die definiert, wann ein Datenelement einer Aufgabe für die Endnutzer sichtbar sein soll.

Felder
route_polyline_points_visibility

VisibilityOption

Das Feld, das angibt, wann Polylinienpunkte der Route sichtbar sein können. Wenn dieses Feld nicht angegeben ist, wird für diese Daten die Konfiguration der Standardsichtbarkeit auf Projektebene verwendet.

estimated_arrival_time_visibility

VisibilityOption

Das Feld, das angibt, wann die voraussichtliche Ankunftszeit sichtbar sein soll. Wenn dieses Feld nicht angegeben ist, wird für diese Daten die Konfiguration der Standardsichtbarkeit auf Projektebene verwendet.

estimated_task_completion_time_visibility

VisibilityOption

Das Feld, das angibt, wann die geschätzte Fertigstellungszeit für Aufgaben sichtbar sein kann. Wenn dieses Feld nicht angegeben ist, wird für diese Daten die Konfiguration der Standardsichtbarkeit auf Projektebene verwendet.

remaining_driving_distance_visibility

VisibilityOption

Das Feld, das angibt, wann die verbleibende Fahrstrecke sichtbar sein soll. Wenn dieses Feld nicht angegeben ist, wird für diese Daten die Konfiguration der Standardsichtbarkeit auf Projektebene verwendet.

remaining_stop_count_visibility

VisibilityOption

Das Feld, das angibt, wann die Anzahl der verbleibenden Haltestellen sichtbar sein soll. Wenn dieses Feld nicht angegeben ist, wird für diese Daten die Konfiguration der Standardsichtbarkeit auf Projektebene verwendet.

vehicle_location_visibility

VisibilityOption

Das Feld, das angibt, wann der Fahrzeugstandort sichtbar ist. Wenn dieses Feld nicht angegeben ist, wird für diese Daten die Konfiguration der Standardsichtbarkeit auf Projektebene verwendet.

VisibilityOption

Die Optionsnachricht, die definiert, wann ein Datenelement für die Endnutzer sichtbar sein soll.

Felder
Union-Feld visibility_option. Die ausgewählte Sichtbarkeitsoption. Für visibility_option ist nur einer der folgenden Werte zulässig:
remaining_stop_count_threshold

int32

Dieses Datenelement ist für die Endnutzer sichtbar, wenn die Anzahl der verbleibenden Haltestellen <= duration_stop_count_threshold ist.

duration_until_estimated_arrival_time_threshold

Duration

Dieses Datenelement ist für die Endnutzer sichtbar, wenn die voraussichtliche Ankunftszeit für die Haltestelle <= duration_until_estimated_arrival_time_threshold ist.

remaining_driving_distance_meters_threshold

int32

Dieses Datenelement ist für die Endnutzer sichtbar, wenn die verbleibende Fahrstrecke in Metern <= restliche_driving_distance_meters_threshold ist.

always

bool

Wenn die Richtlinie auf „true“ gesetzt ist, ist dieses Datenelement für Endnutzer ohne Grenzwerte immer sichtbar. Dieses Feld darf nicht auf "false" gesetzt werden.

never

bool

Wenn die Richtlinie auf „true“ gesetzt ist, wird dieses Datenelement für Endnutzer ohne Schwellenwerte immer ausgeblendet. Dieses Feld darf nicht auf "false" gesetzt werden.

TimeWindow

Einen Zeitraum.

Felder
start_time

Timestamp

Erforderlich. Die Startzeit des Zeitfensters (einschließlich).

end_time

Timestamp

Erforderlich. Die Endzeit des Zeitfensters (einschließlich).

UpdateDeliveryVehicleRequest

Die UpdateDeliveryVehicle-Anfragenachricht.

Felder
header

DeliveryRequestHeader

Optional. Der standardmäßige Delivery API-Anfrageheader.

delivery_vehicle

DeliveryVehicle

Erforderlich. Die DeliveryVehicle-Entitätsaktualisierung, die angewendet werden soll. Hinweis: Der Name von DeliveryVehicle kann nicht aktualisiert werden.

update_mask

FieldMask

Erforderlich. Eine Feldmaske, die angibt, welche DeliveryVehicle-Felder aktualisiert werden sollen. „update_mask“ muss mindestens ein Feld enthalten.

Dies ist eine durch Kommas getrennte Liste voll qualifizierter Feldnamen. Beispiel: "remaining_vehicle_journey_segments".

UpdateTaskRequest

Die UpdateTask-Anfragenachricht.

Felder
header

DeliveryRequestHeader

Optional. Der standardmäßige Delivery API-Anfrageheader.

task

Task

Erforderlich. Die mit der Aktualisierung verknüpfte Aufgabe. Die folgenden Felder werden von Fleet Engine verwaltet. Aktualisieren Sie sie nicht mit Task.update.

  • last_location.
  • last_location_snappable.
  • name.
  • remaining_vehicle_journey_segments.
  • task_outcome_location_source.

Hinweis: Sie können den Wert von task_outcome nicht mehr ändern, nachdem Sie ihn festgelegt haben.

Wenn die Aufgabe einem Lieferfahrzeug zugewiesen wurde, setzen Sie den Aufgabenstatus nicht mithilfe von Task.update auf GESCHLOSSEN. Entfernen Sie stattdessen die VehicleStop, die die Aufgabe enthält, aus dem Lieferfahrzeug. Dadurch wird der Aufgabenstatus automatisch auf GESCHLOSSEN festgelegt.

update_mask

FieldMask

Erforderlich. Die Feldmaske, die angibt, welche Aufgabenfelder aktualisiert werden sollen. Hinweis: update_mask muss mindestens ein Feld enthalten.

Dies ist eine durch Kommas getrennte Liste voll qualifizierter Feldnamen. Beispiel: "task_outcome,task_outcome_time,task_outcome_location".

VehicleJourneySegment

Stellt das Reisesegment eines Fahrzeugs dar, also von der vorherigen Haltestelle bis zur aktuellen Haltestelle. Wenn es die erste aktive Haltestelle ist, wird sie vom aktuellen Standort des Fahrzeugs zu dieser Haltestelle verschoben.

Felder
stop

VehicleStop

Gibt die Position der Haltestelle zusammen mit den mit der Haltestelle verknüpften Tasks an. Einige Felder von VehicleStop sind nicht vorhanden, wenn dieser Fahrtabschnitt Teil von JourneySharingInfo ist.

driving_distance_meters

Int32Value

Nur Ausgabe. Die Entfernung zwischen der vorherigen Haltestelle und dieser Haltestelle. Wenn die aktuelle Haltestelle die erste Haltestelle in der Liste der Fahrtsegmente ist, wird als Startpunkt der Standort des Fahrzeugs verwendet, das zu dem Zeitpunkt erfasst wurde, zu dem diese Haltestelle der Liste hinzugefügt wurde. Dieses Feld ist möglicherweise nicht vorhanden, wenn dieser Wegabschnitt Teil von JourneySharingInfo ist.

driving_duration

Duration

Nur Ausgabe. Die Fahrtzeit von der vorherigen Haltestelle bis zu dieser Haltestelle. Wenn die aktuelle Haltestelle die erste Haltestelle in der Liste der Fahrtsegmente ist, wird als Startpunkt der Standort des Fahrzeugs verwendet, der zu dem Zeitpunkt erfasst wurde, zu dem diese Haltestelle in die Liste aufgenommen wurde.

Wenn dieses Feld im Pfad Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) oder Task.remainingVehicleJourneySegments[0].drivingDuration (REST) definiert ist, kann es mit dem Wert aus DeliveryVehicle.remaining_duration (gRPC) oder DeliveryVehicle.remainingDuration (REST) gefüllt werden. So wird die verbleibende Fahrtzeit vom letzten bekannten Standort der Fahrer-App und nicht mehr der Fahrtzeit ab der vorherigen Haltestelle angezeigt.

path[]

LatLng

Nur Ausgabe. Pfad von der vorherigen Haltestelle zu dieser Haltestelle. Wenn die aktuelle Haltestelle die erste Haltestelle in der Liste der Fahrtsegmente ist, ist dies der Pfad vom aktuellen Standort des Fahrzeugs zu dieser Haltestelle zu dem Zeitpunkt, als die Haltestelle der Liste hinzugefügt wurde. Dieses Feld ist möglicherweise nicht vorhanden, wenn dieser Wegabschnitt Teil von JourneySharingInfo ist.

Wenn dieses Feld im Pfad Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) oder Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) definiert ist, kann es mit den LatLngs gefüllt werden, die aus DeliveryVehicle.current_route_segment (gRPC) oder DeliveryVehicle.currentRouteSegment (REST) decodiert wurden. Dadurch wird der Fahrweg vom letzten bekannten Standort der Fahrer-App und nicht vom Pfad von der vorherigen Haltestelle angegeben.

VehicleStop

Beschreibt einen Punkt, an dem ein Fahrzeug anhält, um eine oder mehrere Tasks auszuführen.

Felder
planned_location

LocationInfo

Erforderlich. Die Position der Haltestelle. Die Orte in den Tasks stimmen möglicherweise nicht genau mit diesem Standort überein, sind aber nicht weit entfernt. Dieses Feld wird in der Antwort auf einen GetTask- oder SearchTasks-Aufruf nicht ausgefüllt.

tasks[]

TaskInfo

Die Liste der Task-Werte, die an dieser Haltestelle ausgeführt werden sollen. Dieses Feld wird in der Antwort auf einen GetTask- oder SearchTasks-Aufruf nicht ausgefüllt.

state

State

Der Status von VehicleStop. Dieses Feld wird in der Antwort auf einen GetTask- oder SearchTasks-Aufruf nicht ausgefüllt.

Status

Der aktuelle Status eines VehicleStop-Objekts.

Enums
STATE_UNSPECIFIED Unbekannt.
NEW Erstellt, aber nicht aktiv weitergeleitet.
ENROUTE Zugewiesenes und aktives Routing
ARRIVED An der Haltestelle angekommen. Bei der Routenplanung zur nächsten Haltestelle wird davon ausgegangen, dass alle vorherigen Haltestellen angefahren wurden.

TaskInfo

Zusätzliche Informationen zu der an dieser Haltestelle ausgeführten Aufgabe.

Felder
task_id

string

Die Aufgaben-ID. Dieses Feld wird in der Antwort auf einen GetTask- oder SearchTasks-Aufruf nicht ausgefüllt. Aufgaben-IDs unterliegen den folgenden Einschränkungen:

  • Muss ein gültiger Unicode-String sein.
  • Er ist auf maximal 64 Zeichen begrenzt.
  • Normalisiert nach der Unicode-Normalisierungsform C.
  • Darf keine der folgenden ASCII-Zeichen enthalten: „/“, „:“, „?“, „,“ oder „#“.
task_duration

Duration

Nur Ausgabe. Die zur Ausführung der Aufgabe erforderliche Zeit.

target_time_window

TimeWindow

Nur Ausgabe. Das Zeitfenster, in dem die Aufgabe abgeschlossen werden soll. Dies wird nur in der Antwort auf GetDeliveryVehicle festgelegt.