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

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

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