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

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

फ़ील्ड मास्क को यूआरएल क्वेरी पैरामीटर या एचटीटीपी या 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;
}

नेस्ट किए गए फ़ील्ड को चुनने के लिए, डॉट सिंटैक्स का इस्तेमाल किया जा सकता है. इसके अलावा, उन्हें पैरंटheses में भी रखा जा सकता है.

एक्सप्रेशन	आउटपुट
*	यह सभी फ़ील्ड और नेस्ट किए गए फ़ील्ड दिखाता है.
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