TaskLog

Das Protokoll einer Task-Ressource in der Deliveries API.

JSON-Darstellung
{
  "name": string,
  "type": enum (TaskTypeLog),
  "state": enum (TaskStateLog),
  "taskOutcome": enum (TaskOutcomeLog),
  "taskOutcomeTime": string,
  "taskOutcomeLocation": {
    object (LocationInfoLog)
  },
  "taskOutcomeLocationSource": enum (TaskOutcomeLocationSourceLog),
  "trackingId": string,
  "deliveryVehicleId": string,
  "plannedLocation": {
    object (LocationInfoLog)
  },
  "taskDuration": string,
  "targetTimeWindow": {
    object (TimeWindowLog)
  },
  "journeySharingInfo": {
    object (JourneySharingInfoLog)
  },
  "taskTrackingViewConfig": {
    object (TaskTrackingViewConfigLog)
  },
  "attributes": [
    {
      object (TaskAttributeLog)
    }
  ]
}
Felder
name

string

Der Ressourcenname der Aufgabe im Format providers/{providerId}/tasks/{taskId}.

type

enum (TaskTypeLog)

Der Aufgabentyp.

state

enum (TaskStateLog)

Der Status einer Aufgabe, der ihren Fortschritt anzeigt.

taskOutcome

enum (TaskOutcomeLog)

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

taskOutcomeTime

string (Timestamp format)

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

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

taskOutcomeLocation

object (LocationInfoLog)

Ort, an dem das Ergebnis der Aufgabe festgelegt wurde.

taskOutcomeLocationSource

enum (TaskOutcomeLocationSourceLog)

Gibt an, woher der Wert von taskOutcomeLocation stammt.

trackingId

string

Dieses Feld erleichtert dem Kunden das Speichern einer ID, um unnötige oder komplizierte Zuordnungen zu vermeiden.

deliveryVehicleId

string

Die ID des Fahrzeugs, das diese Aufgabe ausführt.

plannedLocation

object (LocationInfoLog)

Der Ort, an dem die Aufgabe abgeschlossen wurde.

taskDuration

string (Duration format)

Zusätzliche Zeit, um eine Aktion an diesem Ort auszuführen.

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. Beispiel: "3.5s".

targetTimeWindow

object (TimeWindowLog)

Das Zeitfenster, in dem die Aufgabe abgeschlossen werden soll.

journeySharingInfo

object (JourneySharingInfoLog)

Spezielle Felder für die Reise

taskTrackingViewConfig

object (TaskTrackingViewConfigLog)

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

attributes[]

object (TaskAttributeLog)

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

JourneySharingInfoLog

Spezielle Felder für die Reise

JSON-Darstellung
{
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegmentLog)
    }
  ],
  "lastLocation": {
    object (DeliveryVehicleLocationLog)
  },
  "lastLocationSnappable": boolean
}
Felder
remainingVehicleJourneySegments[]

object (VehicleJourneySegmentLog)

Tracking-Informationen für jede Haltestelle, die das zugewiesene Fahrzeug anfährt, bevor diese Aufgabe abgeschlossen wird. Diese Liste kann Haltestellen aus anderen Aufgaben enthalten.

lastLocation

object (DeliveryVehicleLocationLog)

Der letzte gemeldete Standort des Fahrzeugs.

lastLocationSnappable

boolean

Gibt an, ob das lastLocation des Fahrzeugs an currentRouteSegment angedockt werden kann. False, wenn lastLocation oder currentRouteSegment nicht vorhanden sind.

TaskTrackingViewConfigLog

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

JSON-Darstellung
{
  "routePolylinePointsVisibility": {
    object (VisibilityOptionLog)
  },
  "estimatedArrivalTimeVisibility": {
    object (VisibilityOptionLog)
  },
  "estimatedTaskCompletionTimeVisibility": {
    object (VisibilityOptionLog)
  },
  "remainingDrivingDistanceVisibility": {
    object (VisibilityOptionLog)
  },
  "remainingStopCountVisibility": {
    object (VisibilityOptionLog)
  },
  "vehicleLocationVisibility": {
    object (VisibilityOptionLog)
  }
}
Felder
routePolylinePointsVisibility

object (VisibilityOptionLog)

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

estimatedArrivalTimeVisibility

object (VisibilityOptionLog)

Dieses Feld gibt an, wann die voraussichtliche Ankunftszeit sichtbar sein soll. Wenn dieses Feld nicht angegeben ist, wird für diese Daten die standardmäßige Sichtbarkeitskonfiguration auf Projektebene verwendet.

estimatedTaskCompletionTimeVisibility

object (VisibilityOptionLog)

Das Feld, das angibt, wann die geschätzte Abschlusszeit der Aufgabe sichtbar sein kann. Wenn dieses Feld nicht angegeben ist, wird für diese Daten die standardmäßige Sichtbarkeitskonfiguration auf Projektebene verwendet.

remainingDrivingDistanceVisibility

object (VisibilityOptionLog)

Das Feld, das angibt, wann die verbleibende Fahrstrecke sichtbar ist. Wenn dieses Feld nicht angegeben ist, wird für diese Daten die standardmäßige Sichtbarkeitskonfiguration auf Projektebene verwendet.

remainingStopCountVisibility

object (VisibilityOptionLog)

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 standardmäßige Sichtbarkeitskonfiguration auf Projektebene verwendet.

vehicleLocationVisibility

object (VisibilityOptionLog)

Das Feld, das angibt, wann der Fahrzeugstandort sichtbar sein soll. Wenn dieses Feld nicht angegeben ist, wird für diese Daten die standardmäßige Sichtbarkeitskonfiguration auf Projektebene verwendet.

VisibilityOptionLog

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

JSON-Darstellung
{

  // Union field visibility_option can be only one of the following:
  "remainingStopCountThreshold": integer,
  "durationUntilEstimatedArrivalTimeThreshold": string,
  "remainingDrivingDistanceMetersThreshold": integer,
  "always": boolean,
  "never": boolean
  // End of list of possible types for union field visibility_option.
}
Felder

Union-Feld visibility_option.

Für visibility_option ist nur einer der folgenden Werte zulässig:

remainingStopCountThreshold

integer

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

durationUntilEstimatedArrivalTimeThreshold

string (Duration format)

Dieses Datenelement ist für Endnutzer sichtbar, wenn die voraussichtliche Ankunftszeit für die Haltestelle kleiner als „durationUntilEstimatedArrivalTimeThreshold“ ist.

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. Beispiel: "3.5s".

remainingDrivingDistanceMetersThreshold

integer

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

always

boolean

Wenn die Richtlinie auf „true“ gesetzt ist, ist dieses Datenelement für Endnutzer immer ohne Grenzwert sichtbar.

never

boolean

Wenn die Richtlinie auf „true“ gesetzt ist, ist dieses Datenelement für Endnutzer immer ohne Grenzwert ausgeblendet.

TaskAttributeLog

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

JSON-Darstellung
{
  "key": string,

  // Union field task_attribute_value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field task_attribute_value.
}
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. Für task_attribute_value ist nur einer der folgenden Werte zulässig:
stringValue

string

Als String typisierter Attributwert.

boolValue

boolean

Boolescher Attributwert.

numberValue

number

Doppelt eingegebener Attributwert.