नाम वाली और सुरक्षित की गई रेंज

Google Sheets API से, आप नाम वाली या सुरक्षित की गई रेंज बना सकते हैं, उनमें बदलाव कर सकते हैं, और उन्हें मिटा सकते हैं. इस पेज पर दिए गए उदाहरणों में बताया गया है कि Sheets API की मदद से, Sheets की कुछ सामान्य कार्रवाइयां कैसे की जा सकती हैं.

ये उदाहरण, न्यूट्रल भाषा में एचटीटीपी अनुरोधों के रूप में दिखाए जाते हैं. Google API क्लाइंट लाइब्रेरी का इस्तेमाल करके, बैच अपडेट को अलग-अलग भाषाओं में लागू करने का तरीका जानने के लिए, स्प्रेडशीट अपडेट करें देखें.

इन उदाहरणों में, SPREADSHEET_ID और SHEET_ID प्लेसहोल्डर से पता चलता है कि आपको आईडी कहां देने हैं. स्प्रेडशीट आईडी को स्प्रेडशीट के यूआरएल में देखा जा सकता है. spreadsheets.get तरीके का इस्तेमाल करके, शीट का आईडी पाया जा सकता है. रेंज को A1 नोटेशन का इस्तेमाल करके बताया जाता है. उदाहरण के लिए, Sheet1!A1:D5 रेंज है.

इसके अलावा, प्लेसहोल्डर NAMED_RANGE_ID और PROTECTED_RANGE_ID नाम और सुरक्षित की गई रेंज के आईडी देते हैं. namedRangeId और protectedRangeId का इस्तेमाल, इनसे जुड़ी रेंज को अपडेट करने या मिटाने का अनुरोध करते समय किया जाता है. यह आईडी, Sheets API के ऐसे अनुरोध के जवाब में दिया जाता है जो नाम या सुरक्षित की गई रेंज बनाता है. spreadsheets.get तरीके से मौजूदा रेंज के आईडी, Spreadsheet रिस्पॉन्स के मुख्य हिस्से में पाए जा सकते हैं.

नाम वाली या सुरक्षित की गई रेंज जोड़ें

नीचे दिया गया spreadsheets.batchUpdate कोड सैंपल, अनुरोध वाले दो ऑब्जेक्ट को इस्तेमाल करने का तरीका बताता है. पहला, AddNamedRangeRequest का इस्तेमाल करके, A1:E3 रेंज को "गिनती" कहते हैं. दूसरा चरण, A4:E4 रेंज में चेतावनी के लेवल की सुरक्षा देने के लिए AddProtectedRangeRequest का इस्तेमाल करता है. इस लेवल सुरक्षा अब भी रेंज के अंदर की सेल में बदलाव करने देती है, लेकिन बदलाव करने से पहले चेतावनी देने के लिए कहती है.

ये अनुरोध, रेंज आईडी और प्रॉपर्टी वाले AddNamedRangeResponse और AddProtectedRangeResponse दिखते हैं.

अनुरोध का प्रोटोकॉल नीचे दिखाया गया है.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "addNamedRange": {
        "namedRange": {
          "name": "Counts",
          "range": {
            "sheetId": SHEET_ID,
            "startRowIndex": 0,
            "endRowIndex": 3,
            "startColumnIndex": 0,
            "endColumnIndex": 5,
          },
        }
      }
    },
    {
      "addProtectedRange": {
        "protectedRange": {
          "range": {
            "sheetId": SHEET_ID,
            "startRowIndex": 3,
            "endRowIndex": 4,
            "startColumnIndex": 0,
            "endColumnIndex": 5,
          },
          "description": "Protecting total row",
          "warningOnly": true
        }
      }
    }
  ]
}

नाम वाली या सुरक्षित की गई रेंज मिटाएं

नीचे दिया गया spreadsheets.batchUpdate कोड सैंपल, अनुरोध वाले दो ऑब्जेक्ट को इस्तेमाल करने का तरीका बताता है. पहला, किसी मौजूदा नाम वाली रेंज को मिटाने के लिए, DeleteNamedRangeRequest का इस्तेमाल करता है. इसके लिए, पिछले एपीआई कॉल से NAMED_RANGE_ID का इस्तेमाल किया जाता है. दूसरा, किसी मौजूदा रेंज की सुरक्षा को मिटाने के लिए DeleteProtectedRangeRequest का इस्तेमाल करता है. इसके लिए, पिछले एपीआई कॉल से PROTECTED_RANGE_ID का इस्तेमाल किया जाता है.

अनुरोध का प्रोटोकॉल नीचे दिखाया गया है.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "deleteNamedRange": {
          "namedRangeId": "NAMED_RANGE_ID",
      }
    },
    {
      "deleteProtectedRange": {
        "protectedRangeId": PROTECTED_RANGE_ID,
      }
    }
  ]
}

नाम वाली या सुरक्षित की गई रेंज अपडेट करें

नीचे दिया गया spreadsheets.batchUpdate कोड सैंपल, अनुरोध वाले दो ऑब्जेक्ट को इस्तेमाल करने का तरीका बताता है. पहले UpdateNamedRangeRequest का इस्तेमाल करके, किसी मौजूदा नाम वाली रेंज के नाम को "InitialCounts" में अपडेट किया जाता है. इसके लिए, पिछले एपीआई कॉल के NAMED_RANGE_ID का इस्तेमाल किया जाता है. दूसरा, UpdateProtectedRangeRequest का इस्तेमाल करके, मौजूदा सुरक्षित रेंज को अपडेट करता है, ताकि वह अब नाम वाली उसी रेंज को सुरक्षित रख सके. Editors वाला तरीका सिर्फ़ सूची में शामिल उपयोगकर्ताओं को सेल में बदलाव करने की अनुमति देता है. इस अनुरोध में, पिछले एपीआई कॉल के NAMED_RANGE_ID और PROTECTED_RANGE_ID इस्तेमाल किए जाते हैं.

अनुरोध का प्रोटोकॉल नीचे दिखाया गया है.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "updateNamedRange": {
        "namedRange": {
          "namedRangeId": NAMED_RANGE_ID,
          "name": "InitialCounts",
        },
        "fields": "name",
      }
    },
    {
      "updateProtectedRange": {
        "protectedRange": {
          "protectedRangeId": PROTECTED_RANGE_ID,
          "namedRangeId": NAMED_RANGE_ID,
          "warningOnly": false,
          "editors": {
            "users": [
              "charlie@example.com",
              "sasha@example.com"
            ]
          }
        },
        "fields": "namedRangeId,warningOnly,editors"
      }
    }
  ]
}