Maski pól umożliwiają osobom wywołującym interfejs API wyświetlanie listy pól, które powinny zostać zwrócone przez żądanie. Użycie maski pól pozwala interfejsowi API uniknąć niepotrzebnej pracy i poprawia wydajność.
Maską pola można określić jako parametr zapytania URL albo jako nagłówek HTTP lub gRPC:
Parametr zapytania w adresie URL | Nagłówek HTTP lub gRPC |
---|---|
$fields lub fields |
X-Goog-FieldMask |
Składnia maski pola
Poniższe przykłady masek pól są oparte na tym przykładowym typie odpowiedzi.
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;
}
Zagnieżdżone pola można wybrać za pomocą składni punktów lub umieszczając je w nawiasach.
Wyrażenie | Wyniki |
---|---|
* |
Zwraca wszystkie pola i pola zagnieżdżone. |
field1,field2 |
Zwraca wartość field1 i wszystkie zagnieżdżone pola kolumny field2 . |
field1,field2.foo1 |
Zwraca wartości field1 i field2.foo1 . |
field1,field2(foo1) |
Zwraca wartości field1 i field2.foo1 . |
field1,field2(foo1,foo2)
|
Zwroty: field1 field2.foo1 field2.foo2 |
field1,field2(foo1,foo3(bar1,bar2))
|
Zwroty: field1 field2.foo1 field2.foo3.bar1 field2.foo3.bar2 |