أقنعة الحقل

أقنعة الحقول هي طريقة يمكن لمتصلي واجهة برمجة التطبيقات إدراج الحقول التي يجب أن يعرضها الطلب. يسمح استخدام قناع الحقل لواجهة برمجة التطبيقات بتجنب العمل غير الضروري وتحسين الأداء.

يمكن تحديد قناع الحقل إما كمعلمة طلب بحث عن عنوان URL أو كعنوان HTTP أو gRPC:

مَعلمة طلب البحث في عنوان URL	عنوان HTTP أو gRPC
$fields أو fields	X-Goog-FieldMask

بنية قناع الحقل

تستند أمثلة قناع الحقل التالية إلى نموذج نوع الرد هذا.

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

يمكن تحديد الحقول المتداخلة باستخدام بناء الجملة النقطي أو من خلال تضمينها بين قوسين.

التعبير	الناتج
*	تعرض جميع الحقول والحقول المتداخلة.
field1,field2	تعرض field1 وجميع حقول field2 المتداخلة.
field1,field2.foo1	تعرض field1 وfield2.foo1.
field1,field2(foo1)	تعرض field1 وfield2.foo1.
field1,field2(foo1,foo2)	المرتجعات: field1 field2.foo1 field2.foo2
field1,field2(foo1,foo3(bar1,bar2))	المرتجعات: field1 field2.foo1 field2.foo3.bar1 field2.foo3.bar2