घर में मास्क लगाने की सेवा

फ़ील्ड मास्क की मदद से एपीआई कॉलर, उन फ़ील्ड की सूची बना सकते हैं जिन्हें अनुरोध करने के लिए अनुरोध करना चाहिए. फ़ील्ड मास्क का इस्तेमाल करने से, एपीआई को बेवजह काम करने से बचने और परफ़ॉर्मेंस बेहतर बनाने में मदद मिलती है.

फ़ील्ड मास्क को यूआरएल क्वेरी पैरामीटर या एचटीटीपी या gRPC हेडर के तौर पर बताया जा सकता है:

यूआरएल क्वेरी पैरामीटर	एचटीटीपी या 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