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

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 से तय की गई स्प्रेडशीट से शीट प्रॉपर्टी की जानकारी पाने का तरीका बताया गया है. इस तरीके का इस्तेमाल अक्सर किसी खास स्प्रेडशीट में मौजूद शीट का मेटाडेटा तय करने के लिए किया जाता है, ताकि अन्य कार्रवाइयां उन शीट को टारगेट कर सकें. 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
        }
      },
      ...
  ],
}