Package google.maps.roads.selection.v1

Indeks

RoadsSelection

Definisi layanan untuk Roads Selection API.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

Membuat beberapa SelectedRoute dan memulai jadwal untuk mengambil informasi cache secara berkala untuk setiap rute.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

Membuat SelectedRoute dan memulai jadwal untuk mengambil informasi cache secara berkala untuk rute.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

Menghapus SelectedRoute yang ditentukan untuk project yang ditentukan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

Mendapatkan SelectedRoute seperti yang ditentukan oleh namanya.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

Mencantumkan semua SelectedRoutes untuk project yang ditentukan dengan penomoran halaman.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

BatchCreateSelectedRoutesRequest

Permintaan untuk membuat beberapa SelectedRoute.

Kolom
parent

string

Opsional. Resource project yang dibagikan oleh semua rute yang dipilih. Format: projects/{project} Jika ditetapkan, kolom induk dalam pesan CreateSelectedRouteRequest harus kosong atau cocok dengan kolom ini.
requests[]

CreateSelectedRouteRequest

Wajib. Pesan permintaan yang menentukan rute yang dipilih untuk dibuat. Maksimum 1.000 rute yang dipilih dapat dibuat dalam batch.

BatchCreateSelectedRoutesResponse

Respons dari pembuatan beberapa SelectedRoute.

Kolom
selected_routes[]

SelectedRoute

SelectedRoutes dibuat.

CreateSelectedRouteRequest

Permintaan untuk membuat SelectedRoute.

Kolom
parent

string

Wajib. Project tempat SelectedRoute akan dibuat. Format: projects/{project}
selected_route

SelectedRoute

Wajib. SelectedRoute yang akan dibuat.
selected_route_id

string

Opsional. ID yang akan digunakan untuk SelectedRoute, yang akan menjadi komponen akhir dari nama resource SelectedRoute.

Nilai ini harus terdiri dari 4-63 karakter, dan karakter yang valid adalah: "a-z", "A-Z", "0-9", atau "-". Jika tidak diberikan atau kosong, UUID akan dibuat setelah pembuatan resource.

DeleteSelectedRouteRequest

Permintaan untuk menghapus SelectedRoute.

Kolom
name

string

Wajib. Nama SelectedRoute yang akan dihapus. Format: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

Permintaan untuk mendapatkan SelectedRoute.

Kolom
name

string

Wajib. Nama SelectedRoute yang akan diambil. Format: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

Permintaan untuk mencantumkan SelectedRoute.

Kolom
parent

string

Wajib. Induk, yaitu project tempat semua SelectedRoute akan dikueri. Format: projects/{project}/selectedRoutes
page_size

int32

Opsional. Jumlah hasil yang harus ditampilkan untuk halaman tertentu. Jika tidak ditetapkan, nilai defaultnya adalah 100. Jika nilai 0 diberikan, nilai akan ditetapkan ke default. Nilai maksimum adalah 5.000, setiap nilai di atas 5.000 akan ditetapkan ke 5.000.
page_token

string

Opsional. Token halaman, diterima dari panggilan ListSelectedRoutes sebelumnya.

ListSelectedRoutesResponse

Respons yang mencantumkan SelectedRoute.

Kolom
selected_routes[]

SelectedRoute

Halaman SelectedRoutes yang disimpan dalam project yang ditentukan dalam permintaan.
next_page_token

string

Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini kosong, tidak ada halaman berikutnya.

SelectedRoute

SelectedRoute merepresentasikan rute tertentu yang diinginkan pelanggan untuk mengambil informasi secara berkala (misalnya, durasi) untuk kasus penggunaan yang dikontrak.

Kolom
name

string

ID. Nama resource SelectedRoute.

Format: projects/{project}/selectedRoutes/{selected_route}
display_name

string

Opsional. Nama tampilan rute. Kolom ini bersifat opsional dan dapat digunakan oleh pelanggan. Nama ini tidak harus unik.
create_time

Timestamp

Hanya output. Waktu saat rute yang dipilih pertama kali dibuat.
state

State

Hanya output. Status rute yang dipilih.
route_attributes

map<string, string>

Opsional. Atribut kustom untuk rute yang dipilih. Menambahkannya memungkinkan pemfilteran / pengelompokan rute saat mengambil informasi rute historis dan real-time. Hingga 10 atribut didukung per rute. Setiap kunci dan nilai harus berupa string yang tidak kosong dan dapat berisi hingga 100 karakter. Kunci tidak boleh diawali dengan "goog".
Kolom union route_type. Saat ini hanya DynamicRoute yang didukung. route_type hanya dapat berupa salah satu dari hal berikut:
dynamic_route

DynamicRoute

SelectedRoute adalah rute dinamis.
validation_error

ValidationError

Hanya output. Error validasi untuk rute yang dipilih saat statusnya STATE_INVALID.

DynamicRoute

Ini merepresentasikan rute dengan titik jalan (asal, tujuan, dan perantara). Rute sebenarnya dijamin melewati semua titik jalan, tetapi dapat berubah dari waktu ke waktu karena kondisi lalu lintas yang bervariasi.

Kolom
origin

LatLng

Wajib. Lokasi asal rute.
destination

LatLng

Wajib. Lokasi akhir rute.
intermediates[]

LatLng

Opsional. Kumpulan titik jalan perantara di sepanjang rute (tidak termasuk titik akhir). Titik ini selalu merupakan titik lewat. Hingga 25 titik jalan perantara didukung. Menambahkannya dengan benar dapat mengurangi variasi rute sebenarnya dari waktu ke waktu.

Negara Bagian

Status rute yang dipilih.

Enum
STATE_UNSPECIFIED Status rute ini tidak ditetapkan.
STATE_SCHEDULING Rute telah dibuat dan sedang dijadwalkan.
STATE_RUNNING Rute telah dibuat dan memiliki jadwal aktif.
STATE_DELETING Rute telah ditandai untuk dihapus.
STATE_VALIDATING Rute sedang dalam proses validasi.
STATE_INVALID Rute tidak valid berdasarkan salah satu kriteria validasi.

ValidationError

Error validasi untuk rute yang dipilih.

Enum
VALIDATION_ERROR_UNSPECIFIED Error validasi rute ini tidak ditetapkan.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION Rute berada di luar yurisdiksi proyek.
VALIDATION_ERROR_LOW_ROAD_USAGE Rute memiliki penggunaan jalan yang rendah (sangat sedikit orang yang melewatinya).