PHP と Sheets API を利用して Google Spread Sheets を操作する方法 post

bot 的な何かで諸々集計して、Google スプレッドシートへ内容を保存しようと思い、いろいろ調べてみたところ、見つかった情報が古くなっていたので多少試行錯誤して動くようにした結果をまとめてみました。

PHP を開発言語としていますが、認証キーの登録などの部分は共通なので、他の言語でも多少参考になると思います。

準備

実際のコードを書く前に、認証キーの取得や対象のスプレッドシートの追加などが必要です。

大まかな手順は、

  1. Google API Console へプロジェクトを追加
  2. 認証情報を作成
  3. Google スプレッドシート で対象のスプレッドシートを作成
  4. スプレッドシートを読み書きできるように共有を作成
  5. Google Sheets API - API Manager から API を有効にする
  6. 実際にコードを書いて Go !

こんな感じです。

API Console へプロジェクトを追加

まずは Google API Console へアクセスし、プロジェクトを作成します。

API Console

初めて Google API Console へアクセスの場合は、プロジェクトが作成されていないので、どん!と、「プロジェクトの作成」ボタンが表示されます。

メニューからのプロジェクトの追加

すでに別のプロジェクトがある場合は、そのまま使うか、メニューから「プロジェクトを作成」を選んでください。

プロジェクトの追加のウィザード

プロジェクト名などを設定し、「作成」ボタンを押下するとプロジェクトが作成されます。

認証情報を作成

認証情報の種類の選択肢

左側のナビメニューから「認証情報」を選択し、「認証情報の作成」を選ぶと、作成する認証情報の種別が表示されます。

ここでは「サービスアカウント キー」を選びます。

今回作成するキーは

選択肢 選択内容
認証情報(の種類) サービスアカウント キー
サービスアカウント(の種類) App Engine default service account
キーのタイプ JSON

です。

その他の種別でのアクセス方法は、PHP Quickstart  |  Sheets API  |  Google DevelopersAPI Client Library for PHP (Beta)  |  Google Developers などを参考にしてみてください。

サービスアカウントの種類の選択肢

サービスアカウントの種類は、

  • App Engine default service account
  • Compute Engine default service account

の二種類が今のところ最初から用意されているようです。

サービスアカウントの種類の選択

今回選ぶのは「App Engine default service account」で、キーのタイプは「JSON」です。

認証情報のダウンロード

作成すると、キーがダウンロードされるので大切に保管しましょう。

このキーのコピーはサーバー側にもないので、なくした場合は作り直す必要があります。

スプレッドシートを作成

操作対象のスプレッドシートを Google スプレッドシート で作成します。

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

API を経由してスプレッドシートへアクセスできるように共有を作成します。

API 用にスプレッドシートを共有

書き込みしないのであれば、「閲覧者」でも問題ないかもしれませんが、試していません。

サービスアカウントキーの電子メール

この時、設定するメールアドレスは、IAM と管理 の「サービスアカウント」メニューから取得できます。

認証情報 JSON に書かれたサービスアカウントキーの電子メール

ダウンロードした、秘密鍵を含むキーファイルにも書かれているので、JSON を開いた中の client_email からも取得できます。

サービスアカウントの一覧

API Console の「認証情報」メニューを選び「サービス アカウントの管理」のリンクから飛ぶことができます。

API を有効にする

この状態で、実行するとエラーが結果として帰ってきます。

{
  "error": {
    "code": 403,
    "message": "Google Sheets API has not been used in project {PROJECT_ID} before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/sheets.googleapis.com/overview?project={PROJECT_ID} then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.",
    "errors": [
      {
        "message": ...,
        "domain": "global",
        "reason": "forbidden"
      }
    ],
    "status": "PERMISSION_DENIED"
  }
}

メッセージの部分はこのように書いてあります。

Google Sheets API has not been used in project {PROJECT_ID} before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/sheets.googleapis.com/overview?project={PROJECT_ID} then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.

訳すと、

Google Sheets API は、以前のプロジェクト {PROJECT_ID} で使用されていないか、無効になっています。 https://console.developers.google.com/apis/api/sheets.googleapis.com/overview?project={PROJECT_ID} を訪れ、API を有効にした後、再試行してください。最近この API を有効にした場合は、操作が当社のシステムに伝播するまで数分待ち、再試行してください。

と、「API が有効になっていないなどで、操作ができなかったよ」と書かれています。

Sheats API を有効に

なので、指示に従い Google Sheets API - API Manager から API を有効にします。

サンプルコード

スプレッドシートの読み取りエリア

B2:B3 に 値を書き込み、 A1:D5 までを取得するという、簡単なサンプルコードです。

準備

PHP 用の Google API クライアントライブラリは google/google-api-php-client: A PHP client library for accessing Google APIs が公式のライブラリとなります。

Composer 経由でインストールできるので、

  • composer.jsonrequire"google/apiclient": "^2.0" を追加して composer install
  • composer require google/apiclient:^2.0

のどちらかの方法でインストールができます。

コード

サンプルで使う composer.json です。 composer install してください。

{
    "name": "sharkpp/gsapi-example",
    "require": {
        "google/apiclient": "^2.0"
    }
}

サンプルコードです。

サンプロコード内で、参照されている環境変数にはそれ添えr次のような値をセットしてください。

環境変数名 内容
SERVICE_KEY_JSON 先の手順でダウンロードしたファイル。例えば My Project-19c43c948fd7.json のような名前
SPREADSHEET_ID スプレッドシートを識別する id。例えば https://docs.google.com/spreadsheets/d/XXXXX/edit#gid=9999 がスプレッドシートのアドレスだった場合は、XXXXXSPREADSHEET_ID で、今開いているシートの id が 9999 となります。
<?php

date_default_timezone_set('Asia/Tokyo');

require 'vendor/autoload.php';

define('CREDENTIALS_PATH', getenv('SERVICE_KEY_JSON'));
define('SPREADSHEET_ID',   getenv('SPREADSHEET_ID'));

putenv('GOOGLE_APPLICATION_CREDENTIALS='.dirname(__FILE__).'/'.CREDENTIALS_PATH);
$client = new Google_Client();
$client->useApplicationDefaultCredentials();
$client->addScope(Google_Service_Sheets::SPREADSHEETS);
$client->setApplicationName('test');

$service = new Google_Service_Sheets($client);

// B2:B3 を更新
$value = new Google_Service_Sheets_ValueRange();
$value->setValues([ 'values' => [ 'aaaa', 'bbbb' ] ]);
$response = $service->spreadsheets_values->update(SPREADSHEET_ID, 'シート1!B2', $value, [ 'valueInputOption' => 'USER_ENTERED' ] );

// A1:D5 の範囲を取得
$response = $service->spreadsheets_values->get(SPREADSHEET_ID, 'シート1!A1:D5');
foreach ($response->getValues() as $index => $cols) {
    echo sprintf('#%d >> "%s"', $index+1, implode('", "', $cols)).PHP_EOL;
}

実行すると、まず

A B C D ...
1                  
2 aaaa bbbb
3
4
5
...

値が書き込まれ、表の範囲が取得されますが、

A B C D ...
1                  
2 aaaa bbbb
3
4
5
...

実際に結果から値として取り出せるのは、セルに値がセットされている

A B C
1  ☆         
2

この範囲だけになります。

$ php test.php 
#1 >> ""
#2 >> "", "aaaa", "bbbb"

実際に中身を表示させると、こうなります。

そのため、対象範囲すべてが確保されているものとして、直接添え字を指定しアクセスすると Notice: Undefined offset: ... となるので注意が必要です。

困った時は

◯◯のやり方がわからない

PHP のクライアントライブラリの使い方を懇切丁寧に書いたドキュメントはなさそうなので、

あたりから、気合て探しましょう!

…まあ基本的に英語です。

PHP のバージョン

A PHP client library for accessing Google APIs を動かすのに必要な PHP のバージョンは PHP 5.4.0 or higher と README に書かれているのですが、正解なようで間違っています。

最新を Composer でインストールすると、依存しているライブラリで curl_reset を利用しているものがあり、しかし、この関数が実装されたのは PHP 5.5.0 からなので、結果としてエラーで動作しません。

回避手段は、ドキュメントの「ユーザーが投稿した注記」の #119616 に書かれているように、

<?php

// ---- 追加開始 ----

if (function_exists('curl_init') &&
    !function_exists('curl_reset')) {
    function curl_reset(&$ch) {
        $ch = curl_init();
    }
}

// ---- 追加終了 ----

require 'vendor/autoload.php';
           :

こんな感じの関数を定義してあげれば OK です。

手元では PHP 5.4.12 で動作しています。

参考


 /  変更履歴  /  Permalink  /  このエントリーをはてなブックマークに追加
カテゴリ: ブログ  /  タグ: Google, Google API, Google Spread Sheets, php, How to