स्प्रेडशीट बनाना और उन्हें मैनेज करना

इस दस्तावेज़ में, Google Sheets API का इस्तेमाल करके, Google Sheets में स्प्रेडशीट बनाने और उन्हें मैनेज करने का तरीका बताया गया है.

स्प्रेडशीट बनाएं

Sheets में फ़ाइल बनाने के लिए, बिना किसी पैरामीटर के spreadsheets रिसॉर्स पर create तरीके का इस्तेमाल करें.

फ़ाइल बनाते समय, यह तरीका spreadsheets संसाधन दिखाता है. जवाब में मिले संसाधन में spreadsheetId, properties, sheets की सूची, और spreadsheetUrl शामिल है.

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

Apps Script

sheets/api/spreadsheet_snippets.gs

GitHub पर देखें

/**
 * Creates a new sheet using the sheets advanced services
 * @param {string} title the name of the sheet to be created
 * @returns {string} the spreadsheet ID
 */
Snippets.prototype.create = (title) => {
  // This code uses the Sheets Advanced Service, but for most use cases
  // the built-in method SpreadsheetApp.create() is more appropriate.
  try {
    const sheet = Sheets.newSpreadsheet();
    sheet.properties = Sheets.newSpreadsheetProperties();
    sheet.properties.title = title;
    const spreadsheet = Sheets.Spreadsheets.create(sheet);

    return spreadsheet.spreadsheetId;
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed with error %s", err.message);
  }
};

Java

sheets/snippets/src/main/java/Create.java

GitHub पर देखें

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.Spreadsheet;
import com.google.api.services.sheets.v4.model.SpreadsheetProperties;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.Collections;

/* Class to demonstrate the use of Spreadsheet Create API */
public class Create {
  /**
   * Create a new spreadsheet.
   *
   * @param title - the name of the sheet to be created.
   * @return newly created spreadsheet id
   * @throws IOException - if credentials file not found.
   */
  public static String createSpreadsheet(String title) 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();

    // Create new spreadsheet with a title
    Spreadsheet spreadsheet = new Spreadsheet()
        .setProperties(new SpreadsheetProperties()
            .setTitle(title));
    spreadsheet = service.spreadsheets().create(spreadsheet)
        .setFields("spreadsheetId")
        .execute();
    // Prints the new spreadsheet id
    System.out.println("Spreadsheet ID: " + spreadsheet.getSpreadsheetId());
    return spreadsheet.getSpreadsheetId();
  }
}

JavaScript

sheets/snippets/sheets_create.js

GitHub पर देखें

function create(title, callback) {
  try {
    gapi.client.sheets.spreadsheets.create({
      properties: {
        title: title,
      },
    }).then((response) => {
      if (callback) callback(response);
      console.log('Spreadsheet ID: ' + response.result.spreadsheetId);
    });
  } catch (err) {
    document.getElementById('content').innerText = err.message;
    return;
  }
}

Node.js

sheets/snippets/sheets_create.js

GitHub पर देखें

import {GoogleAuth} from 'google-auth-library';
import {google} from 'googleapis';

/**
 * Creates a new Google Spreadsheet.
 * @param {string} title The title of the new spreadsheet.
 * @return {string} The ID of the created spreadsheet.
 */
async function create(title) {
  // Authenticate with Google and get an authorized client.
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/spreadsheets',
  });

  // Create a new Sheets API client.
  const service = google.sheets({version: 'v4', auth});

  // The resource body for creating a new spreadsheet.
  const resource = {
    properties: {
      title,
    },
  };

  // Create the new spreadsheet.
  const spreadsheet = await service.spreadsheets.create({
    resource,
    fields: 'spreadsheetId',
  });

  // Log the ID of the new spreadsheet.
  console.log(`Spreadsheet ID: ${spreadsheet.data.spreadsheetId}`);
  return spreadsheet.data.spreadsheetId;
}

PHP

sheets/snippets/src/SpreadsheetCreate.php

GitHub पर देखें

<?php
use Google\Client;
use Google\Service\Drive;
use Google\Service\Sheets\SpreadSheet;

/**
* create an empty spreadsheet
* 
*/

 function create($title)
    {   
        /* 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{

            $spreadsheet = new Google_Service_Sheets_Spreadsheet([
                'properties' => [
                    'title' => $title
                    ]
                ]);
                $spreadsheet = $service->spreadsheets->create($spreadsheet, [
                    'fields' => 'spreadsheetId'
                ]);
                printf("Spreadsheet ID: %s\n", $spreadsheet->spreadsheetId);
                return $spreadsheet->spreadsheetId;
        }
        catch(Exception $e) {
            // TODO(developer) - handle error appropriately
            echo 'Message: ' .$e->getMessage();
          }
    }

Python

sheets/snippets/sheets_create.py

GitHub पर देखें

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


def create(title):
  """
  Creates the Sheet 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)
    spreadsheet = {"properties": {"title": title}}
    spreadsheet = (
        service.spreadsheets()
        .create(body=spreadsheet, fields="spreadsheetId")
        .execute()
    )
    print(f"Spreadsheet ID: {(spreadsheet.get('spreadsheetId'))}")
    return spreadsheet.get("spreadsheetId")
  except HttpError as error:
    print(f"An error occurred: {error}")
    return error


if __name__ == "__main__":
  # Pass: title
  create("mysheet1")

Ruby

sheets/snippets/lib/spreadsheet_snippets.rb

GitHub पर देखें

spreadsheet = {
  properties: {
    title: 'Sales Report'
  }
}
spreadsheet = service.create_spreadsheet(spreadsheet,
                                         fields: 'spreadsheetId')
puts "Spreadsheet ID: #{spreadsheet.spreadsheet_id}"

Google Drive फ़ोल्डर में स्प्रेडशीट व्यवस्थित करना

डिफ़ॉल्ट रूप से, बनाई गई स्प्रैडशीट, उपयोगकर्ता के Google Drive के रूट फ़ोल्डर में सेव होती है.

अगर आपको किसी स्प्रेडशीट को Drive के किसी फ़ोल्डर में सेव करना है, तो इनमें से कोई तरीका अपनाएं:

• स्प्रेडशीट फ़ाइल बनाने के बाद, उसे किसी फ़ोल्डर में ले जाएं. इसके लिए, Google Drive API के files रिसॉर्स पर update तरीके का इस्तेमाल करें. ज़्यादा जानकारी के लिए, फ़ाइलों को एक फ़ोल्डर से दूसरे फ़ोल्डर में ले जाना लेख पढ़ें.

• Drive API के files रिसॉर्स पर create तरीके का इस्तेमाल करके, किसी फ़ोल्डर में खाली स्प्रेडशीट जोड़ें. इसके लिए, application/vnd.google-apps.spreadsheet को mimeType के तौर पर तय करें. फ़ाइलें बनाने के बारे में ज़्यादा जानकारी के लिए, किसी फ़ोल्डर में फ़ाइल बनाना लेख पढ़ें. MIME टाइप के बारे में ज़्यादा जानकारी के लिए, Google Workspace और Google Drive के साथ काम करने वाले MIME टाइप लेख पढ़ें.

इन दोनों विकल्पों में से किसी एक को चुनने पर, आपको कॉल को अनुमति देने के लिए, सही Drive API स्कोप जोड़ने होंगे.

अगर आपका ऐप्लिकेशन किसी सेवा खाते का इस्तेमाल कर रहा है, तो बनाई गई स्प्रेडशीट का मालिकाना हक सेवा खाते के पास होता है. इसके बाद, यह फ़ाइल सेवा खाते के Drive स्टोरेज में सेव हो जाती है. जब तक साफ़ तौर पर शेयर नहीं किया जाता, तब तक फ़ाइलें Drive के अन्य स्टोरेज खातों में नहीं दिखतीं. ज़्यादा जानकारी के लिए, फ़ाइल का मालिकाना हक लेख पढ़ें.

शेयर की गई ड्राइव के फ़ोल्डर में किसी फ़ाइल को ले जाने या बनाने के लिए, शेयर की गई ड्राइव के साथ काम करने की सुविधा लागू करना लेख पढ़ें.

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

स्प्रेडशीट पाना

स्प्रेडशीट पाने के लिए, spreadsheetId पाथ पैरामीटर के साथ spreadsheets रिसॉर्स पर get तरीके का इस्तेमाल करें.

यह तरीका, फ़ाइल को spreadsheets संसाधन के इंस्टेंस के तौर पर दिखाता है. डिफ़ॉल्ट रूप से, स्प्रेडशीट में मौजूद डेटा नहीं दिखाया जाता. जवाब में मिली संसाधन फ़ाइल में, स्प्रेडशीट का स्ट्रक्चर और मेटाडेटा होता है. इसमें स्प्रेडशीट की प्रॉपर्टी (जैसे कि टाइटल, स्थान-भाषा, और समय क्षेत्र) और शीट की कुछ खास जानकारी (जैसे कि फ़ॉर्मैटिंग और सुरक्षित रेंज) शामिल होती है.

spreadsheets संसाधन में डेटा शामिल करने के लिए, इन दो तरीकों का इस्तेमाल करें:

• fields सिस्टम पैरामीटर सेट करके, चुने गए फ़ील्ड की फ़ील्ड मास्क लिस्टिंग तय करें.

• बूलियन includeGridData क्वेरी पैरामीटर को true पर सेट करें. अगर फ़ील्ड मास्क सेट किया गया है, तो includeGridData पैरामीटर को अनदेखा कर दिया जाता है.

बड़ी स्प्रेडशीट के साथ काम करते समय, हमारा सुझाव है कि आप सिर्फ़ उन स्प्रेडशीट फ़ील्ड के लिए क्वेरी करें जिनकी आपको ज़रूरत है. get वाला तरीका, स्प्रेडशीट से जुड़ा सारा डेटा दिखाता है. इसलिए, बड़ी स्प्रेडशीट के लिए सामान्य क्वेरी धीमी हो सकती हैं. उदाहरण के लिए, किसी सेल से 100 नंबर को पढ़ने के लिए, spreadsheets.get सेल की वैल्यू के साथ-साथ मेटाडेटा (जैसे कि फ़ॉन्ट का नाम, साइज़ वगैरह) दिखाता है. इससे बड़े JSON पेलोड मिलते हैं जिन्हें पार्स करने में समय लगता है. इसकी तुलना में, values.get को किए गए इसी तरह के कॉल से सिर्फ़ सेल की वैल्यू मिलती है. इससे जवाब का साइज़ काफ़ी कम हो जाता है और वह तुरंत मिल जाता है.

spreadsheets.values संसाधन के बारे में ज़्यादा जानकारी के लिए, यहां दिए गए दस्तावेज़ देखें. इसमें spreadsheets.values.get और spreadsheets.values.batchGet शामिल हैं:

• सेल की वैल्यू पढ़ना और उनमें बदलाव करना
• सामान्य रीडिंग

स्प्रेडशीट की सूची बनाना

Sheets API, पुष्टि किए गए उपयोगकर्ताओं के लिए स्प्रेडशीट की सूची बनाने का तरीका उपलब्ध नहीं कराता है.

स्प्रेडशीट की सूची पाने के लिए, Drive API के files संसाधन पर list तरीके का इस्तेमाल किया जा सकता है. इसके लिए, application/vnd.google-apps.spreadsheet को mimeType के तौर पर तय करें:

HTTP

GET https://www.googleapis.com/drive/v3/files?q=mimeType='application/vnd.google-apps.spreadsheet'

cURL

curl -X GET "https://www.googleapis.com/drive/v3/files?q=mimeType='application/vnd.google-apps.spreadsheet'" \
 -H "Authorization: Bearer ACCESS_TOKEN" \
 -H "Accept: application/json"

ACCESS_TOKEN को उस ऐक्सेस टोकन से बदलें जो एपीआई का ऐक्सेस देता है.

किसी उपयोगकर्ता की स्प्रेडशीट की सूची बनाने के लिए, files.list तरीके का इस्तेमाल करने के लिए, Drive API के सीमित स्कोप की ज़रूरत होती है.

मिलते-जुलते विषय

यहां कुछ ऐसे तरीके दिए गए हैं जिन्हें आज़माया जा सकता है:

• स्प्रेडशीट अपडेट करने के लिए, स्प्रेडशीट अपडेट करना लेख पढ़ें.

• स्मार्ट चिप इस्तेमाल करने के लिए, स्मार्ट चिप लेख पढ़ें.

• डेवलपर मेटाडेटा का इस्तेमाल करने के लिए, मेटाडेटा को पढ़ना, लिखना, और खोजना लेख पढ़ें.