Package maps.fleetengine.delivery.v1

Index

DeliveryService

Der Dienst für die Lieferung auf der letzten Meile.

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

Erstellt eine Gruppe neuer Task-Objekte und gibt sie zurück.

CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

Erstellt ein neues DeliveryVehicle und gibt es zurück.

CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

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

DeleteDeliveryVehicle

rpc DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest) returns (Empty)

Löscht ein DeliveryVehicle aus Fleet Engine.

Gibt FAILED_PRECONDITION zurück, wenn dem DeliveryVehicle OPEN-Aufgaben zugewiesen sind.

DeleteTask

rpc DeleteTask(DeleteTaskRequest) returns (Empty)

Löscht eine einzelne Aufgabe.

Gibt FAILED_PRECONDITION zurück, wenn die Aufgabe OPEN ist und einem DeliveryVehicle zugewiesen wurde.

GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

Gibt die angegebene DeliveryVehicle-Instanz zurück.

GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Ruft Informationen zu einem Task ab.

GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

Gibt die angegebene TaskTrackingInfo-Instanz zurück.

ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

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

ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

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

UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Schreibt aktualisierte DeliveryVehicle-Daten in Fleet Engine und weist Tasks der DeliveryVehicle zu. Sie können den Namen der DeliveryVehicle nicht aktualisieren. Sie können remaining_vehicle_journey_segments aktualisieren, aber es muss alle VehicleJourneySegment enthalten, die auf dem DeliveryVehicle beibehalten werden sollen. Die task_id werden aus remaining_vehicle_journey_segments abgerufen und die entsprechenden Tasks werden dem DeliveryVehicle zugewiesen, sofern sie noch nicht zugewiesen wurden.

UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Aktualisiert die Daten von Task.

BatchCreateTasksRequest

Die Anfragenachricht für BatchCreateTask.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API. Hinweis: Wenn Sie dieses Feld festlegen, muss das Headerfeld in den CreateTaskRequest-Nachrichten entweder leer sein 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. provider muss die Google Cloud-Projekt-ID sein. Beispiel: sample-cloud-project Das übergeordnete Feld in den CreateTaskRequest-Nachrichten muss entweder leer sein oder mit diesem Feld übereinstimmen.

requests[]

CreateTaskRequest

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

BatchCreateTasksResponse

Die Antwortnachricht für BatchCreateTask.

Felder
tasks[]

Task

Die erstellten Aufgaben.

CreateDeliveryVehicleRequest

Die Anfragenachricht für CreateDeliveryVehicle.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API.

parent

string

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

delivery_vehicle_id

string

Erforderlich. Die ID des Lieferfahrzeugs muss eindeutig sein und unterliegt den folgenden Einschränkungen:

  • Muss ein gültiger Unicode-String sein.
  • Die maximale Länge beträgt 64 Zeichen.
  • Normalisiert gemäß Unicode Normalization Form C.
  • Darf keines der folgenden ASCII-Zeichen enthalten: „/“, „:“, „?“, „,“ oder „#“.
delivery_vehicle

DeliveryVehicle

Erforderlich. Die zu erstellende DeliveryVehicle-Entität. Beim Erstellen eines neuen Lieferfahrzeugs können Sie die folgenden optionalen Felder festlegen:

  • Typ
  • last_location
  • Attribute

Hinweis: Das Feld name von DeliveryVehicle wird ignoriert. Alle anderen DeliveryVehicle-Felder dürfen nicht festgelegt werden. Andernfalls wird ein Fehler zurückgegeben.

CreateTaskRequest

Die Anfragenachricht für CreateTask.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API.

parent

string

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

task_id

string

Erforderlich. Die Aufgaben-ID muss eindeutig sein, darf aber keine Sendungsverfolgungs-ID sein. Verwenden Sie das Feld tracking_id, um eine Sendungsverfolgungs-ID zu speichern. Mehrere Aufgaben können dieselbe tracking_id haben. Für Aufgaben-IDs gelten die folgenden Einschränkungen:

  • Muss ein gültiger Unicode-String sein.
  • Die maximale Länge beträgt 64 Zeichen.
  • Normalisiert gemäß Unicode Normalization Form C.
  • Darf keines der folgenden ASCII-Zeichen enthalten: „/“, „:“, „?“, „,“ oder „#“.
task

Task

Erforderlich. Die zu erstellende Task-Entität. Beim Erstellen einer Aufgabe sind die folgenden Felder erforderlich:

  • type
  • state (muss auf OPEN gesetzt 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

Die folgenden Felder können optional festgelegt werden:

  • target_time_window
  • task_tracking_view_config
  • attributes

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

DeleteDeliveryVehicleRequest

DeleteDeliveryVehicle-Anfragenachricht.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API.

name

string

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

DeleteTaskRequest

Anfragenachricht für DeleteTask.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API.

name

string

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

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 keine Sprache angegeben ist, kann die Antwort in einer beliebigen Sprache erfolgen. Englisch wird bevorzugt, wenn 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 Anruf-SDK, falls zutreffend. Das Versionsformat ist „major.minor.patch“, z. B. 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 Anruf-SDK ausgeführt wird. Beispiele für Feldwerte: iPhone12,1, SM-G920F.

sdk_type

SdkType

Der Typ des SDK, das die Anfrage sendet.

maps_sdk_version

string

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

nav_sdk_version

string

Version des NavSDK, von dem das aufrufende SDK abhängt (falls zutreffend). Das Versionsformat ist „major.minor.patch“, z. B. 2.1.0.

platform

Platform

Plattform des aufrufenden SDK.

manufacturer

string

Hersteller des Android-Geräts, von dem das aufrufende SDK stammt. Gilt nur für die Android-SDKs. Beispiel für Feldwert: Samsung.

android_api_level

int32

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

trace_id

string

Optionale ID, die zu Protokollierungszwecken angegeben werden kann, um die Anfrage zu identifizieren.

Plattform

Die Plattform des aufrufenden SDK.

Enums
PLATFORM_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn die Plattform weggelassen wird.
ANDROID Die Anfrage kommt von Android.
IOS Die Anfrage stammt von iOS.
WEB Die Anfrage stammt 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 Anruf-SDK ist „Consumer“.
DRIVER Das aufrufende SDK ist „Driver“.
JAVASCRIPT Das aufrufende SDK ist JavaScript.

DeliveryVehicle

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

Hinweis: gRPC- und REST-APIs verwenden unterschiedliche Namenskonventionen für Felder. Beispiel: Das Feld DeliveryVehicle.current_route_segment in der gRPC API und das Feld DeliveryVehicle.currentRouteSegment in der REST API beziehen sich 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.

past_locations[]

DeliveryVehicleLocation

Nur Eingabe. Orte, an denen sich dieses Lieferfahrzeug in der Vergangenheit befunden hat und die noch nicht an Fleet Engine gemeldet wurden. Dies wird in UpdateDeliveryVehicleRequest verwendet, um Standorte aufzuzeichnen, die zuvor nicht an den Server gesendet werden konnten. Das passiert in der Regel, wenn das Lieferfahrzeug keine Internetverbindung hat.

navigation_status

DeliveryVehicleNavigationStatus

Der Navigationsstatus des Lieferfahrzeugs.

current_route_segment

bytes

Die codierte Polylinie, die die Route angibt, die für die Navigation zum nächsten Wegpunkt empfohlen wird. Ihre Fahrer-App aktualisiert diese Informationen, wenn ein Stopp erreicht oder passiert wird und wenn die Navigation eine neue Route berechnet. Diese LatLng werden in Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) oder Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) für alle aktiven Aufgaben zurückgegeben, die dem Fahrzeug zugewiesen sind.

Es gibt einige Fälle, in denen dieses Feld möglicherweise 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 Fahrer-App hat ihren Standort in letzter Zeit nicht aktualisiert. Der zuletzt aktualisierte Wert für dieses Feld ist möglicherweise nicht mehr aktuell.

  • Die Fahrer-App hat den Standort vor Kurzem aktualisiert, aber der current_route_segment ist veraltet und verweist auf einen früheren Fahrzeugstopp.

In diesen Fällen wird dieses Feld in Fleet Engine mit einer Route vom zuletzt durchfahrenen VehicleStop zum nächsten VehicleStop gefüllt, damit der Nutzer dieses Felds die bestmöglichen Informationen zum aktuellen Pfad des Lieferfahrzeugs erhält.

current_route_segment_end_point

LatLng

Der Ort, an dem die current_route_segment endet. Diese wird derzeit nicht von der Fahrer-App ausgefüllt, kann aber bei UpdateDeliveryVehicle-Aufrufen angegeben werden. Das ist entweder die LatLng der nächsten Haltestelle oder die letzte LatLng der current_route_segment. Fleet Engine versucht dann, einen tatsächlichen VehicleStop zu interpolieren.

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

remaining_distance_meters

Int32Value

Die verbleibende Fahrstrecke für das current_route_segment. Dieses Feld wird in der Regel von der Fahrer-App bereitgestellt. 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 Task 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 die current_route_segment. Dieses Feld wird in der Regel von der Fahrer-App bereitgestellt. 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 diesem Lieferfahrzeug zugewiesenen Fahrtabschnitte, 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 und jedes Attribut muss einen eindeutigen Schlüssel haben.

type

DeliveryVehicleType

Der Typ dieses Lieferfahrzeugs. Wenn nicht festgelegt, wird standardmäßig AUTO verwendet.

DeliveryVehicleType

Der Typ des Lieferfahrzeugs.

Enums
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Der Wert wird nicht verwendet.
AUTO Ein Auto.
TWO_WHEELER Ein Motorrad, Moped oder anderes zweirädriges Fahrzeug
BICYCLE Transport mit Muskelkraft.
PEDESTRIAN Eine Person, die sich zu Fuß oder laufend auf Fußwegen fortbewegt.

DeliveryVehicleAttribute

Beschreibt ein Fahrzeugattribut als Schlüssel/Wert-Paar. Die Länge des „key:value“-Strings darf 256 Zeichen nicht überschreiten.

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 vom Typ „String“, „Bool“ oder „Double“ sein. Für delivery_vehicle_attribute_value ist nur einer der folgenden Werte zulässig:
string_value

string

Attributwert vom Typ „String“.

Hinweis: Dieses Feld ist identisch mit dem Feld value, das demnächst eingestellt wird. Für Erstellungs- oder Aktualisierungsmethoden kann eines der beiden Felder 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 Antworten ausgefüllt.

bool_value

bool

Boolescher Attributwert.

number_value

double

Attributwert vom Typ „Double“.

DeliveryVehicleLocation

Die Position, Geschwindigkeit und Fahrtrichtung eines Fahrzeugs zu einem bestimmten Zeitpunkt.

Felder
location

LatLng

Der Standort des Fahrzeugs. Wenn die Position an Fleet Engine gesendet wird, ist sie ein GPS-Standort. Wenn Sie den Standort in einer Antwort erhalten, kann es sich dabei entweder um einen GPS-Standort, einen ergänzenden Standort oder einen anderen geschätzten Standort handeln. Die Quelle ist in location_sensor angegeben.

horizontal_accuracy
(deprecated)

DoubleValue

Verworfen: Verwenden Sie stattdessen latlng_accuracy.

latlng_accuracy

DoubleValue

Genauigkeit von location Metern als Radius.

heading

Int32Value

Richtung, in die sich das Fahrzeug bewegt, in Grad. 0 steht für Norden. Der gültige Bereich ist [0,360).

bearing_accuracy
(deprecated)

DoubleValue

Verworfen: Verwenden Sie stattdessen heading_accuracy.

heading_accuracy

DoubleValue

Genauigkeit von heading in Grad.

altitude

DoubleValue

Höhe in Metern über WGS84.

vertical_accuracy
(deprecated)

DoubleValue

Verworfen: Verwenden Sie stattdessen altitude_accuracy.

altitude_accuracy

DoubleValue

Genauigkeit von altitude in Metern.

speed_kmph
(deprecated)

Int32Value

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

speed

DoubleValue

Geschwindigkeit des Fahrzeugs in Metern pro Sekunde

speed_accuracy

DoubleValue

Genauigkeit von speed in Metern pro Sekunde.

update_time

Timestamp

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

server_time

Timestamp

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

location_sensor

DeliveryVehicleLocationSensor

Anbieter von 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, seitdem dieser Standort zum ersten Mal an den Server gesendet wurde. Beim ersten Update ist dieser Wert null. Wenn die Zeit 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

Rohdaten zum Fahrzeugstandort (nicht von Road-Snapper verarbeitet).

raw_location_time

Timestamp

Der Zeitstempel, der dem Rohstandort zugeordnet ist.

raw_location_sensor

DeliveryVehicleLocationSensor

Quelle des Rohstandorts. Die Standardeinstellung ist GPS.

raw_location_accuracy

DoubleValue

Genauigkeit von raw_location als Radius in Metern.

flp_location

LatLng

Der Standort vom Android-Anbieter für kombinierte Standortbestimmung (Fused Location Provider; FLP).

flp_update_time

Timestamp

Zeitstempel von flp_location aktualisieren

flp_latlng_accuracy_meters

DoubleValue

Genauigkeit von flp_location Metern als Radius.

flp_heading_degrees

Int32Value

Richtung, in die sich das Fahrzeug bewegt, in Grad, wie vom Fused Location Provider bestimmt. 0 steht für Norden. Der gültige Bereich ist [0,360).

supplemental_location

LatLng

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

supplemental_location_time

Timestamp

Zeitstempel für den zusätzlichen Standort.

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

Verworfen: Verwenden Sie stattdessen is_road_snapped.

DeliveryVehicleLocationSensor

Der Sensor oder die Methode, die zur Bestimmung des Standorts verwendet wurde.

Enums
UNKNOWN_SENSOR Der Sensor ist nicht angegeben oder unbekannt.
GPS GPS oder Assisted GPS.
NETWORK A-GPS, Mobilfunkmast-ID oder WLAN-Zugangspunkt.
PASSIVE ID des Mobilfunkmastes oder WLAN-Zugangspunkt.
ROAD_SNAPPED_LOCATION_PROVIDER Ein Standort, der vom Mobilgerät als wahrscheinlichste Straßenposition ermittelt wurde.
CUSTOMER_SUPPLIED_LOCATION Ein vom Kunden angegebener 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 mit dem Driver SDK stammt. Wenn die ursprüngliche Quelle durch einen der anderen Aufzählungswerte beschrieben wird, verwenden Sie diesen Wert. Standorte, die mit CUSTOMER_SUPPLIED_LOCATION gekennzeichnet sind, werden in der Regel über die last_location.supplemental_location_sensor eines DeliveryVehicle bereitgestellt.
FLEET_ENGINE_LOCATION Ein Standort, der von Fleet Engine anhand der verfügbaren Signale berechnet wird. Nur Ausgabe. Dieser Wert wird abgelehnt, wenn er in einer Anfrage empfangen wird.
FUSED_LOCATION_PROVIDER Anbieter für kombinierte Standortbestimmung von Android.
CORE_LOCATION Der Standortanbieter auf Apple-Betriebssystemen.

DeliveryVehicleNavigationStatus

Der Navigationsstatus des Fahrzeugs.

Enums
UNKNOWN_NAVIGATION_STATUS Nicht angegebener Navigationsstatus.
NO_GUIDANCE Die Navigation der Fahrer-App befindet sich im FREE_NAV-Modus.
ENROUTE_TO_DESTINATION Die detaillierte Routenführung ist verfügbar und die Navigation in der Driver App ist in den Modus GUIDED_NAV gewechselt.
OFF_ROUTE Das Fahrzeug ist von der vorgeschlagenen Route abgewichen.
ARRIVED_AT_DESTINATION Das Fahrzeug befindet sich etwa 50 Meter vom Ziel entfernt.

GetDeliveryVehicleRequest

Die Anfragenachricht für GetDeliveryVehicle.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API.

name

string

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

GetTaskRequest

Die Anfragenachricht für GetTask.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API.

name

string

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

GetTaskTrackingInfoRequest

Die Anfragenachricht für GetTaskTrackingInfoRequest.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API.

name

string

Erforderlich. Muss im Format providers/{provider}/taskTrackingInfo/{tracking_id} vorliegen. provider muss die Google Cloud-Projekt-ID und tracking_id die mit der Aufgabe verknüpfte Tracking-ID sein. Ein Beispielname ist providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id.

ListDeliveryVehiclesRequest

Die Anfragenachricht für ListDeliveryVehicles.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API.

parent

string

Erforderlich. Muss im Format providers/{provider} vorliegen. 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 Anzahl 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 diese 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 eine leere Zeichenfolge für den Filter angeben, werden alle Lieferfahrzeuge zurückgegeben.

Für ListDeliveryVehicles werden nur Anfragen zu Fahrzeugattributen unterstützt, z. B. attributes.<key> = <value> oder attributes.<key1> = <value1> AND attributes.<key2> = <value2>. Außerdem werden alle Attribute als Strings gespeichert. Daher sind nur Stringvergleiche für Attribute möglich. Wenn Sie Zahlen oder boolesche Werte vergleichen möchten, 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").

Die maximale Anzahl der Einschränkungen, die in einer Filterabfrage zulässig sind, beträgt 50. Eine Einschränkung ist ein Teil der Abfrage in der Form attribute.<KEY> <COMPARATOR> <VALUE>, z. B. ist attributes.foo = bar eine Einschränkung.

viewport

Viewport

Optional. Ein Filter, der die zurückgegebenen Fahrzeuge auf diejenigen beschränkt, deren letzter bekannter Standort sich im rechteckigen Bereich des Viewports befand.

ListDeliveryVehiclesResponse

Die Antwortnachricht für ListDeliveryVehicles.

Felder
delivery_vehicles[]

DeliveryVehicle

Die Menge der Lieferfahrzeuge, die die angeforderten Filterkriterien erfüllen. Wenn kein Filter angegeben ist, werden mit 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.

next_page_token

string

Sie können dieses Token in ListDeliveryVehiclesRequest übergeben, um die Auflistung der Ergebnisse fortzusetzen. Wenn alle Ergebnisse zurückgegeben wurden, 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, über alle Seiten hinweg.

ListTasksRequest

Die Anfragenachricht für ListTasks.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API.

parent

string

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

page_size

int32

Optional. Die maximale Anzahl der zurückzugebenden Aufgaben. 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 ListTasks-Aufruf empfangen wurde. Sie können diese 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 einer leeren Zeichenfolge 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, die die Gruppe von Aufgaben enthält, die den Filterkriterien in ListTasksRequest entsprechen.

Felder
tasks[]

Task

Die Menge der Aufgaben, die den angeforderten Filterkriterien entsprechen. Wenn kein Filter angegeben ist, werden mit der Anfrage alle Aufgaben zurückgegeben. Eine erfolgreiche Antwort kann auch leer sein. Eine leere Antwort gibt an, dass keine Aufgaben gefunden wurden, die den angeforderten Filterkriterien entsprechen.

next_page_token

string

Übergeben Sie dieses Token in ListTasksRequest, um die Ergebnisse weiter aufzulisten. Wenn alle Ergebnisse zurückgegeben wurden, ist dieses Feld entweder ein leerer String oder es wird nicht in der Antwort angezeigt.

total_size

int64

Die Gesamtzahl der Aufgaben, die den Anfragekriterien entsprechen, über alle Seiten hinweg.

LocationInfo

Ein Standort mit zusätzlichen Kennzeichnungen.

Felder
point

LatLng

Die Koordinaten des Standorts. Es muss entweder point oder place als Eingabe angegeben werden. Wenn beide angegeben sind, wird point für das Routing und place für Metadaten verwendet. Wenn nur place als Eingabe angegeben wird, wird point aus dem place berechnet und in die Ausgabe aufgenommen.

place

string

Der Ressourcenname des Orts, der diesen Standort repräsentiert. Das Format dafür ist places/{place_id}. Es muss entweder point oder place als Eingabe angegeben werden. Wenn beide angegeben sind, wird point für das Routing und place für Metadaten verwendet. place wird nur in die Ausgabe aufgenommen, wenn es in der Eingabe enthalten war. Das bedeutet, dass keine place-Suche über LatLng erfolgt.

Dies ist eine experimentelle Funktion.

point_location_source

PointSource

Nur Ausgabe. Die Quelle des Felds „latlng“ point. Dies ist Teil einer experimentellen Funktion.

PointSource

Gibt die Quelle eines LatLng an.

Enums
POINT_SOURCE_UNSPECIFIED Punktquelle nicht angegeben.
POINT_SOURCE_DEVELOPER_PROVIDED Die LatLng wurde explizit vom Entwickler bereitgestellt.
POINT_SOURCE_CALCULATED_FROM_PLACE Die LatLng wurde anhand des angegebenen Orts berechnet.

Aufgabe

Eine Aufgabe in der Delivery API stellt eine einzelne zu verfolgende Aktion dar. Im Allgemeinen wird zwischen versandbezogenen Aufgaben und Pausenaufgaben unterschieden. Einer Sendung können mehrere Aufgaben zugeordnet sein. Es kann beispielsweise eine Aufgabe für die Abholung und eine für die Übergabe oder den Transfer geben. Außerdem können verschiedene Aufgaben für eine bestimmte Sendung von verschiedenen Fahrzeugen ausgeführt werden. So könnte beispielsweise ein Fahrzeug die Abholung übernehmen und die Sendung zum Hub fahren, während ein anderes Fahrzeug dieselbe Sendung vom Hub zum Ablieferort fährt.

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

Felder
name

string

Muss im Format providers/{provider}/tasks/{task} vorliegen.

type

Type

Erforderlich. Nicht veränderbar. Definiert den Typ der Aufgabe. Beispiel: eine Pause oder eine Lieferung.

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 von Task vom Anbieter festgelegt wurde.

task_outcome_location

LocationInfo

Der Ort, an dem das Ergebnis von Task festgelegt wurde. Dieser Wert wird im Rahmen von UpdateTask aktualisiert. Wenn dieser Wert nicht explizit vom Anbieter aktualisiert wird, wird er von Fleet Engine standardmäßig mit dem letzten bekannten Fahrzeugstandort (dem Rohstandort) ausgefüllt.

task_outcome_location_source

TaskOutcomeLocationSource

Gibt an, woher der Wert von task_outcome_location stammt.

tracking_id

string

Nicht veränderbar. Dieses Feld erleichtert das Speichern einer ID, sodass Sie keine komplizierte Zuordnung verwenden müssen. Sie können tracking_id nicht für Aufgaben vom Typ UNAVAILABLE und SCHEDULED_STOP festlegen. Für diese IDs gelten die folgenden Einschränkungen:

  • Muss ein gültiger Unicode-String sein.
  • Die maximale Länge beträgt 64 Zeichen.
  • Normalisiert gemäß Unicode Normalization Form C.
  • Darf keines der folgenden ASCII-Zeichen enthalten: „/“, „:“, „?“, „,“ oder „#“.
delivery_vehicle_id

string

Nur Ausgabe. Die ID des Fahrzeugs, mit dem diese Aufgabe ausgeführt wird. Lieferfahrzeug-IDs unterliegen den folgenden Einschränkungen:

  • Muss ein gültiger Unicode-String sein.
  • Die maximale Länge beträgt 64 Zeichen.
  • Normalisiert gemäß Unicode Normalization Form C.
  • Darf keines 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 Aufgaben erforderlich.

task_duration

Duration

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

target_time_window

TimeWindow

Das Zeitfenster, in dem die Aufgabe erledigt werden soll.

journey_sharing_info

JourneySharingInfo

Nur Ausgabe. Felder für das Teilen von Routen Wird nicht ausgefüllt, wenn der Status CLOSED ist.

task_tracking_view_config

TaskTrackingViewConfig

Die Konfiguration für die Aufgabenverfolgung, in der angegeben wird, 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

Spezifische Felder für das Teilen von Routen

Felder
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Tracking-Informationen für die Stopps, die das zugewiesene Fahrzeug vor Abschluss dieser Aufgabe einlegen wird. Diese Liste kann Stopps aus anderen Aufgaben enthalten.

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 bis zum nächsten VehicleStop. Informationen zur aktuellen Route stammen in der Regel aus der Fahrer-App, mit Ausnahme einiger Fälle, die in der Dokumentation für DeliveryVehicle.current_route_segment beschrieben 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 zuletzt gemeldeten Standort des zugewiesenen Fahrzeugs an.

last_location_snappable

bool

Gibt an, ob die lastLocation des Fahrzeugs an die current_route_segment angeglichen werden kann. Dieser Wert ist „False“, wenn last_location oder current_route_segment nicht vorhanden sind. Dieser Wert wird von Fleet Engine berechnet. Updates von Clients werden ignoriert.

Status

Der Status einer Aufgabe. Hier wird der Fortschritt der Aufgabe angezeigt.

Enums
STATE_UNSPECIFIED Standard. Wird für einen nicht angegebenen oder nicht erkannten Aufgabenstatus verwendet.
OPEN Entweder wurde die Aufgabe noch nicht einem Lieferfahrzeug zugewiesen oder das Lieferfahrzeug hat den zugewiesenen Fahrzeugstopp für Task noch nicht erreicht.
CLOSED Wenn das Fahrzeug die Haltestelle für diese Aufgabe passiert.

TaskOutcome

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

Enums
TASK_OUTCOME_UNSPECIFIED Das Ergebnis der Aufgabe, bevor ihr Wert festgelegt wird.
SUCCEEDED Die Aufgabe wurde erfolgreich abgeschlossen.
FAILED Die Aufgabe konnte entweder nicht abgeschlossen werden oder sie wurde abgebrochen.

TaskOutcomeLocationSource

Die Identität der Quelle, aus der die task_outcome_location stammt.

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, daher hat Fleet Engine den zuletzt bekannten Fahrzeugstandort verwendet.

Typ

Der Typ der Aufgabe.

Enums
TYPE_UNSPECIFIED Standardmäßig ist der Aufgabentyp unbekannt.
PICKUP Ein Abholvorgang ist die Aktion, die zum Abholen einer Sendung von einem Kunden ausgeführt wird. Für Abholungen mit Depot- oder Zubringerfahrzeugen sollte der Typ SCHEDULED_STOP verwendet werden.
DELIVERY Eine Lieferaufgabe ist die Aktion, die zum Liefern einer Sendung an einen Endkunden ausgeführt wird. Für Abgaben am Depot oder am Zubringerfahrzeug sollte der Typ SCHEDULED_STOP verwendet werden.
SCHEDULED_STOP Eine Aufgabe vom Typ „Geplanter Stopp“ wird zu Planungszwecken verwendet. Das kann beispielsweise das Abholen oder Abliefern von Sendungen von Zubringerfahrzeugen oder Depots darstellen. Sie sollte nicht für Sendungen verwendet werden, die von einem Endkunden abgeholt oder bei einem Endkunden zugestellt werden.
UNAVAILABLE Eine Aufgabe, die angibt, dass das Fahrzeug nicht für den Service verfügbar ist. Das kann beispielsweise passieren, wenn der Fahrer eine Pause macht oder das Fahrzeug betankt wird.

TaskAttribute

Beschreibt ein Aufgabenattribut als Schlüssel/Wert-Paar. Die Länge des „key:value“-Strings darf 256 Zeichen nicht überschreiten.

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 vom Typ „String“, „Bool“ oder „Double“ sein. Wenn keine festgelegt sind, wird der TaskAttribute-String_value als leerer String „“ gespeichert. task_attribute_value kann nur einer der folgenden Werte sein:
string_value

string

Attributwert vom Typ „String“.

bool_value

bool

Boolescher Attributwert.

number_value

double

Attributwert vom Typ „Double“.

TaskTrackingInfo

Die TaskTrackingInfo-Meldung. Die Nachricht enthält Informationen zur Aufgabenverfolgung, die für die Anzeige verwendet werden. Wenn eine Tracking-ID mehreren Aufgaben zugeordnet ist, verwendet Fleet Engine eine Heuristik, um zu entscheiden, welche TaskTrackingInfo ausgewählt werden soll.

Felder
name

string

Muss im Format providers/{provider}/taskTrackingInfo/{tracking} vorliegen, wobei tracking die Tracking-ID ist.

tracking_id

string

Nicht veränderbar. Die Tracking-ID einer Aufgabe. * Muss ein gültiger Unicode-String sein. * Auf maximal 64 Zeichen beschränkt. * Normalisiert gemäß Unicode Normalization Form C. * Darf keines 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 verbunden werden, eine Polylinie der erwarteten Route des Fahrzeugs zum Standort dieser Aufgabe bilden.

remaining_stop_count

Int32Value

Gibt die Anzahl der verbleibenden Stopps des Fahrzeugs an, bis der Aufgabenstopp erreicht wird, einschließlich des Aufgabenstopps. Wenn der nächste Stopp des Fahrzeugs beispielsweise der Aufgabenstopp ist, ist der Wert 1.

remaining_driving_distance_meters

Int32Value

Die verbleibende Gesamtstrecke in Metern bis zum VehicleStop.

estimated_arrival_time

Timestamp

Der Zeitstempel, der die geschätzte Ankunftszeit am Haltestellenstandort 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 erledigt werden soll.

attributes[]

TaskAttribute

Die für die Aufgabe festgelegten benutzerdefinierten Attribute.

TaskTrackingViewConfig

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

Felder
route_polyline_points_visibility

VisibilityOption

Das Feld, das angibt, wann Punkte der Routenpolylinie sichtbar sein können. Wenn dieses Feld nicht angegeben ist, wird die Standardkonfiguration für die Sichtbarkeit auf Projektebene für diese Daten verwendet.

estimated_arrival_time_visibility

VisibilityOption

Das Feld, in dem angegeben wird, wann die voraussichtliche Ankunftszeit sichtbar sein kann. Wenn dieses Feld nicht angegeben ist, wird die Standardkonfiguration für die Sichtbarkeit auf Projektebene für diese Daten verwendet.

estimated_task_completion_time_visibility

VisibilityOption

Das Feld, in dem angegeben wird, wann die geschätzte Zeit für die Erledigung einer Aufgabe sichtbar sein kann. Wenn dieses Feld nicht angegeben ist, wird die Standardkonfiguration für die Sichtbarkeit auf Projektebene für diese Daten verwendet.

remaining_driving_distance_visibility

VisibilityOption

Das Feld, in dem angegeben wird, wann die verbleibende Fahrstrecke sichtbar sein kann. Wenn dieses Feld nicht angegeben ist, wird die Standardkonfiguration für die Sichtbarkeit auf Projektebene für diese Daten verwendet.

remaining_stop_count_visibility

VisibilityOption

Das Feld, in dem angegeben wird, wann die verbleibende Anzahl von Stopps sichtbar sein kann. Wenn dieses Feld nicht angegeben ist, wird die Standardkonfiguration für die Sichtbarkeit auf Projektebene für diese Daten verwendet.

vehicle_location_visibility

VisibilityOption

Das Feld, in dem angegeben wird, wann der Fahrzeugstandort sichtbar sein kann. Wenn dieses Feld nicht angegeben ist, wird die Standardkonfiguration für die Sichtbarkeit auf Projektebene für diese Daten verwendet.

VisibilityOption

Die Optionsnachricht, die definiert, wann ein Datenelement für 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 Endnutzer sichtbar, wenn die verbleibende Anzahl an Stopps <= remaining_stop_count_threshold ist.

duration_until_estimated_arrival_time_threshold

Duration

Dieses Datenelement ist für Endnutzer sichtbar, wenn die geschätzte Ankunftszeit an der Haltestelle <= duration_until_estimated_arrival_time_threshold ist.

remaining_driving_distance_meters_threshold

int32

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

always

bool

Wenn diese Option auf „true“ gesetzt ist, ist dieses Datenelement immer für Endnutzer sichtbar, ohne dass Grenzwerte gelten. Dieses Feld kann nicht auf „false“ gesetzt werden.

never

bool

Wenn „true“ festgelegt ist, wird dieses Datenelement immer ohne Schwellenwerte vor Endnutzern verborgen. Dieses Feld kann nicht auf „false“ gesetzt werden.

TimeWindow

Ein Zeitraum.

Felder
start_time

Timestamp

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

end_time

Timestamp

Erforderlich. Das Ende des Zeitfensters (einschließlich).

UpdateDeliveryVehicleRequest

Die Anfragenachricht für UpdateDeliveryVehicle.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API.

delivery_vehicle

DeliveryVehicle

Erforderlich. Das anzuwendende DeliveryVehicle-Entitätsupdate. Hinweis: Der Name von DeliveryVehicle kann nicht aktualisiert werden.

update_mask

FieldMask

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

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "remaining_vehicle_journey_segments".

UpdateTaskRequest

Die Anfragenachricht für UpdateTask.

Felder
header

DeliveryRequestHeader

Optional. Der Standard-Anfrageheader der Delivery API.

task

Task

Erforderlich. Die mit dem Update 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: Der Wert von task_outcome kann nach der Festlegung nicht mehr geändert werden.

Wenn die Aufgabe einem Lieferfahrzeug zugewiesen wurde, legen Sie den Aufgabenstatus nicht mit Task.update auf CLOSED fest. Entfernen Sie stattdessen die VehicleStop, die die Aufgabe enthält, aus dem Lieferfahrzeug. Dadurch wird der Aufgabenstatus automatisch auf „ABGESCHLOSSEN“ gesetzt.

update_mask

FieldMask

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

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

VehicleJourneySegment

Stellt einen Fahrabschnitt eines Fahrzeugs dar – von der vorherigen zur aktuellen Haltestelle. Wenn es sich um den ersten aktiven Stopp handelt, wird die Route vom aktuellen Standort des Fahrzeugs zu diesem Stopp berechnet.

Felder
stop

VehicleStop

Gibt den Standort der Haltestelle sowie die mit der Haltestelle verknüpften Task an. Einige Felder von „VehicleStop“ sind möglicherweise nicht vorhanden, wenn dieses Fahrtsegment Teil von JourneySharingInfo ist.

driving_distance_meters

Int32Value

Nur Ausgabe. Die Entfernung von der vorherigen Haltestelle zu dieser Haltestelle. Wenn die aktuelle Haltestelle die erste in der Liste der Reiseabschnitte ist, ist der Startpunkt der Standort des Fahrzeugs, der zu dem Zeitpunkt aufgezeichnet wurde, als diese Haltestelle der Liste hinzugefügt wurde. Dieses Feld ist möglicherweise nicht vorhanden, wenn dieses Segment Teil von JourneySharingInfo ist.

driving_duration

Duration

Nur Ausgabe. Die Reisezeit von der vorherigen Haltestelle zu dieser Haltestelle. Wenn die aktuelle Haltestelle die erste in der Liste der Reiseabschnitte ist, ist der Startpunkt der Standort des Fahrzeugs, der zu dem Zeitpunkt aufgezeichnet wurde, als diese Haltestelle der Liste hinzugefügt 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 Fahrtdauer ab dem letzten bekannten Standort der Fahrer-App und nicht die Fahrzeit ab dem vorherigen Stopp angegeben.

path[]

LatLng

Nur Ausgabe. Der Pfad von der vorherigen Haltestelle zu dieser Haltestelle. Wenn der aktuelle Stopp der erste Stopp in der Liste der Fahrtabschnitte ist, wird hier der Pfad vom aktuellen Standort des Fahrzeugs zu diesem Stopp zum Zeitpunkt des Hinzufügens des Stopps zur Liste angezeigt. Dieses Feld ist möglicherweise nicht vorhanden, wenn dieses Segment 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 ausgefüllt werden, die aus DeliveryVehicle.current_route_segment (gRPC) oder DeliveryVehicle.currentRouteSegment (REST) decodiert wurden. So wird der Fahrweg vom zuletzt bekannten Standort der Fahrer-App und nicht vom vorherigen Stopp aus berechnet.

VehicleStop

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

Felder
planned_location

LocationInfo

Erforderlich. Der Standort des Halts. Die Standorte in den Task stimmen möglicherweise nicht genau mit diesem Standort überein, liegen aber in unmittelbarer Nähe. Dieses Feld wird in der Antwort eines GetTask-Aufrufs nicht ausgefüllt.

tasks[]

TaskInfo

Die Liste der Task, die an dieser Haltestelle ausgeführt werden sollen. Dieses Feld wird in der Antwort eines GetTask-Aufrufs nicht ausgefüllt.

state

State

Der Status von VehicleStop. Dieses Feld wird in der Antwort eines GetTask-Aufrufs nicht ausgefüllt.

Status

Der aktuelle Status einer VehicleStop.

Enums
STATE_UNSPECIFIED Unbekannt
NEW Erstellt, aber nicht aktiv weitergeleitet.
ENROUTE Zugewiesen und aktives Routing.
ARRIVED An der Haltestelle angekommen. Es wird davon ausgegangen, dass alle vorherigen Haltestellen abgeschlossen sind, wenn das Fahrzeug zur nächsten Haltestelle fährt.

TaskInfo

Zusätzliche Informationen zur Aufgabe, die an diesem Stopp ausgeführt wurde.

Felder
task_id

string

Die Aufgaben-ID. Dieses Feld wird in der Antwort eines GetTask-Aufrufs nicht ausgefüllt. Für Aufgaben-IDs gelten die folgenden Einschränkungen:

  • Muss ein gültiger Unicode-String sein.
  • Die maximale Länge beträgt 64 Zeichen.
  • Normalisiert gemäß Unicode Normalization Form C.
  • Darf keines der folgenden ASCII-Zeichen enthalten: „/“, „:“, „?“, „,“ oder „#“.
task_duration

Duration

Nur Ausgabe. Die für die Ausführung der Aufgabe erforderliche Zeit.

target_time_window

TimeWindow

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