Mascarillas de campo

Las máscaras de campo son una forma en que los llamadores de la API pueden enumerar los campos que debe devolver una solicitud. El uso de una máscara de campo permite que la API evite el trabajo innecesario y mejore el rendimiento.

Una máscara de campo se puede especificar como un parámetro de búsqueda 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 la 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 encerrándolos entre paréntesis.

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