Tabellenvorgänge

Mit der Google Tabellen API können Sie Tabellen erstellen, löschen, kopieren und ihre Eigenschaften verwalten. Die Beispiele auf dieser Seite veranschaulichen, wie Sie einige gängige Google Tabellen-Vorgänge mit der Google Tabellen API ausführen können.

Diese Beispiele werden in Form von sprachneutralen HTTP-Anfragen präsentiert. Informationen zum Implementieren eines Batch-Updates in verschiedenen Sprachen mit den Clientbibliotheken der Google API finden Sie unter Listen aktualisieren.

In diesen Beispielen geben die Platzhalter SPREADSHEET_ID und SHEET_ID an, wo Sie diese IDs angeben würden. Sie finden die Tabellen-ID in der Tabellen-URL. Sie können die Tabellen-ID mit der Methode spreadsheets.get abrufen. Die Bereiche werden in der A1-Notation angegeben. Ein Beispiel für einen Bereich ist Tabelle1!A1:D5.

Tabellenblatt hinzufügen

Im folgenden spreadsheets.batchUpdate-Codebeispiel wird gezeigt, wie Sie mit dem AddSheetRequest-Objekt einer Tabelle ein Tabellenblatt 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. das 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 in einem Tabellenblatt löschen, aber Formate beibehalten

Im folgenden Codebeispiel für spreadsheets.batchUpdate sehen Sie, wie Sie mit UpdateCellsRequest alle Werte aus einem Tabellenblatt entfernen und die Formatierung unverändert lassen.

Wenn Sie das Feld userEnteredValue ohne einen entsprechenden Wert angeben, wird dies als Anweisung zum Löschen der Werte im Bereich interpretiert. Diese Einstellung kann auch mit anderen Feldern verwendet werden. Wenn Sie beispielsweise den Wert von fields in userEnteredFormat ändern, wird die gesamte von der Google Tabellen API unterstützte Formatierung aus dem Tabellenblatt entfernt, die Zellenwerte 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"
      }
    }
  ]
}

Tabellenblätter zwischen Tabellen kopieren

Im folgenden spreadsheet.sheets.copyTo-Codebeispiel wird gezeigt, wie ein einzelnes Blatt, das durch SHEET_ID angegeben ist, aus einer Tabelle in eine andere kopiert wird.

Die Variable TARGET_SPREADSHEET_ID im Anfragetext gibt die Zieltabelle an. Die Kopie behält alle Werte, Formatierungen, Formeln und anderen Eigenschaften des Originals bei. Der Titel der kopierten Tabelle lautet „Kopie von [Titel der ursprünglichen Tabelle]“.

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

Tabellenblätter löschen

Das folgende Codebeispiel für spreadsheets.batchUpdate zeigt, wie Sie mit DeleteSheetRequest ein durch SHEET_ID angegebenes Tabellenblatt löschen können.

Das Anfrageprotokoll ist unten dargestellt.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
  "requests": [
    {
      "deleteSheet": {
        "sheetId": SHEET_ID
      }
    }
  ]
}

Tabellendaten lesen

Das folgende Codebeispiel für spreadsheets.get zeigt, wie Sie Informationen zu Tabellenblatt-Attributen aus einer Tabelle abrufen, die durch SHEET_ID und SPREADSHEET_ID angegeben ist. Diese Methode wird häufig verwendet, um die Metadaten von Tabellen in einer bestimmten Tabelle zu ermitteln, damit zusätzliche Vorgänge auf diese Tabellen ausgerichtet werden können. Mit dem Abfrageparameter fields wird angegeben, dass nur Daten zu Tabelleneigenschaften zurückgegeben werden sollen (im Gegensatz zu Zellenwertdaten 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 der Ressource Spreadsheet, die ein Sheet-Objekt mit SheetProperties-Elementen enthält. Wenn ein bestimmtes Antwortfeld auf den Standardwert festgelegt 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
        }
      },
      ...
  ],
}