หน้ากากภาคสนาม

มาสก์ฟิลด์เป็นวิธีที่ผู้เรียก API ใช้เพื่อแสดงรายการฟิลด์ที่คำขอควร ส่งคืน การใช้ FieldMask จะช่วยให้ API หลีกเลี่ยงการทำงานที่ไม่จำเป็นและ ปรับปรุงประสิทธิภาพ

คุณระบุฟิลด์มาสก์ได้ทั้งเป็นพารามิเตอร์การค้นหา URL หรือเป็นส่วนหัว HTTP หรือ gRPC ดังนี้

พารามิเตอร์การค้นหาของ URL	ส่วนหัว HTTP หรือ gRPC
$fields หรือ fields	X-Goog-FieldMask

ไวยากรณ์ฟิลด์มาสก์

ตัวอย่างมาสก์ฟิลด์ต่อไปนี้อิงตามประเภทการตอบกลับตัวอย่างนี้

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

คุณเลือกฟิลด์ที่ซ้อนกันได้โดยใช้ไวยากรณ์แบบจุดหรือโดยการใส่ฟิลด์ไว้ในวงเล็บ

นิพจน์	เอาต์พุต
*	แสดงช่องทั้งหมดและช่องที่ซ้อนกัน
field1,field2	แสดงผล field1 และช่องที่ซ้อนกันทั้งหมดของ field2
field1,field2.foo1	กลับ field1 และ field2.foo1
field1,field2(foo1)	กลับ field1 และ field2.foo1
field1,field2(foo1,foo2)	การคืนสินค้า: field1 field2.foo1 field2.foo2
field1,field2(foo1,foo3(bar1,bar2))	การคืนสินค้า: field1 field2.foo1 field2.foo3.bar1 field2.foo3.bar2