स्प्रेडशीट अपडेट करें

स्प्रेडशीट में सेल में मौजूद वैल्यू के डेटा के अलावा, कई तरह का अन्य डेटा भी शामिल होता है. जैसे:

• आयाम
• सेल के फ़ॉर्मैट और बॉर्डर
• नाम वाली रेंज
• सुरक्षित की गई रेंज
• कंडिशनल यानी शर्त के साथ फ़ॉर्मैटिंग की सुविधा

ये कई तरह के डेटा में से कुछ हैं, जो स्प्रेडशीट के दिखने और काम करने के तरीके को कंट्रोल करते हैं. spreadsheets.batchUpdate तरीके की मदद से, स्प्रेडशीट की इनमें से किसी भी जानकारी को अपडेट किया जा सकता है. बदलावों को एक बैच में ग्रुप किया जाता है, ताकि अगर एक अनुरोध पूरा न हो पाए, तो दूसरे (संभावित रूप से डिपेंडेंट) बदलावों को भी न लिखा जाए.

इस पेज पर, spreadsheets.batchUpdate तरीके का इस्तेमाल करने के बारे में बुनियादी जानकारी दी गई है. अगर आपको सेल वैल्यू का डेटा पढ़ना और उसमें बदलाव करना है, तो सेल वैल्यू पढ़ना और उनमें बदलाव करना में बताए गए spreadsheets.values संसाधन का भी इस्तेमाल किया जा सकता है.

ऑपरेशन की कैटगरी

spreadsheets.batchUpdate के साथ काम करने वाले खास ऑपरेशन को इन बड़ी कैटगरी में बांटा जा सकता है:

कैटगरी	ब्यौरा
जोड़ें (और डुप्लीकेट करें)	नए ऑब्जेक्ट जोड़ें. कभी-कभी, ये पुराने ऑब्जेक्ट के आधार पर जोड़े जाते हैं, जैसे कि डुप्लीकेट अनुरोधों में.
अपडेट करें (और सेट करें)	किसी ऑब्जेक्ट की कुछ प्रॉपर्टी अपडेट करें. आम तौर पर, पुरानी प्रॉपर्टी को अपडेट नहीं किया जाता. वहीं, सेट अनुरोध से पुराने डेटा को बदल दिया जाता है.
मिटाएं	ऑब्जेक्ट हटाएं.

अगले सेक्शन में, इन कैटगरी का इस्तेमाल खास ऑपरेशन के व्यवहार के बारे में बताने के लिए किया जाता है.

एक साथ कई आइटम अपडेट करने की कार्रवाइयां

spreadsheets.batchUpdate तरीका, एक या एक से ज़्यादा Request ऑब्जेक्ट लेकर काम करता है. हर ऑब्जेक्ट, एक तरह के अनुरोध के बारे में बताता है. अनुरोध कई तरह के होते हैं. यहां अलग-अलग कैटगरी में बांटकर, अनुरोधों के टाइप के बारे में जानकारी दी गई है.

ऑब्जेक्ट	जोड़ें / डुप्लीकेट	UPDATE / SET	मिटाएं
स्प्रेडशीट प्रॉपर्टी		UpdateSpreadsheetPropertiesRequest
Sheets	AddSheetRequest DuplicateSheetRequest	UpdateSheetPropertiesRequest	DeleteSheetRequest
डाइमेंशन (इसमें डाइमेंशन की रेंज भी शामिल है)	InsertDimensionRequest AppendDimensionRequest	UpdateDimensionPropertiesRequest MoveDimensionRequest AutoResizeDimensionsRequest	DeleteDimensionRequest
सेल (इसमें वैल्यू, फ़ॉर्मैट, डेटा की पुष्टि वगैरह शामिल हैं)		RepeatCellRequest UpdateCellsRequest AppendCellsRequest
नाम वाली रेंज	AddNamedRangeRequest	UpdateNamedRangeRequest	DeleteNamedRangeRequest
बॉर्डर		UpdateBordersRequest
फ़िल्टर (इनमें फ़िल्टर व्यू और सामान्य फ़िल्टर शामिल हैं)	AddFilterViewRequest DuplicateFilterViewRequest	UpdateFilterViewRequest SetBasicFilterRequest	ClearBasicFilterRequest
डेटा की पुष्टि करना		SetDataValidationRequest
शर्त के साथ फ़ॉर्मैटिंग के नियम	AddConditionalFormatRuleRequest	UpdateConditionalFormatRuleRequest	DeleteConditionalFormatRuleRequest
सुरक्षित की गई रेंज	AddProtectedRangeRequest	UpdateProtectedRangeRequest	DeleteProtectedRangeRequest
एम्बेड किए गए ऑब्जेक्ट (इसमें चार्ट भी शामिल हैं)	AddChartRequest	UpdateChartSpecRequest UpdateEmbeddedObjectPositionRequest	DeleteEmbeddedObjectRequest
मर्ज	MergeCellsRequest		UnmergeCellsRequest

डेटा में बदलाव करने के लिए, उपयोगकर्ता की कार्रवाइयों की नकल करने वाले कुछ और अनुरोध भी होते हैं:

• AutoFillRequest
• CutPasteRequest
• CopyPasteRequest
• FindReplaceRequest
• PasteDataRequest
• TextToColumnsRequest
• SortRangeRequest

सीमाएं

Google Sheets में सेल और पंक्तियों की सीमाओं के बारे में ज़्यादा जानने के लिए, Google Drive में सेव की जा सकने वाली फ़ाइलें लेख पढ़ें.

फ़ील्ड मास्क

"अपडेट" करने के कई अनुरोधों के लिए, फ़ील्ड मास्क की ज़रूरत होती है. ये फ़ील्ड की सूची होती है, जिसमें कॉमा लगा होता है. इनका इस्तेमाल करके, किसी ऑब्जेक्ट के सिर्फ़ कुछ फ़ील्ड को अपडेट किया जा सकता है. बाकी फ़ील्ड में कोई बदलाव नहीं होता. * फ़ील्ड मास्क को वाइल्डकार्ड की तरह माना जाता है. साथ ही, यह मैसेज में हर फ़ील्ड की जानकारी देने का शॉर्टहैंड है. इसका मतलब है कि अगर अनुरोध में किसी फ़ील्ड के लिए वैल्यू नहीं दी जाती है, तो वह फ़ील्ड अपनी डिफ़ॉल्ट स्थिति पर वापस आ सकता है. फ़ील्ड मास्क के बारे में ज़्यादा जानने के लिए, फ़ील्ड मास्क का इस्तेमाल करना लेख पढ़ें.

नीचे दिए गए सैंपल में, स्प्रेडशीट के सिर्फ़ टाइटल को अपडेट करने के लिए, UpdateSpreadsheetPropertiesRequest का इस्तेमाल किया गया है:

अनुरोध:

POST .../v4/spreadsheets/spreadsheetId:batchUpdate

अनुरोध का मुख्य हिस्सा:

{
  "requests": [{
      "updateSpreadsheetProperties": {
          "properties": {"title": "TITLE"},
          "fields": "title"
      }
  }]
}

TITLE को स्प्रेडशीट के नए टाइटल से बदलें.

जवाब

स्प्रेडशीट अपडेट करते समय, कुछ तरह के अनुरोधों के जवाब मिल सकते हैं. ये ऐरे में दिखाए जाते हैं. हर जवाब, उसी इंडेक्स में दिखता है जिसमें संबंधित अनुरोध दिखता है. कुछ अनुरोधों के लिए जवाब नहीं हैं और उनका जवाब खाली है.

आम तौर पर, "जोड़ें" अनुरोधों के जवाब में, जोड़े गए ऑब्जेक्ट का आईडी जैसी जानकारी मिलती है. इस्तेमाल किए जा सकने वाले रिस्पॉन्स की सूची देखने के लिए, रिस्पॉन्स देखें.

उदाहरण

यहां दिया गया कोड सैंपल, ये कार्रवाइयां करता है:

1. title वैरिएबल का इस्तेमाल करके, स्प्रेडशीट का टाइटल अपडेट करता है.
2. find और replacement वैरिएबल का इस्तेमाल करके, स्प्रेडशीट में सेल की वैल्यू ढूंढता है और उन्हें बदलता है.

Apps Script

sheets/api/spreadsheet_snippets.gs

GitHub पर देखना

/**
 * Updates the specified sheet using advanced sheet services
 * @param {string} spreadsheetId id of the spreadsheet to be updated
 * @param {string} title name of the sheet in the spreadsheet to be updated
 * @param {string} find string to be replaced
 * @param {string} replacement the string to replace the old data
 * @returns {*} the updated spreadsheet
 */
Snippets.prototype.batchUpdate = (spreadsheetId, title,
  find, replacement) => {
  // This code uses the Sheets Advanced Service, but for most use cases
  // the built-in method SpreadsheetApp.getActiveSpreadsheet()
  //     .getRange(range).setValues(values) is more appropriate.

  try {
    // Change the spreadsheet's title.
    let updateSpreadsheetPropertiesRequest =
      Sheets.newUpdateSpreadsheetPropertiesRequest();
    updateSpreadsheetPropertiesRequest.properties =
      Sheets.newSpreadsheetProperties();
    updateSpreadsheetPropertiesRequest.properties.title = title;
    updateSpreadsheetPropertiesRequest.fields = 'title';

    // Find and replace text.
    let findReplaceRequest = Sheets.newFindReplaceRequest();
    findReplaceRequest.find = find;
    findReplaceRequest.replacement = replacement;
    findReplaceRequest.allSheets = true;

    let requests = [Sheets.newRequest(), Sheets.newRequest()];
    requests[0].updateSpreadsheetProperties =
      updateSpreadsheetPropertiesRequest;
    requests[1].findReplace = findReplaceRequest;

    let batchUpdateRequest = Sheets.newBatchUpdateSpreadsheetRequest();
    batchUpdateRequest.requests = requests;

    // Add additional requests (operations)
    const result =
      Sheets.Spreadsheets.batchUpdate(batchUpdateRequest, spreadsheetId);
    return result;
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed with error %s', err.message);
  }
};

Java

sheets/snippets/src/main/java/BatchUpdate.java

GitHub पर देखना

import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.sheets.v4.Sheets;
import com.google.api.services.sheets.v4.SheetsScopes;
import com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest;
import com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetResponse;
import com.google.api.services.sheets.v4.model.FindReplaceRequest;
import com.google.api.services.sheets.v4.model.FindReplaceResponse;
import com.google.api.services.sheets.v4.model.Request;
import com.google.api.services.sheets.v4.model.SpreadsheetProperties;
import com.google.api.services.sheets.v4.model.UpdateSpreadsheetPropertiesRequest;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/* Class to demonstrate the use of Spreadsheet Batch Update API */
public class BatchUpdate {
  /**
   * Updates spreadsheet's title and cell values.
   *
   * @param spreadsheetId - Id of the spreadsheet.
   * @param title         - New title of the spreadsheet.
   * @param find          - Find cell values
   * @param replacement   - Replaced cell values
   * @return response metadata
   * @throws IOException - if credentials file not found.
   */
  public static BatchUpdateSpreadsheetResponse batchUpdate(String spreadsheetId,
                                                           String title,
                                                           String find,
                                                           String replacement)
      throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Collections.singleton(SheetsScopes.SPREADSHEETS));
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Create the sheets API client
    Sheets service = new Sheets.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Sheets samples")
        .build();

    List<Request> requests = new ArrayList<>();
    BatchUpdateSpreadsheetResponse response = null;
    try {
      // Change the spreadsheet's title.
      requests.add(new Request()
          .setUpdateSpreadsheetProperties(new UpdateSpreadsheetPropertiesRequest()
              .setProperties(new SpreadsheetProperties()
                  .setTitle(title))
              .setFields("title")));
      // Find and replace text.
      requests.add(new Request()
          .setFindReplace(new FindReplaceRequest()
              .setFind(find)
              .setReplacement(replacement)
              .setAllSheets(true)));

      BatchUpdateSpreadsheetRequest body =
          new BatchUpdateSpreadsheetRequest().setRequests(requests);
      response = service.spreadsheets().batchUpdate(spreadsheetId, body).execute();
      FindReplaceResponse findReplaceResponse = response.getReplies().get(1).getFindReplace();

      System.out.printf("%d replacements made.", findReplaceResponse.getOccurrencesChanged());
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      GoogleJsonError error = e.getDetails();
      if (error.getCode() == 404) {
        System.out.printf("Spreadsheet not found with id '%s'.\n", spreadsheetId);
      } else {
        throw e;
      }
    }
    return response;
  }
}

JavaScript

sheets/snippets/sheets_batch_update.js

GitHub पर देखना

function batchUpdate(spreadsheetId, title, find, replacement, callback) {
  const requests = [];
  // Change the spreadsheet's title.
  requests.push({
    updateSpreadsheetProperties: {
      properties: {
        title: title,
      },
      fields: 'title',
    },
  });
  // Find and replace text.
  requests.push({
    findReplace: {
      find: find,
      replacement: replacement,
      allSheets: true,
    },
  });
  try {
    // Add additional requests (operations) ...
    const batchUpdateRequest = {requests: requests};
    gapi.client.sheets.spreadsheets.batchUpdate({
      spreadsheetId: spreadsheetId,
      resource: batchUpdateRequest,
    }).then((response) => {
      const findReplaceResponse = response.result.replies[1].findReplace;
      console.log(`${findReplaceResponse.occurrencesChanged} replacements made.`);
      if (callback) callback(response);
    });
  } catch (err) {
    document.getElementById('content').innerText = err.message;
    return;
  }
}

Node.js

sheets/snippets/sheets_batch_update.js

GitHub पर देखना

/**
 * Updates the Spreadsheet title. Finds and replaces a string in the sheets.
 * @param {string} spreadsheetId The Spreadsheet to update
 * @param {string} title The new Spreadsheet title
 * @param {string} find The text to find
 * @param {string} replacement The text to replace
 * @return {obj} holding the information regarding the replacement of strings
 */
async function batchUpdate(spreadsheetId, title, find, replacement) {
  const {GoogleAuth} = require('google-auth-library');
  const {google} = require('googleapis');

  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/spreadsheets',
  });

  const service = google.sheets({version: 'v4', auth});
  const requests = [];
  // Change the spreadsheet's title.
  requests.push({
    updateSpreadsheetProperties: {
      properties: {
        title,
      },
      fields: 'title',
    },
  });
  // Find and replace text.
  requests.push({
    findReplace: {
      find,
      replacement,
      allSheets: true,
    },
  });
  // Add additional requests (operations) ...
  const batchUpdateRequest = {requests};
  try {
    const response = await service.spreadsheets.batchUpdate({
      spreadsheetId,
      resource: batchUpdateRequest,
    });
    const findReplaceResponse = response.data.replies[1].findReplace;
    console.log(`${findReplaceResponse.occurrencesChanged} replacements made.`);
    return response;
  } catch (err) {
    // TODO (developer) - Handle exception
    throw err;
  }
}

PHP

sheets/snippets/src/SpreadsheetBatchUpdate.php

GitHub पर देखना

use Google\Client;
use Google\Service\Drive;
use Google\Service\Sheets\BatchUpdateSpreadsheetRequest;

/**
 * to batch update a spreadsheet
 */
function batchUpdate($spreadsheetId, $title, $find, $replacement)
    {   
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
        $client = new Google\Client();
        $client->useApplicationDefaultCredentials();
        $client->addScope(Google\Service\Drive::DRIVE);
        $service = new Google_Service_Sheets($client);
        try{
            //execute the request
            $requests = [
                new Google_Service_Sheets_Request([
              'updateSpreadsheetProperties' => [
                  'properties' => [
                      'title' => $title
                    ],
                    'fields' => 'title'
              ]
          ]),
          new Google_Service_Sheets_Request([
              'findReplace' => [
                  'find' => $find,
                  'replacement' => $replacement,
                  'allSheets' => true
                  ]
                  ])
                ];
                $batchUpdateRequest = new Google_Service_Sheets_BatchUpdateSpreadsheetRequest([
                    'requests' => $requests
                ]);
        $response = $service->spreadsheets->batchUpdate($spreadsheetId, $batchUpdateRequest);
        $findReplaceResponse = $response->getReplies()[1]->getFindReplace();
        printf("%s replacements made.\n",
        $findReplaceResponse->getOccurrencesChanged());
        return $response;
    }
    catch(Exception $e) {
        // TODO(developer) - handle error appropriately
        echo 'Message: ' .$e->getMessage();
      }
    }

Python

sheets/snippets/sheets_batch_update.py

GitHub पर देखना

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def sheets_batch_update(spreadsheet_id, title, find, replacement):
  """
  Update the sheet details in batch, the user has access to.
  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """

  creds, _ = google.auth.default()
  # pylint: disable=maybe-no-member

  try:
    service = build("sheets", "v4", credentials=creds)

    requests = []
    # Change the spreadsheet's title.
    requests.append(
        {
            "updateSpreadsheetProperties": {
                "properties": {"title": title},
                "fields": "title",
            }
        }
    )
    # Find and replace text
    requests.append(
        {
            "findReplace": {
                "find": find,
                "replacement": replacement,
                "allSheets": True,
            }
        }
    )
    # Add additional requests (operations) ...

    body = {"requests": requests}
    response = (
        service.spreadsheets()
        .batchUpdate(spreadsheetId=spreadsheet_id, body=body)
        .execute()
    )
    find_replace_response = response.get("replies")[1].get("findReplace")
    print(
        f"{find_replace_response.get('occurrencesChanged')} replacements made."
    )
    return response

  except HttpError as error:
    print(f"An error occurred: {error}")
    return error


if __name__ == "__main__":
  sheets_batch_update("spreadsheet_id", "title", "find", "replacement")

Ruby

sheets/snippets/lib/spreadsheet_snippets.rb

GitHub पर देखना

requests = []
# Change the name of sheet ID '0' (the default first sheet on every
# spreadsheet)
requests.push({
                update_sheet_properties: {
                  properties: { sheet_id: 0, title: 'New Sheet Name' },
                  fields:     'title'
                }
              })
# Find and replace text
requests.push({
                find_replace: {
                  find:        find,
                  replacement: replacement,
                  all_sheets:  true
                }
              })
# Add additional requests (operations) ...

body = { requests: requests }
result = service.batch_update_spreadsheet(spreadsheet_id, body, {})
find_replace_response = result.replies[1].find_replace
puts "#{find_replace_response.occurrences_changed} replacements made."