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

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

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

इन उदाहरणों में, SPREADSHEET_ID और SHEET_ID प्लेसहोल्डर से पता चलता है कि आपको ऐसे आईडी कहां देने हैं. स्प्रेडशीट के यूआरएल में, स्प्रेडशीट आईडी देखा जा सकता है. spreadsheets.get तरीके का इस्तेमाल करके, शीट आईडी पाया जा सकता है. रेंज की जानकारी, A1 नोटेशन का इस्तेमाल करके दी जाती है. उदाहरण के लिए, Sheets1!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 कोड सैंपल, DeleteSheetRequest का इस्तेमाल करके, SHEET_ID की बताई गई शीट को मिटाने का तरीका बताता है.

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

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 संसाधन शामिल होते हैं, जिसमें SheetProperties एलिमेंट वाला Sheet ऑब्जेक्ट होता है. अगर दिया गया रिस्पॉन्स फ़ील्ड डिफ़ॉल्ट वैल्यू पर सेट है, तो उसे रिस्पॉन्स में शामिल नहीं किया जाता.

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