「「GAS Station #2」に参加してきました。」で書いた通り、先週GAS(Google Apps Script)のハンズオンイベント「GAS Station #2」に参加し、新しいAPI「Apps Script Execution API」を触ってきたので、どんな感じで使うのかを書いていこうと思います。

Execution APIは“自分が書いたGAS関数を外部から呼び出すAPI”で、複数のGoogleサービスを跨ぐ処理を行いたい場合、一つの関数にまとめてしまえば、単一のエンドポイントから処理を実行することができます。
(Office 365のunified APIに似ているところがありますね。)

参考情報

• GASのExecution APIを使ってGASを外部からぶっ叩く
• http://qiita.com/soundTricker/items/1bcfc5c9e80d29a7ae4b
• Apps Script Execution API
• https://developers.google.com/apps-script/guides/rest/
• Run Apps Script code from anywhere using the Execution API
• http://googleappsdeveloper.blogspot.jp/2015/09/run-apps-script-code-from-anywhere.html

呼び出すスクリプトの準備

1. シート名を取得するスクリプトを呼び出すため、適当にスプレッドシートを用意します。シートのIDは下図の通り、URLから取得することができます。



2. https://script.google.com/ から「空のプロジェクト」を作成します。



3. 下記コードを貼り付けた後「myFunction」を実行し、動作確認を行います。

function getSheetNames(sheetId) {
  var ss = SpreadsheetApp.openById(sheetId);
  var sheets = ss.getSheets();
  return sheets.map(function(sheet) {
    return sheet.getName();
  });
}

function myFunction() {
  Logger.log(getSheetNames("シートID"));
}







4. シート名が取得できれば動作確認終了です。

API IDとスコープの取得

1. 公開メニューから「実行可能 API として導入」をクリックします。



2. 実行可能 API として導入画面が表示されたらバージョンを入力し、「導入」ボタンをクリックします。



3. 「スクリプトの新しいバージョンで新しいスコープが検出されました」との警告が表示された場合は、「続行」ボタンをクリックします。



4. 「現在の API ID:」欄にAPI IDが表示されるので、メモ帳にコピーしておきます。



5. ファイルメニューから「プロジェクトのプロパティ」をクリックします。



6. 「スコープ」タブに表示される OAuth スコープをメモ帳にコピーしておきます(今回の場合は https://www.googleapis.com/auth/spreadsheets )。

クライアント IDとクライアント シークレットの取得

1. リソースメニューから「Developers Console プロジェクト」をクリックします。



2. Developers Console プロジェクト画面が表示されたら「このスクリプトが現在関連付けられているプロジェクト」の下にあるリンクをクリックします。



3. Developers Consoleが表示されたら「APIと認証」から「API」を開きます。
4. API ライブラリの検索ボックスに「Execution」と入力し、「Google Apps Script Execution API」を有効にします。





5. 「APIと認証」から「認証情報」を開きます。
6. 「認証情報を追加」から「OAuth 2.0 クライアント ID」をクリックします。



7. クライアント ID の作成画面が表示されたら下記情報を入力し「作成」ボタンをクリックします。

※ 通常はここでアプリに合わせた設定を行います。

• アプリケーションの種類：ウェブ アプリケーション
• 名前：Sample Client
• 承認済みの JavaScript 生成元：https://developers.google.com
• 承認済みのリダイレクト URI：https://developers.google.com/oauthplayground



8. OAuth クライアント画面に表示される「クライアント ID」と「クライアント シークレット」をメモ帳にコピーし、「OK」ボタンをクリックします。

OAuth Playgroundによる動作確認

1. 「OAuth Playground」を開きます。
2. OAuth 2.0 Configurationから「Use your own OAuth credentials」にチェックを入れ、「OAuth Client ID:」欄と「OAuth Client secret:」欄に、コピーしておいたクライアント IDとクライアント シークレットを貼り付けます。



3. Step 1 Select & authorize APIsにある「Input your own scopes」欄にコピーしておいたスコープを貼り付け「Authorize APIs」ボタンをクリックします。



4. 許可のリクエスト画面が表示されたら「許可」ボタンをクリックします。



5. Step 2 Exchange authorization code for tokensにAuthorization codeが表示されたら「Exchange authorization code for tokens」ボタンをクリックします。



6. Step 3 Configure request to APIが表示されるので、下記のように項目を設定し、「Send the request」ボタンをクリックします。
• HTTP Method：POST
• Request URI：https://script.googleapis.com/v1/scripts/(API ID):run
• Content-Type：application/json
• Enter request body：

{
    'function': 'getSheetNames',
    'parameters': '(シートID)',
    'devMode': true
}

※ 各パラメーターの説明は「GASのExecution APIを使ってGASを外部からぶっ叩く」をご参照ください。





7. 無事にスクリプトが呼び出せれば、JSON形式で結果が返ってきます。

というわけで、「GASのExecution APIを使ってGASを外部からぶっ叩く」を見ながらAPIを試してみましたが、特に問題もなく動作確認できました。

ただ、下記のような拡張サービスのURL Shortener APIを使ったコードを呼び出そうとしたところ、

function getShortUrl(url){
  return UrlShortener.Url.insert({longUrl:url}).id
}

下記のPERMISSION_DENIEDエラーが返ってきました。

HTTP/1.1 403 Forbidden
Alternate-protocol: 443:quic,p=1
Content-length: 138
X-xss-protection: 1; mode=block
X-content-type-options: nosniff
Transfer-encoding: chunked
Vary: Origin, X-Origin, Referer
Server: ESF
-content-encoding: gzip
Cache-control: private
Date: Fri, 16 Oct 2015 02:20:59 GMT
X-frame-options: SAMEORIGIN
Alt-svc: quic=":443"; p="1"; ma=604800
Content-type: application/json; charset=UTF-8
Www-authenticate: Bearer realm="https://accounts.google.com/", error="insufficient_scope", scope="https://www.googleapis.com/auth/directory.group https://spreadsheets.google.com/feeds/worksheets/ https://sites.google.com/feeds/ https://apps-apis.google.com/a/feeds/ https://mail.google.com/mail/ https://www.google.com/m8/feeds http://mail.google.com/ https://www.googleapis.com/auth/script.storage https://www.googleapis.com/auth/forms https://apps-apis.google.com/a/feeds https://www.googleapis.com/auth/admin.directory.user https://mail.google.com/mail https://www.googleapis.com/auth/drive https://spreadsheets.google.com/feeds https://www.googleapis.com/auth/script.webapp.deploy https://www.googleapis.com/auth/admin.directory.group https://www.googleapis.com/auth/groups http://sites.google.com/feeds/#readonly https://mail.google.com https://www.google.com/calendar/feeds/ http://mail.google.com https://www.google.com/calendar/feeds/default/owncalendars/full https://apps-apis.google.com/a/feeds/alias/ https://www.googleapis.com/auth/forms.currentonly https://www.googleapis.com/auth/directory.user https://www.googleapis.com/auth/userinfo#email https://www.google.com/m8/feeds/contacts/default/full https://www.googleapis.com/auth/gpa https://www.googleapis.com/auth/script.send_mail http://sites.google.com/feeds https://www.google.com/m8/feeds/groups/ https://www.googleapis.com/auth/calendar https://www.google.com/m8/feeds/photos/ tag:google.com,2010:auth/groups2 https://mail.google.com/mail/feed/atom https://www.googleapis.com/auth/sqlservice https://www.googleapis.com/auth/documents https://www.google.com/m8/feeds/contacts https://www.google.com/m8/feeds/groups https://www.google.com/m8/feeds/profiles https://spreadsheets.google.com/feeds/spreadsheets https://sites.google.com/feeds/#readonly https://www.googleapis.com/auth/dynamiccreatives https://apps-apis.google.com/a/feeds/groups/ https://www.googleapis.com/auth/script.cpanel http://sites.google.com/feeds/ https://www.googleapis.com/auth/contacts https://www.googleapis.com/auth/script.external_request https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/spreadsheets https://www.googleapis.com/auth/apps.directory.user http://spreadsheets.google.com/feeds/ https://www-opensocial.googleusercontent.com/api/people/@me/@self https://mail.google.com/ https://www.googleapis.com/auth/apps.directory.group https://sites.google.com/feeds https://www.google.com/m8/feeds/photos https://www.google.com/m8/feeds/profiles/ http://www.google.com/calendar/feeds/default/allcalendars/full https://mail.google.com/a/ https://www.google.com/m8/feeds/ https://mail.google.com/mail/feed/atom/ https://www.googleapis.com/auth/script.scriptapp https://www.googleapis.com/auth/documents.currentonly https://www.google.com/calendar/feeds https://www.google.com/m8/feeds/contacts/ https://spreadsheets.google.com/feeds/ https://www.googleapis.com/auth/spreadsheets.currentonly"
{
  "error": {
    "status": "PERMISSION_DENIED", 
    "message": "Request had insufficient authentication scopes.", 
    "code": 403
  }
}

「Method scripts.run」にも書いてありますが、現時点ではすべてのスコープに対応しているわけでは無さそうです。
このあたりは今後に期待したいところですね！

2015/11/19 追記：
VBAからの呼び出しについて記事を書きました。

・VBAマクロからGoogle Apps Script Execution APIを呼び出す。
//www.ka-net.org/blog/?p=6415