Mask kolom

Mask kolom adalah cara bagi pemanggil API untuk mencantumkan kolom yang harus ditampilkan oleh permintaan. Dengan menggunakan mask kolom, API dapat menghindari tugas yang tidak perlu dan meningkatkan performa.

Masker kolom dapat ditentukan sebagai parameter kueri URL atau sebagai header HTTP atau gRPC:

Parameter Kueri URL	Header HTTP atau gRPC
$fields atau fields	X-Goog-FieldMask

Sintaksis mask kolom

Contoh mask kolom berikut didasarkan pada jenis respons contoh ini.

message ExampleResponse {
  message Foo {
    string foo1 = 1;
    string foo2 = 2;
    Bar foo3 = 3;
  }

  message Bar {
    string bar1 = 1;
    string bar2 = 2;
    string bar3 = 3;
  }

  string field1 = 1;
  repeated Foo field2 = 2;
}

Kolom bertingkat dapat dipilih menggunakan sintaksis titik atau dengan menyertakannya dalam tanda kurung.

Ekspresi	Output
*	Menampilkan semua kolom dan kolom bertingkat.
field1,field2	Menampilkan field1 dan semua kolom bertingkat dari field2.
field1,field2.foo1	Menampilkan field1 dan field2.foo1.
field1,field2(foo1)	Menampilkan field1 dan field2.foo1.
field1,field2(foo1,foo2)	Hasil: field1 field2.foo1 field2.foo2
field1,field2(foo1,foo3(bar1,bar2))	Hasil: field1 field2.foo1 field2.foo3.bar1 field2.foo3.bar2