Khẩu trang địa phương

Mặt nạ trường (field mask) là một cách để phương thức gọi API liệt kê các trường mà yêu cầu sẽ trả về. Việc sử dụng mặt nạ trường (field mask) giúp API tránh được các thao tác không cần thiết và cải thiện hiệu suất.

Bạn có thể chỉ định mặt nạ trường (field mask) làm tham số truy vấn URL hoặc tiêu đề HTTP hoặc gRPC:

Tham số truy vấn URL	Tiêu đề HTTP hoặc gRPC
$fields hoặc fields	X-Goog-FieldMask

Cú pháp mặt nạ cho trường (field mask)

Các ví dụ sau đây về mặt nạ cho trường đều dựa trên loại phản hồi trong ví dụ này.

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;
}

Bạn có thể chọn các trường lồng nhau bằng cú pháp dấu chấm hoặc đặt các trường đó trong dấu ngoặc đơn.

Cụm từ	Đầu ra
*	Trả về tất cả các trường và các trường lồng nhau.
field1,field2	Trả về field1 và tất cả các trường lồng nhau của field2.
field1,field2.foo1	Trả về field1 và field2.foo1.
field1,field2(foo1)	Trả về field1 và field2.foo1.
field1,field2(foo1,foo2)	Trả lại hàng: field1 field2.foo1 field2.foo2
field1,field2(foo1,foo3(bar1,bar2))	Trả lại hàng: field1 field2.foo1 field2.foo3.bar1 field2.foo3.bar2