【Python】【gspread】指定した範囲のセルをクリアする方法！

あきぞらです。

Pythonのgspreadというライブラリを使うときがたまにあります。

「特定の範囲のセルだけクリアする」処理を入れたい時がありました。

パッとやり方が分からず、少し悪戦苦闘したので、やり方を紹介していこうと思います。

そもそもgspreadとは？

PythonでGoogle SpreadSheetの操作が可能になるライブラリです。

GitHub

 

14 users

GitHub - burnash/gspread: Google Sheets Python API

https://github.com/burnash/gspread

Google Sheets Python API. Contribute to burnash/gspread development by creating an account on GitHub.

Pythonが入っていれば、以下でpipインストールできます。

$ pip install gspread

参考になったサイト

さて、表題の「セルをクリアにする方法」ですが、

stackoverflowに同じ悩みを持っている人が質問していました。

Stack Overflow

How to clear a range in google sheet via gspread

https://stackoverflow.com/questions/58876935/how-to-clear-a-range-in-google-sheet-via-gspread

Hi I would like to clear a range of A3:J10000 in google sheet by using gspread. Doing a loop like this takes too much time: for cell in range_to_clear: cell.value='' sh.worksheet('WorksheetX').

ここの質問の回答を参考にすると、やり方が分かりました。

また、公式サイトをよく読んでみると、書いてありました。

公式サイトはしっかり読まないとダメですね。

gspread.readthedocs.io

API Reference — gspread 3.6.0 documentation

https://gspread.readthedocs.io/en/latest/api.html#gspread.models.Spreadsheet.values_clear

特定の範囲のセルをクリアする方法

まず、スプレッドシートのオブジェクトを取得したあと、

values_clearという関数を使ってクリアの処理を行います。

from oauth2client.service_account import ServiceAccountCredentials

# スプレッドシートのAPIを使うための認証情報
SCOPES = [
    'https://spreadsheets.google.com/feeds',
    'https://www.googleapis.com/auth/drive'
]
credentials = ServiceAccountCredentials.from_json_keyfile_name(
    './service_account.json',
    SCOPES
)
gc = gspread.authorize(credentials)

workbook = gc.open_by_key('スプレッドシートのID')

# シート名が「テストシート」の、A1～H1000までの範囲をクリアにする
workbook.values_clear("'テストシート':!A1:H1000")

最後の方の、workbook.values_clearのところでシート名:!セル範囲を指定してあげることで、

指定のセルをクリアすることができます。