Package maps.fleetengine.delivery.v1

Dizin

DeliveryService

Last Mile Delivery hizmeti.

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

Bir grup yeni Task nesnesi oluşturur ve döndürür.

CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

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

CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

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

GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

Belirtilen DeliveryVehicle örneğini döndürür.

GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Task hakkında bilgi alır.

GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

Belirtilen TaskTrackingInfo örneğini döndürür.

ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

Belirtilen filtreleme ölçütlerini karşılayan tüm DeliveryVehicle'leri alır.

ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

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

UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Güncellenen DeliveryVehicle verilerini Fleet Engine'e yazar ve Tasks değerini DeliveryVehicle öğesine atar. DeliveryVehicle öğesinin adını güncelleyemezsiniz. remaining_vehicle_journey_segments öğesini güncelleyebilirsiniz ancak DeliveryVehicle üzerinde kalıcı olması için tüm VehicleJourneySegment öğelerini içermelidir. task_id öğeleri remaining_vehicle_journey_segments kaynağından alınır ve bunlara karşılık gelen Tasks öğeleri henüz atanmamışsa DeliveryVehicle öğesine atanır.

UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Task verilerini günceller.

BatchCreateTasksRequest

BatchCreateTask istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API isteği başlığı. Not: Bu alanı ayarlarsanız CreateTaskRequest iletilerindeki başlık alanı boş olmalı veya bu alanla eşleşmelidir.

parent

string

Zorunlu. Tüm görevler tarafından paylaşılan üst kaynak. Bu değer providers/{provider} biçiminde olmalıdır. provider, Google Cloud proje kimliği olmalıdır. Örneğin, sample-cloud-project. CreateTaskRequest mesajlarındaki üst alan boş bırakılmamalı veya bu alanla eşleşmelidir.

requests[]

CreateTaskRequest

Zorunlu. Oluşturulacak kaynakları belirten istek mesajı. Not: Bir toplu görevde en fazla 500 görev oluşturabilirsiniz.

BatchCreateTasksResponse

BatchCreateTask yanıt mesajı.

Alanlar
tasks[]

Task

Oluşturulan Görevler.

CreateDeliveryVehicleRequest

CreateDeliveryVehicle istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API isteği başlığı.

parent

string

Zorunlu. providers/{provider} biçiminde olmalıdır. Sağlayıcı, Google Cloud proje kimliği olmalıdır. Örneğin, sample-cloud-project.

delivery_vehicle_id

string

Zorunlu. Teslimat Aracı Kimliği benzersiz olmalı ve aşağıdaki kısıtlamalara tabi olmalıdır:

  • 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ştirilmiştir.
  • Şu ASCII karakterlerden hiçbirini içeremez: '/', ':', '?', ',' veya '#'.
delivery_vehicle

DeliveryVehicle

Zorunlu. Oluşturulacak DeliveryVehicle varlığı. Yeni bir teslimat aracı oluştururken aşağıdaki isteğe bağlı alanları ayarlayabilirsiniz:

  • last_location
  • attributes

Not: DeliveryVehicle'ın name alanı yoksayılır. Diğer tüm Teslimat Aracı alanları ayarlanmamalıdır; aksi takdirde bir hata döndürülür.

CreateTaskRequest

CreateTask istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API isteği başlığı.

parent

string

Zorunlu. providers/{provider} biçiminde olmalıdır. provider, Google Cloud proje kimliği olmalıdır. Örneğin, sample-cloud-project.

task_id

string

Zorunlu. Görev kimliği benzersiz olmalıdır ancak kargo takip kimliği olmamalıdır. Kargo takip kimliğini saklamak için tracking_id alanını kullanın. Birden çok görevin aynı tracking_id öğesine sahip olabileceğini unutmayın. Görev 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ştirilmiştir.
  • Şu ASCII karakterlerden hiçbirini içeremez: '/', ':', '?', ',' veya '#'.
task

Task

Zorunlu. Oluşturulacak Görev varlığı. Görev oluştururken aşağıdaki alanlar gereklidir:

  • type
  • state (OPEN olarak ayarlanmalıdır)
  • tracking_id (UNAVAILABLE veya SCHEDULED_STOP görevleri için ayarlanmamalıdır ancak diğer tüm görev türleri için gereklidir)
  • planned_location (UNAVAILABLE görev için isteğe bağlı)
  • task_duration

Not: Görevin name alanı yoksayılır. Diğer tüm Görev alanları ayarlanmamalıdır, aksi takdirde hata döndürülür.

DeliveryRequestHeader

RequestHeader, tüm Yayın RPC isteklerinde ortak olan alanları içerir.

Alanlar
language_code

string

BCP-47 dil kodu (ör. en-US veya sr-Latn). Daha fazla bilgi için http://www.unicode.org/reports/tr35/#Unicode_locale_identifier sayfasına bakın. Hiçbir dil belirtilmezse yanıt herhangi bir dilde olabilir ve böyle bir ad varsa İngilizce tercih edilir. Alan değeri örneği: en-US.

region_code

string

Zorunlu. İsteğin kaynağı olan bölgenin CLDR bölge kodu. Alan değeri örneği: US.

sdk_version

string

Çağrı yapan SDK'nın sürümü (varsa). Sürüm biçimi "major.minor.yama" şeklindedir. Örnek: 1.1.2.

os_version

string

Çağrı yapan SDK'nın çalıştığı işletim sisteminin sürümü. Alan değeri örnekleri: 4.4.1, 12.1.

device_model

string

Çağrı yapan SDK'nın çalıştığı cihazın modeli. Alan değeri örnekleri: iPhone12,1, SM-G920F.

sdk_type

SdkType

İsteği gönderen SDK'nın türü.

maps_sdk_version

string

Varsa, çağrı SDK'sının kullandığı MapSDK sürümü. Sürüm biçimi "major.minor.yama" şeklindedir. Örnek: 5.2.1.

nav_sdk_version

string

Geçerliyse, çağrı yapan SDK'nın kullandığı NavSDK sürümü. Sürüm biçimi "major.minor.yama" şeklindedir. Örnek: 2.1.0.

platform

Platform

Çağrı yapan SDK'nın platformu.

manufacturer

string

Çağrı yapan SDK'dan Android cihazın üreticisi. Yalnızca Android SDK'ları için geçerlidir. Alan değeri örneği: Samsung.

android_api_level

int32

Çağrı yapan SDK'nın Android API düzeyi, yalnızca Android SDK'ları için geçerlidir. Alan değeri örneği: 23.

trace_id

string

İsteği tanımlamak amacıyla günlüğe kaydetme amacıyla sağlanabilecek isteğe bağlı kimlik.

Platform

Çağrı yapan SDK'nın platformu.

Sıralamalar
PLATFORM_UNSPECIFIED Varsayılan değerdir. Platform atlanırsa bu değer kullanılır.
ANDROID İstek Android'den geliyor.
IOS İstek iOS'ten geliyor.
WEB İstek web'den geliyor.

SdkType

Olası SDK türleri.

Sıralamalar
SDK_TYPE_UNSPECIFIED Varsayılan değerdir. sdk_type atlanırsa bu değer kullanılır.
CONSUMER Çağrı yapan SDK, Tüketici'dir.
DRIVER Çağrı yapan SDK, Driver'dır.
JAVASCRIPT Çağrı yapan SDK, JavaScript'tir.

DeliveryVehicle

DeliveryVehicle mesajı. Teslimat aracı, gönderileri bir depodan teslimat konumuna ve teslim alma konumundan depoya taşır. Bazı durumlarda teslimat araçları, gönderileri doğrudan teslim alma konumundan teslimat konumuna taşır.

Not: gRPC ve REST API'lerinde farklı alan adlandırma kuralları kullanılır. Örneğin, gRPC API'sindeki DeliveryVehicle.current_route_segment alanı ile REST API'deki DeliveryVehicle.currentRouteSegment alanı aynı alana işaret eder.

Alanlar
name

string

Bu teslimat aracının benzersiz adı. Biçim şöyledir: providers/{provider}/deliveryVehicles/{vehicle}.

last_location

DeliveryVehicleLocation

Teslimat Aracının bildirilen son konumu.

navigation_status

DeliveryVehicleNavigationStatus

Teslimat Aracının navigasyon durumu.

current_route_segment

bytes

Gezinmenin bir sonraki ara noktaya gitmeyi önerdiği rotayı belirten kodlanmış çoklu çizgi. Sürücü uygulamanız, bir durağa ulaşıldığında veya duraktan geçildiğinde ve navigasyon yeniden rotaya geçtiğinde bu ayarı günceller. Bu LatLng'lar, araca atanan tüm etkin Görevler için Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) veya Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) içinde döndürülür.

Bu alanın Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) veya Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) alanını doldurmak için kullanılamayacağı birkaç durum vardır:

  • current_route_segment uç noktası, DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) veya DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST) ile eşleşmiyor.

  • Sürücü uygulaması yakın zamanda konumunu güncellemediğinden, bu alan için en son güncellenen değer eski olabilir.

  • Sürücü uygulaması kısa süre önce konumunu güncelledi ancak current_route_segment eski ve eski bir araç durağına işaret ediyor.

Bu tür durumlarda Fleet Engine, bu alandaki tüketicinin teslim aracının mevcut yolu hakkında en iyi bilgiye sahip olmasını sağlamak için bu alanı en son geçen VehicleStop'tan yaklaşan VehicleStop'a (Araç Durdurma) bir rotayla doldurur.

current_route_segment_end_point

LatLng

current_route_segment etkinliğinin sona erdiği konum. Bu alan, şu anda sürücü uygulaması tarafından doldurulmamaktadır, ancak UpdateDeliveryVehicle görüşmelerinde bunu sağlayabilirsiniz. Ya yaklaşan araç durağındaki LatLng ya da current_route_segment ayının son LatLng günü. Ardından Fleet Engine, gerçek bir VehicleStop değerine interpolasyon sağlamak için elinden geleni yapacaktır.

current_route_segment alanı boşsa bu alan UpdateDeliveryVehicle çağrılarında yoksayılır.

remaining_distance_meters

Int32Value

current_route_segment için kalan sürüş mesafesi. Bu alan genellikle Driver uygulaması tarafından sağlanır ancak Fleet Engine'in uygulama tarafından gönderilen değeri geçersiz kıldığı bazı durumlar vardır. Daha fazla bilgi için DeliveryVehicle.current_route_segment adresini ziyaret edin. Bu alan, teslim aracına atanmış tüm etkin Task'ler için Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) veya Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) cinsinden döndürülür.

current_route_segment alanı boşsa Fleet Engine, UpdateDeliveryVehicleRequest içindeki bu alanı yoksayar.

remaining_duration

Duration

current_route_segment için kalan sürüş süresi. Bu alan genellikle Driver uygulaması tarafından sağlanır ancak Fleet Engine'in uygulama tarafından gönderilen değeri geçersiz kıldığı bazı durumlar vardır. Daha fazla bilgi için DeliveryVehicle.current_route_segment adresini ziyaret edin. Teslimat Aracı'na atanan tüm etkin görevler için bu alan, Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) veya Task.remainingVehicleJourneySegments[0].drivingDuration (REST) biçiminde döndürülür.

current_route_segment alanı boşsa Fleet Engine, UpdateDeliveryVehicleRequest içindeki bu alanı yoksayar.

remaining_vehicle_journey_segments[]

VehicleJourneySegment

Aracın en son bildirilen konumundan başlayarak bu teslimat aracına atanan yolculuk segmentleri. Bu alan, ListDeliveryVehicles yanıtında doldurulmayacak.

attributes[]

DeliveryVehicleAttribute

Özel Teslimat Aracı özelliklerinin listesi. Bir teslimat aracının en fazla 100 özelliği olabilir ve her özelliğin benzersiz bir anahtarı olmalıdır.

type

DeliveryVehicleType

Bu teslimat aracının türü. Politika ayarlanmadan bırakılırsa varsayılan olarak AUTO ayarlanır.

DeliveryVehicleType

Teslimat aracının türü.

Sıralamalar
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Değer kullanılmıyor.
AUTO Bir otomobil.
TWO_WHEELER Motosiklet, moped veya diğer iki tekerlekli araç
BICYCLE İnsan gücüyle ulaşım.
PEDESTRIAN Genellikle yürüyen veya koşan, yaya yollarında ilerleyen bir insan taşıyıcı.

DeliveryVehicleAttribute

Araç özelliğini anahtar/değer çifti olarak tanımlar. "key:value" dizesinin uzunluğu 256 karakterden uzun olamaz.

Alanlar
key

string

Özelliğin anahtarı.

value

string

Özelliğin değeri.

Birleştirme alanı delivery_vehicle_attribute_value. Özelliğin değeri dize, bool veya çift tür olabilir. delivery_vehicle_attribute_value şunlardan yalnızca biri olabilir:
string_value

string

Dize türünde özellik değeri.

Not: Bu, zaman içinde kullanımdan kaldırılacak olan value alanıyla aynıdır. Oluşturma veya güncelleme yöntemleri için her iki alan da kullanılabilir ancak string_value kullanılması önemle tavsiye edilir. Hem string_value hem de value ayarlanırsa bunlar aynı olmalıdır. Aksi takdirde hata verilir. Yanıtlarda her iki alan da doldurulur.

bool_value

bool

Boole türünde özellik değeri.

number_value

double

Özellik değeri iki kez yazılmış.

DeliveryVehicleLocation

Bir aracın belirli bir zamandaki konumu, hızı ve yönü.

Alanlar
location

LatLng

Aracın konumu. Fleet Engine'e gönderildiğinde, aracın konumu bir GPS konumudur. Yanıt olarak aldığınızda, aracın konumu bir GPS konumu, ek bir konum veya başka bir tahmini konum olabilir. Kaynak, location_sensor öğesinde belirtilmiş.

horizontal_accuracy
(deprecated)

DoubleValue

Desteği sonlandırıldı: Bunun yerine latlng_accuracy kullanın.

latlng_accuracy

DoubleValue

Yarıçap olarak location değerinin metre cinsinden doğruluğu.

heading

Int32Value

Aracın derece cinsinden hareket ettiği yön. 0, Kuzeyi temsil eder. Geçerli aralık [0,360]'dır.

bearing_accuracy
(deprecated)

DoubleValue

Desteği sonlandırıldı: Bunun yerine heading_accuracy kullanın.

heading_accuracy

DoubleValue

heading cinsinden doğruluk derecesi.

altitude

DoubleValue

WGS84'ün üzerinde metre cinsinden rakım.

vertical_accuracy
(deprecated)

DoubleValue

Desteği sonlandırıldı: Bunun yerine altitude_accuracy kullanın.

altitude_accuracy

DoubleValue

Metre cinsinden altitude doğruluğu.

speed_kmph
(deprecated)

Int32Value

Aracın kilometre/saat cinsinden hızı. Desteği sonlandırıldı: Bunun yerine speed kullanın.

speed

DoubleValue

Aracın metre/saniye cinsinden hızı

speed_accuracy

DoubleValue

Metre/saniye cinsinden speed doğruluk oranı.

update_time

Timestamp

Sensör saatine göre sensörün location öğesini bildirdiği zaman.

server_time

Timestamp

Yalnızca çıkış. Sunucunun konum bilgilerini aldığı zaman.

location_sensor

DeliveryVehicleLocationSensor

Konum verileri sağlayıcı (örneğin, GPS).

is_road_snapped

BoolValue

location cihazının yola bağlanıp bağlanmadığı.

is_gps_sensor_enabled

BoolValue

Yalnızca giriş. Mobil cihazda GPS sensörünün etkin olup olmadığını belirtir.

time_since_update

Int32Value

Yalnızca giriş. Bu konumun sunucuya ilk gönderilmesinden bu yana geçen süre (saniye cinsinden). Bu değer, ilk güncelleme için sıfır olur. Saat bilinmiyorsa (örneğin, uygulama yeniden başlatıldığında) bu değer sıfıra sıfırlanır.

num_stale_updates
(deprecated)

Int32Value

Yalnızca giriş. Desteği sonlandırıldı: Bir konumun eski olup olmadığını belirlemek için artık başka sinyaller de kullanılmaktadır.

raw_location

LatLng

Ham araç konumu (yol gezgini tarafından işlenmemiş).

raw_location_time

Timestamp

Ham konumla ilişkilendirilen zaman damgası.

raw_location_sensor

DeliveryVehicleLocationSensor

İşlenmemiş konumun kaynağı. Varsayılan olarak GPS değerine ayarlanır.

raw_location_accuracy

DoubleValue

raw_location değerinin metre cinsinden yarıçap olarak doğruluğu.

supplemental_location

LatLng

Entegrasyon uygulaması tarafından sağlanan ek konum.

supplemental_location_time

Timestamp

Ek konumla ilişkilendirilen zaman damgası.

supplemental_location_sensor

DeliveryVehicleLocationSensor

Ek konumun kaynağı. Varsayılan olarak CUSTOMER_SUPPLIED_LOCATION değerine ayarlanır.

supplemental_location_accuracy

DoubleValue

supplemental_location değerinin metre cinsinden yarıçap olarak doğruluğu.

road_snapped
(deprecated)

bool

Desteği sonlandırıldı: Bunun yerine is_road_snapped kullanın.

DeliveryVehicleLocationSensor

Konumu belirlemek için kullanılan sensör veya metodoloji.

Sıralamalar
UNKNOWN_SENSOR Sensör belirtilmemiş veya bilinmiyor.
GPS GPS veya Yardımlı GPS.
NETWORK Yardımlı GPS, baz istasyonu kimliği veya WiFi erişim noktası.
PASSIVE Baz istasyonu kimliği veya kablosuz erişim noktası.
ROAD_SNAPPED_LOCATION_PROVIDER Mobil cihaz tarafından en olası yol konumu olarak belirlenen bir konum.
CUSTOMER_SUPPLIED_LOCATION Bağımsız bir kaynaktan müşteri tarafından sağlanan konum Genellikle bu değer, Driver SDK'sını çalıştıran mobil cihaz dışındaki kaynaklardan sağlanan bir konum için kullanılır. Orijinal kaynak diğer enum değerlerinden biriyle açıklanıyorsa bu değeri kullanın. CUSTOMER_SUMPLIED_LOCATION işaretli konumlar genellikle bir DeliveryVehicle'ın last_location.supplemental_location_sensor hizmeti ile sağlanır.
FLEET_ENGINE_LOCATION Kullanabildiği sinyallere göre Fleet Engine tarafından hesaplanan konum. Yalnızca çıkış. Bu değer bir istekte alınırsa reddedilir.
FUSED_LOCATION_PROVIDER Android'in Çok Kaynaklı Konum Sağlayıcısı.
CORE_LOCATION Apple işletim sistemlerindeki konum sağlayıcı.

DeliveryVehicleNavigationStatus

Aracın navigasyon durumu.

Sıralamalar
UNKNOWN_NAVIGATION_STATUS Navigasyon durumu belirtilmemiş.
NO_GUIDANCE Sürücü uygulamasının navigasyonu FREE_NAV modunda.
ENROUTE_TO_DESTINATION Adım adım navigasyon kullanılabilir ve Sürücü uygulamasında navigasyon GUIDED_NAV moduna girdi.
OFF_ROUTE Araç, önerilen rotadan ayrıldı.
ARRIVED_AT_DESTINATION Araç, varış noktasına yaklaşık 50 metre mesafede olmalıdır.

GetDeliveryVehicleRequest

GetDeliveryVehicle istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API isteği başlığı.

name

string

Zorunlu. providers/{provider}/deliveryVehicles/{delivery_vehicle} biçiminde olmalıdır. provider, Google Cloud proje kimliği olmalıdır. Örneğin, sample-cloud-project.

GetTaskRequest

GetTask istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API isteği başlığı.

name

string

Zorunlu. providers/{provider}/tasks/{task} biçiminde olmalıdır. provider, Google Cloud proje kimliği olmalıdır. Örneğin, sample-cloud-project.

GetTaskTrackingInfoRequest

GetTaskTrackingInfoRequest istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API isteği başlığı.

name

string

Zorunlu. providers/{provider}/taskTrackingInfo/{tracking_id} biçiminde olmalıdır. provider, Google Cloud proje kimliği, tracking_id ise görevle ilişkili izleme kimliği olmalıdır. providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id, buna örnek olarak verilebilir.

ListDeliveryVehiclesRequest

ListDeliveryVehicles istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API isteği başlığı.

parent

string

Zorunlu. providers/{provider} biçiminde olmalıdır. provider, Google Cloud proje kimliği olmalıdır. Örneğin, sample-cloud-project.

page_size

int32

İsteğe bağlı. Geri dönülecek maksimum araç sayısı. Hizmet, bu sayıdan daha az değer döndürebilir. Bu sayıyı belirtmezseniz, döndürülecek sonuç sayısını sunucu belirler.

page_token

string

İsteğe bağlı. Önceki ListDeliveryVehicles çağrısından alınan bir sayfa jetonu. Sonraki sayfayı almak için bunu sağlamanız gerekir.

Sayfalara ayırma işlemi sırasında ListDeliveryVehicles öğesine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

filter

string

İsteğe bağlı. Teslimat araçları listelenirken uygulanacak bir filtre sorgusu. Filtre söz dizimi örnekleri için http://aip.dev/160 adresine bakın. Değer belirtmezseniz veya filtre için boş bir dize belirtirseniz tüm teslimat araçları döndürülür.

ListDeliveryVehicles için desteklenen sorguların yalnızca araç özelliklerinde (örneğin, attributes.<key> = <value> veya attributes.<key1> = <value1> AND attributes.<key2> = <value2>) bulunduğunu unutmayın. Ayrıca, tüm özellikler dize olarak depolandığından, özelliklerle karşılaştırıldığında yalnızca dize karşılaştırmaları desteklenir. Sayı veya boole değerleriyle karşılaştırma yapabilmek için değerlerin dize olarak değerlendirilmeleri için açıkça tırnak içine alınması gerekir (ör. attributes.<key> = "10" veya attributes.<key> = "true").

Bir filtre sorgusunda izin verilen maksimum kısıtlama sayısı 50'dir. Kısıtlama, attribute.<KEY> <COMPARATOR> <VALUE> biçimindeki sorgunun bir parçasıdır. Örneğin, attributes.foo = bar 1 kısıtlamadır.

viewport

Viewport

İsteğe bağlı. Geri gelen araçları, bilinen son konumu görüntü alanının tanımladığı dikdörtgen alanda olan araçlarla sınırlayan bir filtre.

ListDeliveryVehiclesResponse

ListDeliveryVehicles yanıt mesajı.

Alanlar
delivery_vehicles[]

DeliveryVehicle

İstenen filtreleme ölçütlerini karşılayan teslimat araçları grubu. Filtre belirtilmediğinde, istek tüm teslimat araçlarını döndürür. Başarılı bir yanıt da boş olabilir. Boş bir yanıt, istenen filtre ölçütlerini karşılayan hiçbir teslimat aracının bulunamadığını gösterir.

next_page_token

string

Sonuçları listelemeye devam etmek için bu jetonu ListDeliveryVehiclesRequest uygulamasında aktarabilirsiniz. Tüm sonuçlar döndürüldüğünde bu alan yanıtta yer almaz veya boş bir dize olur.

total_size

int64

Tüm sayfalarda istek ölçütleriyle eşleşen yayınlama araçlarının toplam sayısı.

ListTasksRequest

ListTasks istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API isteği başlığı.

parent

string

Zorunlu. providers/{provider} biçiminde olmalıdır. provider, Google Cloud proje kimliği olmalıdır. Örneğin, sample-cloud-project.

page_size

int32

İsteğe bağlı. Döndürülecek maksimum görev sayısı. Hizmet bu değerden daha az bir değer döndürebilir. Bu değeri belirtmezseniz döndürülecek sonuç sayısını sunucu belirler.

page_token

string

İsteğe bağlı. Önceki ListTasks çağrısından alınan bir sayfa jetonu. Sonraki sayfayı almak için bunu sağlayabilirsiniz.

Sayfalara ayırma işlemi sırasında ListTasks öğesine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

filter

string

İsteğe bağlı. Görevler listelenirken uygulanacak bir filtre sorgusu. Filtre söz dizimi örnekleri için http://aip.dev/160 adresine bakın. Bir değer belirtmezseniz veya boş bir dizeye filtre uygularsanız tüm Görevler döndürülür. Filtreleyebileceğiniz Görev özellikleri hakkında bilgi edinmek için Görevleri listeleme başlıklı makaleyi inceleyin.

ListTasksResponse

ListTasksRequest öğesindeki filtre ölçütlerini karşılayan Görevler grubunu içeren ListTasks yanıtı.

Alanlar
tasks[]

Task

İstenen filtreleme ölçütlerini karşılayan Görevler kümesi. Filtre belirtilmediğinde, istek tüm görevleri döndürür. Başarılı bir yanıt da boş olabilir. Boş bir yanıt, istenen filtre ölçütlerini karşılayan bir Görev bulunamadığını gösterir.

next_page_token

string

Sonuçları listelemeye devam etmek için bu jetonu ListTasksRequest uygulamasında iletin. Tüm sonuçlar döndürüldüyse bu alan boş bir dizedir veya yanıtta görünmez.

total_size

int64

Tüm sayfalarda istek ölçütleriyle eşleşen Görevler'in toplam sayısı.

LocationInfo

Ek tanımlayıcılara sahip bir konum.

Alanlar
point

LatLng

Konumun koordinatları.

Görev

Delivery API'deki bir Görev, izlenecek tek bir işlemi temsil eder. Genel olarak, sevkiyatla ilgili Görevler ile aradaki görevler arasında bir fark vardır. Bir gönderiyle ilişkili birden fazla görev olabilir. Örneğin, teslim alma için bir Görev ve teslim etme ya da aktarma için başka bir Görev olabilir. Ayrıca, belirli bir gönderi için farklı görevler farklı araçlar tarafından gerçekleştirilebilir. Örneğin, bir araç teslimi alarak kargoyu merkeze yönlendirirken başka bir araç aynı gönderiyi merkezden teslim noktasına doğru götürebilir.

Not: gRPC ve REST API'lerinde farklı alan adlandırma kuralları kullanılır. Örneğin, gRPC API'sindeki Task.journey_sharing_info alanı ile REST API'deki Task.journeySharingInfo alanı aynı alana işaret eder.

Alanlar
name

string

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

type

Type

Zorunlu. Sabit. Görevin türünü tanımlar. Örneğin, ara veya kargo.

state

State

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

task_outcome

TaskOutcome

Görevin sonucu.

task_outcome_time

Timestamp

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

task_outcome_location

LocationInfo

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

task_outcome_location_source

TaskOutcomeLocationSource

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

tracking_id

string

Sabit. Bu alan, karmaşık bir eşleme kullanmaktan kaçınmanızı sağlayacak bir kimliğin depolanmasını kolaylaştırır. UNAVAILABLE ve SCHEDULED_STOP türündeki Görevler için tracking_id değerini 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ştirilmiştir.
  • Şu ASCII karakterlerden hiçbirini içeremez: '/', ':', '?', ',' veya '#'.
delivery_vehicle_id

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ştirilmiştir.
  • Şu ASCII karakterlerden hiçbirini içeremez: '/', ':', '?', ',' veya '#'.
planned_location

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

task_duration

Duration

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

target_time_window

TimeWindow

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

journey_sharing_info

JourneySharingInfo

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

task_tracking_view_config

TaskTrackingViewConfig

Hangi veri öğelerinin hangi durumlarda son kullanıcılar tarafından görülebileceğini belirten görev izleme yapılandırması.

attributes[]

TaskAttribute

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

JourneySharingInfo

Belirli alanları paylaşma yolculuğu.

Alanlar
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Atanan aracın bu görevi tamamlamadan önce yapacağı duraklar hakkında takip bilgileri. Bu listenin diğer görevlere ait 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 sonraki VehicleStop konumuna kadar rota bilgilerini içeriyor. DeliveryVehicle.current_route_segment belgelerinde belirtilen bazı durumlar dışında, 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) içindeki diğer segmentler Fleet Engine tarafından doldurulur. Bunlar, kalan VehicleStops arasındaki rota bilgilerini sağlar.

last_location

DeliveryVehicleLocation

Aracın atanan araçla ilgili en son bildirilen konumunu belirtir.

last_location_snappable

bool

Aracın son konumunun current_route_segment cihazına tutturulup tutulmayacağını gösterir. last_location veya current_route_segment yoksa bu değer Yanlış'tır. Bu değer, Fleet Engine tarafından hesaplanmaktadır. İstemcilerden gelen güncellemeler yoksayılır.

Eyalet

Bir görevin durumu. Bu, Görevler'in ilerleme durumunu gösterir.

Sıralamalar
STATE_UNSPECIFIED Varsayılan. Belirtilmemiş veya tanınmayan Görev durumu için kullanılır.
OPEN Görev henüz bir teslimat aracına atanmadı veya teslimat aracı Task tarafından atanan araç durağından henüz geçmedi.
CLOSED Araç bu görev için durduğunda.

TaskOutcome

Bir görevi yürütmeye çalışmanın sonucu. TaskState kapatıldığında TaskOutcome, görevin başarıyla tamamlanıp tamamlanmadığını belirtir.

Sıralamalar
TASK_OUTCOME_UNSPECIFIED Değeri belirlenmeden önceki Görev sonucu.
SUCCEEDED Görev başarıyla tamamlandı.
FAILED Görev tamamlanamadı veya iptal edildi.

TaskOutcomeLocationSource

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

Sıralamalar
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Görevin sonucu belirlenmeden önce.
PROVIDER Sağlayıcı, task_outcome_location adını belirtti.
LAST_VEHICLE_LOCATION task_outcome_location, sağlayıcı belirtmediğinden Fleet Engine bilinen son araç konumunu kullandı.

Tür

Görevin türü.

Sıralamalar
TYPE_UNSPECIFIED Varsayılan olarak 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ç bırakma değerleri SCHEDULED_STOP türünü kullanmalıdır.
SCHEDULED_STOP Planlanmış bir durdurma görevi, planlama amacıyla kullanılır. Örneğin, besleyici araçlarından veya depolarından gönderilerin alınmasını ya da bırakılmasını gösterebilir. Son müşteriden alınan veya son müşteriden bırakılan gönderiler için kullanılmamalıdır.
UNAVAILABLE Aracın servis için kullanılamadığını ifade eden bir görev. Örneğin, sürücü mola verdiğinde veya araç yakıt verildiğinde bu durum gerçekleşebilir.

TaskAttribute

Bir görev özelliğini anahtar/değer çifti olarak tanımlar. "key:value" dizesinin uzunluğu 256 karakterden uzun olamaz.

Alanlar
key

string

Özelliğin anahtarı. Anahtarlar, iki nokta üst üste karakterini (:) içeremez.

Birleştirme alanı task_attribute_value. Özelliğin değeri dize, bool veya çift tür olabilir. Hiçbiri ayarlanmazsa TaskAttribute string_value boş dizesi "" olarak depolanır. task_attribute_value aşağıdakilerden yalnızca biri olabilir:
string_value

string

Dize türünde özellik değeri.

bool_value

bool

Boole türünde özellik değeri.

number_value

double

Özellik değeri iki kez yazılmış.

TaskTrackingInfo

TaskTrackingInfo mesajı. Bu mesaj, görüntülenmek için görev izleme bilgilerini içerir. Bir izleme kimliği birden fazla Görev ile ilişkiliyse Fleet Engine, hangi Görevin TaskTrackingInfo bilgisinin seçileceğine karar vermek için buluşsal bir yöntem kullanır.

Alanlar
name

string

providers/{provider}/taskTrackingInfo/{tracking} biçiminde olmalıdır. Burada tracking, izleme kimliğini temsil eder.

tracking_id

string

Sabit. Bir görevin izleme kimliği. * 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ştirilmiştir. * Şu ASCII karakterlerden hiçbirini içeremez: '/', ':', '?', ',' veya '#'.

vehicle_location

DeliveryVehicleLocation

Aracın son konumu.

route_polyline_points[]

LatLng

Bağlandığında aracın beklenen rotasının bu görevin konumuna giden çoklu çizgisini oluşturan noktaların listesi.

remaining_stop_count

Int32Value

Görevin durması da dahil olmak üzere, görev durdurulana kadar aracın kaç kez durması gerektiğini belirtir. Örneğin, aracın bir sonraki durağı görev durağıysa değer 1 olur.

remaining_driving_distance_meters

Int32Value

İlgilenilen VehicleStop noktasına kadar metre cinsinden kalan toplam mesafe.

estimated_arrival_time

Timestamp

Durak konumuna tahmini varış zamanını gösteren zaman damgası.

estimated_task_completion_time

Timestamp

Bir görevin tahmini tamamlanma zamanını gösteren zaman damgası.

state

State

Görevin mevcut yürütme durumu.

task_outcome

TaskOutcome

Bir görevi yürütmeye çalışmanın sonucu.

task_outcome_time

Timestamp

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

planned_location

LocationInfo

Sabit. Görevin tamamlanacağı konum.

target_time_window

TimeWindow

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

attributes[]

TaskAttribute

Görevde ayarlanan özel özellikler.

TaskTrackingViewConfig

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

Alanlar
route_polyline_points_visibility

VisibilityOption

Güzergah çoklu çizgi noktalarının ne zaman görünebileceğ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.

estimated_arrival_time_visibility

VisibilityOption

Tahmini varış saatinin ne zaman görünebileceğ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.

estimated_task_completion_time_visibility

VisibilityOption

Tahmini görev tamamlanma süresinin ne zaman görüneceğ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.

remaining_driving_distance_visibility

VisibilityOption

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

remaining_stop_count_visibility

VisibilityOption

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

vehicle_location_visibility

VisibilityOption

Araç konumunun 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.

VisibilityOption

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

Alanlar
Birleştirme alanı visibility_option. İlgili görünürlük seçeneği belirlendi. visibility_option şunlardan yalnızca biri olabilir:
remaining_stop_count_threshold

int32

Kalan durdurma sayısı <= geri kalan_stop_count_threshold değerine eşitse son kullanıcılar bu veri öğesini görebilir.

duration_until_estimated_arrival_time_threshold

Duration

Bu veri öğesi, duracak tahmini varış süresi <= Duration_until_estimated_arrival_time_threshold'da geçerliyse son kullanıcılar tarafından görülebilir.

remaining_driving_distance_meters_threshold

int32

Bu veri öğesi, metre cinsinden kalan sürüş mesafesi <= geri_kalan_driving_distance_meters_threshold ise son kullanıcılar tarafından görülebilir.

always

bool

Politika, Doğru değerine ayarlanırsa bu veri öğesi, eşiği olmayan son kullanıcılar tarafından her zaman görülebilir. Bu alan false olarak ayarlanamaz.

never

bool

Politika, Doğru değerine ayarlanırsa bu veri öğesi, eşiği olmayan son kullanıcılardan her zaman gizlenir. Bu alan false olarak ayarlanamaz.

TimeWindow

Zaman aralığı.

Alanlar
start_time

Timestamp

Zorunlu. Zaman aralığının başlangıç zamanı (bu zaman dahil).

end_time

Timestamp

Zorunlu. Zaman aralığının bitiş zamanı (dahil).

UpdateDeliveryVehicleRequest

UpdateDeliveryVehicle istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API isteği başlığı.

delivery_vehicle

DeliveryVehicle

Zorunlu. Uygulanacak DeliveryVehicle varlığı güncellemesi. Not: DeliveryVehicle öğesinin adını güncelleyemezsiniz.

update_mask

FieldMask

Zorunlu. Hangi DeliveryVehicle alanlarının güncelleneceğini gösteren alan maskesi. "update_mask" değerinin en az bir alan içermesi gerektiğini unutmayın.

Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: "remaining_vehicle_journey_segments".

UpdateTaskRequest

UpdateTask istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API isteği başlığı.

task

Task

Zorunlu. Güncellemeyle ilişkili Görev. Aşağıdaki alanlar Fleet Engine tarafından yönetilir. Bunları Task.update kullanarak güncellemeyin.

  • last_location.
  • last_location_snappable.
  • name.
  • remaining_vehicle_journey_segments.
  • task_outcome_location_source.

Not: task_outcome değerini bir kez ayarladıktan sonra değiştiremezsiniz.

Görev bir teslimat aracına atandıysa Task.update kullanarak Görev durumunu KAPALI olarak ayarlamayın. Bunun yerine, görevi içeren VehicleStop öğesini teslim aracından kaldırın. Bu işlem, Görev durumunu otomatik olarak KAPATILDI şeklinde ayarlar.

update_mask

FieldMask

Zorunlu. Hangi Görev alanlarının güncelleneceğini gösteren alan maskesi. Not: update_mask en az bir alan içermelidir.

Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: "task_outcome,task_outcome_time,task_outcome_location".

VehicleJourneySegment

Bir aracın önceki durağından geçerli durağına kadar seyahat segmentini temsil eder. İlk etkin duraksa aracın mevcut konumundan bu duraka kadardır.

Alanlar
stop

VehicleStop

Durakla ilişkili Task'lerle birlikte durak konumunu belirtir. Bu yolculuk segmenti JourneySharingInfo kapsamındaysa bazı VehicleStop alanları mevcut olmayabilir.

driving_distance_meters

Int32Value

Yalnızca çıkış. Önceki durak ile bu durak arasındaki seyahat mesafesi. Mevcut durak, yolculuk segmentleri listesindeki ilk duraksa başlangıç noktası, bu durağın listeye eklendiği sırada aracın kayıtlı konumudur. Bu yolculuk segmenti JourneySharingInfo kapsamındaysa bu alan mevcut olmayabilir.

driving_duration

Duration

Yalnızca çıkış. Önceki durak ile bu durak arasındaki seyahat süresi. Mevcut durak, yolculuk segmentleri listesindeki ilk duraksa başlangıç noktası, bu durağın listeye eklendiği sırada Aracın kayıtlı konumudur.

Bu alan, Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) veya Task.remainingVehicleJourneySegments[0].drivingDuration (REST) yolunda tanımlanmışsa DeliveryVehicle.remaining_duration (gRPC) ya da DeliveryVehicle.remainingDuration (REST) kaynaklı değerle doldurulabilir. Bu sayede, önceki duraktaki sürüş süresi yerine sürücü uygulamasının bilinen en son konumundan kalan sürüş süresi gösterilir.

path[]

LatLng

Yalnızca çıkış. Önceki duraktan bu konuma giden yol. Mevcut durak, yolculuk segmentleri listesindeki ilk duraksa bu, durağın listeye eklendiği zamanda aracın mevcut konumundan bu durma noktasına kadar olan yoldur. Bu yolculuk segmenti JourneySharingInfo kapsamındaysa bu alan mevcut olmayabilir.

Bu alan, Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) veya Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) yolunda tanımlanmışsa DeliveryVehicle.current_route_segment (gRPC) ya da DeliveryVehicle.currentRouteSegment (REST) kaynağından kodu çözülmüş LatLng'lerle doldurulabilir. Bu şekilde, önceki duraktaki yol yerine sürücü uygulamasının bilinen en son konumundan alınan yol bilgisi sağlanır.

VehicleStop

Bir aracın bir veya daha fazla Task yapmak için durduğu bir noktayı açıklar.

Alanlar
planned_location

LocationInfo

Zorunlu. Durağın konumu. Task içindeki konumların bu konumla tam olarak eşleşmeyebileceğini ancak bu konuma kısa bir mesafede olacağını unutmayın. Bu alan, GetTask çağrısının yanıtında doldurulmaz.

tasks[]

TaskInfo

Bu durakta gerçekleştirilecek Task listesi. Bu alan, GetTask çağrısının yanıtında doldurulmaz.

state

State

VehicleStop cihazının durumu. Bu alan, GetTask çağrısının yanıtında doldurulmaz.

Eyalet

VehicleStop öğesinin mevcut durumu.

Sıralamalar
STATE_UNSPECIFIED Bilinmiyor.
NEW Oluşturulmuş ancak etkin olarak yönlendirilmiyor.
ENROUTE Atanan ve etkin olarak yönlendiriliyor.
ARRIVED Durağa varıldı. Araç bir sonraki durağa giderken önceki tüm durakların tamamlandığı varsayılır.

TaskInfo

Bu durakta gerçekleştirilen Görev hakkında ek bilgi.

Alanlar
task_id

string

Görev kimliği. Bu alan, GetTask çağrısının yanıtında doldurulmaz. Görev 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ştirilmiştir.
  • Şu ASCII karakterlerden hiçbirini içeremez: '/', ':', '?', ',' veya '#'.
task_duration

Duration

Yalnızca çıkış. Görevi gerçekleştirmek için gereken süre.

target_time_window

TimeWindow

Yalnızca çıkış. Görevin tamamlanması gereken zaman aralığı. Bu, yalnızca GetDeliveryVehicle yanıtında ayarlanır.