Tabellenvorgänge

Mit der Google Sheets API können Sie Tabellenblätter erstellen, leeren, kopieren und löschen sowie ihre Eigenschaften steuern. Die Beispiele auf dieser Seite veranschaulichen, wie Sie einige häufige Tabellenblattvorgänge mit der Sheets API ausführen können.

Diese Beispiele werden in Form von HTTP-Anfragen dargestellt, um sprachneutral zu sein. Informationen zum Implementieren einer Batchaktualisierung in verschiedenen Sprachen mit den Google API-Clientbibliotheken finden Sie unter Tabellen aktualisieren.

In diesen Beispielen geben die Platzhalter SPREADSHEET_ID und SHEET_ID an, wo Sie diese IDs angeben müssen. Sie finden die Tabellen ID in der Tabellen-URL. Sie können die Tabellenblatt-ID mit der spreadsheets.get Methode abrufen. Die Bereiche werden mit der A1-Notation angegeben. Ein Beispielbereich ist Sheet1!A1:D5.

Tabellenblatt hinzufügen

Das folgende spreadsheets.batchUpdate Codebeispiel zeigt, wie Sie mit AddSheetRequest ein Tabellenblatt zu einer Tabelle hinzufügen und gleichzeitig den Titel, die Rastergröße und die Tab-Farbe festlegen.

Die Antwort besteht aus einem AddSheetResponse, das ein Objekt mit den Eigenschaften des erstellten Tabellenblatts enthält (z. B. die SHEET_ID).

Das Anfrageprotokoll ist unten dargestellt.

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

Alle Werte aus einem Tabellenblatt löschen, aber Formate beibehalten

Das folgende spreadsheets.batchUpdate Codebeispiel zeigt, wie Sie mit UpdateCellsRequest alle Werte aus einem Tabellenblatt entfernen, die Formatierung aber beibehalten.

Wenn Sie das userEnteredValue Feld ohne einen entsprechenden Wert angeben, wird dies als Anweisung zum Löschen von Werten im Bereich interpretiert. Diese Einstellung kann auch mit anderen Feldern verwendet werden. Wenn Sie beispielsweise den Wert fields in userEnteredFormat ändern, wird die gesamte von der Sheets API unterstützte Formatierung aus dem Tabellenblatt entfernt, die Zellwerte bleiben jedoch unverändert.

Das Anfrageprotokoll ist unten dargestellt.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "updateCells": {
        "range": {
          "sheetId": SHEET_ID
        },
        "fields": "userEnteredValue"
      }
    }
  ]
}

Tabellenblatt aus einer Tabelle in eine andere kopieren

Das folgende spreadsheet.sheets.copyTo Codebeispiel zeigt, wie Sie ein einzelnes Tabellenblatt, das durch SHEET_ID angegeben wird, aus einer Tabelle in eine andere kopieren.

Die Variable TARGET_SPREADSHEET_ID im Anfragetext gibt die Ziel-Tabelle an. Die Kopie behält alle Werte, Formatierungen, Formeln und andere Eigenschaften des Originals bei. Der Titel des kopierten Tabellenblatts wird auf „Kopie von [Originaltitel des Tabellenblatts]“ gesetzt.

Die Antwort besteht aus einem SheetProperties Objekt, das die Eigenschaften des erstellten Tabellenblatts beschreibt.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/sheets/SHEET_ID:copyTo

{
  "destinationSpreadsheetId": "TARGET_SPREADSHEET_ID"
}

Tabellenblatt löschen

Das folgende spreadsheets.batchUpdate -Codebeispiel zeigt, wie Sie mit DeleteSheetRequest ein Tabellenblatt löschen, das durch SHEET_ID angegeben wird.

Das Anfrageprotokoll ist unten dargestellt.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "deleteSheet": {
        "sheetId": SHEET_ID
      }
    }
  ]
}

Tabellenblattdaten lesen

Das folgende spreadsheets.get Codebeispiel zeigt, wie Sie Informationen zu den Tabellenblatteigenschaften aus einer Tabelleabrufen, die durch SHEET_ID und SPREADSHEET_IDangegeben wird. Diese Methode wird häufig verwendet, um die Metadaten von Tabellenblättern in einer bestimmten Tabelle zu ermitteln, damit zusätzliche Vorgänge auf diese Tabellenblätter ausgerichtet werden können. Der Abfrageparameter fields gibt an, dass nur Daten zu den Tabellenblatteigenschaften zurückgegeben werden sollen (im Gegensatz zu Zellwertdaten oder Daten, die sich auf die gesamte Tabelle beziehen).

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID?&fields=sheets.properties

Die Antwort besteht aus einer Spreadsheet Ressource, die ein Sheet Objekt mit SheetProperties Elementen enthält. Wenn ein bestimmtes Antwortfeld auf den Standardwert gesetzt ist, wird es aus der Antwort entfernt.

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