Mascarillas de campo

Las máscaras de campo permiten que los llamadores de API enumeren los campos que debe mostrar una solicitud. El uso de una máscara de campo permite que la API evite trabajo innecesario y mejore el rendimiento.

Una máscara de campo se puede especificar como un parámetro de consulta de URL o como un encabezado HTTP o gRPC:

Parámetro de consulta de URL	Encabezado HTTP o gRPC
$fields o fields	X-Goog-FieldMask

Sintaxis de máscara de campo

Los siguientes ejemplos de máscaras de campo se basan en este tipo de respuesta de ejemplo.

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

Los campos anidados se pueden seleccionar con la sintaxis de puntos o encerrarlos entre paréntesis.

Expresión	Salida
*	Muestra todos los campos y campos anidados.
field1,field2	Muestra field1 y todos los campos anidados de field2.
field1,field2.foo1	Muestra field1 y field2.foo1.
field1,field2(foo1)	Muestra field1 y field2.foo1.
field1,field2(foo1,foo2)	Muestra: field1 field2.foo1 field2.foo2
field1,field2(foo1,foo3(bar1,bar2))	Muestra: field1 field2.foo1 field2.foo3.bar1 field2.foo3.bar2