Google Apps Scriptを外部から実行できるGoogle Apps Script Execution APIを試してみた

2015/9/28 18:16

Google Apps Script を外部から実行できる「Google Apps Script Execution API」という API が公開されています。ただスクリプトを実行するだけの API ですが、この API を使えばわざわざスクリプトエディタを開かなくても Google Apps Script が実行できるようになって便利です。

使い方の概要はこのあたり → Using the Execution API | Apps Script | Google Developers
実際のサンプルコードはこのあたり → Create a Target Project for the Apps Script Execution API | Apps Script | Google Developers

詳しくは上記ドキュメントを読めば分かりますが、手順に漏れがあるとうまくいかないので簡単に手順をメモしておきます。試したサンプルコードは PHP のサンプルコードです。

まず事前準備ですが、通常の Google の API を利用する手順と同様です。

Google Developers Console にてプロジェクト作成。もしくは既存のプロジェクトを利用。
「APIと認証」-「API」にて「Google Apps Script Execution API」を有効にする。
「APIと認証」-「認証情報」にて「OAuth 2.0 クライアント ID」を作成。作成するアプリケーションの種類は「その他」にする。

クライアント ID の作成のところで、作成するアプリケーションをウェブアプリケーションにしてしまうと、アクセストークン取得のところで redirect_uri の指定がないというエラーになるので注意。

次に実行したい Google Apps Script をスクリプトエディタで開くか新規作成します。スクリプトが完成したら、「リソース」メニューにある「Developer Console プロジェクト」を選択します。

↑ 「Developer Console プロジェクト」を開く。

↑ 「プロジェクトを変更」から、最初に作成したプロジェクトの番号を指定して関連付けを変更します。(すでに関連付けられているプロジェクトに新たに OAuth 2.0 のクライアント ID を作成してもいいです。)

次にスクリプトエディタの「公開」メニューから「実行可能 API として導入」を選択し、自分だけアクセス可能な状態で公開します。

↑ これをやっておかないと外部実行できません。

(追記 2015-10-27) なお、スクリプトを編集したらその都度上記「実行可能 API として導入」を選択し、新たなバージョンを作成する必要があります。そうしなければ Execution API は常に以前のバージョンのスクリプトを実行し続けてしまうので注意が必要です。

あとは公式の PHP のサンプルコード通りにコードを作成して実行してみます。

すでに Composer でライブラリを導入済みだったら最新のものに更新しておきます。google/google-api-php-client のバージョン 1.1.5 以降が必要です。
サンプルコード内の CREDENTIALS_PATH は一度取得したアクセストークンを保存するファイルなので、事前に用意する必要はありません。
CLIENT_SECRET_PATH に指定されている client_secret.json は、Developers Console からダウンロードできます。
SCOPES に指定するスコープは、実行したい Google Apps Script をスクリプトエディタで開き、「ファイル」-「プロジェクトのプロパティ」に表示されているものを指定します。
$scriptId に指定する値も同様にプロジェクトのプロパティから確認できる「プロジェクトキー」の値を指定します。「実行可能 API として導入」の操作をした際のダイアログにも表示されてます。