फ़ील्ड मास्क

Ad Manager REST API, कुछ टेक्स्ट को पढ़ने और लिखने के लिए फ़ील्ड मास्क का इस्तेमाल करता है. यह काम कर सकता है ट्रांसफ़र किए जाने वाले डेटा की मात्रा को सीमित करके परफ़ॉर्मेंस को बेहतर बनाएं. फ़ील्ड मास्क को फ़ील्ड नामों की कॉमा-सेपरेटेड लिस्ट से दिखाया जाता है. उदाहरण के लिए:

startTime,endTime,targeting.geoTargeting

मास्क पढ़ें

रीड मास्क यह कंट्रोल करते हैं कि एपीआई रिस्पॉन्स में कौनसे फ़ील्ड मौजूद होंगे. आपके पास अपने अनुरोध पर मास्क दो तरीकों से पढ़ें:

  1. fields क्वेरी पैरामीटर:

    curl https://admanager.googleapis.com/v1/networks/123456/adUnits?fields=adUnits,nextPageToken,totalSize

  2. X-Goog-FieldMask एचटीटीपी हेडर:

    curl -H "X-Goog-FieldMask: adUnits,nextPageToken,totalSize" \
    https://admanager.googleapis.com/v1/networks/123456/adUnits

डिफ़ॉल्ट रीड मास्क

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

फ़ील्ड मास्क में, इन फ़ील्ड का अनुरोध साफ़ तौर पर नाम से या इसके ज़रिए किया जाना चाहिए * वाइल्डकार्ड का इस्तेमाल करके.

मास्क अपडेट करें

अपडेट मास्क यह कंट्रोल करते हैं कि अपडेट में किन फ़ील्ड में बदलाव किया जाएगा (PATCH) अनुरोध. अपडेट मास्क सेट होने पर, सिर्फ़ मास्क के फ़ील्ड अपडेट किए जाएंगे भले ही, अनुरोध के मुख्य हिस्से में कौनसे फ़ील्ड सेट हों.

अपडेट मास्क, क्वेरी पैरामीटर के तौर पर सेट किए जाते हैं. उदाहरण के लिए:

curl -X PATCH https://admanager.googleapis.com/v1/networks/1234/order/4567?updateMask=displayName

फ़ील्ड ट्रैवर्सल

फ़ील्ड मास्क, किसी इकाई में . वर्ण का इस्तेमाल करके फ़ील्ड तय कर सकते हैं ट्रैवर्सल. यह वही सिंटैक्स है जिसका इस्तेमाल किया गया है फ़िल्टर.

फ़ील्ड मास्क हमेशा रिस्पॉन्स ऑब्जेक्ट के सापेक्ष होते हैं. उदाहरण के लिए, LineItem को पढ़ने में primaryGoal.units शामिल हो सकता है. इससे जुड़ा मास्क लिस्टिंग के लिए LineItems lineItems.primaryGoal.units है.

आपके पास किसी पूरे फ़ील्ड या उसके किसी सबफ़ील्ड को चुनने का विकल्प होता है. दोनों primaryGoal और primaryGoal.units मान्य हैं.

यह दोहराए गए फ़ील्ड पर भी लागू होता है. LineItem का फ़ील्ड मास्क creativePlaceholders.size मान्य है और इसमें सिर्फ़ size फ़ील्ड शामिल है हर CreativePlaceholder के लिए.

वाइल्डकार्ड

फ़ील्ड मास्क, * वर्ण के साथ काम करते हैं. यह वर्ण, मैसेज के सभी फ़ील्ड दिखाता है. नीचे दिए गए उदाहरणों में, लिस्टिंग में वाइल्डकार्ड के इस्तेमाल के बारे में बताया गया है Orders. इस तरीके का डिफ़ॉल्ट रीड मास्क होता है, जो total_size फ़ील्ड को शामिल नहीं करना चाहिए.

उदाहरण मतलब
* total_size समेत सभी फ़ील्ड शामिल हैं
orders सिर्फ़ orders फ़ील्ड और इसके सभी सबफ़ील्ड शामिल हैं
orders.* सिर्फ़ orders फ़ील्ड और इसके सभी सबफ़ील्ड शामिल हैं

अमान्य फ़ील्ड

अगर फ़ील्ड मास्क किसी ऐसी वैल्यू के बारे में बताता है जो मौजूद नहीं है, तो एपीआई जवाब देगा INVALID_ARGUMENT गड़बड़ी हुई.