このページは Cloud Translation API によって翻訳されました。

シートのオペレーション

Google Sheets API を使用すると、スプレッドシートの作成、消去、コピー、削除を行うことができます。そのプロパティを制御します。このページの例では一般的なスプレッドシート操作を Sheets API です。

これらの例は、HTTP リクエストという形式で示されています。これは、ニュートラルです。異なる言語のバッチアップデートを実装する方法については、 Google API クライアントライブラリについては、スプレッドシート。

これらの例では、プレースホルダ SPREADSHEET_ID と SHEET_ID は、は、これらの ID を指定する場所を示しています。そのスプレッドシートの ID を入力します。取得できるもの: シート ID spreadsheets.get メソッドを使用します。「範囲は A1 表記で指定します。「 Sheet1!A1:D5 です。

スプレッドシートを追加

次の spreadsheets.batchUpdate コードサンプルを使用して、Terraform で AddSheetRequest スプレッドシートにシートを追加できるほか、タイトル、グリッドサイズ、タブの色。

レスポンスは AddSheetResponse これには、作成されたシートのプロパティ（ SHEET_ID など）。

リクエストプロトコルを以下に示します。

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

書式を維持しながらすべての値のシートをクリアします

次の spreadsheets.batchUpdate コードサンプルを使用して、Terraform で UpdateCellsRequest を使用すると、書式設定はそのままにして、シートからすべての値を削除できます。

Pod の userEnteredValue フィールド対応する値がない場合、値をクリアする指示と解釈されます。必要があります。この設定は他のフィールドでも使用できます。たとえば fields の値を userEnteredFormat が削除 Sheets API でサポートされているすべての形式セルの値はそのままにします。

リクエストプロトコルを以下に示します。

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

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

スプレッドシート間でシートをコピーする

次の spreadsheet.sheets.copyTo SHEET_ID で指定された 1 つのシートをコピーするコードサンプル別のスプレッドシートに移動できます。

リクエスト本文の TARGET_SPREADSHEET_ID 変数では、表示されます。このコピーでは、すべての値、書式設定、数式、その他のプロパティを指定します。コピーしたシートのタイトルは「コピー」 of [元のシートタイトル]」です。

レスポンスは SheetProperties 作成されるシートのプロパティを記述するオブジェクト。

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

{
  "destinationSpreadsheetId": "TARGET_SPREADSHEET_ID"
}

シートを削除する

次の spreadsheets.batchUpdate コードサンプルを使用して、Terraform で DeleteSheetRequest SHEET_ID で指定されたシートを削除する。

リクエストプロトコルを以下に示します。

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

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

シートデータを読み取る

次の spreadsheets.get のコードサンプルスプレッドシートのプロパティ情報を取得する方法を示します。スプレッドシート（SHEET_ID で指定されたもの）から取得と SPREADSHEET_ID。この方法は多くの場合にシートのメタデータを自動的に追加して、追加のオペレーションをそれらのシートをターゲットにしますfields クエリパラメータでシートプロパティのみが指定されている（セル値のデータや関連するデータではなく）。

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

レスポンスは Spreadsheet リソースには、変数の次を含む Sheet オブジェクト SheetProperties あります。特定のレスポンスフィールドがデフォルト値に設定されている場合、このフィールドは省略されます。取得できます。

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