필드 마스크

필드 마스크를 사용하면 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