מסכות שדה

מסכות שדות מאפשרות למשתמשים שקוראים ל-API לציין את השדות שהבקשה צריכה להחזיר. שימוש במסכת שדות מאפשר ל-API להימנע מעבודה מיותרת ומשפר את הביצועים.

אפשר לציין את מסכת השדה כפרמטר של שאילתת 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