Pythonでスプレッドシートに値を書き込みしたいが、エラーが発生してしまう(AttributeError: 'Spreadsheet'...)

Question

前提

お世話になります。
今回、質問させて頂きます。プログラミング初心者の者です。
エラーが出て、調べても解決できないのでこの場を借りてご教授いただきたいです。

実現したいこと

今回、Pythonを実行してGoogleスプレッドシートへ値を書き込むという動作をしたいと思い、
1.Google cloud Platformのプロジェクトを作成
2.Google Drive APIを有効化
3.Google Sheets APIを有効化
4.外部アプリからスプレッドシートにアクセスするための認証情報を設定
5.スプレッドシート側の共有設定
6.実際にプログラムを書く　←ここで躓いています。

上記、5番まで済ませて、
まずはスプレッドシートを操作・通信できるか確認したいと思い、
【スプレッドシートに値を書き込む動作】を書きました。

そしてプログラムを実行するとエラーになります。
エラーメッセージは下記の通りです。

発生している問題・エラーメッセージ

AttributeError: 'Spreadsheet' object has no attribute 'update_cell'

該当のソースコード

from time import sleep
from selenium import webdriver
import os
import time
import gspread
import json
from oauth2client.service_account import ServiceAccountCredentials


scope = ['https://spreadsheets.google.com/feeds','https://www.googleapis.com/auth/drive']
pas = r'C:\Users\sasur\OneDrive\プログラミング\Python関係\test_gs\pythontest-278807-eb0d1c5f41d7.json'
credentials = ServiceAccountCredentials.from_json_keyfile_name(pas,scope)
gc = gspread.authorize(credentials)
SPREADSHEET_KEY = '1w0TuBEgg8TTw9B1XozbLEIRox7ghZFyZUKMcjhwSO2M'
worksheet = gc.open_by_key(SPREADSHEET_KEY)

worksheet.update_cell(1, 1, 'test value')

試したこと

要因などを一つづつ潰していきました。
また、エラーコードをネットなどで調べて様々なサイトなどを見てみました。

・今回使用するライブラリのバージョンの違いなのか→問題なく最新です。
・コードの記述が悪いのか→おそらく正常な書き方だと思います。
・設定が悪いのか→YouTubeなどで手順などを確認しながら行ったのでおそらく問題ないと思います。
・そもそもの実行ファイルが違うのか→ファイルの指定は合っています。

なかなか解決できませんでした。

補足情報（FW/ツールのバージョンなど）

コード最後の行、worksheet.update_cell(1, 1, 'test value')を消すと、エラーなど出ず問題なく実行できます。

試しにコードを下記のように変更しても同様なエラーが発生します。
worksheet.update_cell(1, 1, 'test value')→print(worksheet.acell("G2").value)

説明が分かりづらかったら申し訳ありません。
なぜ、スプレッドシートに読み書き、通信などができない原因が知りたいです。

以上、ご教授の程よろしくお願いいたします。

Comments

[TakaiY]

すでに回答ついていますが、gspreadモジュールの使いかたは何を参考にしていますか？

[sasu46]

コメントありがとうございます。
回答者様が送って頂いた参考サイトのような公式ページを見たわけでは無く、スプレッドシート書き方、などと検索して出てきた記事を参考にして書きました。

例えばですが、皆さんはコードを書く際、やはりモジュール等は公式ページなどを見てコードを書くのですが、あまり一からコードを書くときの流れなどが分かっていなくて💦
申し訳ございません。ご教授お願いいたします。

[TakaiY]

やったことのないことであればやはりWebで情報を探します。でも、公式のドキュメントは必ず参照します。機能や引数・返り値などを確認します。サンプルコードなども参考になります。
Webの記事はとても参考になるものが多いのですが、間違えているものも多いです。複数の記事にあたることは重要です。そして、鮮度も。

またコーディングにあたっては、コードはおまじないではないので、各行の処理が何をしているのかちゃんと把握しながら書いていくべきです。今回の件も、「gc.open_by_key()」がSpreadsheetを返すことがわかれば自分で解決できたのではないかと思います。

[sasu46]

ご丁寧な説明ありがとうございます。

承知いたしました。公式ページ参考にしながらこれからコーディングしていきます。

正直に申し上げますと、「gc.open_by_key()」がSpreadsheetを返すという意味が理解できないです。
Spreadsheetというのは変数ではないのですか？？

長々と申し訳ありません。とても勉強になっておりますのでこの機に理解しておきたいです。💦
ご教授お願いします。。

[TakaiY]

書き方がわるかったかもしれません。

ちゃんと書けば、「Spreadsheetクラスのインスタンス」です。 後ろの部分は省略されることが多いです。

Excelなどのスプレッドシートはたいてい階層構造を持つオブジェクトで表現されていて、gspreadでも同じです。
gc.open_by_key() であれば、gc は gspread.authorize() の 返り値だから gspread.Client(クラスのインスタンス)なので、 gc.open_by_key() は Spreadsheet(くらすのインスタンス)を返しています。
それぞれのドキュメントはこちら。
https://docs.gspread.org/en/v5.4.0/api/top-level.html?highlight=authorize#gspread.authorize
https://docs.gspread.org/en/v5.4.0/api/client.html#gspread.Client
https://docs.gspread.org/en/v5.4.0/api/client.html#gspread.Client.open_by_key

スプレッドシートの階層構造については、以下のサイトが参考になるでしょう。
VBAのものですが、他でも呼び名が違っていたりしますが、だいたい同じです。
https://www.isa-school.net/blog/?p=21
https://macvba.net/object-hierarchy-example
2番目の方が図があってわかりやすいですが、1番目の方が簡潔です。

[sasu46]

本当に丁寧なご説明ありがとうございます！

とても勉強になります。参考の記事をじっくり読んでみて理解してみます！！
回答ありがとうございます！！！

Answer 1

gc.open_by_keyの戻り値はWorksheetではなくSpreadsheet（Excelでいうワークブック）です。
Spreadsheetからget_worksheetなどでWorksheetを選択、取得する必要があります。
参考：Examples of gspread Usage

Comments

[sasu46]

from time import sleep
from selenium import webdriver
import os
import time
import gspread
import json
from oauth2client.service_account import ServiceAccountCredentials

scope = ['https://spreadsheets.google.com/feeds','https://www.googleapis.com/auth/drive']
pas = r'C:\Users\sasur\OneDrive\プログラミング\Python関係\test_gs\pythontest-278807-eb0d1c5f41d7.json'
credentials = ServiceAccountCredentials.from_json_keyfile_name(pas,scope)
gc = gspread.authorize(credentials)
SPREADSHEET_KEY = '1w0TuBEgg8TTw9B1XozbLEIRox7ghZFyZUKMcjhwSO2M'

Spreadsheet = gc.open_by_key(SPREADSHEET_KEY)

worksheet = Spreadsheet.get_worksheet(0)
value = worksheet.acell('G2').value
print(value)

上記のように書きましたら動きました！
G2のセルの値を読み取るというコードを書き、無事値を読み取ることができました。

この書き方、戻り値をSpreadsheetにして返す。という流れで合っていますでしょうか？💦
書き方についてアドバイス・指摘等ありましたらご教授お願いしたいです。
正直、理解が追い付いていなくて、、

[TakaiY]

(関わりついでに)
pythonでは大文字で始まる名前はクラス名としていることが多いです。
スタイルガイド : https://pep8-ja.readthedocs.io/ja/latest/

なので「Spreadsheet 」は変数名といてはあまりよくありません。
ss とか spread_sheet などにしましょう。

「戻り値をSpreadsheetにして返す」というのは、ニュアンスが異なります。
別途書きましたが、 「gc.open_by_key()の戻り値 Spreadsheetを変数spread_sheetで受けとる」あたりかと。
次は、「spread_sheetのメソッドget_worksheet()を使ってspread_sheetの0番目のWorksheetを取得」で、
その次は、「worksheetのメソッドacellでG2セルのオブジェクトを取得して、さらにそのセルの値を取得」ですね。