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

Doit se présenter sous la forme providers/{provider}/tasks/{task}.

enum (Type)

Obligatoire. Immuable. Définit le type de la tâche. (par exemple, une pause ou une livraison).

enum (State)

Obligatoire. État d'exécution actuel de la tâche.

enum (TaskOutcome)

Le résultat de la tâche.

string (Timestamp format)

Code temporel indiquant à quel moment le résultat de la Task a été défini par le fournisseur.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

object (LocationInfo)

Lieu où le résultat de Task a été défini. Cette valeur est mise à jour dans le cadre de tasks.patch. Si cette valeur n'est pas explicitement mise à jour par le fournisseur, Fleet Engine l'insère par défaut avec la dernière position connue du véhicule (emplacement brut).

enum (TaskOutcomeLocationSource)

Indique la provenance de la valeur de taskOutcomeLocation.

string

Immuable. Ce champ facilite le stockage d'un identifiant, ce qui vous évite d'utiliser un mappage compliqué. Vous ne pouvez pas définir trackingId pour les tâches de type UNAVAILABLE et SCHEDULED_STOP. Ces ID sont soumis aux restrictions suivantes:

• Vous devez saisir une chaîne Unicode valide.
• La longueur ne doit pas dépasser 64 caractères.
• Normalisée conformément au formulaire de normalisation Unicode C.
• Ne doit contenir aucun des caractères ASCII suivants: "/", ":", "?", ""," ou "#".

string

Uniquement en sortie. ID du véhicule qui exécute cette tâche. Les ID de véhicule de livraison sont soumis aux restrictions suivantes:

• Vous devez saisir une chaîne Unicode valide.
• La longueur ne doit pas dépasser 64 caractères.
• Normalisée conformément au formulaire de normalisation Unicode C.
• Ne doit contenir aucun des caractères ASCII suivants: "/", ":", "?", ""," ou "#".

object (LocationInfo)

Immuable. Emplacement où la tâche sera terminée. Facultatif pour les tâches UNAVAILABLE, mais obligatoire pour toutes les autres tâches.

string (Duration format)

Obligatoire. Immuable. Temps nécessaire pour exécuter une tâche à cet emplacement.

Durée en secondes avec un maximum de neuf chiffres après la virgule, se terminant par "s". Exemple: "3.5s".

object (TimeWindow)

Période pendant laquelle la tâche doit être terminée.

object (JourneySharingInfo)

Uniquement en sortie. Champs spécifiques au partage de parcours. Non renseigné lorsque l'état est CLOSED.

object (TaskTrackingViewConfig)

Configuration du suivi des tâches qui spécifie les éléments de données visibles par les utilisateurs finaux dans quelles circonstances.

object (TaskAttribute)

Liste d'attributs Task personnalisés. Chaque attribut doit avoir une clé unique.

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

object (VehicleJourneySegment)

Informations de suivi concernant les arrêts que le véhicule assigné passera avant d'effectuer cette tâche Notez que cette liste peut contenir des arrêts associés à d'autres tâches.

Le premier segment, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), contient des informations sur l'itinéraire depuis la dernière position connue du conducteur jusqu'au prochain VehicleStop. Les informations sur l'itinéraire actuel proviennent généralement de l'application du conducteur, sauf dans certains cas indiqués dans la documentation de DeliveryVehicle.current_route_segment. Les autres segments dans Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) ou Task.journeySharingInfo.remainingVehicleJourneySegments (REST) sont renseignés par Fleet Engine. Ils fournissent des informations sur l'itinéraire entre les VehicleStops restants.

object (DeliveryVehicleLocation)

Indique la dernière position signalée du véhicule attribué.

boolean

Indique si le lastLocation du véhicule peut être ancré à currentRouteSegment. Cette valeur est "False" si lastLocation ou currentRouteSegment n'existe pas. Cette valeur est calculée par Fleet Engine. Les mises à jour des clients sont ignorées.

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

object (VisibilityOption)

Champ indiquant dans quel cas les points de la polyligne de l'itinéraire peuvent être visibles. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.

object (VisibilityOption)

Champ spécifiant le moment auquel l'heure d'arrivée estimée peut être visible. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.

object (VisibilityOption)

Champ qui spécifie le moment auquel le temps estimé d'achèvement de la tâche peut être visible. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.

object (VisibilityOption)

Le champ indiquant quand la distance restante en voiture peut être visible. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.

object (VisibilityOption)

Champ spécifiant quand le nombre d'arrêts restants peut être visible. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.

object (VisibilityOption)

Champ indiquant dans quels cas la position du véhicule peut être visible. Si ce champ n'est pas spécifié, la configuration de visibilité par défaut au niveau du projet pour ces données sera utilisée.

{

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

Cet élément de données est visible par les utilisateurs finaux si le nombre d'arrêts restant est inférieur ou égal à restantStopCountThreshold.

string (Duration format)

Cet élément de données est visible par les utilisateurs finaux si l'heure d'arrivée prévue à l'arrêt est inférieure ou égale à durationEstimationArrivalTimeThreshold.

Durée en secondes avec un maximum de neuf chiffres après la virgule, se terminant par "s". Exemple: "3.5s".

integer

Cet élément de données est visible par les utilisateurs finaux si la distance restante en voiture en mètres est inférieure ou égale à resterDrivingDistanceMetersThreshold.

boolean

Si cette règle est définie sur "True", cet élément de données est toujours visible par les utilisateurs finaux sans seuil. Ce champ ne peut pas être défini sur "false".

boolean

Si cette règle est définie sur "True", cet élément de données est toujours masqué pour les utilisateurs finaux sans seuil. Ce champ ne peut pas être défini sur "false".