फ़ील्ड मास्क का इस्तेमाल करना

फ़ील्ड मास्क एक ऐसा तरीका है जिसकी मदद से एपीआई कॉल करने वाले, अनुरोध किए जाने वाले फ़ील्ड की सूची बना सकते हैं वापस लौटाने या अपडेट करने के लिए. इसका इस्तेमाल करके FieldMask इसकी मदद से, एपीआई को गैर-ज़रूरी काम से बचने और परफ़ॉर्मेंस को बेहतर बनाने में मदद मिलती है. फ़ील्ड मास्क इसका इस्तेमाल Google Sheets API में, पढ़ने और अपडेट करने के तरीकों के लिए किया जाता है.

फ़ील्ड मास्क की मदद से पढ़ना

स्प्रेडशीट बड़ी हो सकती हैं और अक्सर आपको स्प्रेडशीट के हर हिस्से की ज़रूरत नहीं होती Spreadsheet पढ़ने के अनुरोध से मिला संसाधन. आप यह तय कर सकते हैं कि fields यूआरएल पैरामीटर का इस्तेमाल करके, Sheets API का रिस्पॉन्स. सर्वश्रेष्ठ के लिए परफ़ॉर्मेंस, साफ़ तौर पर सिर्फ़ उन फ़ील्ड की जानकारी दें जिनकी आपको ज़रूरत है जवाब में.

फ़ील्ड पैरामीटर का फ़ॉर्मैट वही होता है जो FieldMask की JSON एन्कोडिंग. संक्षेप में, कई अलग-अलग फ़ील्ड कॉमा लगाकर अलग किए गए होते हैं और सबफ़ील्ड डॉट से अलग किया हुआ. फ़ील्ड के नाम camelCase में दिए जा सकते हैं या separated_by_underscores. सुविधा के लिए, एक ही प्रॉपर्टी से कई सबफ़ील्ड टाइप को ब्रैकेट में रखा जा सकता है.

नीचे दिए गए spreadsheets.get अनुरोध उदाहरण: sheets.properties(sheetId,title,sheetType,gridProperties) के फ़ील्ड मास्क का इस्तेमाल करके सिर्फ़ शीट आईडी, टाइटल फ़ेच करें, SheetType, और GridProperties एक SheetProperties ऑब्जेक्ट:

GET https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId?fields=sheets.properties(sheetId,title,sheetType,gridProperties)

इस तरीके से मिले कॉल का जवाब Spreadsheet ऑब्जेक्ट है, जिसमें फ़ील्ड मास्क में अनुरोध किए गए कॉम्पोनेंट हैं. ध्यान दें कि sheetType=OBJECT में gridProperties शामिल नहीं हैं:

{
  "sheets": [
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "TITLE",
        "sheetType": "GRID",
        "gridProperties": {
          "rowCount": 1000,
          "columnCount": 25
        }
      }
    },
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "TITLE",
        "sheetType": "OBJECT"
      }
    }
  ]
}

फ़ील्ड मास्क से अपडेट करना

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

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

अपडेट फ़ील्ड मास्क का सिंटैक्स और रीड फ़ील्ड मास्क एक जैसे होते हैं.

नीचे दिए गए उदाहरण में AddSheetRequest Grid टाइप की नई शीट जोड़ने के लिए, पहली पंक्ति को फ़्रीज़ करें और नई शीट में रंग भरें शीट का टैब लाल:

POST https://sheets.googleapis.com/v1/spreadsheets/spreadsheetId:batchUpdate

{
  "spreadsheetId": "SPREADSHEET_ID",
  "replies": [
    {
      "addSheet": {
        "properties": {
          "sheetId": SHEET_ID,
          "title": "TITLE",
          "index": 6,
          "sheetType": "GRID",
          "gridProperties": {
            "rowCount": 1000,
            "columnCount": 26,
            "frozenRowCount": 1
          },
          "tabColor": {
            "red": 0.003921569
          },
          "tabColorStyle": {
            "rgbColor": {
              "red": 0.003921569
            }
          }
        }
      }
    }
  ]
}