शीट से जुड़ी कार्रवाइयां

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

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

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

कोई शीट जोड़ना

इस spreadsheets.batchUpdate कोड के सैंपल में, AddSheetRequest का इस्तेमाल करके स्प्रेडशीट में कोई शीट जोड़ने का तरीका बताया गया है. साथ ही, इसमें टाइटल, ग्रिड का साइज़, और टैब का रंग सेट करने का तरीका भी बताया गया है.

जवाब में एक AddSheetResponse होता है. इसमें बनाई गई शीट की प्रॉपर्टी (जैसे कि उसका SHEET_ID) वाला एक ऑब्जेक्ट होता है.

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

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "addSheet": {
        "properties": {
          "title": "Deposits",
          "gridProperties": {
            "rowCount": 20,
            "columnCount": 12
          },
          "tabColor": {
            "red": 1.0,
            "green": 0.3,
            "blue": 0.4
          }
        }
      }
    }
  ]
}

फ़ॉर्मैट को सुरक्षित रखते हुए, किसी शीट की सभी वैल्यू मिटाना

यहां दिए गए spreadsheets.batchUpdate कोड सैंपल में बताया गया है कि फ़ॉर्मैटिंग में बदलाव किए बिना, किसी शीट से सभी वैल्यू हटाने के लिए UpdateCellsRequest का इस्तेमाल कैसे किया जाता है.

userEnteredValue फ़ील्ड में कोई वैल्यू न डालने का मतलब है कि रेंज में मौजूद वैल्यू मिटाने का निर्देश दिया गया है. इस सेटिंग का इस्तेमाल, अन्य फ़ील्ड के साथ भी किया जा सकता है. उदाहरण के लिए, fields वैल्यू को userEnteredFormat में बदलने से, Sheets API के साथ काम करने वाली सभी फ़ॉर्मैटिंग हट जाती है. हालांकि, सेल की वैल्यू में कोई बदलाव नहीं होता.

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

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "updateCells": {
        "range": {
          "sheetId": SHEET_ID
        },
        "fields": "userEnteredValue"
      }
    }
  ]
}

किसी शीट को एक स्प्रेडशीट से दूसरी स्प्रेडशीट में कॉपी करना

यहां दिए गए spreadsheet.sheets.copyTo कोड सैंपल में, SHEET_ID से तय की गई किसी एक शीट को एक स्प्रेडशीट से दूसरी स्प्रेडशीट में कॉपी करने का तरीका बताया गया है.

अनुरोध के मुख्य हिस्से में मौजूद TARGET_SPREADSHEET_ID वैरिएबल, डेस्टिनेशन स्प्रेडशीट के बारे में बताता है. कॉपी में, ओरिजनल चार्ट की सभी वैल्यू, फ़ॉर्मैटिंग, फ़ॉर्मूले, और अन्य प्रॉपर्टी बनी रहती हैं. कॉपी की गई शीट का टाइटल, "[ओरिजनल शीट का टाइटल] की कॉपी" के तौर पर सेट होता है.

जवाब में, बनाई गई शीट की प्रॉपर्टी के बारे में बताने वाला SheetProperties ऑब्जेक्ट होता है.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/sheets/SHEET_ID:copyTo

{
  "destinationSpreadsheetId": "TARGET_SPREADSHEET_ID"
}

किसी शीट को मिटाना

यहां दिए गए spreadsheets.batchUpdate कोड के उदाहरण में, SHEET_ID में दी गई शीट को मिटाने के लिए DeleteSheetRequest का इस्तेमाल करने का तरीका दिखाया गया है.

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

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "deleteSheet": {
        "sheetId": SHEET_ID
      }
    }
  ]
}

शीट का डेटा पढ़ने की अनुमति

यहां दिए गए spreadsheets.get कोड सैंपल में, SHEET_ID और SPREADSHEET_ID से तय की गई स्प्रेडशीट से sheet प्रॉपर्टी की जानकारी पाने का तरीका बताया गया है. इस तरीके का इस्तेमाल अक्सर किसी स्प्रेडशीट में मौजूद शीट के मेटाडेटा का पता लगाने के लिए किया जाता है, ताकि अन्य कार्रवाइयां उन शीट को टारगेट कर सकें. fields क्वेरी पैरामीटर से यह तय किया जाता है कि सिर्फ़ शीट की प्रॉपर्टी का डेटा दिखाया जाए. इसमें सेल की वैल्यू का डेटा या पूरी स्प्रेडशीट से जुड़ा डेटा शामिल नहीं होता.

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID?&fields=sheets.properties

जवाब में एक Spreadsheet संसाधन होता है. इसमें Sheet ऑब्जेक्ट होता है. साथ ही, इसमें SheetProperties एलिमेंट होते हैं. अगर किसी जवाब वाले फ़ील्ड को डिफ़ॉल्ट वैल्यू पर सेट किया जाता है, तो उसे जवाब से हटा दिया जाता है.

{
  "sheets": [
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "Sheet1",
        "index": 0,
        "sheetType": "GRID",
        "gridProperties": {
          "rowCount": 100,
          "columnCount": 20,
          "frozenRowCount": 1
        }
        "tabColor": {
          "blue": 1.0
        }
      },
      ...
  ],
}