أقنعة الحقل

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

يمكن تحديد قناع الحقل كمعلَمة طلب بحث في عنوان 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