Alan maskeleri

Alan maskeleri, API çağıranların bir isteğin döndürmesi gereken alanları listelemesinin bir yoludur. Alan maskesi kullanmak, API'nin gereksiz işlerden kaçınmasını sağlar ve performansı artırır.

Alan maskesi, URL sorgu parametresi veya HTTP ya da gRPC üst bilgisi olarak belirtilebilir:

URL sorgu parametresi	HTTP veya gRPC başlığı
$fields veya fields	X-Goog-FieldMask

Alan maskesi söz dizimi

Aşağıdaki alan maskesi örnekleri, bu örnek yanıt türüne dayanmaktadır.

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çe yerleştirilmiş alanlar, nokta söz dizimi kullanılarak veya parantez içine alınarak seçilebilir.

İfade	Çıkış
*	Tüm alanları ve iç içe yerleştirilmiş alanları döndürür.
field1,field2	field1 ve field2'nin tüm iç içe alanlarını döndürür.
field1,field2.foo1	İade field1 ve field2.foo1.
field1,field2(foo1)	İade field1 ve field2.foo1.
field1,field2(foo1,foo2)	İade sayısı: field1 field2.foo1 field2.foo2
field1,field2(foo1,foo3(bar1,bar2))	İade sayısı: field1 field2.foo1 field2.foo3.bar1 field2.foo3.bar2