REST Resource: providers.tasks

Kaynak: Görev

Delivery API'deki Görev, izlenecek tek bir işlemi temsil eder. Genel olarak, gönderimle ilgili Görevler ile ara Görevleri arasında bir fark vardır. Bir gönderimle ilişkili birden fazla Görev olabilir. Örneğin, teslim alma için bir görev, bırakma veya aktarma için başka bir görev olabilir. Ayrıca, belirli bir gönderime ilişkin farklı Görevler farklı araçlar tarafından yürütülebilir. Örneğin, bir araç teslim alma işlemini gerçekleştirip sevkiyatı merkeze; başka bir araç ise aynı sevkiyatı merkezden teslim noktasına götürebilir.

Not: gRPC ve REST API'leri farklı alan adlandırma kuralları kullanır. Örneğin, gRPC API'deki Task.journey_sharing_info alanı ile REST API'deki Task.journeySharingInfo alanı aynı alanı ifade eder.

JSON gösterimi
{
  "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)
    }
  ]
}
Alanlar
name

string

providers/{provider}/tasks/{task} biçiminde olmalıdır.

type

enum (Type)

Zorunlu. Sabit. Görevin türünü tanımlar. Örneğin, mola veya gönderim.

state

enum (State)

Zorunlu. Görevin mevcut yürütme durumu.

taskOutcome

enum (TaskOutcome)

Görevin sonucu.

taskOutcomeTime

string (Timestamp format)

Task sonucunun sağlayıcı tarafından ne zaman ayarlandığını gösteren zaman damgası.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

taskOutcomeLocation

object (LocationInfo)

Task sonucunun ayarlandığı konum. Bu değer, tasks.patch kapsamında güncellenir. Bu değer sağlayıcı tarafından açıkça güncellenmezse Fleet Engine, değeri varsayılan olarak bilinen son araç konumuyla (ham konum) doldurur.

taskOutcomeLocationSource

enum (TaskOutcomeLocationSource)

taskOutcomeLocation değerinin nereden geldiğini gösterir.

trackingId

string

Sabit. Bu alan, bir kimliğin depolanmasını kolaylaştırarak karmaşık bir eşlemenin kullanılmasını önler. UNAVAILABLE ve SCHEDULED_STOP türündeki Görevler için trackingId ayarlayamazsınız. Bu kimlikler aşağıdaki kısıtlamalara tabidir:

  • Geçerli bir Unicode dizesi olmalıdır.
  • Maksimum 64 karakterle sınırlıdır.
  • Unicode Normalleştirme Formu C'ye göre normalleştirilir.
  • Şu ASCII karakterlerden hiçbirini içeremez: "/", ":", "?", "," veya "#".
deliveryVehicleId

string

Yalnızca çıkış. Bu görevi yürüten aracın kimliği. Teslimat Aracı Kimlikleri aşağıdaki kısıtlamalara tabidir:

  • Geçerli bir Unicode dizesi olmalıdır.
  • Maksimum 64 karakterle sınırlıdır.
  • Unicode Normalleştirme Formu C'ye göre normalleştirilir.
  • Şu ASCII karakterlerden hiçbirini içeremez: "/", ":", "?", "," veya "#".
plannedLocation

object (LocationInfo)

Sabit. Görevin tamamlanacağı konum. UNAVAILABLE Görevler için isteğe bağlıdır, ancak diğer tüm Görevler için zorunludur.

taskDuration

string (Duration format)

Zorunlu. Sabit. Bu konumdaki bir Görevi yürütmek için gereken süre.

"s" ile biten ve en fazla dokuz kesir basamağı olan, saniye cinsinden bir süre. Örnek: "3.5s".

targetTimeWindow

object (TimeWindow)

Görevin tamamlanması gereken zaman aralığı.

journeySharingInfo

object (JourneySharingInfo)

Yalnızca çıkış. Yolculuk paylaşımına özel alanlar. Eyalet CLOSED olduğunda doldurulmaz.

taskTrackingViewConfig

object (TaskTrackingViewConfig)

Hangi veri öğelerinin hangi koşullarda son kullanıcılara görünür olacağını belirten görev izleme yapılandırmasıdır.

attributes[]

object (TaskAttribute)

Özel Görev özelliklerinin listesi. Her özelliğin benzersiz bir anahtarı olmalıdır.

Tür

Görevin türü.

Sıralamalar
TYPE_UNSPECIFIED Varsayılan ayar olan Görev türü bilinmiyor.
PICKUP Teslim alma görevi, bir müşteriden gönderi teslim almak için gerçekleştirilen işlemdir. Depo veya besleyici araç teslim alma işlemlerinde SCHEDULED_STOP türü kullanılmalıdır.
DELIVERY Teslimat görevi, bir gönderimi son müşteriye teslim etmek için gerçekleştirilen işlemdir. Depo veya besleyici araç teslimleri SCHEDULED_STOP türünü kullanmalıdır.
SCHEDULED_STOP Planlanmış bir durdurma Görevi, planlama amacıyla kullanılır. Örneğin, besleyici taşıtlardan veya depolardan gelen sevkiyatların alınıp bırakılmasını ifade edebilir. Son müşteriden teslim alınan veya bırakılan gönderiler için kullanılmamalıdır.
UNAVAILABLE Aracın hizmet için uygun olmadığını belirten bir Görev. Bu durum, örneğin, sürücü mola verirken veya araçta yakıt doldurma sırasında gerçekleşebilir.

TaskOutcomeLocationSource

taskOutcomeLocation öğesini dolduran kaynağın kimliği.

Sıralamalar
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Henüz belirlenmeden görev sonucu.
PROVIDER Sağlayıcı, taskOutcomeLocation belirledi.
LAST_VEHICLE_LOCATION Sağlayıcı taskOutcomeLocation belirtmediği için Fleet Engine, bilinen son araç konumunu kullandı.

JourneySharingInfo

Yolculuk paylaşımıyla ilgili belirli alanlar.

JSON gösterimi
{
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "lastLocationSnappable": boolean
}
Alanlar
remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

Atanan aracın bu Görevi tamamlamadan önce yapacağı duraklarla ilgili izleme bilgileri. Bu listenin diğer görevlerdeki durakları içerebileceğini unutmayın.

İlk segment, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) veya Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), sürücünün bilinen son konumundan yaklaşan VehicleStop konumuna kadar olan rota bilgilerini içerir. DeliveryVehicle.current_route_segment dokümanlarında belirtilen bazı durumlar haricinde, mevcut rota bilgileri genellikle sürücü uygulamasından alınır. Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) veya Task.journeySharingInfo.remainingVehicleJourneySegments (REST) üzerindeki diğer segmentler Fleet Engine tarafından doldurulur. Bunlar, kalan VehicleStops arasındaki rota bilgilerini sağlar.

lastLocation

object (DeliveryVehicleLocation)

Atanan aracın aracın en son bildirilen konumunu gösterir.

lastLocationSnappable

boolean

Aracın lastLocation değerinin currentRouteSegment'e tutturulup takılamayacağını belirtir. lastLocation veya currentRouteSegment yoksa bu değer False'tur. Bu değer Fleet Engine tarafından hesaplanır. İstemcilerden gelen güncellemeler yoksayılır.

TaskTrackingViewConfig

Bir Görevin veri öğesinin son kullanıcılara ne zaman görüneceğini tanımlayan yapılandırma mesajı.

JSON gösterimi
{
  "routePolylinePointsVisibility": {
    object (VisibilityOption)
  },
  "estimatedArrivalTimeVisibility": {
    object (VisibilityOption)
  },
  "estimatedTaskCompletionTimeVisibility": {
    object (VisibilityOption)
  },
  "remainingDrivingDistanceVisibility": {
    object (VisibilityOption)
  },
  "remainingStopCountVisibility": {
    object (VisibilityOption)
  },
  "vehicleLocationVisibility": {
    object (VisibilityOption)
  }
}
Alanlar
routePolylinePointsVisibility

object (VisibilityOption)

Rota çoklu çizgi noktalarının ne zaman gösterilebileceğini belirten alan. Bu alan belirtilmezse bu veriler için proje düzeyindeki varsayılan görünürlük yapılandırması kullanılır.

estimatedArrivalTimeVisibility

object (VisibilityOption)

Tahmini varış saatinin ne zaman görünür olabileceğini belirten alan. Bu alan belirtilmezse bu veriler için proje düzeyindeki varsayılan görünürlük yapılandırması kullanılır.

estimatedTaskCompletionTimeVisibility

object (VisibilityOption)

Tahmini görev tamamlama süresinin ne zaman görünür olabileceğini belirten alan. Bu alan belirtilmezse bu veriler için proje düzeyindeki varsayılan görünürlük yapılandırması kullanılır.

remainingDrivingDistanceVisibility

object (VisibilityOption)

Kalan sürüş mesafesini belirten alan görünür durumda olabilir. Bu alan belirtilmezse bu veriler için proje düzeyindeki varsayılan görünürlük yapılandırması kullanılır.

remainingStopCountVisibility

object (VisibilityOption)

Kalan durdurma sayısının ne zaman belirtildiğini belirten alan görünür olabilir. Bu alan belirtilmezse bu veriler için proje düzeyindeki varsayılan görünürlük yapılandırması kullanılır.

vehicleLocationVisibility

object (VisibilityOption)

Araç konumunun ne zaman görünür olabileceğini belirten alan. Bu alan belirtilmezse bu veriler için proje düzeyindeki varsayılan görünürlük yapılandırması kullanılır.

VisibilityOption

Bir veri öğesinin son kullanıcılara ne zaman görünür olacağını tanımlayan seçenek mesajı.

JSON gösterimi
{

  // 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.
}
Alanlar
Birleştirme alanı visibility_option. Belirlenen spesifik görünürlük seçeneği. visibility_option şunlardan yalnızca biri olabilir:
remainingStopCountThreshold

integer

Kalan durdurma sayısı <= remainingStopCountThreshold olursa bu veri öğesi son kullanıcılar tarafından görülebilir.

durationUntilEstimatedArrivalTimeThreshold

string (Duration format)

Duracak TVS'si <= durationUntilForecastArrivalTimeThreshold olursa bu veri öğesi son kullanıcılar tarafından görülebilir.

"s" ile biten ve en fazla dokuz kesir basamağı olan, saniye cinsinden bir süre. Örnek: "3.5s".

remainingDrivingDistanceMetersThreshold

integer

Kalan sürüş mesafesinin metre cinsinden <= geriye kalanSürüşMetersThreshold değerine sahip olması durumunda bu veri öğesi son kullanıcılar tarafından görülebilir.

always

boolean

Doğru değerine ayarlanırsa bu veri öğesi, herhangi bir eşik olmadan son kullanıcılara her zaman gösterilir. Bu alan yanlış değerine ayarlanamaz.

never

boolean

Doğru değerine ayarlanırsa bu veri öğesi, eşik değeri olmayan son kullanıcılardan her zaman gizlenir. Bu alan yanlış değerine ayarlanamaz.

Yöntemler

batchCreate

Yeni Task nesneleri grubu oluşturur ve döndürür.

create

Yeni bir Task nesnesi oluşturur ve döndürür.

get

Task ile ilgili bilgileri alır.

list

Belirtilen filtreleme ölçütlerini karşılayan tüm Task öğelerini alır.

patch

Task verilerini günceller.

search
(deprecated)

Kullanımdan kaldırıldı: Bunun yerine GetTaskTrackingInfo kullanın.