Google Apps Script API には、指定された Apps Script 関数をリモートで実行する scripts.run
メソッドが用意されています。呼び出し元アプリケーションでこのメソッドを使用して、いずれかのスクリプト プロジェクトの関数をリモートで実行し、レスポンスを受け取ることができます。
要件
呼び出し元アプリで scripts.run
メソッドを使用するには、次の要件を満たす必要があります。必要なこと:
スクリプト プロジェクトを API 実行可能ファイルとしてデプロイします。必要に応じて、プロジェクトのデプロイ、デプロイ解除、再デプロイを行うことができます。
適切なスコープで実行用の OAuth トークンを指定します。この OAuth トークンは、呼び出された関数で使用されるものだけでなく、スクリプトで使用されるすべてのスコープを網羅している必要があります。メソッド リファレンスで認可スコープの全一覧をご覧ください。
スクリプトと呼び出し元アプリケーションの OAuth2 クライアントが共通の Google Cloud プロジェクトを共有していることを確認します。Cloud プロジェクトは標準の Cloud プロジェクトである必要があります。Apps Script プロジェクト用に作成されたデフォルトのプロジェクトだけでは不十分です。新しい標準 Cloud プロジェクトまたは既存の標準プロジェクトを使用できます。
Cloud プロジェクトで Google Apps Script API を有効にします。
scripts.run
メソッド
scripts.run
メソッドを実行するには、キー識別情報が必要です。
- スクリプト プロジェクトの ID。
- 実行する関数の名前。
- 関数に必要なパラメータのリスト(存在する場合)。
必要に応じて、開発モードで実行するようにスクリプトを構成できます。このモードは、最後にデプロイされたバージョンではなく、最後に保存されたスクリプト プロジェクトのバージョンで実行されます。これを行うには、リクエスト本文で devMode
ブール値を true
に設定します。開発モードでスクリプトを実行できるのは、そのスクリプトのオーナーのみです。
パラメータのデータ型を処理する
Apps Script API の scripts.run
メソッドを使用する場合、通常、データを関数パラメータとして Apps Script に送信し、関数の戻り値としてデータを取得します。この API は、基本型(文字列、配列、オブジェクト、数値、ブール値)の値のみを受け取り、返すことができます。これらは JavaScript の基本的な型に似ています。Document や Sheet のような複雑な Apps Script オブジェクトは、API でスクリプト プロジェクトとの間でやり取りすることはできません。
呼び出し元のアプリケーションが Java などの厳密に型指定された言語で記述されている場合、パラメータはこれらの基本的な型に対応する汎用オブジェクトのリストまたは配列として渡されます。多くの場合、単純な型変換を自動的に適用できます。たとえば、数値パラメータを受け取る関数に、追加の処理を行うことなく、Java Double
、Integer
、Long
オブジェクトをパラメータとして指定できます。
API が関数のレスポンスを返す場合、多くの場合、返される値を使用する前に正しい型にキャストする必要があります。Java ベースの例をいくつか示します。
- API から Java アプリケーションに返される数値は
java.math.BigDecimal
オブジェクトとして送信されます。数値は、必要に応じてDoubles
型またはint
型に変換する必要があります。 Apps Script 関数が文字列の配列を返す場合、Java アプリケーションはレスポンスを
List<String>
オブジェクトにキャストします。List<String> mylist = (List<String>)(op.getResponse().get("result"));
Bytes
の配列を返す場合は、Apps Script 関数内で配列を base64 文字列としてエンコードし、その文字列を代わりに返すと便利です。return Utilities.base64Encode(myByteArray); // returns a String.
以下のコードサンプルの例は、API レスポンスの解釈方法を示しています。
一般的な手順
Apps Script API を使用して Apps Script 関数を実行する一般的な手順は次のとおりです。
ステップ 1: 共通の Cloud プロジェクトを設定する
スクリプトと呼び出し元アプリケーションの両方が同じ Cloud プロジェクトを共有している必要があります。この Cloud プロジェクトは、既存のプロジェクトでも、この目的で作成された新しいプロジェクトでもかまいません。Cloud プロジェクトを取得したら、そのプロジェクトを使用するようにスクリプト プロジェクトを切り替える必要があります。
ステップ 2: API 実行可能ファイルとしてスクリプトをデプロイする
- 使用する関数がある Apps Script プロジェクトを開きます。
- 右上の [デプロイ] > [新しいデプロイ] をクリックします。
- 表示されたダイアログで、デプロイタイプを有効にする > [API Executable] をクリックします。
- [アクセスできるユーザー] プルダウン メニューで、Apps Script API を使用してスクリプトの関数を呼び出すことを許可するユーザーを選択します。
- [Deploy] をクリックします。
ステップ 3: 呼び出し元アプリケーションを構成する
呼び出し元のアプリケーションで Apps Script API を有効にして、OAuth 認証情報を確立してから使用する必要があります。この操作を行うには、Cloud プロジェクトへのアクセス権が必要です。
- 呼び出し元のアプリケーションとスクリプトが使用する Cloud プロジェクトを構成します。手順は次のとおりです。
- スクリプト プロジェクトを開き、左側の [概要] をクリックします。
- [プロジェクト OAuth スコープ] で、スクリプトに必要なすべてのスコープを記録します。
呼び出し元のアプリケーション コードで、API 呼び出し用の OAuth アクセス トークン スクリプトを生成します。これは API 自体が使用するトークンではなく、スクリプトの実行時に必要となるトークンです。これは、Cloud プロジェクトのクライアント ID と記録しておいたスクリプト スコープを使用してビルドする必要があります。
Google クライアント ライブラリは、このトークンの作成とアプリケーションでの OAuth の処理に大いに役立ちます。通常は、スクリプト スコープを使用して、より高いレベルの「認証情報」オブジェクトを作成できます。スコープのリストから認証情報オブジェクトを作成する例については、Apps Script API クイックスタートをご覧ください。
ステップ 4: script.run
リクエストを行う
呼び出し元アプリケーションの構成が完了すると、scripts.run
を呼び出せるようになります。各 API 呼び出しは、次のステップで構成されます。
- スクリプト ID、関数名、必要なパラメータを使用して API リクエストを作成します。
scripts.run
呼び出しを行い、作成したスクリプト OAuth トークンをヘッダーに含めるか(基本的なPOST
リクエストを使用している場合)、スクリプト スコープを使用して作成した認証情報オブジェクトを使用します。- スクリプトの実行が完了するまで待ちます。スクリプトの実行には最大 6 分かかるため、アプリケーションはこれを考慮する必要があります。
- 終了時にスクリプト関数は値を返すことがあります。値がサポートされているタイプであれば、API はそれをアプリケーションに返します。
以下に script.run
API 呼び出しの例を示します。
API リクエストの例
次の例は、さまざまな言語で Apps Script API 実行リクエストを行い、Apps Script 関数を呼び出して、ユーザーのルート ディレクトリにあるフォルダのリストを出力する方法を示しています。実行される関数を含む Apps Script プロジェクトのスクリプト ID を、ENTER_YOUR_SCRIPT_ID_HERE
で示される場所に指定する必要があります。各例では、それぞれの言語の Google API クライアント ライブラリを使用しています。
ターゲット スクリプト
このスクリプトの関数は、Drive API を使用します。
スクリプトをホストするプロジェクトで Drive API を有効にする必要があります。
また、呼び出し元アプリケーションは、次のドライブ スコープを含む OAuth 認証情報を送信する必要があります。
https://www.googleapis.com/auth/drive
ここで紹介するサンプル アプリケーションでは、Google クライアント ライブラリを使用し、このスコープを使用して OAuth 用の認証情報オブジェクトをビルドしています。
/**
* Return the set of folder names contained in the user's root folder as an
* object (with folder IDs as keys).
* @return {Object} A set of folder names keyed by folder ID.
*/
function getFoldersUnderRoot() {
const root = DriveApp.getRootFolder();
const folders = root.getFolders();
const folderSet = {};
while (folders.hasNext()) {
const folder = folders.next();
folderSet[folder.getId()] = folder.getName();
}
return folderSet;
}
Java
/**
* Create a HttpRequestInitializer from the given one, except set
* the HTTP read timeout to be longer than the default (to allow
* called scripts time to execute).
*
* @param {HttpRequestInitializer} requestInitializer the initializer
* to copy and adjust; typically a Credential object.
* @return an initializer with an extended read timeout.
*/
private static HttpRequestInitializer setHttpTimeout(
final HttpRequestInitializer requestInitializer) {
return new HttpRequestInitializer() {
@Override
public void initialize(HttpRequest httpRequest) throws IOException {
requestInitializer.initialize(httpRequest);
// This allows the API to call (and avoid timing out on)
// functions that take up to 6 minutes to complete (the maximum
// allowed script run time), plus a little overhead.
httpRequest.setReadTimeout(380000);
}
};
}
/**
* Build and return an authorized Script client service.
*
* @param {Credential} credential an authorized Credential object
* @return an authorized Script client service
*/
public static Script getScriptService() throws IOException {
Credential credential = authorize();
return new Script.Builder(
HTTP_TRANSPORT, JSON_FACTORY, setHttpTimeout(credential))
.setApplicationName(APPLICATION_NAME)
.build();
}
/**
* Interpret an error response returned by the API and return a String
* summary.
*
* @param {Operation} op the Operation returning an error response
* @return summary of error response, or null if Operation returned no
* error
*/
public static String getScriptError(Operation op) {
if (op.getError() == null) {
return null;
}
// Extract the first (and only) set of error details and cast as a Map.
// The values of this map are the script's 'errorMessage' and
// 'errorType', and an array of stack trace elements (which also need to
// be cast as Maps).
Map<String, Object> detail = op.getError().getDetails().get(0);
List<Map<String, Object>> stacktrace =
(List<Map<String, Object>>) detail.get("scriptStackTraceElements");
java.lang.StringBuilder sb =
new StringBuilder("\nScript error message: ");
sb.append(detail.get("errorMessage"));
sb.append("\nScript error type: ");
sb.append(detail.get("errorType"));
if (stacktrace != null) {
// There may not be a stacktrace if the script didn't start
// executing.
sb.append("\nScript error stacktrace:");
for (Map<String, Object> elem : stacktrace) {
sb.append("\n ");
sb.append(elem.get("function"));
sb.append(":");
sb.append(elem.get("lineNumber"));
}
}
sb.append("\n");
return sb.toString();
}
public static void main(String[] args) throws IOException {
// ID of the script to call. Acquire this from the Apps Script editor,
// under Publish > Deploy as API executable.
String scriptId = "ENTER_YOUR_SCRIPT_ID_HERE";
Script service = getScriptService();
// Create an execution request object.
ExecutionRequest request = new ExecutionRequest()
.setFunction("getFoldersUnderRoot");
try {
// Make the API request.
Operation op =
service.scripts().run(scriptId, request).execute();
// Print results of request.
if (op.getError() != null) {
// The API executed, but the script returned an error.
System.out.println(getScriptError(op));
} else {
// The result provided by the API needs to be cast into
// the correct type, based upon what types the Apps
// Script function returns. Here, the function returns
// an Apps Script Object with String keys and values,
// so must be cast into a Java Map (folderSet).
Map<String, String> folderSet =
(Map<String, String>) (op.getResponse().get("result"));
if (folderSet.size() == 0) {
System.out.println("No folders returned!");
} else {
System.out.println("Folders under your root folder:");
for (String id : folderSet.keySet()) {
System.out.printf(
"\t%s (%s)\n", folderSet.get(id), id);
}
}
}
} catch (GoogleJsonResponseException e) {
// The API encountered a problem before the script was called.
e.printStackTrace(System.out);
}
}
JavaScript
/**
* Load the API and make an API call. Display the results on the screen.
*/
function callScriptFunction() {
const scriptId = '<ENTER_YOUR_SCRIPT_ID_HERE>';
// Call the Apps Script API run method
// 'scriptId' is the URL parameter that states what script to run
// 'resource' describes the run request body (with the function name
// to execute)
try {
gapi.client.script.scripts.run({
'scriptId': scriptId,
'resource': {
'function': 'getFoldersUnderRoot',
},
}).then(function(resp) {
const result = resp.result;
if (result.error && result.error.status) {
// The API encountered a problem before the script
// started executing.
appendPre('Error calling API:');
appendPre(JSON.stringify(result, null, 2));
} else if (result.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.
const error = result.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 (let i = 0; i < error.scriptStackTraceElements.length; i++) {
const 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).
const folderSet = result.response.result;
if (Object.keys(folderSet).length == 0) {
appendPre('No folders returned!');
} else {
appendPre('Folders under your root folder:');
Object.keys(folderSet).forEach(function(id) {
appendPre('\t' + folderSet[id] + ' (' + id + ')');
});
}
}
});
} catch (err) {
document.getElementById('content').innerText = err.message;
return;
}
}
Node.js
/**
* Call an Apps Script function to list the folders in the user's root Drive
* folder.
*
*/
async function callAppsScript() {
const scriptId = '1xGOh6wCm7hlIVSVPKm0y_dL-YqetspS5DEVmMzaxd_6AAvI-_u8DSgBT';
const {GoogleAuth} = require('google-auth-library');
const {google} = require('googleapis');
// Get credentials and build service
// TODO (developer) - Use appropriate auth mechanism for your app
const auth = new GoogleAuth({
scopes: 'https://www.googleapis.com/auth/drive',
});
const script = google.script({version: 'v1', auth});
try {
// Make the API request. The request object is included here as 'resource'.
const resp = await script.scripts.run({
auth: auth,
resource: {
function: 'getFoldersUnderRoot',
},
scriptId: scriptId,
});
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.
const error = resp.error.details[0];
console.log('Script error message: ' + error.errorMessage);
console.log('Script error stacktrace:');
if (error.scriptStackTraceElements) {
// There may not be a stacktrace if the script didn't start executing.
for (let i = 0; i < error.scriptStackTraceElements.length; i++) {
const trace = error.scriptStackTraceElements[i];
console.log('\t%s: %s', 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
// Node.js object (folderSet).
const folderSet = resp.response.result;
if (Object.keys(folderSet).length == 0) {
console.log('No folders returned!');
} else {
console.log('Folders under your root folder:');
Object.keys(folderSet).forEach(function(id) {
console.log('\t%s (%s)', folderSet[id], id);
});
}
}
} catch (err) {
// TODO(developer) - Handle error
throw err;
}
}
Python
import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
def main():
"""Runs the sample."""
# pylint: disable=maybe-no-member
script_id = "1VFBDoJFy6yb9z7-luOwRv3fCmeNOzILPnR4QVmR0bGJ7gQ3QMPpCW-yt"
creds, _ = google.auth.default()
service = build("script", "v1", credentials=creds)
# Create an execution request object.
request = {"function": "getFoldersUnderRoot"}
try:
# Make the API request.
response = service.scripts().run(scriptId=script_id, body=request).execute()
if "error" in response:
# 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
# a list of stack trace elements.
error = response["error"]["details"][0]
print(f"Script error message: {0}.{format(error['errorMessage'])}")
if "scriptStackTraceElements" in error:
# There may not be a stacktrace if the script didn't start
# executing.
print("Script error stacktrace:")
for trace in error["scriptStackTraceElements"]:
print(f"\t{0}: {1}.{format(trace['function'], trace['lineNumber'])}")
else:
# The structure of the result depends 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 Python dictionary (folder_set).
folder_set = response["response"].get("result", {})
if not folder_set:
print("No folders returned!")
else:
print("Folders under your root folder:")
for folder_id, folder in folder_set.items():
print(f"\t{0} ({1}).{format(folder, folder_id)}")
except HttpError as error:
# The API encountered a problem before the script started executing.
print(f"An error occurred: {error}")
print(error.content)
if __name__ == "__main__":
main()
制限事項
Apps Script API にはいくつかの制限があります。
共通の Cloud プロジェクト。呼び出されるスクリプトと呼び出し元のアプリケーションは、Cloud プロジェクトを共有する必要があります。Cloud プロジェクトは標準の Cloud プロジェクトである必要があります。Apps Script プロジェクト用に作成されたデフォルトのプロジェクトだけでは不十分です。標準 Cloud プロジェクトは、新しいプロジェクトまたは既存のプロジェクトです。
基本的なパラメータと戻り値の型。この API では、Apps Script 固有のオブジェクト(Documents、Blobs、Calendars、Drive Files など)をアプリケーションに渡すことも、返すこともできません。渡して返すことができるのは、文字列、配列、オブジェクト、数値、ブール値などの基本的な型のみです。
OAuth スコープ。API は、必要なスコープを少なくとも 1 つ持つスクリプトのみを実行できます。つまり、1 つ以上のサービスの承認を必要としないスクリプトを API を使用して呼び出すことはできません。
トリガーなし。API は Apps Script トリガーを作成できません。