<h1 id="%E8%A8%98%E4%BA%8B%E6%A6%82%E8%A6%81">
<a class="header-anchor-link" href="#%E8%A8%98%E4%BA%8B%E6%A6%82%E8%A6%81" aria-hidden="true"></a> 記事概要</h1>
Python から Google スプレッドシートを操作するアプリケーションを作成する機会があったので、必要な設定などを備忘のため記事化したものです。
本記事では、以下のようなスプレッドシートを用意して、対象シートのすべての値を取得する所まで実施します。
<img src="https://res.cloudinary.com/zenn/image/fetch/s--UC0gHViU--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/4f4b83f60eebeda278a1e0c3.png%3Fsha%3D930231b693cb68a61372b55b81831e088d4d6f76" alt loading="lazy" class="md-img">
<div class="code-block-container"><pre class="language-python"><code class="language-python">print(spreadsheet.sheet1.get_all_values())

# [['Hello, gspread!']]
</code></pre></div><h1 id="google-cloud-platform-%E5%81%B4%E3%81%AE%E8%A8%AD%E5%AE%9A">
<a class="header-anchor-link" href="#google-cloud-platform-%E5%81%B4%E3%81%AE%E8%A8%AD%E5%AE%9A" aria-hidden="true"></a> Google Cloud Platform 側の設定</h1>
<h2 id="%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AE%E4%BD%9C%E6%88%90">
<a class="header-anchor-link" href="#%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AE%E4%BD%9C%E6%88%90" aria-hidden="true"></a> プロジェクトの作成</h2>
任意の名称でプロジェクトを作成します。（本記事では <code>DEMO-gspread</code> としています）
<img src="https://res.cloudinary.com/zenn/image/fetch/s--_RPwor54--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/a9a25634116c908739ec5ab6.png%3Fsha%3Db72444725718471437e32550df822fc7cf3f6b4f" alt loading="lazy" class="md-img">
<h2 id="api-%E3%81%AE%E6%9C%89%E5%8A%B9%E5%8C%96">
<a class="header-anchor-link" href="#api-%E3%81%AE%E6%9C%89%E5%8A%B9%E5%8C%96" aria-hidden="true"></a> API の有効化</h2>
gspread を利用するには、以下の API を有効にします。
<ul>
<li><a href="https://developers.google.com/drive/api" target="_blank" rel="nofollow noopener noreferrer">Google Drive API</a></li>
<li><a href="https://developers.google.com/sheets/api" target="_blank" rel="nofollow noopener noreferrer">Google Sheets API</a></li>
</ul>
<hr>
① コンソール画面のサイドバーから、[API とサービス] - [有効な API サービス] を押下します。
<img src="https://res.cloudinary.com/zenn/image/fetch/s--PAjyu9Ln--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/78f7d3666604671ffd36aeda.png%3Fsha%3D21a57d653e9770bab1cf8eaa733e9702012c4863" alt loading="lazy" class="md-img">
<hr>
② [API とサービスの有効化] を押下します。
<img src="https://res.cloudinary.com/zenn/image/fetch/s--YrkGoxO2--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/b0167da22d38ff2e20f4e798.png%3Fsha%3D9e43a9a0a7547f373fb464c62ec36c854d4606b1" alt loading="lazy" class="md-img">
<hr>
③ 検索窓から API をキーワード検索します。
<img src="https://res.cloudinary.com/zenn/image/fetch/s--uBujuKiF--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/ca41f06abc3e5f444ad60d48.png%3Fsha%3D5ffdac70c9552df212cf54284bd5d5618de3356a" alt loading="lazy" class="md-img">
<hr>
④ [有効にする] を押下し、API を有効にします。
Google Drive API
<img src="https://res.cloudinary.com/zenn/image/fetch/s--hcWPaU-I--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/2e657cbe641ab4a6ee7d6a4d.png%3Fsha%3D6aeac46683ea8509e8ff729f104096711d860892" alt loading="lazy" class="md-img">
Google Sheets API
<img src="https://res.cloudinary.com/zenn/image/fetch/s--WmqSjsT4--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/4aba1984e7461e2b3c7f24d3.png%3Fsha%3D68b70ddeeded9e6f883c39906b3f4a750ee9eb01" alt loading="lazy" class="md-img">
<h2 id="%E8%AA%8D%E8%A8%BC%E6%83%85%E5%A0%B1%E3%81%AE%E7%99%BA%E8%A1%8C">
<a class="header-anchor-link" href="#%E8%AA%8D%E8%A8%BC%E6%83%85%E5%A0%B1%E3%81%AE%E7%99%BA%E8%A1%8C" aria-hidden="true"></a> 認証情報の発行</h2>
gspread を利用するには Google サービスへの認証・認可が必要になりますが、その方法として以下の２つが提供されています。
<ul>
<li>サービスアカウントの利用 <a href="#fn-d711-1" id="fnref-d711-1">[1]</a>
</li>
<li>OAuth クライアント ID の利用 <a href="#fn-d711-2" id="fnref-d711-2">[2]</a>
</li>
</ul>
本記事では「サービスアカウント」を利用します。サービスアカウント <a href="#fn-d711-3" id="fnref-d711-3">[3]</a> とは、特殊なタイプの Google アカウントのことで、いわゆる Bot です。認証情報は Bot (アプリケーション 等) に対して Google サービスへの認証・認可を提供します。
サービスアカウントは分離された異なるアカウントであるため、デフォルトではスプレッドシートに対するアクセス権限を持っていません。今回はスプレッドシートにアクセスさせたいため、ユーザーはこのサービスアカウントと対象のスプレッドシートを共有することになります。
<hr>
① コンソール画面のサイドバーから、[API とサービス] - [認証情報] を押下します。
<img src="https://res.cloudinary.com/zenn/image/fetch/s--8vcwBSke--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/1ff4eb533a439c50cf511c19.png%3Fsha%3Dec2e14562824a61462c9c1d1e20c9441c4e675d6" alt loading="lazy" class="md-img">
<hr>
② [認証情報] - [サービスアカウント] を押下します。
<img src="https://res.cloudinary.com/zenn/image/fetch/s--YwBql93C--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/da7fa7086981da120ac94beb.png%3Fsha%3D438613b976e43fa4c595c189b769869fe66c65cf" alt loading="lazy" class="md-img">
<hr>
③ 任意のサービスアカウント名を入力し、[完了] を押下します。
<img src="https://res.cloudinary.com/zenn/image/fetch/s--Pa6nbiKM--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/eac5322eea83fcee326d075b.png%3Fsha%3Ddadb435bcfba0cbed12bf9bf6b9ff69943818cf1" alt loading="lazy" class="md-img">
<hr>
④ [キー] タブを開き、[鍵を追加] - [新しい鍵を作成] を押下します。
<img src="https://res.cloudinary.com/zenn/image/fetch/s--m54p-ErY--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/7d1798c0dca36475428c77b3.png%3Fsha%3D3804c46c42b0a47d8a01210907b772a4fdb22db2" alt loading="lazy" class="md-img">
<hr>
⑤ 「キーのタイプ」を json のまま、[作成] を押下します。（※注意にもある通り、ダウンロードされる認証情報は厳重に管理します）
<img src="https://res.cloudinary.com/zenn/image/fetch/s--l3mOfpa---/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/649831eda4d905f2ece8bb5a.png%3Fsha%3D1cfe33376646743137ec4560ae056e2f28e00517" alt loading="lazy" class="md-img">
<hr>
以上で Google Cloud Platform 側の設定は完了です。
<h1 id="google-%E3%82%B9%E3%83%97%E3%83%AC%E3%83%83%E3%83%89%E3%82%B7%E3%83%BC%E3%83%88%E3%81%AE%E4%BD%9C%E6%88%90%E3%81%A8%E5%85%B1%E6%9C%89">
<a class="header-anchor-link" href="#google-%E3%82%B9%E3%83%97%E3%83%AC%E3%83%83%E3%83%89%E3%82%B7%E3%83%BC%E3%83%88%E3%81%AE%E4%BD%9C%E6%88%90%E3%81%A8%E5%85%B1%E6%9C%89" aria-hidden="true"></a> Google スプレッドシートの作成と共有</h1>
① 適当な Google スプレッドシートを作成し、[共有] を押下します。
<img src="https://res.cloudinary.com/zenn/image/fetch/s---Ilv7aTf--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/00b623d3af5872268815664b.png%3Fsha%3D5ed0bd75dafed4c2209a349cba7adcc0a96ed8da" alt loading="lazy" class="md-img">
② 作成したサービスアカウントのメールアドレスを入力し、適切な権限を選択した上で [送信] を押下します。
<img src="https://res.cloudinary.com/zenn/image/fetch/s--UVudTzds--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/0449742b97cde4f5693accc4.png%3Fsha%3D69d2a5fb8546978130050276a8c4a21b1fcf6f13" alt loading="lazy" class="md-img">
<h1 id="python-%E3%82%A2%E3%83%97%E3%83%AA%E3%82%B1%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%8B%E3%82%89%E3%81%AE%E6%93%8D%E4%BD%9C">
<a class="header-anchor-link" href="#python-%E3%82%A2%E3%83%97%E3%83%AA%E3%82%B1%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%8B%E3%82%89%E3%81%AE%E6%93%8D%E4%BD%9C" aria-hidden="true"></a> Python アプリケーションからの操作</h1>
<h2 id="%E3%83%A9%E3%82%A4%E3%83%96%E3%83%A9%E3%83%AA%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">
<a class="header-anchor-link" href="#%E3%83%A9%E3%82%A4%E3%83%96%E3%83%A9%E3%83%AA%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" aria-hidden="true"></a> ライブラリインストール</h2>
<a href="https://pypi.org/project/gspread/" target="_blank" rel="nofollow noopener noreferrer">gspread</a> および <a href="https://pypi.org/project/google/" target="_blank" rel="nofollow noopener noreferrer">google</a> をインストールしておきます。
<div class="code-block-container"><pre class="language-shell"><code class="language-shell">$ pip install --upgrade pip
$ pip install google
$ pip install gspread
</code></pre></div><h2 id="%E8%AA%8D%E8%A8%BC">
<a class="header-anchor-link" href="#%E8%AA%8D%E8%A8%BC" aria-hidden="true"></a> 認証</h2>
認証のサンプルコードを以下に示します。
<div class="code-block-container"><pre class="language-python"><code class="language-python">from google.oauth2.service_account import Credentials
import gspread

scopes = [
 'https://www.googleapis.com/auth/spreadsheets',
 'https://www.googleapis.com/auth/drive'
]

credentials = Credentials.from_service_account_file(
 YOUR_CREDENTIAL_FILEPATH,
 scopes=scopes
)

gc = gspread.authorize(credentials)
</code></pre></div><aside class="msg message">!<div class="msg-content">
oauth2client <a href="#fn-d711-4" id="fnref-d711-4">[4]</a> は現在非推奨になっており、今後は google-auth <a href="#fn-d711-5" id="fnref-d711-5">[5]</a> の利用が推奨されています。
</div></aside>
<h2 id="%E3%82%B9%E3%83%97%E3%83%AC%E3%83%83%E3%83%89%E3%82%B7%E3%83%BC%E3%83%88%E6%93%8D%E4%BD%9C">
<a class="header-anchor-link" href="#%E3%82%B9%E3%83%97%E3%83%AC%E3%83%83%E3%83%89%E3%82%B7%E3%83%BC%E3%83%88%E6%93%8D%E4%BD%9C" aria-hidden="true"></a> スプレッドシート操作</h2>
動作確認として、"シート1" に含まれるすべての値を取得・表示してみます。
<div class="code-block-container"><pre class="language-python"><code class="language-python">spreadsheet_url = "https://docs.google.com/spreadsheets/d/xxxxxxxxxxxxxxxx"

spreadsheet = gc.open_by_url(spreadsheet_url)
print(spreadsheet.sheet1.get_all_values())
</code></pre></div><div class="code-block-container">
<div class="code-block-filename-container">Output</div>
<pre><code>[['Hello, gspread!']]
</code></pre>
</div>ということで、無事 gspread を使用して Python アプリケーションから Google スプレッドシートへのアクセス・操作ができました！
<section class="footnotes">
脚注
<ol class="footnotes-list">
<li id="fn-d711-1" class="footnote-item">
<a href="https://docs.gspread.org/en/v4.0.0/oauth2.html#for-bots-using-service-account" target="_blank" rel="nofollow noopener noreferrer">For Bots: Using Service Accoun</a> - gspread <a href="#fnref-d711-1" class="footnote-backref">↩︎</a>
</li>
<li id="fn-d711-2" class="footnote-item">
<a href="https://docs.gspread.org/en/v4.0.0/oauth2.html#for-end-users-using-oauth-client-id" target="_blank" rel="nofollow noopener noreferrer">For End Users: Using OAuth Client ID</a> - gspread <a href="#fnref-d711-2" class="footnote-backref">↩︎</a>
</li>
<li id="fn-d711-3" class="footnote-item">
<a href="https://cloud.google.com/iam/docs/service-accounts" target="_blank" rel="nofollow noopener noreferrer">Service accounts</a> - Google Cloud <a href="#fnref-d711-3" class="footnote-backref">↩︎</a>
</li>
<li id="fn-d711-4" class="footnote-item">
<a href="https://oauth2client.readthedocs.io/en/latest/" target="_blank" rel="nofollow noopener noreferrer">oauth2client</a> - oauth2clinet <a href="#fnref-d711-4" class="footnote-backref">↩︎</a>
</li>
<li id="fn-d711-5" class="footnote-item">
<a href="https://google-auth.readthedocs.io/en/master/index.html" target="_blank" rel="nofollow noopener noreferrer">google-auth - Google Auth Library for Python</a> - google-auth <a href="#fnref-d711-5" class="footnote-backref">↩︎</a>
</li>
</ol>
</section>

gspread で Python から Google スプレッドシートを扱えるようにするまで

Google スプレッドシートの作成と共有

Python アプリケーションからの操作

python

Discussion