Google Sheets APIを利用したスプレッドシートの内容取得方法

初投稿となります。Horiです。

今回はGoogle Sheets APIを利用し、スプレッドシートの内容を取得する方法を紹介致します。

【Google Sheets APIとは】

Google Sheets APIについて簡単に説明すると、スプレッドシートと連携し、様々な操作をすることが出来るAPIです。その操作の中で今回はスプレッドシートの内容取得を行います。

【Google Sheets APIを利用するための手順】

Google Sheets APIを利用するには、まず認証情報とブラウザ側、ウェブサーバー側のリクエスト用URIの設定を行う必要があるため以下の手順で設定を行います。

1. Google Cloud Platformでプロジェクトを作成もしくは選択
2. API Manager>ライブラリ>sheets APIを選択、有効にする
3. API Manager>認証情報>OAuth同意画面を選択
4. メールアドレスとサービス名を設定後、保存を選択
5. 認証情報の作成>OAuthクライアントID>ウェブアプリケーションを選択
6. 制限事項に従ってURIを入力後、作成を選択
7. OAuthクライアントのダイアログが確認後、OKを選択

OAuth(オーオース)とは認証情報を扱っている仕様のことを示しています。今回だとスプレッドシートに対してGoogle Sheets APIによる読み取りを許可するため、OAuthクライアント作成時に生成されたクライアントIDとスコープというものが必要になります。

var CLIENT_ID = 'XXXXXXXXXXXX';
var SCOPES = 'https://www.googleapis.com/auth/drive https://www.googleapis.com/auth/spreadsheets.readonly';

【スプレッドシートの読み取り】

続いてスプレッドシートの読み取り方法について説明します。

スプレッドシートの読み取りを行うには読み取りたいスプレッドシートのスプレッドシートID、ワークシート名、範囲を指定します。

スプレッドシートIDはスプレッドシートを開いた際に表示されているURL中に存在します。

https://docs.google.com/spreadsheets/d/スプレッドシートID/edit#gid=XXX

各要素の指定は以下のように行います。

spreadsheetId: 'スプレッドシートID',
range: 'ワークシート名!行:列',

rangeには読み取りたいワークシート名とその範囲を指定しています。また、ワークシート名のみを指定するとワークシートの全範囲を取得してくれるようです。