Feldmasken

Mit Feldmasken können API-Aufrufer die Felder auflisten, die von einer Anfrage zurückgegeben werden sollen. Durch die Verwendung einer Feldmaske kann die API unnötige Arbeit vermeiden und die Leistung verbessern.

Eine Feldmaske kann entweder als URL-Abfrageparameter oder als HTTP- oder gRPC-Header angegeben werden:

URL-Abfrageparameter	HTTP- oder gRPC-Header
$fields oder fields	X-Goog-FieldMask

Feldmaskensyntax

Die folgenden Beispiele für Feldmasken basieren auf diesem Beispielantworttyp.

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

Verschachtelte Felder können mithilfe der Punktsyntax ausgewählt oder in Klammern gesetzt werden.

Ausdruck	Ausgabe
*	Gibt alle Felder und verschachtelten Felder zurück.
field1,field2	Gibt field1 und alle verschachtelten Felder von field2 zurück.
field1,field2.foo1	Gibt field1 und field2.foo1 zurück.
field1,field2(foo1)	Gibt field1 und field2.foo1 zurück.
field1,field2(foo1,foo2)	Gibt Folgendes zurück: field1 field2.foo1 field2.foo2
field1,field2(foo1,foo3(bar1,bar2))	Gibt Folgendes zurück: field1 field2.foo1 field2.foo3.bar1 field2.foo3.bar2