Görevleri bulma

Bu belgede, bir sunucudan veya tarayıcıdan görev bilgilerini bulma yöntemleri açıklanmaktadır. Fleet Engine, görevleri bulmanın iki yolunu destekler:

  • Görevleri arama: Görevleri aşağıdaki kimliklere göre arayabilirsiniz:

    • Görev kimliği: Görev verilerinin tam görünümüne erişimi olan filo operatörleri gibi kullanıcılar tarafından kullanılır.
    • İzleme kimliği: İstemci yazılımınız tarafından son kullanıcıya sınırlı bilgi (ör. bir paketin evine ne zaman ulaşacağı) sağlamak için kullanılır.

    Görev kimliği ile görev izleme kimliği arasındaki farkı anladığınızdan emin olun. Ancak bunlar aynı değildir. Zamanlanmış görev kılavuzundaki Temel görev alanları bölümüne bakın.

  • Görevleri listeleme: Görevlere geniş kapsamlı erişim sağlar. Yalnızca güvenilir kullanıcılar için tasarlanmıştır.

Görevleri arama

Bu bölümde, görev kimliği veya izleme kimliğine göre görevlerin nasıl aranacağı açıklanmaktadır. Şu şartları karşılaması gerekir:

  • İzleme kimliğine göre yapılan aramalar, Takip edilen nesneler için görünürlük kuralları bölümünde belirtilen görünürlük kurallarına uygun olmalıdır.

  • Güvenlik risklerini sınırlamak için mümkün olan en dar kapsamlı jetonu kullanın. Örneğin, Teslimat Tüketici Jetonu kullanırsanız tüm çağrılar yalnızca ilgili son kullanıcıyla alakalı bilgileri (ör. gönderinin göndereni veya alıcısı) döndürür. Fleet Engine, yanıtlardaki diğer tüm bilgileri çıkartır. Jetonlar hakkında daha fazla bilgi için JSON Web Jetonları başlıklı makaleyi inceleyin.

Görev kimliğine göre görev arama

gRPC veya REST kullanarak bir sunucu ortamından görev kimliğine göre görev arayabilirsiniz. Aşağıdaki örneklerde, Java gRPC kitaplığının veya GetTask'a yönelik bir REST isteğinin nasıl kullanılacağı gösterilmektedir.

gRPC

 static final String PROJECT_ID = "my-delivery-co-gcp-project";
 static final String TASK_ID = "task-8597549";

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Task request
 String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
 GetTaskRequest getTaskRequest = GetTaskRequest.newBuilder()  // No need for the header
     .setName(taskName)
     .build();

 try {
   Task task = deliveryService.getTask(getTaskRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;

      case PERMISSION_DENIED:
        break;
   }
   return;
 }

REST

GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<taskId>

  • <id>, görevin benzersiz tanımlayıcısıdır.
  • <taskId>, aranacak görevin kimliğidir.
  • İstek başlığında, Bearer <token> değerine sahip bir Authorization alanı bulunmalıdır. Burada <token>, Hizmet hesabı rolleri ve JSON Web jetonları bölümlerinde açıklanan yönergelere göre sunucunuz tarafından verilir.
  • İstek metni boş olmalıdır.
  • Arama başarılı olursa yanıt gövdesi bir görev öğesi içerir.

Örnek curl komutu:

    # Set JWT, PROJECT_ID, and TASK_ID in the local environment
    curl -H "Authorization: Bearer ${JWT}" \
      "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}"

Görevleri izleme kimliğine göre arama

Aşağıdaki örneklerde, gRPC veya GetTaskTrackingInfo adresine yapılan bir HTTP REST çağrısı kullanılarak görevlerin gönderi izleme kimliğine göre nasıl aranacağı gösterilmektedir.

gRPC

static final String PROJECT_ID = "my-delivery-co-gcp-project";
static final String TRACKING_ID = "TID-7449w087464x5";

DeliveryServiceBlockingStub deliveryService =
  DeliveryServiceGrpc.newBlockingStub(channel);

// Tasks request
String parent = "providers/" + PROJECT_ID;
GetTaskTrackingInfoRequest getTaskTrackingInfoRequest = GetTaskTrackingInfoRequest.newBuilder()  // No need for the header
    .setParent(parent)
    .setTrackingId(TRACKING_ID)
    .build();

try {
  TaskTrackingInfo taskTrackingInfo = deliveryService.getTaskTrackingInfo(getTaskTrackingInfoRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
     case NOT_FOUND:
       break;

     case PERMISSION_DENIED:
       break;
  }
  return;
}

REST

GET https://fleetengine.googleapis.com/v1/providers/<project_id>/taskTrackingInfo/<tracking_id>

  • <tracking_id>, görevle ilişkili izleme kimliğidir.

  • İstek başlığı, Bearer <token> değerine sahip bir Authorization alanı içermelidir. Burada <token>, doğru hizmet hesabı rolünü taşır. Hizmet hesabı rolleri bölümüne bakın.

  • Arama başarılı olursa yanıt gövdesi bir taskTrackingInfo varlığı içerir.

Örnek curl komutu:

# Set JWT, PROJECT_ID, and TRACKING_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
  "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/taskTrackingInfo/${TRACKING_ID}"

Görevleri listeleyin

Görevleri listelemek için görevlere geniş kapsamlı erişim gerekir. Görevleri listeleme özelliği yalnızca güvenilir kullanıcılar içindir. Görevleri listeleme istekleri gönderirken Teslimat Filosu Okuyucusu veya Teslimat Yöneticisi kimlik doğrulama jetonlarını kullanın. Daha fazla bilgi için Hizmet hesabı rolleri başlıklı makaleyi inceleyin.

Listeleri sayfalandırma

Görev listeleri sayfalandırılır. Görevleri listeleme isteklerinde sayfa boyutu belirtilebilir. Sayfa boyutu belirtilirse döndürülen görevlerin sayısı, belirtilen sayfa boyutundan fazla olmaz. Sayfa boyutu yoksa makul bir varsayılan değer kullanılır. İstenen sayfa boyutu dahili bir maksimum değeri aşarsa dahili maksimum değer kullanılır.

Görev listesi, sonuçların sonraki sayfasını okumak için bir jeton içerebilir. Sonraki sayfayı almak için aynı isteği sayfa jetonuyla birlikte yeniden gönderin. Döndürülen sayfa jetonu boş olduğunda alınabilecek başka görev yoktur.

Görevleri listelerken kullanılan alanlar

Fleet Engine, görevleri listelerken aşağıdaki alanları çıkartır:

  • VehicleStop.planned_location
  • VehicleStop.state
  • VehicleStop.TaskInfo.taskId

Google API İyileştirme Önerileri'ne göre aşağıdaki alan biçimlerini kullanın:

Alan Türü Biçim Örnek
Zaman damgası RFC-3339 task_outcome_time = 2022-03-01T11:30:00-08:00
Süre Saniye sayısı ve ardından s task_duration = 120s
Enum Dize state = CLOSED AND type = PICKUP
Konum point.latitude ve point.longitude planned_location.point.latitude > 36.1 AND planned_location.point.longitude < -122.0

Listelenen görevleri filtreleme

Listelenen görevleri çoğu görev özelliğine göre filtreleyebilirsiniz. Filtre sorgusu söz dizimi için AIP-160'a bakın. Filtre sorgusu belirtilmezse tüm görevler listelenir.

Aşağıdaki tabloda, filtreleme için kullanabileceğiniz geçerli görev özellikleri gösterilmektedir:

Listeleri filtrelemek için görev özellikleri
  • type
  • attributes
  • tracking_id
  • delivery_vehicle_id
  • state
  • planned_location
  • task_duration
  • task_duration_outcome
  • task_outcome
  • task_outcome_location
  • task_outcome_time

Filtre sorgusu operatörlerinin tam listesi için AIP-160'a bakın.

Görev örneklerini listeleme

Aşağıdaki örnekte, hem Java gRPC kitaplığı hem de ListTasks için HTTP REST çağrısı kullanılarak bir deliveryVehicleId ve görev özelliği için görevlerin nasıl listeleneceği gösterilmektedir.

Başarılı bir yanıt boş da olabilir. Boş bir yanıt, sağlanan deliveryVehicleId ile ilişkili görev olmadığını gösterir.

gRPC

 static final String PROJECT_ID = "my-delivery-co-gcp-project";
 static final String TRACKING_ID = "TID-7449w087464x5";

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Tasks request
 String parent = "providers/" + PROJECT_ID;
 ListTasksRequest listTasksRequest = ListTasksRequest.newBuilder()  // No need for the header
     .setParent(parent)
     .setFilter("delivery_vehicle_id = 123 AND attributes.foo = true")
     .build();

 try {
   ListTasksResponse listTasksResponse = deliveryService.listTasks(listTasksRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;

      case PERMISSION_DENIED:
        break;
   }
   return;
 }

REST

GET https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks

Listelenen görevlere filtre uygulamak için, URL'den kaçışlı filtre sorgusunu değer olarak içeren bir "filter" URL parametresi ekleyin.

İstek başlığı, Bearer <token> değerine sahip bir Authorization alanı içermelidir. Burada <token>, doğru hizmet hesabı rolünü taşır. Hizmet hesabı rolleri bölümüne bakın.

Başarılı bir arama, aşağıdaki yapıya sahip bir yanıt gövdesi sağlar:

    // JSON representation
    {
      "tasks": [
        {
          object (Task)
        }
      ],
      "nextPageToken": string,
      "totalSize": integer
    }

Örnek curl komutu:

 # Set JWT, PROJECT_ID, and VEHICLE_ID in the local environment
 curl -H "Authorization: Bearer ${JWT}" \
   "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks?filter=state%20%3D%20OPEN%20AND%20delivery_vehicle_id%20%3D%20${VEHICLE_ID}"

Sırada ne var?