Google Sheets API を使用すると、シートの作成、消去、コピー、削除、プロパティの制御を行うことができます。このページの例は、Sheets API を使用して一般的なスプレッドシート操作を行う方法を示しています。
これらの例では、特定の言語に依存しない HTTP リクエストの形式を採用しています。Google API クライアント ライブラリを使用してバッチ アップデートをさまざまな言語で実装する方法については、スプレッドシートを更新するをご覧ください。
以下の例では、SPREADSHEET_ID と SHEET_ID というプレースホルダを使用して、これらの ID をどこで指定するかを示しています。スプレッドシート ID はスプレッドシートの URL で確認できます。シート ID は、spreadsheets.get メソッドを使用して取得できます。範囲は A1 表記を使用して指定します。範囲の例は Sheet1!A1:D5 です。
シートを追加する
次の spreadsheets.batchUpdate コードサンプルは、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 コードサンプルは、UpdateCellsRequest を使用して、書式を変更せずにシートからすべての値を削除する方法を示しています。
対応する値を指定せずに 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 で指定された単一のシートをスプレッドシート間でコピーする方法を示しています。
リクエスト本文の TARGET_SPREADSHEET_ID 変数には、宛先スプレッドシートを指定します。このコピーでは、元のシートのすべての値、表示形式、数式、その他のプロパティが維持されます。コピーされたシートのタイトルは、「[元のシートタイトル] のコピー」に設定されます。
レスポンスは、作成されたシートのプロパティを記述する SheetProperties オブジェクトで構成されます。
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/sheets/SHEET_ID:copyTo
{
"destinationSpreadsheetId": "TARGET_SPREADSHEET_ID"
}
シートを削除する
次の spreadsheets.batchUpdate コードサンプルは、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 リソースで構成され、SheetProperties 要素を含む Sheet オブジェクトが含まれています。指定したレスポンス フィールドがデフォルト値に設定されている場合、レスポンスから省略されます。
{
"sheets": [
{
"properties": {
"sheetId": SHEET_ID,
"title": "Sheet1",
"index": 0,
"sheetType": "GRID",
"gridProperties": {
"rowCount": 100,
"columnCount": 20,
"frozenRowCount": 1
}
"tabColor": {
"blue": 1.0
}
},
...
],
}