Maschere da campo

Le maschere di campo consentono ai chiamanti API di elencare i campi che una richiesta deve restituire. L'utilizzo di una maschera di campo consente all'API di evitare lavoro non necessario e migliora le prestazioni.

Una maschera di campo può essere specificata come parametro di query URL o come intestazione HTTP o gRPC:

Parametro di query URL	Intestazione HTTP o gRPC
$fields o fields	X-Goog-FieldMask

Sintassi della maschera del campo

I seguenti esempi di maschere di campo si basano su questo tipo di risposta di esempio.

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

I campi nidificati possono essere selezionati utilizzando la sintassi con il punto o racchiudendoli tra parentesi.

Espressione	Output
*	Restituisce tutti i campi e i campi nidificati.
field1,field2	Restituisce field1 e tutti i campi nidificati di field2.
field1,field2.foo1	Restituisce field1 e field2.foo1.
field1,field2(foo1)	Restituisce field1 e field2.foo1.
field1,field2(foo1,foo2)	Resi: field1 field2.foo1 field2.foo2
field1,field2(foo1,foo3(bar1,bar2))	Resi: field1 field2.foo1 field2.foo3.bar1 field2.foo3.bar2