【2021年】PythonでGoogleスプレッドシートに書き込みする方法

Pythonでスプレッドシートに書き込む方法（Spread Sheet）

Pythonからスプレッドシートにアクセスするには、下記の2点の準備が必要です。この記事では下記設定手順について解説します。

GCPの無料枠について確認しておこう！

GCPをはじめて利用開始すると1年間300ドル分のクレジットがついた無料期間がはじまります。この期間であれば課金が発生することはありません。クレジットカードの登録は必須ですが期間が終了しても自動的に課金が始まることはありません。

1年間が経過後は本登録のお手続きをすれば利用中のAPIを使い続けることができます。本登録後もAlways Freeという、GCPの各サービスに設けられた無料枠がありますので、その範囲内で使用する限りは無料で使い続けることが可能です。（具体的な使用量についてはこちらのGoogle公式情報をご確認ください。）

ただし、本登録後は無料使用量を超えると自動で課金されてしまいますのでご注意ください。使用量が一定のラインを越えたらメール通知を受ける設定もあるので設定しておくことをおすすめします。（メール通知を設定しても自動課金がストップするわけではありません。）

本記事の内容は古くなる可能性があります。無料枠で使っているつもりが自動的に課金が始まってしまう可能性もありますので、ご利用の際は必ずご自身でGoogleの公式情報を確認してください。この記事の内容によって損害が生じても当方では補償できかねます。

（STEP1）GCPの設定

（STEP2）スプレッドシートの設定

Pythonプログラムの作成

必要なPythonパッケージをインストールします。

VS Codeのターミナル（あるいはターミナル、コマンドプロンプト）を開き、下記の2つのパッケージをインストールしましょう。（Macはpip→pip3コマンドかもしれません。また、pipではなくcondaの人もいるかもしれません。）

$ pip install gspread
$ pip install oauth2client

gspreadはスプレッドシートを操作するパッケージ、oauth2clientはGoogleとの認証を簡略化するためのパッケージです。

お決まりの文句を記述する。

下記は、スプレッドシートにアクセスするときに必ず記述するお決まりのコードです。（良く使うのでコピペツールに保存しておくと便利です。ちなみに私はBoostNoteとCliborを使っています。）

import gspread
from google.oauth2.service_account import Credentials


# お決まりの文句
# 2つのAPIを記述しないとリフレッシュトークンを3600秒毎に発行し続けなければならない
scope = ['https://www.googleapis.com/auth/spreadsheets','https://www.googleapis.com/auth/drive']
#ダウンロードしたjsonファイル名をクレデンシャル変数に設定。
credentials = Credentials.from_service_account_file("JSONファイルのパス", scopes=scope)
#OAuth2の資格情報を使用してGoogle APIにログイン。
gc = gspread.authorize(credentials)

#スプレッドシートIDを変数に格納する。
SPREADSHEET_KEY = 'シートID'
# スプレッドシート（ブック）を開く
workbook = gc.open_by_key(SPREADSHEET_KEY)

コード文中の、

「シートID」のところは、先程取得したスプレッドシートのURLから取得したシートIDに置き換えてください。

「JSONファイルのパス」は、先程取得したJSONファイルのフルパスか相対パスに置き換えてください。

テストコード

さて、ようやくこれでいよいよgspreadパッケージを使用してコードを好きなように書いていく準備は整いました。

ですがその前に、簡単なコードを書いてスプレッドシートとの連携が本当にできるのかテストをしてみましょう。下記のコードを先ほど紹介した”お決まりの文句”の下に追記してみてください。「スプレッドシートの”シート1”という名前のシートのA1セルに”test value”という文字を挿入する」という簡単なコードです。コードが作成できたらスクリプトを実行して、スプレッドシートのA1セルに出力されるかチェックしてみてくださいね。

    # スプレッドシート（ブック）を開く
    workbook = gc.open_by_key(SPREADSHEET_KEY)

    # シートの一覧を取得する。（リスト形式）
    worksheets = workbook.worksheets()
    print(worksheets)

    # シートを開く
    worksheet = workbook.worksheet('シート1')

    # セルA1に”test value”という文字列を代入する。
    worksheet.update_cell(1, 1, 'test value')

エラーがでた、スプレッドシートに書き込みができない場合

良くあるエラーとして下記があります。確認してみてくださいね。

▼スプレッドシートの共有設定ができていないとコンソールに下記のようなエラーがでます。きちんと「編集者」になっているか確認しましょう。

gspread.exceptions.APIError: {‘code’: 403, ‘message’: ‘The caller does not have permission’, ‘status’: ‘PERMISSION_DENIED’}

Pythonスクリプトの作成方法

gspreadライブラリの使い方

Pythonを学ぶならコチラの講座がおすすめです。

わたしは「デイトラPythonコース」でPythonを学びました。

2021年08月16日現在 10,000円OFFキャンペーン中のようですので興味のある方はリンクから詳細をご確認ください。キャンペーンは終了し現在は通常価格のようです。