ماسک های میدانی

فیلد ماسک راهی برای تماس گیرندگان 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

،

فیلد ماسک راهی برای تماس گیرندگان 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