Package maps.fleetengine.delivery.v1

Dizin

DeliveryService

The Last Mile teslimat 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şturup döndürür.

GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

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

GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Bir 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 öğelerini alır.

ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

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

UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Güncellenen DeliveryVehicle verilerini Fleet Engine'a yazar ve Tasks'yi DeliveryVehicle'ye 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'ler remaining_vehicle_journey_segments'dan alınır ve henüz atanmamışsa ilgili Tasks'ler DeliveryVehicle'a 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 istek başlığı. Not: Bu alanı ayarlarsanız CreateTaskRequest iletilerindeki üstbilgi 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 iletilerindeki üst alan boş olmalı veya bu alanla eşleşmelidir.

requests[]

CreateTaskRequest

Zorunlu. Oluşturulacak kaynakları belirten istek mesajı. Not: Bir toplu işlemde 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 istek 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 Biçimi C'ye göre normalleştirilmiştir.
  • Aşağıdaki ASCII karakterlerinden hiçbirini içeremez: '/', ':', '?', ',' veya '#'.
delivery_vehicle

DeliveryVehicle

Zorunlu. Oluşturulacak DeliveryVehicle öğesi. Yeni bir yayınlama aracı oluştururken aşağıdaki isteğe bağlı alanları ayarlayabilirsiniz:

  • tür
  • last_location
  • özellikler

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

CreateTaskRequest

CreateTask istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API istek 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 gönderi takip kimliği olmamalıdır. Gönderi takip kimliğini saklamak için tracking_id alanını kullanın. Birden fazla görevin aynı tracking_id değerine 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 Biçimi C'ye göre normalleştirilmiştir.
  • Aşağıdaki ASCII karakterlerinden hiçbirini içeremez: '/', ':', '?', ',' veya '#'.
task

Task

Zorunlu. Oluşturulacak Task öğesi. 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örevleri 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 adresini ziyaret edin. 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 kaynaklandığı 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 "büyük.küçük.yama" şeklindedir (örnek: 1.1.2).

os_version

string

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

device_model

string

Arayan 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

Varsa çağıran SDK'nın bağlı olduğu NavSDK sürümü. Sürüm biçimi "major.minor.yama" şeklindedir. Örnek: 2.1.0.

platform

Platform

Çağıran SDK'nın platformu.

manufacturer

string

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

android_api_level

int32

Arayan 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ük kaydı için sağlanabilecek isteğe bağlı kimlik.

Platform

Çağıran 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ğer. sdk_type atlanmışsa bu değer kullanılır.
CONSUMER Arayan SDK, Tüketici.
DRIVER Çağıran SDK, Driver'dır.
JAVASCRIPT Çağıran SDK JavaScript'dir.

DeliveryVehicle

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

Not: gRPC ve REST API'leri farklı alan adlandırma kuralları kullanır. Örneğin, gRPC API'sindeki DeliveryVehicle.current_route_segment alanı ile REST API'deki DeliveryVehicle.currentRouteSegment alanı aynı alanı ifade eder.

Alanlar
name

string

Bu yayınlama 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 yol noktasına gitmek için ö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) için doldurulmasında kullanılamayabileceği 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ının konumu kısa süre önce güncellendi ancak current_route_segment eski ve önceki bir araç durağına işaret ediyor.

Bu gibi 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'ün sona erdiği konum. Bu alan şu anda sürücü uygulaması tarafından doldurulmaz ancak UpdateDeliveryVehicle aramalarında bu bilgiyi sağlayabilirsiniz. Yaklaşan araç durağından itibaren LatLng veya current_route_segment'un son LatLng'idir. Daha sonra Fleet Engine, gerçek bir VehicleStop değerine ulaşmak 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. Sürücü uygulaması genellikle bu alanı sağlar ancak Fleet Engine'ın uygulama tarafından gönderilen değeri geçersiz kılacağı bazı durumlar vardır. Daha fazla bilgi için DeliveryVehicle.current_route_segment bölümüne bakın. 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.

Fleet Engine, current_route_segment alanı boşsa UpdateDeliveryVehicleRequest alanındaki bu alanı yoksayar.

remaining_duration

Duration

current_route_segment için kalan sürüş süresi. Sürücü uygulaması genellikle bu alanı sağlar ancak Fleet Engine'ın uygulama tarafından gönderilen değeri geçersiz kılacağı bazı durumlar vardır. Daha fazla bilgi için DeliveryVehicle.current_route_segment bölümüne bakın. Bu alan, Yayın Aracı'na atanan tüm etkin görevler için Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) veya Task.remainingVehicleJourneySegments[0].drivingDuration (REST) olarak döndürülür.

Fleet Engine, current_route_segment alanı boşsa UpdateDeliveryVehicleRequest alanındaki bu alanı yoksayar.

remaining_vehicle_journey_segments[]

VehicleJourneySegment

Araç'ı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 yayın aracı en fazla 100 özelliğe sahip olabilir ve her özelliğin benzersiz bir anahtarı olmalıdır.

type

DeliveryVehicleType

Bu teslimat aracının türü. Ayarlanmazsa varsayılan olarak AUTO olur.

DeliveryVehicleType

Teslimat aracının türü.

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

DeliveryVehicleAttribute

Araç özelliğini anahtar/değer çifti olarak tanımlar. "anahtar:değer" dizesi 256 karakteri aşamaz.

Alanlar
key

string

Özelliğin anahtarı.

value

string

Özelliğin değeri.

Birlik alanı delivery_vehicle_attribute_value. Özelliğin değeri dize, boole veya double türünde olabilir. delivery_vehicle_attribute_value yalnızca aşağıdakilerden biri olabilir:
string_value

string

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

Not: Bu, desteği sonlandı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 alanının kullanılması önemle tavsiye edilir. Hem string_value hem value ayarlanırsa aynı olmalıdırlar. Aksi takdirde hata oluşur. Yanıtlarda her iki alan da doldurulur.

bool_value

bool

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

number_value

double

Çift taşlı özellik değeri.

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 GPS konumu, ek 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 metre cinsinden location doğruluğu.

heading

Int32Value

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

bearing_accuracy
(deprecated)

DoubleValue

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

heading_accuracy

DoubleValue

Derece cinsinden heading doğruluk.

altitude

DoubleValue

WGS84'e göre 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ğruluk.

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 hızı (metre/saniye)

speed_accuracy

DoubleValue

Saniyede metre cinsinden speed doğruluk.

update_time

Timestamp

Sensörün saatine göre location değerinin sensör tarafından bildirildiği zaman.

server_time

Timestamp

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

location_sensor

DeliveryVehicleLocationSensor

Konum verisi sağlayıcısı (ö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 kamerası tarafından işlenmemiş).

raw_location_time

Timestamp

Ham konumla ilişkili 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 yarıçap olarak doğruluğu (metre cinsinden).

supplemental_location

LatLng

Entegre eden uygulama tarafından sağlanan ek konum.

supplemental_location_time

Timestamp

Ek konumla ilişkili 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 yarıçap olarak doğruluğu (metre cinsinden).

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 Destekli GPS, baz istasyonu kimliği veya kablosuz 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. Bu değer genellikle Driver SDK'sı ç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_SUPPLIED_LOCATION olarak işaretlenen konumlar genellikle bir DeliveryVehicle'ın last_location.supplemental_location_sensor aracılığıyla sağlanır.
FLEET_ENGINE_LOCATION Fleet Engine tarafından, kendisine sunulan sinyallere göre hesaplanan bir 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 Belirtilmemiş gezinme durumu.
NO_GUIDANCE Sürücü uygulamasının navigasyonu FREE_NAV modunda.
ENROUTE_TO_DESTINATION Adım adım rota özelliği kullanılabilir durumdadır ve Sürücü uygulaması navigasyonu GUIDED_NAV moduna girmiştir.
OFF_ROUTE Araç, önerilen rotadan ayrıldı.
ARRIVED_AT_DESTINATION Araç, hedefe yaklaşık 50 metre mesafededir.

GetDeliveryVehicleRequest

GetDeliveryVehicle istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API istek 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 istek 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 istek 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. Örnek bir ad providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id olabilir.

ListDeliveryVehiclesRequest

ListDeliveryVehicles istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API istek 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 araç sayısı. Hizmet bu sayıdan daha az sonuç 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.

Sayfalandırma yapılırken ListDeliveryVehicles parametresine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

filter

string

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

ListDeliveryVehicles için desteklenen tek sorguların araç özellikleriyle (ör. attributes.<key> = <value> veya attributes.<key1> = <value1> AND attributes.<key2> = <value2>) ilgili olduğunu unutmayın. Ayrıca tüm özellikler dize olarak depolandığından, özelliklerle ilgili desteklenen tek karşılaştırma dize karşılaştırmasıdır. Sayı veya Boole değerleriyle karşılaştırmak için değerlerin dize olarak değerlendirilmesi amacıyla açıkça tırnak içine alınması gerekir (örneğin, 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ı. Döndürülen araçları, bilinen son konumu görüntü alanı tarafından tanımlanan 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 yayın araçları grubu. Hiçbir filtre belirtilmediğinde istek tüm yayın araçlarını döndürür. Başarılı yanıtlar da boş olabilir. Boş bir yanıt, istenen filtre ölçütlerini karşılayan yayın aracı bulunamadığını gösterir.

next_page_token

string

Sonuçları listelemeyi sürdürmek için bu jetonu ListDeliveryVehiclesRequest parametresinde iletebilirsiniz. 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 toplam yayın aracı sayısı.

ListTasksRequest

ListTasks istek mesajı.

Alanlar
header

DeliveryRequestHeader

İsteğe bağlı. Standart Delivery API istek 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 sonuç 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 bir ListTasks çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bunu sağlayabilirsiniz.

Sayfalandırma yapılırken ListTasks parametresine 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 dizeyle filtreleme yaparsanız tüm Görevler döndürülür. Filtre uygulayabileceğ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 grubu. Filtre belirtilmediğinde istek tüm görevleri döndürür. Başarılı yanıtlar da boş olabilir. Boş bir yanıt, istenen filtre ölçütlerini karşılayan hiçbir Görev bulunamadığını gösterir.

next_page_token

string

Sonuçları listelemeyi sürdürmek için bu jetonu ListTasksRequest parametresinde iletin. Tüm sonuçlar döndürülmüşse bu alan boş bir dizedir veya yanıtta görünmez.

total_size

int64

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

LocationInfo

Ek tanımlayıcıları olan 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önderimle ilişkili birden fazla görev olabilir. Örneğin, teslim alma için bir görev ve teslim etme veya aktarma için bir görev olabilir. Ayrıca, belirli bir gönderim için farklı Görevler farklı araçlar tarafından ele alınabilir. Örneğin, bir araç kargoyu merkeze götürerek teslim alırken başka bir araç aynı kargoyu merkezden teslimat noktasına götürür.

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

Alanlar
name

string

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

type

Type

Zorunlu. Değişmez. 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 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çınabilmeniz için kimliğin depolanmasını kolaylaştırır. UNAVAILABLE ve SCHEDULED_STOP türündeki Görevler için tracking_id 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 Biçimi C'ye göre normalleştirilmiştir.
  • Aşağıdaki ASCII karakterlerinden hiçbirini içeremez: '/', ':', '?', ',' veya '#'.
delivery_vehicle_id

string

Yalnızca çıkış. Bu görevi yürüten aracın kimliği. Yayınlama 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.
  • Aşağıdaki ASCII karakterlerinden 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örev'i 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ış. Yolculuğu paylaşma işlemine özgü alanlar. Durum 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ğı duraklarla ilgili izleme bilgileri. Bu listenin diğer görevlerdeki durak noktalarını 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'ye kadar olan rota bilgilerini içerir. Mevcut rota bilgileri genellikle DeliveryVehicle.current_route_segment dokümanlarında belirtilen bazı durumlar hariç olmak üzere sürücü uygulamasından gelir. Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) veya Task.journeySharingInfo.remainingVehicleJourneySegments (REST) içindeki diğer segmentler Fleet Engine tarafından doldurulur. Kalan VehicleStops arasında rota bilgileri sağlar.

last_location

DeliveryVehicleLocation

Atanan aracın son bildirilen konumunu gösterir.

last_location_snappable

bool

Aracın lastLocation özelliğinin current_route_segment'e bağlanıp bağlanamayacağını belirtir. last_location veya current_route_segment mevcut değilse bu değer False olur. Bu değer Fleet Engine tarafından hesaplanır. İstemcilerden gelen güncellemeler yok sayılır.

Eyalet

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 atanmamış veya teslimat aracı Task'ye atanan araç durağından henüz geçmemiştir.
CLOSED Araç, bu Görev için araç durağından geçtiğinde.

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 ayarlanmadan önceki görev sonucu.
SUCCEEDED Görev başarıyla tamamlandı.
FAILED Görev tamamlanamadı veya iptal edildi.

TaskOutcomeLocationSource

task_outcome_location değerini 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. Araç parkı veya besleyici araç alımları için SCHEDULED_STOP türü kullanılmalıdır.
DELIVERY Teslimat görevi, bir gönderimi son müşteriye ulaştırmak için gerçekleştirilen işlemdir. Araç parkı veya besleyici araç bırakma noktaları için SCHEDULED_STOP türü kullanılmalıdır.
SCHEDULED_STOP Planlanmış bir durdurma görevi, planlama amacıyla kullanılır. Örneğin, aktarma araçları veya depolardan kargo alma veya bırakma işlemlerini temsil edebilir. Son müşteriden teslim alınan veya son müşteriye teslim edilen kargolar için kullanılmamalıdır.
UNAVAILABLE Aracın servise hazır olmadığı anlamına gelen bir görev. Örneğin, sürücü ara verdiğinde veya araca yakıt doldurulduğunda bu durumla karşılaşabilirsiniz.

TaskAttribute

Bir görev özelliğini anahtar/değer çifti olarak tanımlar. "anahtar:değer" dizesi 256 karakteri aşamaz.

Alanlar
key

string

Özelliğin anahtarı. Anahtarlar iki nokta karakteri (:) içeremez.

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

string

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

bool_value

bool

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

number_value

double

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

TaskTrackingInfo

TaskTrackingInfo mesajı. Mesaj, görüntüleme için kullanılacak görev izleme bilgilerini içerir. Bir izleme kimliği birden fazla Görev ile ilişkilendirilmişse Fleet Engine, hangi Görev'in TaskTrackingInfo özelliğinin seçileceğine karar vermek için bir sezgisel 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

Değişmez. Görevin takip kimliği. * Geçerli bir Unicode dizesi olmalıdır. * Maksimum 64 karakterle sınırlıdır. * Unicode Normalleştirme Biçimi 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ğlı olduklarında aracın bu görevin konumuna giden beklenen rotasının bir çok ç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

Değişmez. Görevin tamamlanacağı konum.

target_time_window

TimeWindow

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

attributes[]

TaskAttribute

Görevde ayarlanan özel özellikler.

TaskTrackingViewConfig

Bir Görev'in veri öğesinin son kullanıcılara ne zaman gösterileceğini tanımlayan yapılandırma mesajı.

Alanlar
route_polyline_points_visibility

VisibilityOption

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

estimated_arrival_time_visibility

VisibilityOption

Tahmini varış zamanının ne zaman gösterilebileceğini belirten alan. Bu alan belirtilmezse bu veriler için proje düzeyinde 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üzeyinde 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üzeyinde 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 gösterilebileceğini belirten alan. Bu alan belirtilmezse bu veriler için proje düzeyinde varsayılan görünürlük yapılandırması kullanılır.

vehicle_location_visibility

VisibilityOption

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

VisibilityOption

Bir veri öğesinin son kullanıcılara ne zaman gösterileceğini tanımlayan seçenek mesajı.

Alanlar
Birleştirme alanı visibility_option. Seçilen görünürlük seçeneği. visibility_option yalnızca aşağıdakilerden biri olabilir:
remaining_stop_count_threshold

int32

Bu veri öğesi, kalan durdurma sayısı <= geri kalan_stop_count_threshold) ise son kullanıcılar tarafından görülebilir.

duration_until_estimated_arrival_time_threshold

Duration

Bu veri öğesi, durak için tahmini varış zamanı <= duration_until_estimated_arrival_time_threshold ise 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

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

never

bool

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

TimeWindow

Bir zaman aralığı.

Alanlar
start_time

Timestamp

Zorunlu. Zaman aralığının başlangıç 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 istek başlığı.

delivery_vehicle

DeliveryVehicle

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

update_mask

FieldMask

Zorunlu. Hangi DeliveryVehicle alanlarının güncelleneceğini belirten bir alan maskesi. update_mask parametresinin en az bir alan içermesi gerektiğini unutmayın.

Bu, alanların tam nitelikli 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 istek başlığı.

task

Task

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

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

Not: task_outcome değerini 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 yayın aracından kaldırın. Bu işlem, görev durumunu otomatik olarak KAPALI olarak ayarlar.

update_mask

FieldMask

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

Bu, alanların tam nitelikli 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 mevcut durağa kadar olan seyahat segmentini temsil eder. İlk etkin duraksa, aracın mevcut konumundan bu duraka olan mesafedir.

Alanlar
stop

VehicleStop

Durağın konumunu ve durakla ilişkili Task öğelerini belirtir. Bu yolculuk segmenti JourneySharingInfo kapsamındaysa bazı VehicleStop alanları mevcut olmayabilir.

driving_distance_meters

Int32Value

Yalnızca çıkış. Önceki duraktan bu durağa olan seyahat mesafesi. Mevcut durak, yolculuk segmentleri listesindeki ilk duraksa başlangıç noktası, bu durak listeye eklendiğinde kaydedilen aracın konumudur. Bu yolculuk segmenti JourneySharingInfo'ün bir parçasıysa 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 durak listeye eklendiğinde kaydedilen aracın konumudur.

Bu alan Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) veya Task.remainingVehicleJourneySegments[0].drivingDuration (REST) yolunda tanımlanırsa DeliveryVehicle.remaining_duration (gRPC) veya DeliveryVehicle.remainingDuration (REST) alanındaki 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 durağa giden yol. Mevcut durak, yolculuk segmentleri listesindeki ilk duraksa bu, durak listeye eklendiğinde aracın mevcut konumundan bu duraka giden yoldur. Bu yolculuk segmenti JourneySharingInfo'ün bir parçasıysa 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ımlanırsa DeliveryVehicle.current_route_segment (gRPC) veya DeliveryVehicle.currentRouteSegment (REST) kaynaklı LatLng'lerin kodu çözülerek doldurulabilir. Bu, önceki duraktan gelen yol yerine sürücü uygulamasının bilinen son konumundan gelen sürüş yolunu sağlar.

VehicleStop

Bir aracın bir veya daha fazla Task gerçekleştirmek için durduğu noktayı tanımlar.

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 yapılacak Task'lerin 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'ün mevcut durumu.

Sıralamalar
STATE_UNSPECIFIED Bilinmiyor.
NEW Oluşturuldu ancak etkin bir şekilde yönlendirmiyor.
ENROUTE Atanan ve etkin olarak yönlendiriliyor.
ARRIVED Durağa varıldı. Araç bir sonraki durağa giderken önceki tüm durakların tamamlanmış olduğu 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.
  • Aşağıdaki ASCII karakterlerinden 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 isteğine verilen yanıtta ayarlanır.