Operacje arkusza

Interfejs API Arkuszy Google pozwala tworzyć, czyścić, kopiować i usuwać arkusze, a także ich właściwości. Przykłady na tej stronie pokazują, jak wykonywać typowe operacje w Arkuszach za pomocą Interfejs Arkuszy API.

Przykłady te są przedstawione w formie żądań HTTP, które stanowią język. i nie mam zdania. Aby dowiedzieć się, jak wdrożyć aktualizację zbiorczą w różnych językach za pomocą bibliotek klienta interfejsów API Google, przeczytaj artykuł Aktualizacja arkusze kalkulacyjne.

W tych przykładach zmienne SPREADSHEET_ID i SHEET_ID wskazuje, gdzie należy je podać. Arkusz kalkulacyjny można znaleźć ID w adresie URL arkusza kalkulacyjnego. Możesz uzyskać identyfikator arkusza za pomocą funkcji spreadsheets.get. zakresy określa się w notacji A1. An przykładowy zakres to Arkusz1!A1:D5.

Dodaj arkusz

Poniżej spreadsheets.batchUpdate przykładowy kod pokazuje, jak korzystać z AddSheetRequest aby dodać arkusz do arkusza kalkulacyjnego, a także ustawić tytuł, rozmiar siatki kolor karty.

Odpowiedź składa się z AddSheetResponse, który zawiera obiekt o właściwościach utworzonego arkusza (taki jak jego SHEET_ID).

Protokół żądania jest widoczny poniżej.

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

Wyczyść arkusz ze wszystkimi wartościami, zachowując formaty

Poniżej spreadsheets.batchUpdate przykładowy kod pokazuje, jak korzystać z UpdateCellsRequest , aby usunąć wszystkie wartości z arkusza i pozostawić formatowanie bez zmian.

Określanie parametru Pole userEnteredValue bez odpowiedniej wartości jest interpretowane jako instrukcja czyszczenia wartości. w zakresie. Tego ustawienia możesz też używać w przypadku innych pól. Przykład: zmieniam wartość fields na userEnteredFormat usuwa całe formatowanie obsługiwane przez interfejs Arkuszy API z arkusza, ale nie zmienia wartości komórek.

Protokół żądania jest widoczny poniżej.

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

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

Kopiowanie arkusza z jednego arkusza kalkulacyjnego do innego

Poniżej spreadsheet.sheets.copyTo przykładowy kod pokazuje, jak skopiować pojedynczy arkusz określony przez SHEET_ID między arkuszami kalkulacyjnymi.

Zmienna TARGET_SPREADSHEET_ID w treści żądania określa parametr docelowym arkuszu kalkulacyjnym. Kopia zachowuje wszystkie wartości, formatowanie, formuły innych właściwości oryginału. Tytuł skopiowanego arkusza ma wartość „Kopiuj [tytuł oryginalnego arkusza]”.

Odpowiedź składa się z SheetProperties obiekt opisujący właściwości utworzonego arkusza.

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

{
  "destinationSpreadsheetId": "TARGET_SPREADSHEET_ID"
}

Usuwanie arkusza

Poniżej spreadsheets.batchUpdate przykładowy kod pokazuje, jak korzystać z DeleteSheetRequest aby usunąć arkusz określony przez SHEET_ID.

Protokół żądania jest widoczny poniżej.

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

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

Odczytywanie danych arkusza

Poniżej spreadsheets.get – przykładowy kod pokazuje, jak uzyskać informacje o właściwościach arkusza. z arkusza kalkulacyjnego określonego przez SHEET_ID i SPREADSHEET_ID. Metoda ta jest często używana do określania określonych arkuszy kalkulacyjnych w określonym arkuszu kalkulacyjnym, umożliwiając dodatkowe operacje, i kierować na te arkusze. Parametr zapytania fields określa tylko właściwość arkusza danych (w przeciwieństwie do wartości komórek czy danych związanych z cały arkusz kalkulacyjny).

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

Odpowiedź składa się z Spreadsheet , który zawiera Sheet obiekt z SheetProperties . Jeśli dane pole odpowiedzi ma wartość domyślną, jest ono pomijane. z odpowiedzi.

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