Google apps scriptで作った関数がエディターでは動くが外部から叩けない

googleスプレッドシートにスクリプトを追加しAPIとして公開後、auth認証してjavascriptから呼び出してみたのですが、
スクリプトエディターでは動くのに外部から叩くと動かない関数がありまして、原因を探しています。

例えばgoogle app script側で

google
1function myAPI()
2{
3  var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
4  var ss = sheet.getRange(1,1).getValues();
5  return ss;
6}

このような関数を用意し、外部から実行すると

JSON
1Error calling API:
2{
3  "name": "myAPI",
4  "done": true,
5  "error": {
6    "code": 3,
7    "message": "TypeError",
8    "details": [
9      {
10        "@type": "type.googleapis.com/google.apps.script.v1.ExecutionError",
11        "scriptStackTraceElements": [
12          {
13            "function": "myAPI",
14            "lineNumber": 4
15          }
16        ],
17        "errorMessage": "null のメソッド「getActiveSheet」を呼び出せません。",
18        "errorType": "TypeError"
19      }
20    ]
21  }
22}

といった具合でエラーが返ってきます。
getActiveSheetが実行できていないようです。

しかしLogger.log()などでss変数を覗いてみると、きちんと返ってきました。

呼び出し側のプログラムを変更せず、以下のようなAPIを用意し外部から実行すると通ります。

google
1function myAPI(hoge)
2{
3  var result = [hoge]
4  return JSON.stringify(result);
5
6}

GASで用意されてる関数を叩かなければ、特に問題なく結果が返ってきました。

スクリプトエディターのデバッガーでは値がとれるのに、外部から叩こうとするとエラーがでる原因が知りたいです。なにかご存じの方がいればアドバイスをお願いします。

行動規範の内容に同意します

回答1件

ベストアンサー

GAS側コード

function myAPI()
{
  var ss = SpreadsheetApp.openById("スプレッドシートキー");
  var sh = ss.getActiveSheet();
  var val = sh.getRange(1,1).getValue();
  return val;
}

公開→実行可能APIとして導入から諸々設定

リソース→Developers Console プロジェクトから諸々設定（Execution API有効化、認証設定）

この設定周りはいろいろと面倒くさいのですがキータの記事を参考にしてみてください。

サーバー側に置くHTMLファイル
公式サイトのサンプルを参考に、必要な部分を変更しています。
JavaScript Quickstart

<html>
  <head>
    <script type="text/javascript">
      // Your Client ID can be retrieved from your project in the Google
      // Developer Console, https://console.developers.google.com
      var CLIENT_ID = '<YOUR_CLIENT_ID>'; // ←認証情報設定から拾う

      var SCOPES = ['https://www.googleapis.com/auth/spreadsheets'];

      /**
       * Check if current user has authorized this application.
       */
      function checkAuth() {
        gapi.auth.authorize(
          {
            'client_id': CLIENT_ID,
            'scope': SCOPES.join(' '),
            'immediate': true
          }, handleAuthResult);
      }

      /**
       * Handle response from authorization server.
       *
       * @param {Object} authResult Authorization result.
       */
      function handleAuthResult(authResult) {
        var authorizeDiv = document.getElementById('authorize-div');
        if (authResult && !authResult.error) {
          // Hide auth UI, then load client library.
          authorizeDiv.style.display = 'none';
          callScriptFunction();
        } else {
          // Show auth UI, allowing the user to initiate authorization by
          // clicking authorize button.
          authorizeDiv.style.display = 'inline';
        }
      }

      /**
       * Initiate auth flow in response to user clicking authorize button.
       *
       * @param {Event} event Button click event.
       */
      function handleAuthClick(event) {
        gapi.auth.authorize(
          {client_id: CLIENT_ID, scope: SCOPES, immediate: false},
          handleAuthResult);
        return false;
      }

      /**
       * Calls an Apps Script function to list the folders in the user's
       * root Drive folder.
       */
      function callScriptFunction() {
        var scriptId = "ENTER_YOUR_SCRIPT_ID_HERE"; // ←スクリプトエディタのURL欄から拾うか、「ファイル」→「プロジェクトのプロパティ」から拾う

        // Create an execution request object.
        var request = {
            'function': 'myAPI'
            };

        // Make the API request.
        var op = gapi.client.request({
            'root': 'https://script.googleapis.com',
            'path': 'v1/scripts/' + scriptId + ':run',
            'method': 'POST',
            'body': request
        });

        op.execute(function(resp) {
          if (resp.error && resp.error.status) {
            // The API encountered a problem before the script
            // started executing.
            appendPre('Error calling API:');
            appendPre(JSON.stringify(resp, null, 2));
          } else if (resp.error) {
            // The API executed, but the script returned an error.

            // Extract the first (and only) set of error details.
            // The values of this object are the script's 'errorMessage' and
            // 'errorType', and an array of stack trace elements.
            var error = resp.error.details[0];
            appendPre('Script error message: ' + error.errorMessage);

            if (error.scriptStackTraceElements) {
              // There may not be a stacktrace if the script didn't start
              // executing.
              appendPre('Script error stacktrace:');
              for (var i = 0; i < error.scriptStackTraceElements.length; i++) {
                var trace = error.scriptStackTraceElements[i];
                appendPre('\t' + trace.function + ':' + trace.lineNumber);
              }
            }
          } else {
            // The structure of the result will depend upon what the Apps
            // Script function returns. Here, the function returns an Apps
            // Script Object with String keys and values, and so the result
            // is treated as a JavaScript object (folderSet).
            var folderSet = resp.response.result;
            if (Object.keys(data).length == 0) {
                appendPre('No data returned!');
            } else {
              Object.keys(data).forEach(function(id){
                appendPre(data[id]);
              });
            }
          }
        });
      }

      /**
       * Append a pre element to the body containing the given message
       * as its text node.
       *
       * @param {string} message Text to be placed in pre element.
       */
      function appendPre(message) {
        var pre = document.getElementById('output');
        var textContent = document.createTextNode(message);
        pre.appendChild(textContent);
      }

    </script>
    <script src="https://apis.google.com/js/client.js?onload=checkAuth">
    </script>
  </head>
  <body>
    <div id="authorize-div" style="display: none">
      <span>Authorize access to Google Apps Script Execution API</span>
      <!--Button for the user to click to initiate auth sequence -->
      <button id="authorize-button" onclick="handleAuthClick(event)">
        Authorize
      </button>
    </div>
    <pre id="output"></pre>
  </body>
</html>

これでA1に入力した値がそのままブラウザに表示されると思います。

投稿2016/11/14 01:56