Package maps.fleetengine.delivery.v1

Indeks

DeliveryService

Layanan Pengiriman Kilometer Terakhir.

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

Membuat dan menampilkan batch objek Task baru.
CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

Membuat dan menampilkan DeliveryVehicle baru.
CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

Membuat dan menampilkan objek Task baru.
GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

Menampilkan instance DeliveryVehicle yang ditentukan.
GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Mendapatkan informasi tentang Task.
GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

Menampilkan instance TaskTrackingInfo yang ditentukan.
ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

Mendapatkan semua DeliveryVehicle yang memenuhi kriteria pemfilteran yang ditentukan.
ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

Mendapatkan semua Task yang memenuhi kriteria pemfilteran yang ditentukan.
UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

Menulis data DeliveryVehicle yang diperbarui ke Fleet Engine, dan menetapkan Tasks ke DeliveryVehicle. Anda tidak dapat memperbarui nama DeliveryVehicle. Anda dapat mengupdate remaining_vehicle_journey_segments, tetapi harus berisi semua VehicleJourneySegment agar dipertahankan di DeliveryVehicle. task_id diambil dari remaining_vehicle_journey_segments, dan Tasks yang sesuai ditetapkan ke DeliveryVehicle jika belum ditetapkan.
UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

Memperbarui data Task.

BatchCreateTasksRequest

Pesan permintaan BatchCreateTask.

Kolom
header

DeliveryRequestHeader

Opsional. Header permintaan Delivery API standar. Catatan: Jika Anda menetapkan bidang ini, maka bidang header dalam pesan CreateTaskRequest harus kosong, atau harus cocok dengan bidang ini.
parent

string

Wajib. Resource induk yang digunakan bersama oleh semua tugas. Nilai ini harus dalam format providers/{provider}. provider harus berupa ID Project Google Cloud. Misalnya, sample-cloud-project. Kolom induk dalam pesan CreateTaskRequest harus kosong, atau harus cocok dengan kolom ini.
requests[]

CreateTaskRequest

Wajib. Pesan permintaan yang menentukan resource yang akan dibuat. Catatan: Anda dapat membuat maksimum 500 tugas dalam satu batch.

BatchCreateTasksResponse

Pesan respons BatchCreateTask.

Kolom
tasks[]

Task

Tugas yang dibuat.

CreateDeliveryVehicleRequest

Pesan permintaan CreateDeliveryVehicle.

Kolom
header

DeliveryRequestHeader

Opsional. Header permintaan Delivery API standar.
parent

string

Wajib. Harus dalam format providers/{provider}. Penyedia harus berupa Project ID Google Cloud. Misalnya, sample-cloud-project.
delivery_vehicle_id

string

Wajib. ID Kendaraan Pengiriman harus unik dan tunduk kepada batasan berikut:

  • Harus berupa string Unicode yang valid.
  • Dibatasi hingga panjang maksimum 64 karakter.
  • Dinormalkan menurut Formulir Normalisasi Unicode C.
  • Tidak boleh berisi karakter ASCII berikut: '/', ':', '?', ',', atau '#'.
delivery_vehicle

DeliveryVehicle

Wajib. Entity DeliveryVehicle yang akan dibuat. Saat membuat kendaraan pengiriman baru, Anda dapat menetapkan kolom opsional berikut:

  • jenis
  • last_location
  • attribut

Catatan: Kolom name DeliveryKendaraan diabaikan. Semua kolom DeliveryKendaraan lainnya tidak boleh ditetapkan; jika tidak, pesan {i>error<i} akan muncul.

CreateTaskRequest

Pesan permintaan CreateTask.

Kolom
header

DeliveryRequestHeader

Opsional. Header permintaan Delivery API standar.
parent

string

Wajib. Harus dalam format providers/{provider}. provider harus berupa ID Project Google Cloud. Misalnya, sample-cloud-project.
task_id

string

Wajib. ID Tugas harus unik, tetapi tidak boleh berupa ID pelacakan pengiriman. Untuk menyimpan ID pelacakan pengiriman, gunakan kolom tracking_id. Perhatikan bahwa beberapa tugas dapat memiliki tracking_id yang sama. ID tugas tunduk pada batasan berikut:

  • Harus berupa string Unicode yang valid.
  • Dibatasi hingga panjang maksimum 64 karakter.
  • Dinormalkan menurut Formulir Normalisasi Unicode C.
  • Tidak boleh berisi karakter ASCII berikut: '/', ':', '?', ',', atau '#'.
task

Task

Wajib. Entitas Tugas yang akan dibuat. Saat membuat Tugas, kolom berikut wajib diisi:

  • type
  • state (harus ditetapkan ke OPEN)
  • tracking_id (tidak boleh ditetapkan untuk tugas UNAVAILABLE atau SCHEDULED_STOP, tetapi diperlukan untuk semua jenis tugas lainnya)
  • planned_location (opsional untuk UNAVAILABLE tugas)
  • task_duration

Catatan: Kolom name Tugas diabaikan. Semua kolom Tugas lainnya tidak boleh ditetapkan; jika tidak, pesan {i>error<i} akan muncul.

DeliveryRequestHeader

RequestHeader berisi kolom yang umum untuk semua permintaan RPC Penayangan.

Kolom
language_code

string

Kode bahasa BCP-47, seperti en-US atau sr-Latn. Untuk informasi selengkapnya, lihat http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Jika tidak ada yang ditentukan, respons dapat dalam bahasa apa pun, dengan preferensi bahasa Inggris jika nama tersebut ada. Contoh nilai kolom: en-US.
region_code

string

Wajib. Kode wilayah CLDR wilayah tempat asal permintaan. Contoh nilai kolom: US.
sdk_version

string

Versi SDK panggilan, jika berlaku. Format versinya adalah "major.minor.patch", contoh: 1.1.2.
os_version

string

Versi sistem operasi tempat SDK panggilan berjalan. Contoh nilai kolom: 4.4.1, 12.1.
device_model

string

Model perangkat tempat SDK panggilan berjalan. Contoh nilai kolom: iPhone12,1, SM-G920F.
sdk_type

SdkType

Jenis SDK yang mengirim permintaan.
maps_sdk_version

string

Versi MapSDK yang menjadi dependensi SDK panggilan, jika berlaku. Format versinya adalah "major.minor.patch", contoh: 5.2.1.
nav_sdk_version

string

Versi NavSDK yang diandalkan SDK panggilan, jika berlaku. Format versinya adalah "major.minor.patch", contoh: 2.1.0.
platform

Platform

Platform SDK panggilan.
manufacturer

string

Produsen perangkat Android dari SDK panggilan, hanya berlaku untuk Android SDK. Contoh nilai kolom: Samsung.
android_api_level

int32

Level API Android dari SDK panggilan, hanya berlaku untuk Android SDK. Contoh nilai kolom: 23.
trace_id

string

ID opsional yang dapat diberikan untuk tujuan logging guna mengidentifikasi permintaan.

Platform

Platform SDK panggilan.

Enum
PLATFORM_UNSPECIFIED Nilai default. Nilai ini digunakan jika platform dihilangkan.
ANDROID Permintaan berasal dari Android.
IOS Permintaan berasal dari iOS.
WEB Permintaan berasal dari web.

SdkType

Kemungkinan jenis SDK.

Enum
SDK_TYPE_UNSPECIFIED Nilai default. Nilai ini digunakan jika sdk_type dihilangkan.
CONSUMER SDK panggilan adalah Konsumen.
DRIVER SDK panggilan adalah Driver.
JAVASCRIPT SDK panggilan adalah JavaScript.

DeliveryVehicle

Pesan DeliveryVehicle. Kendaraan pengiriman mengangkut kiriman dari depot ke lokasi pengiriman, dan dari lokasi pengambilan ke depot. Dalam beberapa kasus, kendaraan pengiriman juga mengangkut kiriman langsung dari lokasi pengambilan ke lokasi pengiriman.

Catatan: gRPC dan REST API menggunakan konvensi penamaan kolom yang berbeda. Misalnya, kolom DeliveryVehicle.current_route_segment di gRPC API dan kolom DeliveryVehicle.currentRouteSegment di REST API merujuk ke kolom yang sama.

Kolom
name

string

Nama unik Kendaraan Pengiriman ini. Formatnya adalah providers/{provider}/deliveryVehicles/{vehicle}.
last_location

DeliveryVehicleLocation

Lokasi Kendaraan Pengiriman yang terakhir dilaporkan.
navigation_status

DeliveryVehicleNavigationStatus

Status navigasi Kendaraan Pengiriman.
current_route_segment

bytes

Polyline yang dienkode yang menetapkan rute yang direkomendasikan navigasi ke titik jalan berikutnya. Aplikasi pengemudi Anda akan mengupdate ini saat perhentian dicapai atau dilewati, dan saat navigasi diubah rute. LatLng ini ditampilkan di Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) atau Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) untuk semua Tugas aktif yang ditetapkan ke Kendaraan.

Ada beberapa kasus ketika kolom ini mungkin tidak digunakan untuk mengisi Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) atau Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST):

  • Endpoint current_route_segment tidak cocok dengan DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) atau DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST).

  • Aplikasi pengemudi belum mengupdate lokasinya baru-baru ini, sehingga nilai terakhir yang diupdate untuk kolom ini mungkin sudah tidak berlaku.

  • Aplikasi pengemudi baru-baru ini memperbarui lokasinya, tetapi current_route_segment sudah tidak berlaku, dan mengarah ke perhentian kendaraan sebelumnya.

Dalam kasus ini, Fleet Engine mengisi kolom ini dengan rute dari VehicleStop yang terakhir diteruskan ke VehicleStop mendatang untuk memastikan konsumen kolom ini memiliki informasi terbaik yang tersedia di jalur Kendaraan Pengiriman saat ini.
current_route_segment_end_point

LatLng

Lokasi tempat current_route_segment berakhir. Kolom ini saat ini tidak diisi oleh aplikasi driver, tetapi Anda dapat menyediakannya pada panggilan UpdateDeliveryVehicle. LatLng dari perhentian kendaraan yang akan datang, atau LatLng terakhir dari current_route_segment. Fleet Engine kemudian akan melakukan yang terbaik untuk berinterpolasi ke VehicleStop yang sebenarnya.

Kolom ini diabaikan dalam panggilan UpdateDeliveryVehicle jika kolom current_route_segment kosong.
remaining_distance_meters

Int32Value

Jarak mengemudi yang tersisa untuk current_route_segment. Aplikasi Driver biasanya menyediakan kolom ini, tetapi ada beberapa situasi saat Fleet Engine akan mengganti nilai yang dikirim oleh aplikasi. Untuk informasi selengkapnya, lihat DeliveryVehicle.current_route_segment. Kolom ini ditampilkan di Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) atau Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) untuk semua Task aktif yang ditetapkan ke Kendaraan Pengiriman.

Fleet Engine mengabaikan kolom ini di UpdateDeliveryVehicleRequest jika kolom current_route_segment kosong.
remaining_duration

Duration

Sisa waktu mengemudi untuk current_route_segment. Aplikasi Driver biasanya menyediakan kolom ini, tetapi ada beberapa situasi saat Fleet Engine akan mengganti nilai yang dikirim oleh aplikasi. Untuk informasi selengkapnya, lihat DeliveryVehicle.current_route_segment. Kolom ini ditampilkan di Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) atau Task.remainingVehicleJourneySegments[0].drivingDuration (REST) untuk semua tugas aktif yang ditetapkan ke Kendaraan Pengiriman.

Fleet Engine mengabaikan kolom ini di UpdateDeliveryVehicleRequest jika kolom current_route_segment kosong.
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Segmen perjalanan yang ditetapkan ke Kendaraan Pengiriman ini, mulai dari lokasi Kendaraan yang terakhir dilaporkan. Kolom ini tidak akan diisi dalam respons ListDeliveryVehicles.
attributes[]

DeliveryVehicleAttribute

Daftar atribut Kendaraan Pengiriman kustom. Kendaraan Pengiriman dapat memiliki maksimal 100 atribut, dan setiap atribut harus memiliki kunci yang unik.
type

DeliveryVehicleType

Jenis kendaraan pengiriman ini. Jika tidak disetel, nilai defaultnya adalah AUTO.

DeliveryVehicleType

Jenis kendaraan pengiriman.

Enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED Nilai tidak digunakan.
AUTO Mobil.
TWO_WHEELER Sepeda motor, moped, atau kendaraan roda dua lainnya
BICYCLE Transportasi yang ditenagai oleh manusia.
PEDESTRIAN Pengangkut manusia, biasanya berjalan atau berlari, yang berjalan di sepanjang jalur pejalan kaki.

DeliveryVehicleAttribute

Menjelaskan atribut kendaraan sebagai pasangan nilai kunci. "key:value" panjang string tidak boleh lebih dari 256 karakter.

Kolom
key

string

Kunci atribut.
value

string

Nilai atribut.
Kolom union delivery_vehicle_attribute_value. Nilai atribut, dapat berupa string, bool, atau tipe ganda. delivery_vehicle_attribute_value hanya dapat berupa salah satu dari berikut:
string_value

string

Nilai atribut berjenis string.

Catatan: Ini sama dengan kolom value yang pada akhirnya tidak akan digunakan lagi. Untuk metode pembuatan atau update, kedua kolom dapat digunakan, tetapi sangat direkomendasikan untuk menggunakan string_value. Jika string_value dan value ditetapkan, keduanya harus identik atau error akan ditampilkan. Kedua kolom diisi dalam respons.
bool_value

bool

Nilai atribut yang diketik Boolean.
number_value

double

Nilai atribut dengan jenis ganda.

DeliveryVehicleLocation

Lokasi, kecepatan, dan arah kendaraan pada satu waktu.

Kolom
location

LatLng

Lokasi kendaraan. Ketika dikirim ke Fleet Engine, lokasi kendaraan adalah lokasi GPS. Saat Anda menerimanya sebagai respons, lokasi kendaraan dapat berupa lokasi GPS, lokasi tambahan, atau perkiraan lokasi lainnya. Sumber ditentukan di location_sensor.
horizontal_accuracy
(deprecated)

DoubleValue

Tidak digunakan lagi: Sebagai gantinya, gunakan latlng_accuracy.
latlng_accuracy

DoubleValue

Akurasi location dalam meter sebagai radius.
heading

Int32Value

Arah kendaraan bergerak dalam derajat. 0 mewakili Utara. Rentang yang valid adalah [0,360).
bearing_accuracy
(deprecated)

DoubleValue

Tidak digunakan lagi: Sebagai gantinya, gunakan heading_accuracy.
heading_accuracy

DoubleValue

Akurasi heading dalam derajat.
altitude

DoubleValue

Ketinggian dalam meter di atas WGS84.
vertical_accuracy
(deprecated)

DoubleValue

Tidak digunakan lagi: Sebagai gantinya, gunakan altitude_accuracy.
altitude_accuracy

DoubleValue

Akurasi altitude dalam meter.
speed_kmph
(deprecated)

Int32Value

Kecepatan kendaraan dalam kilometer per jam. Tidak digunakan lagi: Sebagai gantinya, gunakan speed.
speed

DoubleValue

Kecepatan kendaraan dalam meter/detik
speed_accuracy

DoubleValue

Akurasi speed dalam meter/detik.
update_time

Timestamp

Waktu saat location dilaporkan oleh sensor menurut jam sensor.
server_time

Timestamp

Hanya output. Waktu saat server menerima informasi lokasi.
location_sensor

DeliveryVehicleLocationSensor

Penyedia data lokasi (misalnya, GPS).
is_road_snapped

BoolValue

Apakah location dipaskan ke jalan.
is_gps_sensor_enabled

BoolValue

Input saja. Menunjukkan apakah sensor GPS diaktifkan pada perangkat seluler.
time_since_update

Int32Value

Input saja. Waktu (dalam detik) sejak lokasi ini pertama kali dikirim ke server. Nilainya akan nol untuk update pertama. Jika waktu tidak diketahui (misalnya, saat aplikasi dimulai ulang), nilai ini akan direset ke nol.
num_stale_updates
(deprecated)

Int32Value

Input saja. Tidak digunakan lagi: Sinyal lain kini digunakan untuk menentukan apakah suatu lokasi sudah usang.
raw_location

LatLng

Lokasi kendaraan mentah (tidak diproses oleh pemukul jalan).
raw_location_time

Timestamp

Stempel waktu yang terkait dengan lokasi mentah.
raw_location_sensor

DeliveryVehicleLocationSensor

Sumber lokasi mentah. Default-nya adalah GPS.
raw_location_accuracy

DoubleValue

Akurasi raw_location sebagai radius, dalam meter.
supplemental_location

LatLng

Lokasi tambahan yang disediakan oleh aplikasi yang mengintegrasikan.
supplemental_location_time

Timestamp

Stempel waktu yang terkait dengan lokasi tambahan.
supplemental_location_sensor

DeliveryVehicleLocationSensor

Sumber lokasi tambahan. Default-nya adalah CUSTOMER_SUPPLIED_LOCATION.
supplemental_location_accuracy

DoubleValue

Akurasi supplemental_location sebagai radius, dalam meter.
road_snapped
(deprecated)

bool

Tidak digunakan lagi: Sebagai gantinya, gunakan is_road_snapped.

DeliveryVehicleLocationSensor

Sensor atau metodologi yang digunakan untuk menentukan lokasi.

Enum
UNKNOWN_SENSOR Sensor tidak ditentukan atau tidak diketahui.
GPS GPS atau GPS Berbantuan.
NETWORK GPS berbantuan, ID menara BTS, atau titik akses Wi-Fi.
PASSIVE ID menara BTS atau titik akses Wi-Fi.
ROAD_SNAPPED_LOCATION_PROVIDER Lokasi yang ditentukan oleh perangkat seluler sebagai posisi jalan yang paling mungkin.
CUSTOMER_SUPPLIED_LOCATION Lokasi yang disediakan pelanggan dari sumber independen. Biasanya, nilai ini digunakan untuk lokasi yang disediakan dari sumber selain perangkat seluler yang menjalankan Driver SDK. Jika sumber asli dijelaskan oleh salah satu nilai enum lainnya, gunakan nilai tersebut. Lokasi bertanda CUSTOMER_SUPPLIED_LOCATION biasanya disediakan melalui last_location.supplemental_location_sensor DeliveryKendaraan.
FLEET_ENGINE_LOCATION Lokasi yang dihitung oleh Fleet Engine berdasarkan sinyal yang tersedia. Hanya output. Nilai ini akan ditolak jika diterima dalam permintaan.
FUSED_LOCATION_PROVIDER Penyedia Lokasi Gabungan Android.
CORE_LOCATION Penyedia lokasi di sistem operasi Apple.

DeliveryVehicleNavigationStatus

Status navigasi kendaraan.

Enum
UNKNOWN_NAVIGATION_STATUS Status navigasi tidak ditentukan.
NO_GUIDANCE Navigasi aplikasi Driver berada dalam mode FREE_NAV.
ENROUTE_TO_DESTINATION Navigasi belokan demi belokan tersedia dan navigasi aplikasi Pengemudi telah memasuki mode GUIDED_NAV.
OFF_ROUTE Kendaraan keluar dari rute yang disarankan.
ARRIVED_AT_DESTINATION Kendaraan berada dalam jarak sekitar 50 m dari tujuan.

GetDeliveryVehicleRequest

Pesan permintaan GetDeliveryVehicle.

Kolom
header

DeliveryRequestHeader

Opsional. Header permintaan Delivery API standar.
name

string

Wajib. Harus dalam format providers/{provider}/deliveryVehicles/{delivery_vehicle}. provider harus berupa ID Project Google Cloud. Misalnya, sample-cloud-project.

GetTaskRequest

Pesan permintaan GetTask.

Kolom
header

DeliveryRequestHeader

Opsional. Header permintaan Delivery API standar.
name

string

Wajib. Harus dalam format providers/{provider}/tasks/{task}. provider harus berupa ID Project Google Cloud. Misalnya, sample-cloud-project.

GetTaskTrackingInfoRequest

Pesan permintaan GetTaskTrackingInfoRequest.

Kolom
header

DeliveryRequestHeader

Opsional. Header permintaan Delivery API standar.
name

string

Wajib. Harus dalam format providers/{provider}/taskTrackingInfo/{tracking_id}. provider harus berupa ID Project Google Cloud, dan tracking_id harus merupakan ID pelacakan yang terkait dengan tugas tersebut. Contoh nama dapat berupa providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id.

ListDeliveryVehiclesRequest

Pesan permintaan ListDeliveryVehicles.

Kolom
header

DeliveryRequestHeader

Opsional. Header permintaan Delivery API standar.
parent

string

Wajib. Harus dalam format providers/{provider}. provider harus berupa ID Project Google Cloud. Misalnya, sample-cloud-project.
page_size

int32

Opsional. Jumlah maksimum kendaraan yang akan dikembalikan. Layanan mungkin menampilkan lebih sedikit dari jumlah ini. Jika Anda tidak menentukan angka ini, server akan menentukan jumlah hasil yang akan ditampilkan.
page_token

string

Opsional. Token halaman, yang diterima dari panggilan ListDeliveryVehicles sebelumnya. Anda harus menyediakannya untuk mengambil halaman selanjutnya.

Saat memberi nomor halaman, semua parameter lain yang diberikan ke ListDeliveryVehicles harus cocok dengan panggilan yang menyediakan token halaman.
filter

string

Opsional. Kueri filter yang akan diterapkan saat mencantumkan kendaraan pengiriman. Lihat http://aip.dev/160 untuk mengetahui contoh sintaksis filter. Jika Anda tidak menentukan nilai, atau jika Anda menentukan string kosong untuk filter, semua kendaraan pengiriman akan ditampilkan.

Perhatikan bahwa satu-satunya kueri yang didukung untuk ListDeliveryVehicles adalah di atribut kendaraan (misalnya, attributes.<key> = <value> atau attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Selain itu, semua atribut disimpan sebagai string, sehingga satu-satunya perbandingan yang didukung terhadap atribut adalah perbandingan string. Untuk membandingkan dengan nilai angka atau boolean, nilai harus dikutip secara eksplisit agar diperlakukan sebagai string (misalnya, attributes.<key> = "10" atau attributes.<key> = "true").

Jumlah batasan maksimum yang diizinkan dalam kueri filter adalah 50. Pembatasan adalah bagian dari kueri bentuk attribute.<KEY> <COMPARATOR> <VALUE>, misalnya attributes.foo = bar adalah 1 pembatasan.
viewport

Viewport

Opsional. Filter yang membatasi pengembalian kendaraan ke mobil yang lokasi terakhirnya diketahui berada di area persegi panjang yang ditentukan oleh area pandang.

ListDeliveryVehiclesResponse

Pesan respons ListDeliveryVehicles.

Kolom
delivery_vehicles[]

DeliveryVehicle

Kumpulan kendaraan pengiriman yang memenuhi kriteria pemfilteran yang diminta. Jika tidak ada filter yang ditentukan, permintaan akan menampilkan semua kendaraan pengiriman. Respons berhasil juga boleh kosong. Respons kosong menunjukkan bahwa tidak ditemukan kendaraan pengiriman yang memenuhi kriteria filter yang diminta.
next_page_token

string

Anda dapat meneruskan token ini di ListDeliveryVehiclesRequest untuk terus mencantumkan hasil. Jika semua hasil ditampilkan, kolom ini tidak akan ada dalam respons, atau akan berupa string kosong.
total_size

int64

Total jumlah kendaraan pengiriman yang cocok dengan kriteria permintaan, di semua halaman.

ListTasksRequest

Pesan permintaan ListTasks.

Kolom
header

DeliveryRequestHeader

Opsional. Header permintaan Delivery API standar.
parent

string

Wajib. Harus dalam format providers/{provider}. provider harus berupa ID Project Google Cloud. Misalnya, sample-cloud-project.
page_size

int32

Opsional. Jumlah maksimum Tasks yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika Anda tidak menentukan nilai ini, server akan menentukan jumlah hasil yang akan ditampilkan.
page_token

string

Opsional. Token halaman yang diterima dari panggilan ListTasks sebelumnya. Anda dapat menyediakannya untuk mengambil halaman berikutnya.

Saat memberi nomor halaman, semua parameter lain yang diberikan ke ListTasks harus cocok dengan panggilan yang menyediakan token halaman.
filter

string

Opsional. Kueri filter yang akan diterapkan saat mencantumkan Tasks. Lihat http://aip.dev/160 untuk mengetahui contoh sintaksis filter. Jika Anda tidak menentukan nilai, atau jika Anda memfilter string kosong, semua Tasks akan ditampilkan. Untuk informasi tentang properti Tugas yang dapat Anda filter, lihat Membuat daftar tugas.

ListTasksResponse

Respons ListTasks yang berisi kumpulan Tasks yang memenuhi kriteria filter di ListTasksRequest.

Kolom
tasks[]

Task

Kumpulan Tugas yang memenuhi kriteria pemfilteran yang diminta. Jika tidak ada filter yang ditentukan, permintaan akan menampilkan semua tugas. Respons berhasil juga boleh kosong. Respons kosong menunjukkan bahwa tidak ada Tasks yang ditemukan yang memenuhi kriteria filter yang diminta.
next_page_token

string

Teruskan token ini di ListTasksRequest untuk terus mencantumkan hasil. Jika semua hasil telah ditampilkan, berarti kolom ini berupa string kosong atau tidak muncul dalam respons.
total_size

int64

Jumlah total Tasks yang cocok dengan kriteria permintaan, di semua halaman.

LocationInfo

Lokasi dengan ID tambahan.

Kolom
point

LatLng

Koordinat lokasi.

Tugas

Tugas di Delivery API mewakili satu tindakan yang akan dilacak. Secara umum, ada perbedaan antara Tasks yang terkait dengan pengiriman dan memecah Tasks. Sebuah pengiriman dapat memiliki beberapa Tugas yang terkait dengannya. Misalnya, mungkin ada satu Tugas untuk penjemputan, dan satu untuk pengantaran atau transfer. Selain itu, Tugas yang berbeda untuk pengiriman tertentu dapat ditangani oleh kendaraan yang berbeda. Misalnya, satu kendaraan dapat menangani pengambilan, mendorong pengiriman ke pusat pengiriman, sementara kendaraan lain mendorong pengiriman yang sama dari hub ke lokasi pengantaran.

Catatan: gRPC dan REST API menggunakan konvensi penamaan kolom yang berbeda. Misalnya, kolom Task.journey_sharing_info di gRPC API dan kolom Task.journeySharingInfo di REST API merujuk ke kolom yang sama.

Kolom
name

string

Harus dalam format providers/{provider}/tasks/{task}.
type

Type

Wajib. Tidak dapat diubah. Mendefinisikan jenis Tugas. Misalnya, kerusakan atau pengiriman.
state

State

Wajib. Status eksekusi Tugas saat ini.
task_outcome

TaskOutcome

Hasil dari Tugas.
task_outcome_time

Timestamp

Stempel waktu yang menunjukkan waktu hasil Task ditetapkan oleh penyedia.
task_outcome_location

LocationInfo

Lokasi tempat hasil Task ditetapkan. Nilai ini diperbarui sebagai bagian dari UpdateTask. Jika nilai ini tidak diperbarui secara eksplisit oleh penyedia, Fleet Engine akan mengisinya secara default dengan lokasi kendaraan terakhir yang diketahui (lokasi raw).
task_outcome_location_source

TaskOutcomeLocationSource

Menunjukkan asal nilai task_outcome_location.
tracking_id

string

Tidak dapat diubah. Kolom ini memfasilitasi penyimpanan ID sehingga Anda dapat menghindari penggunaan pemetaan yang rumit. Anda tidak dapat menetapkan tracking_id untuk Tasks dengan jenis UNAVAILABLE dan SCHEDULED_STOP. ID ini tunduk kepada batasan berikut:

  • Harus berupa string Unicode yang valid.
  • Dibatasi hingga panjang maksimum 64 karakter.
  • Dinormalkan menurut Formulir Normalisasi Unicode C.
  • Tidak boleh berisi karakter ASCII berikut: '/', ':', '?', ',', atau '#'.
delivery_vehicle_id

string

Hanya output. ID kendaraan yang menjalankan Tugas ini. ID Kendaraan Pengiriman tunduk pada batasan berikut:

  • Harus berupa string Unicode yang valid.
  • Dibatasi hingga panjang maksimum 64 karakter.
  • Dinormalkan menurut Formulir Normalisasi Unicode C.
  • Tidak boleh berisi karakter ASCII berikut: '/', ':', '?', ',', atau '#'.
planned_location

LocationInfo

Tidak dapat diubah. Lokasi tempat Tugas akan diselesaikan. Opsional untuk UNAVAILABLE Tasks, tetapi diperlukan untuk semua Tasks lainnya.
task_duration

Duration

Wajib. Tidak dapat diubah. Waktu yang diperlukan untuk menjalankan Tugas di lokasi ini.
target_time_window

TimeWindow

Periode waktu saat tugas harus diselesaikan.
journey_sharing_info

JourneySharingInfo

Hanya output. Kolom khusus berbagi perjalanan. Tidak diisi saat status adalah CLOSED.
task_tracking_view_config

TaskTrackingViewConfig

Konfigurasi untuk pelacakan tugas yang menentukan elemen data mana yang terlihat oleh pengguna akhir dalam keadaan apa.
attributes[]

TaskAttribute

Daftar atribut Tugas kustom. Setiap atribut harus memiliki kunci unik.

JourneySharingInfo

Membagikan kolom tertentu dalam perjalanan.

Kolom
remaining_vehicle_journey_segments[]

VehicleJourneySegment

Informasi pelacakan untuk perhentian yang akan dibuat oleh kendaraan yang ditetapkan sebelum menyelesaikan Tugas ini. Perhatikan bahwa daftar ini dapat berisi perhentian dari tugas lain.

Segmen pertama, Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) atau Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST), berisi informasi rute dari lokasi terakhir pengemudi yang diketahui ke VehicleStop mendatang. Informasi rute saat ini biasanya berasal dari aplikasi pengemudi, kecuali untuk beberapa kasus yang tercantum dalam dokumentasi untuk DeliveryVehicle.current_route_segment. Segmen lain di Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) atau Task.journeySharingInfo.remainingVehicleJourneySegments (REST) diisi oleh Fleet Engine. Properti tersebut memberikan informasi rute di antara VehicleStops yang tersisa.
last_location

DeliveryVehicleLocation

Menunjukkan lokasi terakhir kendaraan yang dilaporkan untuk kendaraan yang ditetapkan.
last_location_snappable

bool

Menunjukkan apakah lastLocation kendaraan dapat dipaskan ke current_route_segment. Nilai ini Salah jika last_location atau current_route_segment tidak ada. Nilai ini dihitung oleh Fleet Engine. Pembaruan dari klien akan diabaikan.

Negara Bagian

Status Tugas. Ini menunjukkan progres Tasks.

Enum
STATE_UNSPECIFIED Default. Digunakan untuk status Tugas yang tidak ditentukan atau tidak dikenal.
OPEN Tugas ini belum ditetapkan ke kendaraan pengiriman, atau kendaraan pengiriman belum melewati perhentian kendaraan yang ditetapkan Task.
CLOSED Saat kendaraan melewati perhentian kendaraan untuk Tugas ini.

TaskOutcome

Hasil dari upaya menjalankan Tugas. Jika TaskState ditutup, TaskOutcome akan menunjukkan apakah proses berhasil diselesaikan.

Enum
TASK_OUTCOME_UNSPECIFIED Hasil Tugas sebelum nilainya ditetapkan.
SUCCEEDED Tugas berhasil diselesaikan.
FAILED Tugas tidak dapat diselesaikan atau dibatalkan.

TaskOutcomeLocationSource

Identitas sumber yang mengisi task_outcome_location.

Enum
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED Hasil tugas sebelum ditetapkan.
PROVIDER Penyedia menentukan task_outcome_location.
LAST_VEHICLE_LOCATION Penyedia tidak menentukan task_outcome_location, jadi Fleet Engine menggunakan lokasi kendaraan terakhir yang diketahui.

Jenis

Jenis Task.

Enum
TYPE_UNSPECIFIED Default, Jenis tugas tidak diketahui.
PICKUP Tugas pengambilan adalah tindakan yang diambil untuk mengambil kiriman dari pelanggan. Pengambilan kendaraan pengangkutan atau depot harus menggunakan jenis SCHEDULED_STOP.
DELIVERY Tugas pengiriman adalah tindakan yang diambil untuk mengirimkan kiriman ke pelanggan akhir. Penerimaan dari kendaraan pengangkut atau depot harus menggunakan jenis SCHEDULED_STOP.
SCHEDULED_STOP Tugas perhentian terjadwal digunakan untuk tujuan perencanaan. Contohnya, data dapat mewakili mengambil atau menurunkan barang kiriman dari kendaraan pengumpan atau depot. Metode ini tidak boleh digunakan untuk pengiriman yang diambil atau diantarkan dari pelanggan akhir.
UNAVAILABLE Tugas yang berarti Kendaraan tidak dapat diservis. Misalnya, hal ini dapat terjadi saat pengemudi beristirahat, atau saat kendaraan sedang mengisi bahan bakar.

TaskAttribute

Menjelaskan atribut tugas sebagai pasangan nilai kunci. "key:value" panjang string tidak boleh lebih dari 256 karakter.

Kolom
key

string

Kunci atribut. Kunci tidak boleh berisi karakter titik dua (:).
Kolom union task_attribute_value. Nilai atribut, dapat berupa string, bool, atau tipe ganda. Jika tidak ada yang ditetapkan, TaskAttribute string_value akan disimpan sebagai string kosong "". task_attribute_value hanya dapat berupa salah satu dari yang berikut:
string_value

string

Nilai atribut berjenis string.
bool_value

bool

Nilai atribut yang diketik Boolean.
number_value

double

Nilai atribut dengan jenis ganda.

TaskTrackingInfo

Pesan TaskTrackingInfo. Pesan ini berisi informasi pelacakan tugas yang akan digunakan untuk tampilan. Jika ID pelacakan dikaitkan dengan beberapa Tasks, Fleet Engine menggunakan heuristik untuk memutuskan TaskTrackingInfo Task mana yang akan dipilih.

Kolom
name

string

Harus dalam format providers/{provider}/taskTrackingInfo/{tracking}, dengan tracking mewakili ID pelacakan.
tracking_id

string

Tidak dapat diubah. ID pelacakan Task. * Harus berupa string Unicode yang valid. * Dibatasi hingga panjang maksimum 64 karakter. * Dinormalkan menurut Formulir Normalisasi Unicode C. * Tidak boleh berisi karakter ASCII berikut: '/', ':', '?', ',', atau '#'.
vehicle_location

DeliveryVehicleLocation

Lokasi terakhir kendaraan.
route_polyline_points[]

LatLng

Daftar titik yang ketika terhubung membentuk polyline rute kendaraan yang diharapkan ke lokasi tugas ini.
remaining_stop_count

Int32Value

Menunjukkan jumlah perhentian yang tersisa untuk kendaraan hingga perhentian tugas tercapai, termasuk perhentian tugas. Misalnya, jika perhentian berikutnya untuk kendaraan adalah perhentian tugas, nilainya adalah 1.
remaining_driving_distance_meters

Int32Value

Total jarak yang tersisa dalam meter ke VehicleStop yang diinginkan.
estimated_arrival_time

Timestamp

Stempel waktu yang menunjukkan perkiraan waktu kedatangan ke lokasi perhentian.
estimated_task_completion_time

Timestamp

Stempel waktu yang menunjukkan perkiraan waktu penyelesaian Tugas.
state

State

Status eksekusi Tugas saat ini.
task_outcome

TaskOutcome

Hasil dari upaya menjalankan Tugas.
task_outcome_time

Timestamp

Stempel waktu yang menunjukkan kapan hasil Tugas ditetapkan oleh penyedia.
planned_location

LocationInfo

Tidak dapat diubah. Lokasi tempat Tugas akan diselesaikan.
target_time_window

TimeWindow

Periode waktu saat tugas harus diselesaikan.
attributes[]

TaskAttribute

Atribut khusus yang ditetapkan pada tugas.

TaskTrackingViewConfig

Pesan konfigurasi yang menentukan kapan elemen data Tugas harus terlihat oleh pengguna akhir.

Kolom
route_polyline_points_visibility

VisibilityOption

Kolom yang menentukan kapan titik polyline rute dapat terlihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default level project untuk data ini akan digunakan.
estimated_arrival_time_visibility

VisibilityOption

Kolom yang menentukan kapan perkiraan waktu kedatangan dapat terlihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default level project untuk data ini akan digunakan.
estimated_task_completion_time_visibility

VisibilityOption

Kolom yang menentukan kapan perkiraan waktu penyelesaian tugas dapat terlihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default level project untuk data ini akan digunakan.
remaining_driving_distance_visibility

VisibilityOption

Kolom yang menentukan kapan jarak mengemudi yang tersisa dapat terlihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default level project untuk data ini akan digunakan.
remaining_stop_count_visibility

VisibilityOption

Kolom yang menentukan kapan jumlah perhentian yang tersisa dapat terlihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default level project untuk data ini akan digunakan.
vehicle_location_visibility

VisibilityOption

Kolom yang menentukan kapan lokasi kendaraan dapat terlihat. Jika kolom ini tidak ditentukan, konfigurasi visibilitas default level project untuk data ini akan digunakan.

VisibilityOption

Pesan opsi yang menentukan kapan elemen data harus terlihat oleh pengguna akhir.

Kolom
Kolom union visibility_option. Opsi visibilitas spesifik dipilih. visibility_option hanya dapat berupa salah satu dari berikut:
remaining_stop_count_threshold

int32

Elemen data ini dapat dilihat oleh pengguna akhir jika jumlah perhentian yang tersisa <= remaining_stop_count_threshold.
duration_until_estimated_arrival_time_threshold

Duration

Elemen data ini dapat dilihat oleh pengguna akhir jika PWT ke perhentian <= duration_until_estimated_arrival_time_threshold.
remaining_driving_distance_meters_threshold

int32

Elemen data ini dapat dilihat oleh pengguna akhir jika jarak mengemudi yang tersisa dalam meter <= remaining_driving_distance_meters_threshold.
always

bool

Jika disetel ke benar (true), elemen data ini selalu terlihat oleh pengguna akhir tanpa nilai minimum. Kolom ini tidak boleh disetel ke salah.
never

bool

Jika disetel ke benar (true), elemen data ini akan selalu disembunyikan dari pengguna akhir tanpa nilai minimum. Kolom ini tidak boleh disetel ke salah.

TimeWindow

Rentang waktu.

Kolom
start_time

Timestamp

Wajib. Waktu mulai dari jangka waktu tersebut (termasuk).
end_time

Timestamp

Wajib. Waktu berakhir dalam jangka waktu tersebut (termasuk).

UpdateDeliveryVehicleRequest

Pesan permintaan UpdateDeliveryVehicle.

Kolom
header

DeliveryRequestHeader

Opsional. Header permintaan Delivery API standar.
delivery_vehicle

DeliveryVehicle

Wajib. Pembaruan entitas DeliveryVehicle yang akan diterapkan. Catatan: Anda tidak dapat memperbarui nama DeliveryVehicle.
update_mask

FieldMask

Wajib. Mask kolom yang menunjukkan kolom DeliveryVehicle mana yang akan diperbarui. Perhatikan bahwa update_mask harus berisi setidaknya satu kolom.

Ini adalah daftar yang dipisahkan koma yang berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "remaining_vehicle_journey_segments".

UpdateTaskRequest

Pesan permintaan UpdateTask.

Kolom
header

DeliveryRequestHeader

Opsional. Header permintaan Delivery API standar.
task

Task

Wajib. Tugas yang terkait dengan update. Kolom berikut dikelola oleh Fleet Engine. Jangan mengupdatenya menggunakan Task.update.

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

Catatan: Anda tidak dapat mengubah nilai task_outcome setelah menetapkannya.

Jika Tugas telah ditetapkan ke kendaraan pengiriman, jangan tetapkan status Tugas ke TUTUP menggunakan Task.update. Sebagai gantinya, hapus VehicleStop yang berisi Tugas dari kendaraan pengiriman, yang secara otomatis menetapkan status Tugas menjadi TUTUP.
update_mask

FieldMask

Wajib. Mask kolom yang menunjukkan kolom Task mana yang akan diperbarui. Catatan: update_mask harus berisi setidaknya satu kolom.

Ini adalah daftar yang dipisahkan koma yang berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "task_outcome,task_outcome_time,task_outcome_location".

VehicleJourneySegment

Mewakili segmen perjalanan Kendaraan - dari perhentian sebelumnya ke perhentian saat ini. Jika perhentian aktif pertama, berarti perhentian tersebut dari lokasi Kendaraan saat ini ke perhentian ini.

Kolom
stop

VehicleStop

Menentukan lokasi perhentian, beserta Task yang terkait dengan perhentian. Beberapa kolom VehicleStop mungkin tidak ada jika segmen perjalanan ini adalah bagian dari JourneySharingInfo.
driving_distance_meters

Int32Value

Hanya output. Jarak perjalanan dari perhentian sebelumnya ke perhentian ini. Jika perhentian saat ini adalah perhentian pertama dalam daftar segmen perjalanan, titik awalnya adalah lokasi kendaraan yang dicatat pada saat perhentian ini ditambahkan ke daftar. Kolom ini mungkin tidak ada jika segmen perjalanan ini adalah bagian dari JourneySharingInfo.
driving_duration

Duration

Hanya output. Waktu perjalanan dari perhentian sebelumnya ke perhentian ini. Jika perhentian saat ini adalah perhentian pertama dalam daftar segmen perjalanan, titik awalnya adalah lokasi Kendaraan yang dicatat pada saat perhentian ini ditambahkan ke daftar.

Jika kolom ini ditentukan di jalur Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) atau Task.remainingVehicleJourneySegments[0].drivingDuration (REST), kolom tersebut mungkin diisi dengan nilai dari DeliveryVehicle.remaining_duration (gRPC) atau DeliveryVehicle.remainingDuration (REST). Data ini menampilkan sisa durasi mengemudi dari lokasi terbaru aplikasi pengemudi yang diketahui, bukan waktu mengemudi dari perhentian sebelumnya.
path[]

LatLng

Hanya output. Jalur dari perhentian sebelumnya ke perhentian ini. Jika perhentian saat ini adalah perhentian pertama dalam daftar segmen perjalanan, berarti ini adalah jalur dari lokasi kendaraan saat ini ke perhentian ini pada saat perhentian ditambahkan ke daftar. Kolom ini mungkin tidak ada jika segmen perjalanan ini adalah bagian dari JourneySharingInfo.

Jika kolom ini ditentukan di jalur Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) atau Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST), kolom tersebut mungkin diisi dengan LatLng yang didekode dari DeliveryVehicle.current_route_segment (gRPC) atau DeliveryVehicle.currentRouteSegment (REST). Ini memberikan jalur mengemudi dari lokasi terbaru aplikasi pengemudi yang diketahui, bukan jalur dari perhentian sebelumnya.

VehicleStop

Menjelaskan titik saat Kendaraan berhenti untuk melakukan satu atau beberapa Task.

Kolom
planned_location

LocationInfo

Wajib. Lokasi perhentian. Perhatikan bahwa lokasi di Task mungkin tidak sama persis dengan lokasi ini, tetapi jaraknya tidak terlalu jauh. Kolom ini tidak akan diisi sebagai respons dari panggilan GetTask.
tasks[]

TaskInfo

Daftar Task yang akan dilakukan di perhentian ini. Kolom ini tidak akan diisi sebagai respons dari panggilan GetTask.
state

State

Status VehicleStop. Kolom ini tidak akan diisi sebagai respons dari panggilan GetTask.

Negara Bagian

Status VehicleStop saat ini.

Enum
STATE_UNSPECIFIED Tak diketahui.
NEW Dibuat, tetapi tidak secara aktif memilih rute.
ENROUTE Ditetapkan dan aktif memilih rute.
ARRIVED Tiba di perhentian. Mengasumsikan bahwa saat Kendaraan memilih rute ke perhentian berikutnya, semua perhentian sebelumnya telah selesai.

TaskInfo

Informasi tambahan tentang Tugas yang dijalankan di perhentian ini.

Kolom
task_id

string

ID Tugas. Kolom ini tidak akan diisi sebagai respons dari panggilan GetTask. ID tugas tunduk pada batasan berikut:

  • Harus berupa string Unicode yang valid.
  • Dibatasi hingga panjang maksimum 64 karakter.
  • Dinormalkan menurut Formulir Normalisasi Unicode C.
  • Tidak boleh berisi karakter ASCII berikut: '/', ':', '?', ',', atau '#'.
task_duration

Duration

Hanya output. Waktu yang diperlukan untuk menjalankan Tugas.
target_time_window

TimeWindow

Hanya output. Periode waktu saat tugas harus diselesaikan. Ini hanya ditetapkan sebagai respons terhadap GetDeliveryVehicle.