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

มาสก์ของช่องเป็นวิธีหนึ่งที่ผู้โทร API ใช้ในการแสดงรายการช่องที่คำขอควรแสดงผล การใช้ฟิลด์มาสก์ช่วยให้ 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