Tabellen erstellen und verwalten

In diesem Dokument wird erläutert, wie Sie mit der Google Sheets API Tabellen in Google Sheets erstellen und verwalten.

Tabelle erstellen

Verwenden Sie die create Methode für die spreadsheets Ressource ohne Parameter, um eine Datei in Google Sheets zu erstellen.

Wenn Sie die Datei erstellen, gibt die Methode eine spreadsheets-Ressource zurück. Die zurückgegebene Ressource enthält eine spreadsheetId, properties, eine Liste von sheets und eine spreadsheetUrl.

Das folgende Codebeispiel zeigt, wie Sie eine leere Tabelle mit einem bestimmten Titel erstellen.

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}"

Tabellen in Google Drive-Ordnern organisieren

Standardmäßig wird die erstellte Tabelle im Stammordner des Nutzers in Google Drive gespeichert.

Wenn Sie eine Tabelle in einem bestimmten Drive-Ordner speichern möchten, verwenden Sie eine der folgenden Methoden:

Für beide Alternativen müssen Sie die entsprechenden Drive API scopes hinzufügen, um den Aufruf zu autorisieren.

Wenn Ihre App ein Dienstkonto verwendet, ist das Dienstkonto der Inhaber der erstellten Tabelle. Diese Datei befindet sich dann im dedizierten Drive-Speicher des Dienstkontos. Dateien werden in anderen Drive-Speicherkonten nur angezeigt, wenn sie explizit freigegeben wurden. Weitere Informationen finden Sie unter Datei inhaberschaft.

Informationen zum Verschieben oder Erstellen einer Datei in einem Ordner einer geteilten Ablage finden Sie unter Unterstützung für geteilte Ablagen implementieren.

Weitere Informationen zu den Beschränkungen für Zellen und Zeilen in Google Sheets finden Sie unter In Google Drive speicherbare Dateien.

Tabelle abrufen

Verwenden Sie die get Methode für die spreadsheets Ressource mit dem spreadsheetId Pfadparameter, um eine Tabelle abzurufen.

Die Methode gibt die Datei als Instanz einer spreadsheets-Ressource zurück. Standardmäßig werden keine Daten aus der Tabelle zurückgegeben. Die zurückgegebene Ressource enthält die Struktur und die Metadaten der Tabelle, einschließlich der Tabelleneigenschaften (z. B. Titel, Gebietsschema und Zeitzone) und einiger detaillierter Tabelleninformationen (z. B. Formatierung und geschützte Bereiche).

Verwenden Sie eine der folgenden beiden Methoden, um Daten in eine spreadsheets-Ressource einzufügen:

  • Geben Sie eine Feldmaske mit den ausgewählten Feldern an, indem Sie den fields System parameter festlegen.

  • Setzen Sie den booleschen includeGridData Abfrageparameter auf true. Wenn eine Feldmaske festgelegt ist, wird der Parameter includeGridData ignoriert.

Wenn Sie mit großen Tabellen arbeiten, empfehlen wir, nur die spezifischen Tabellenfelder abzufragen, die Sie benötigen. Die Methode get gibt alle Daten zurück, die mit der Tabelle verknüpft sind. Allgemeine Abfragen für große Tabellen können daher langsam sein. Wenn Sie beispielsweise die Zahl 100 aus einer Zelle lesen möchten, gibt spreadsheets.get den Zellenwert und Metadaten (z. B. Schriftart, Größe usw.) zurück. Das führt zu großen JSON-Nutzlasten, die langsam zu parsen sind. Im Vergleich dazu gibt ein ähnlicher Aufruf von values.get nur den spezifischen Zellenwert zurück, was zu einer viel leichteren und schnelleren Antwort führt.

Weitere Informationen zur spreadsheets.values Ressource, einschließlich spreadsheets.values.get und spreadsheets.values.batchGet, finden Sie in den folgenden Dokumenten:

Tabellen auflisten

Die Sheets API bietet keine Methode zum Auflisten von Tabellen für authentifizierte Nutzer.

Verwenden Sie die Methode list der Drive API für die Ressource files und geben Sie application/vnd.google-apps.spreadsheet als mimeType an, um eine Liste von Tabellen abzurufen:

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"

Ersetzen Sie ACCESS_TOKEN durch das Zugriffstoken, das Zugriff auf die API gewährt.

Für die Verwendung der files.list Methode zum Auflisten der Tabellen eines Nutzers ist ein eingeschränkter Drive API Bereich erforderlich.

Hier sind einige nächste Schritte, die Sie ausprobieren können: