nodejsのObjectをGoogleSpreadsheetで見る方法

私はNodejsでコンソールアプリ等をよく作っています。

結果をconsoleに出力する時に、読みにくい場合が多々あります。
とはいえHtmlで見やすい形にするのも面倒です。

そういえば確かGoogleSpreadsheetってAPIあるよね、と思い使ってみました。

目標

items = [
  ['Alex',17,'1234-5678']
  ['Billy',33,'1357-2468']
  ['Charlie',28,'3333-3333']
  ['Daniel',15,'5555-5555']
  ['Edward',63,'9999-9999']
]

↑こんな感じの配列を
↓こうしたい。

前準備

Google SpreadsheetのAPIを使うための前準備です。webで行います。
大きく分けて２つのSTEPがあります。

1. developers-consoleでアカウントを作成して認証用のJSONファイルをダウンロードする
2. Spreadsheetを開いて(1)のアカウントを共有リストに加える

Google developers consoleの設定

console.developers.google.comにアクセスして[プロジェクトを作成]をクリック

プロジェクト名を適当に入力して[作成]するとこんなページに移動します。
(もし違う場合は一覧から作成したプロジェクトを選択して移動してください)

[Drive API]をクリック -> [有効にする]

画面左のタブから[認証情報]をクリック -> [認証情報を作成] -> [サービスアカウントキー]

サービスアカウントキーの作成画面になります。[サービスアカウント] -> [新しいサービスアカウント]からサービスアカウント名を入力

[役割を選択] -> [プロジェクト] -> [オーナー]

[キーのタイプ]を[JSON]にして[作成]

以上で認証情報が入ったJSONファイルがダウンロードされますので、Nodejsのプロジェクトに移動しておきます。

Spreadsheet側の設定

1.認証用メールアドレスを控えておく

まず先程ダウンロードしたJSONファイルを開いて、client_emailの部分に入っているメールアドレスを控えておいてください。

"client_email": "[email protected]"

2.スプレッドシートIDを控えておく

Google スプレッドシートを開いて新規のスプレッドシートを作成します。

URL欄からSpreadsheet-IDを控えておいてください。Nodejsで使います。
https://docs.google.com/spreadsheets/d/[Spreadsheet-ID]/edit#gid=0

3.(1)の認証用メールアドレスを使って共有する

画面右の[共有]のボタンをクリック。スプレッドシート名がデフォルトの状態のままなら[名前をつけてください]と言われるので設定します。

(1)のメールアドレスをコピペして[送信]

これで準備は終わりです。

Nodejs

いよいよNodeでコードを書いていきます。

ここではcoffee-scriptで書いています。

npmにいい感じのラッパーがあるのでこれを使います。

Google Spreadsheets Data API for Node.js

コールバック関数を処理するのに便利なasyncも使います。

npm install -S google-spreadsheet async

node-google-spreadsheetのREADMEを見れば使い方はわかると思いますが、簡単に紹介します。

今回、node-google-spreadsheetで使うのは主に３つです。

GoogleSpreadsheet.useServiceAccountAuth(account_info, callback)

このメソッドは認証部分を担当します。といっても先程の認証JSONファイルを渡すだけです。

GoogleSpreadsheet.addWorksheet(options, callback)

新しいワークシートを追加します。
オプションでワークシートのタイトルや行数、列数を指定できます。

options (optional)
title - title for the new sheet, must be unique in the doc (default = 'Worksheet {timestamp}')
rowCount - number of rows (default = 50)
colCount - number of columns (default = 20)
headers - array of string keys to put in the first row

ポイントはheadersの部分です。

例えば

headers: ['name','age','phone']

という感じで設定すると、ワークシートの１行目にこの項目が並びます。

そして次項のaddRow関数などを使う時にheadersで設定した項目がそのままプロパティになります。

コールバックは(error,sheet)と引数があり、第二引数のsheetはSpreadsheetWorksheetクラスになります。

SpreadsheetWorksheet.addRow(new_row, callback)

ワークシートに新しい行を追加します。

先程のaddWorksheet関数で設定したheadersがプロパティとして使えます。

        rowData =
          name: item[0]
          age: item[1]
          phone: item[2]
        sheet.addRow(rowData, callback)

example

「CoffeeScriptとかマジありえねぇ」という方はこちら

settings =
  # 解説の都合上別にしてありますが、もちろんコード内にベタ書きでも構いません。
  spreadsheetID: 'xxxxxx_xxxxxxxxxxxxx__xxx_xxxxxxxxxx'
  jsonFilePath: '../../gss-test-xxxxxxxxxx.json'

items = [
  ['Alex',17,'1234-5678']
  ['Billy',33,'1357-2468']
  ['Charlie',28,'3333-3333']
  ['Daniel',15,'5555-5555']
  ['Edward',63,'9999-9999']
]
GoogleSpreadsheet = require('google-spreadsheet')
async = require('async')
doc = new GoogleSpreadsheet(settings.spreadsheetID)
creds = require(settings.jsonFilePath)

doc.useServiceAccountAuth creds, (err)->
  throw err if err
  opt =
    title: 'sample sheet'
    headers: ['name','age','phone']
  doc.addWorksheet opt, (err, sheet) ->
    throw err if err
    async.eachSeries items, (item, next) ->
      console.log item
      rowData =
        name: item[0]
        age: item[1]
        phone: item[2]
      sheet.addRow(rowData, next)
    ,(err)->
      console.log 'complete'

このコードを走らせるとSpreadsheetに新規シートが作成されて、冒頭の画像のように書き込むことができました。