Tworzenie arkuszy kalkulacyjnych i zarządzanie nimi

Z tego artykułu dowiesz się, jak tworzyć arkusze kalkulacyjne w Arkuszach Google i nimi zarządzać za pomocą interfejsu Google Sheets API.

Tworzenie arkusza kalkulacyjnego

Aby utworzyć plik w Arkuszach, użyj metody create w zasobie spreadsheets bez parametrów.

Gdy utworzysz plik, metoda zwróci zasób spreadsheets. Zwrócony zasób zawiera spreadsheetId, properties, listę sheets i spreadsheetUrl.

Poniższy przykładowy kod pokazuje, jak utworzyć pusty arkusz kalkulacyjny z określonym tytułem.

Apps Script

sheets/api/spreadsheet_snippets.gs
/**
 * 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
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
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
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
<?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
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
spreadsheet = {
  properties: {
    title: 'Sales Report'
  }
}
spreadsheet = service.create_spreadsheet(spreadsheet,
                                         fields: 'spreadsheetId')
puts "Spreadsheet ID: #{spreadsheet.spreadsheet_id}"

Porządkowanie arkuszy kalkulacyjnych w folderach na Dysku Google

Domyślnie utworzony arkusz kalkulacyjny jest zapisywany w folderze głównym użytkownika na Dysku Google.

Jeśli chcesz zapisać arkusz kalkulacyjny w określonym folderze na Dysku, użyj tych metod:

W obu przypadkach musisz dodać odpowiednie Drive API zakresy aby autoryzować wywołanie.

Jeśli Twoja aplikacja używa konta usługi, utworzony arkusz kalkulacyjny należy do tego konta. Ten plik znajduje się wtedy w dedykowanym miejscu na Dysku konta usługi. Pliki nie są widoczne na innych kontach miejsca na Dysku, chyba że zostaną udostępnione. Więcej informacji znajdziesz w artykule Własność pliku.

Aby przenieść lub utworzyć plik w folderze na dysku współdzielonym, zapoznaj się z artykułem Implementowanie obsługi dysków współdzielonych.

Więcej informacji o limitach komórek i wierszy w Arkuszach Google znajdziesz w artykule Pliki, które możesz przechowywać na Dysku Google.

Pobieranie arkusza kalkulacyjnego

Aby pobrać arkusz kalkulacyjny, użyj metody get w zasobie spreadsheets z parametrem ścieżki spreadsheetId.

Metoda zwraca plik jako instancję zasobu spreadsheets. Domyślnie dane w arkuszu kalkulacyjnym nie są zwracane. Zwrócony zasób zawiera strukturę i metadane arkusza kalkulacyjnego, w tym jego właściwości (np. tytuł, ustawienia regionalne i strefę czasową) oraz szczegółowe informacje o arkuszu (np. formatowanie i zakresy chronione).

Aby uwzględnić dane w zasobie spreadsheets, użyj tych 2 metod:

  • Określ maskę pola zawierającą wybrane pola, ustawiając fields parametr systemowy.

  • Ustaw wartość logiczną includeGridData parametru zapytania na true. Jeśli ustawiona jest maska pola, parametr includeGridData jest ignorowany.

Gdy pracujesz z dużymi arkuszami kalkulacyjnymi, zalecamy wysyłanie zapytań tylko o te pola arkusza, których potrzebujesz. Metoda get zwraca wszystkie dane powiązane z arkuszem kalkulacyjnym, więc ogólne zapytania dotyczące dużych arkuszy mogą być wolne. Na przykład, aby odczytać liczbę 100 z komórki, metoda spreadsheets.get zwraca wartość komórki oraz metadane (np. nazwę czcionki, rozmiar itp.), co powoduje, że duże ładunki JSON są wolno analizowane. Dla porównania, podobne wywołanie metody values.get zwraca tylko wartość konkretnej komórki, co daje znacznie lżejszą i szybszą odpowiedź.

Więcej informacji o zasobie spreadsheets.values, w tym spreadsheets.values.get i spreadsheets.values.batchGet, znajdziesz w tych dokumentach:

Wyświetlanie listy arkuszy kalkulacyjnych

Interfejs Sheets API nie oferuje metody wyświetlania listy arkuszy kalkulacyjnych dla uwierzytelnionych użytkowników.

Aby pobrać listę arkuszy kalkulacyjnych, możesz użyć metody list interfejsu Drive API w zasobie files, określając application/vnd.google-apps.spreadsheet jako 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"

Zastąp ACCESS_TOKEN tokenem dostępu, który przyznaje dostęp do interfejsu API.

Użycie metody files.list do wyświetlenia listy arkuszy kalkulacyjnych użytkownika wymaga ograniczonego zakresu interfejsu Drive API scope.

Oto kilka kolejnych kroków, które możesz wykonać: