REST Resource: providers.tasks

{
  "name": string,
  "type": enum (Type),
  "state": enum (State),
  "taskOutcome": enum (TaskOutcome),
  "taskOutcomeTime": string,
  "taskOutcomeLocation": {
    object (LocationInfo)
  },
  "taskOutcomeLocationSource": enum (TaskOutcomeLocationSource),
  "trackingId": string,
  "deliveryVehicleId": string,
  "plannedLocation": {
    object (LocationInfo)
  },
  "taskDuration": string,
  "targetTimeWindow": {
    object (TimeWindow)
  },
  "journeySharingInfo": {
    object (JourneySharingInfo)
  },
  "taskTrackingViewConfig": {
    object (TaskTrackingViewConfig)
  },
  "attributes": [
    {
      object (TaskAttribute)
    }
  ]
}

string

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

enum (Type)

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

enum (State)

Erforderlich. Der aktuelle Ausführungsstatus der Aufgabe.

enum (TaskOutcome)

Das Ergebnis der Aufgabe.

string (Timestamp format)

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

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".

object (LocationInfo)

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

enum (TaskOutcomeLocationSource)

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

string

Nicht veränderbar. Dieses Feld erleichtert das Speichern einer ID, sodass Sie eine komplizierte Zuordnung vermeiden können. Sie können trackingId 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 „#“.

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 „#“.

object (LocationInfo)

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

string (Duration format)

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

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

object (TimeWindow)

Das Zeitfenster, in dem die Aufgabe abgeschlossen werden soll.

object (JourneySharingInfo)

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

object (TaskTrackingViewConfig)

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

object (TaskAttribute)

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

{
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "lastLocationSnappable": boolean
}

object (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.

object (DeliveryVehicleLocation)

Gibt den letzten gemeldeten Standort des zugewiesenen Fahrzeugs an.

boolean

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

{
  "routePolylinePointsVisibility": {
    object (VisibilityOption)
  },
  "estimatedArrivalTimeVisibility": {
    object (VisibilityOption)
  },
  "estimatedTaskCompletionTimeVisibility": {
    object (VisibilityOption)
  },
  "remainingDrivingDistanceVisibility": {
    object (VisibilityOption)
  },
  "remainingStopCountVisibility": {
    object (VisibilityOption)
  },
  "vehicleLocationVisibility": {
    object (VisibilityOption)
  }
}

object (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.

object (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.

object (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.

object (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.

object (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.

object (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.

{

  // 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.
}

integer

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

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".

integer

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

boolean

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.

boolean

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.