このガイドでは、Google Sheets API を使用してスプレッドシートにテーブルを作成する方法と理由について説明します。
テーブルとは
テーブルを活用すると、データ範囲に書式や構造を自動的に適用することができ、データ作成を簡素化したり、データの書式設定、入力、更新を繰り返す手間を省いたりすることができます。
テーブルには、ヘッダー、フッター、列の型、フィルタ、ビュー、テーブル参照、テーブル名など、多くの機能があります。詳しくは、機能のお知らせと Google スプレッドシートでテーブルを使用するをご覧ください。
表機能は、プロジェクト追跡やイベントの計画、在庫管理といったタスクに利用できます。
表を追加する
テーブルを追加するには、addTable リクエストを指定して batchUpdate メソッドを使用します。このリクエストを使用して、スプレッドシートにテーブルを追加します。
次の例では、指定された range
に 2 つのセット列を持つ「Project Tracker」という名前のテーブルを作成します。最初の列はパーセント列、2 番目の列はプルダウン列の型です。
{
"addTable": {
"table": {
"name": "Project Tracker",
"tableId": "123",
"range": {
"sheetId": 0,
"startColumnIndex": 0,
"endColumnIndex": 5,
"startRowIndex": 0,
"endRowIndex": 5,
},
"columnProperties": [
{
"columnIndex": 0,
"columnName": "Column 1",
"columnType": "PERCENT"
},
{
"columnIndex": 1,
"columnName": "Column 2",
"columnType": "DROPDOWN",
"dataValidationRule": {
"condition": {
"type": "ONE_OF_LIST",
"values": [
{
"userEnteredValue": "Not Started"
},
{
"userEnteredValue": "In Progress"
},
{
"userEnteredValue": "Complete"
}
]
}
}
}
],
}
}
}
列の型
表には、数値、日付、プルダウン、スマートチップ、チェックボックスなどの列のタイプがあります。評価列とチェックボックス列には、それぞれデフォルト値の 0 と FALSE が入力されます。
プルダウンの列タイプ
プルダウンの列タイプでは、チップのプルダウンが作成されます。列の型がドロップダウンに設定されている場合、列の dataValidationRule
は ONE_OF_LIST 条件で設定する必要があります。他の列タイプでは、`dataValidationRule` フィールドを設定しないでください。
テーブルの更新
spreadsheets.batchUpdate
メソッドを使用して、UpdateTableRequest を指定します。
表のサイズを変更する
UpdateTableRequest メソッドを使用して、テーブルが新しい行や列を追加するために使用する range
を変更します。
表内に行または列を追加する必要がある場合は、InsertRangeRequest または InsertDimensionRequest を使用します。
テーブルの行を削除する必要がある場合は DeleteRangeRequest を使用します。それ以外の場合は、DeleteDimensionRequest を使用して、スプレッドシートから行全体を削除できます。
表のフッターを切り替える
フッターのない既存のテーブルを更新してフッターを追加すると、range
が 1 行拡張されます。フッターを含む既存のテーブルを更新してフッターを削除すると、range
が 1 行縮小します。
テーブルに値を追加する
tableId
を使用して AppendCellsRequest を使用すると、テーブルの末尾に行を追加できます。これにより、値が最初の空の行に追加され、完全な行とフッターが認識されます。空の行がない場合は、テーブルの末尾とフッターの前に(該当する場合)行を挿入します。
テーブルを削除する
spreadsheets.batchUpdate
メソッドを使用して、DeleteTableRequest を指定します。DeleteTableRequest を使用して、テーブル全体とテーブルの内容を削除します。
DeleteBandingRequest を使用して、テーブルの書式設定を削除し、データを保持します。
テーブルを他のスプレッドシート機能と併用する
テーブルをバックアップ データとしてサポートする他の API 機能には、フィルタ、フィルタビュー、保護された範囲などがあります。