- Permintaan HTTP
- Isi permintaan
- Isi respons
- Jalur
- Segmen
- AnnotationOptions
- AnnotatedPath
- AnnotatedSegment
- SegmentSpanAttribute
- SegmentSpan
- LevelOfService
Menampilkan kembali jalur berbasis segmen input dengan anotasi untuk atribut dinamis di sepanjang jalur.
Permintaan HTTP
POST https://routes.googleapis.com/annotations/v2:annotatePaths
URL menggunakan sintaksis gRPC Transcoding.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "paths": [ { object ( |
Kolom | |
---|---|
paths[] |
Wajib. Rute yang diminta untuk diisi dengan data atribut dinamis. Semua jalur harus memiliki segmen awal yang sama, menjadi segmen yang saat ini dilalui kendaraan. Kendaraan tersebut diasumsikan berada di awal segmen pertama. Jika jalur tidak dimulai dari segmen yang sama, error akan ditampilkan. |
annotationOptions |
Wajib. Atribut data dinamis yang diminta dan harus ditambahkan di jalur input. Jika kosong, permintaan tidak akan dianotasi. |
Isi respons
AnnotatePathsResponse berisi jalur input dengan data tambahan yang ditambahkan untuk semua anotasi yang diminta.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"annotatedPaths": [
{
object ( |
Kolom | |
---|---|
annotatedPaths[] |
Jalur dari input yang dianotasi dengan atribut yang diminta. |
Jalur
Jalur tempat atribut dinamis diminta.
Jalur harus memiliki segmen yang terhubung dan dapat dilalui. Segmen jalur diasumsikan mengikuti rute logis, dan jika rute tidak dapat ditemukan pada segmen input, error akan ditampilkan. Misalnya, jika segmen dalam jalur tidak memiliki endpoint yang terhubung, atau jalur kosong, hal ini akan menghasilkan error.
Panjang jalur saat ini dibatasi hingga 15 km. Jalur ini diukur dari awal segmen pertama, lokasi kendaraan yang diasumsikan. Error akan ditampilkan jika segmen dalam jalur dimulai lebih dari 15 km dari awal segmen pertama. Segmen terakhir dapat dimulai sebelum 15 km dan berakhir melewati 15 km masih dapat diterima. Tidak ada respons sebagian yang akan ditampilkan.
Jalur dapat berisi segmen yang sama dengan jalur lain, tetapi anotasi segmen juga dapat berisi respons yang berbeda berdasarkan perbedaan di bagian jalur yang lain.
Representasi JSON |
---|
{
"segments": [
{
object ( |
Kolom | |
---|---|
segments[] |
Wajib. Daftar segmen yang diurutkan yang membentuk jalur. |
Segmen
Segmen yang termasuk dalam jalur.
Representasi JSON |
---|
{ "polyline": { object ( |
Kolom | |
---|---|
polyline |
Wajib. Polyline segmen, yang dapat digunakan untuk mengidentifikasi segmen jika ID tidak dapat ditemukan, serta untuk membedakan dua segmen jika memiliki ID yang sama. Polyline dienkode menggunakan Format Algoritme Polyline yang Dienkode Google Maps Platform standar. |
Kolom union id . Digunakan untuk mengidentifikasi segmen ini dalam ruang ID. Wajib. id hanya ada berupa salah satu diantara berikut: |
|
placeId |
ID Tempat untuk segmen jalan ini. Digunakan di seluruh API. |
AnnotationOptions
Anotasi yang diminta untuk jalur input.
Representasi JSON |
---|
{ "includeLevelOfService": boolean } |
Kolom | |
---|---|
includeLevelOfService |
Opsional. Jika ditetapkan ke true, segmen dalam respons akan dianotasi dengan prediksi nilai traffic. "Level Layanan" adalah istilah yang umumnya digunakan untuk menjelaskan kategorisasi alur traffic, tetapi level definisi layanan dalam API ini berasal dari API ini saja. |
AnnotatedPath
Salinan jalur input yang ditampilkan dengan atribut yang diprediksi.
Representasi JSON |
---|
{
"annotatedSegments": [
{
object ( |
Kolom | |
---|---|
annotatedSegments[] |
Daftar segmen berurutan yang membentuk jalur utama, dianotasi dengan atribut yang diminta. |
AnnotatedSegment
Segmen yang membuat jalur, dianotasi dengan atribut data dinamis.
Representasi JSON |
---|
{ "segment": { object ( |
Kolom | |
---|---|
segment |
Detail segmen digunakan untuk membedakannya dari segmen lain. |
segmentSpanAttributes[] |
Atribut yang ditetapkan ke segmen. Atribut ini mungkin berbeda berdasarkan jalur tempat segmen berada. Span dapat mencakup seluruh segmen. Rentang atribut akan dalam urutan maju dari lokasi kendaraan ke akhir jalur. |
SegmentSpanAttribute
SegmentSpanAttribute berisi anotasi yang ditampilkan dari API.
Representasi JSON |
---|
{ "segmentSpan": { object ( |
Kolom | |
---|---|
segmentSpan |
Menjelaskan di bagian mana pada segmen tersebut anotasi berlaku. |
levelOfService |
Tingkat traffic yang diprediksi untuk rentang segmen, ditentukan oleh kecepatan lalu lintas yang diharapkan pada segmen ini saat kendaraan tiba di awal segmen. |
SegmentSpan
Digunakan untuk membatasi subbagian segmen. Jika sebuah span mencakup seluruh segmen, startMeters akan menjadi 0 dan endMeters akan menjadi panjang segmen.
Representasi JSON |
---|
{ "startMeters": integer, "endMeters": integer } |
Kolom | |
---|---|
startMeters |
Dengan awal span berasal dari titik awal polyline segmen. |
endMeters |
Dengan akhir span dari titik awal polyline segmen. |
LevelOfService
Prediksi nilai bucket traffic, yang akan digunakan untuk fungsi ADAS, yang dipetakan ke tingkat traffic umum. Nilai yang ditampilkan oleh API ini bersifat independen dan tidak boleh diandalkan agar sesuai dengan API lain.
Enum | |
---|---|
LEVEL_OF_SERVICE_UNSPECIFIED |
Nilai default. Nilai ini berarti bahwa tidak ada prediksi nilai traffic yang tersedia. |
LEVEL_OF_SERVICE_STOPPED |
Lalu lintas padam. |
LEVEL_OF_SERVICE_STOP_AND_GO |
Lalu lintas padat dan normal. |
LEVEL_OF_SERVICE_SLOW |
Pelambatan diperkirakan akan terjadi, tetapi tidak ada prediksi kemacetan lalu lintas. |
LEVEL_OF_SERVICE_NORMAL |
Kecepatan normal, diperkirakan tidak ada pelambatan. |