Memilih kolom yang akan ditampilkan

Saat meminta rute atau matriks rute, Anda harus menggunakan mask kolom untuk menentukan informasi yang harus ditampilkan oleh respons. Tidak ada daftar default kolom yang ditampilkan. Jika Anda tidak menentukan mask kolom, metode akan menampilkan error.

Penggunaan mask kolom juga memastikan bahwa Anda tidak meminta data yang tidak diperlukan, yang pada akhirnya membantu latensi respons dan menghindari tagihan yang tidak perlu untuk informasi yang tidak diperlukan sistem Anda.

Anda menentukan daftar kolom yang diperlukan dalam mask kolom respons. Kemudian, Anda meneruskan mask kolom respons ke salah satu metode menggunakan parameter URL $fields atau fields, atau menggunakan header HTTP atau gRPC X-Goog-FieldMask.

Untuk mengetahui informasi selengkapnya tentang parameter URL, lihat Parameter Sistem.

Menentukan mask kolom respons

Mask kolom respons adalah daftar jalur yang dipisahkan koma, dengan setiap jalur menentukan kolom unik dalam pesan respons. Jalur dimulai dari pesan respons tingkat atas dan menggunakan jalur yang dipisahkan titik ke kolom yang ditentukan.

Buat dan tentukan jalur kolom sebagai berikut:

  1. Temukan kolom yang berisi informasi yang Anda perlukan dari Routes API. Untuk mengetahui detailnya, lihat Referensi Kolom.
  2. Tentukan jalur untuk kolom yang Anda perlukan dan buat mask kolom untuk kolom tersebut: Untuk mengetahui detailnya, lihat Menentukan mask kolom yang ingin Anda gunakan.

  3. Gabungkan mask kolom untuk semua kolom yang Anda perlukan, dengan memisahkan mask kolom menggunakan koma. Misalnya, untuk meminta distanceMeters untuk segmen rute, ditambah durasi untuk setiap langkah segmen rute, masukkan keduanya, dipisahkan dengan koma, tanpa spasi:

    routes.legs.distanceMeters,routes.legs.steps.duration

  4. Kirim mask kolom dengan permintaan API Anda. Misalnya, dalam permintaan cURL, Anda akan menentukan mask kolom dengan -H dan X-Goog-FieldMask:

    -H X-Goog-FieldMask: routes.legs.distanceMeters,routes.legs.steps.duration
Untuk contoh dan detail selengkapnya, lihat bagian berikut.

Referensi Kolom

Untuk melihat kolom yang dapat Anda minta dalam respons melalui mask kolom, lihat referensi Routes API yang ditautkan dalam daftar berikut. Tentukan kolom dalam camel case seperti yang ditunjukkan dalam referensi. Misalnya, routePreference.

Referensi ini mencakup kolom yang tersedia; namun, Anda perlu merujuk ke hierarki kolom untuk menentukan jalur mask kolom lengkap. Untuk mengetahui detail tentang cara mendapatkan hierarki kolom, lihat Menentukan mask kolom yang ingin Anda gunakan.

  • Mask kolom rute komputasi
    • REST: Menentukan kolom objek Route dalam respons yang akan ditampilkan, diawali dengan routes., misalnya, routes.distanceMeters.
    • gRPC: Menentukan kolom objek Route dalam respons yang akan ditampilkan.
  • Mask kolom matriks rute komputasi

Menentukan mask kolom yang akan digunakan

Berikut cara menentukan kolom yang ingin Anda gunakan, dan membuat mask kolom untuk kolom tersebut:

  1. Minta semua kolom menggunakan mask kolom *.
  2. Lihat hierarki kolom dalam respons untuk kolom yang Anda inginkan.

  3. Buat mask kolom menggunakan hierarki kolom yang ditampilkan pada langkah sebelumnya, menggunakan format ini:

    topLevelField[.secondLevelField][.thirdLevelField][...]

Misalnya, untuk respons sebagian ini dari rute:

"routes": [
    {
        "legs": [
            {  "steps": [
                    {"distanceMeters": 119},
                    {"distanceMeters": 41}  ]
            }
        ],
        "distanceMeters": 160
    }
]

Jika Anda hanya ingin menampilkan kolom distanceMeters untuk segmen rute; yaitu, distanceMeters terakhir dalam contoh sebelumnya, mask kolom Anda adalah sebagai berikut:

routes.legs.distanceMeters

Jika Anda ingin menampilkan kolom distanceMeters untuk setiap langkah segmen rute; yaitu, distanceMeters di bagian steps dalam contoh sebelumnya, mask kolom Anda adalah sebagai berikut:

routes.legs.steps.distanceMeters

Jika Anda ingin menampilkan keduanya, dengan hasil di atas, mask kolom Anda adalah sebagai berikut:

routes.legs.distanceMeters,routes.legs.steps.distanceMeters

Contoh jalur mask kolom

Bagian ini berisi contoh selengkapnya tentang cara menentukan jalur kolom sebagai bagian dari mask kolom respons dalam panggilan REST dan gRPC.

Panggilan REST ke computeRoutes

Pada contoh pertama, Anda menggunakan panggilan REST ke metode computeRoutes untuk menghitung rute. Dalam contoh ini, di header, Anda menentukan mask kolom untuk menampilkan kolom distanceMeters dan duration rute dalam respons. Jangan lupa untuk menambahkan awalan routes ke nama kolom.

X-Goog-FieldMask: routes.distanceMeters,routes.duration

Panggilan REST ke computeRouteMatrix

Untuk metode computeRouteMatrix REST yang digunakan untuk menghitung matriks rute, di header, tentukan untuk menampilkan originIndex, destinationIndex, dan duration untuk setiap kombinasi asal dan tujuan:

X-Goog-FieldMask: originIndex,destinationIndex,duration

Panggilan gRPC

Untuk gRPC, tetapkan variabel yang berisi mask kolom respons. Kemudian, Anda dapat meneruskan variabel tersebut ke permintaan.

const (
  fieldMask = "routes.distanceMeters,routes.duration,routes.polyline.encodedPolyline"
)

Pertimbangan jalur kolom

Hanya sertakan kolom yang Anda perlukan dalam respons untuk menampilkan kolom yang Anda perlukan:

  • Mengurangi waktu pemrosesan, sehingga hasil Anda ditampilkan dengan latensi yang lebih rendah.
  • Memastikan performa latensi yang stabil. Jika memilih semua kolom, atau jika memilih semua kolom di tingkat teratas, Anda mungkin mengalami penurunan performa saat kolom baru ditambahkan, lalu otomatis disertakan dalam respons Anda.
  • Menghasilkan ukuran respons yang lebih kecil, yang berarti throughput jaringan yang lebih tinggi.
  • Memastikan Anda tidak meminta data yang tidak diperlukan, yang membantu menghindari waktu pemrosesan dan tagihan yang tidak perlu.

Untuk mengetahui detail selengkapnya tentang cara membuat mask kolom, lihat field_mask.proto.