Apps Script API(旧称 Apps Script Execution API)を使用すると、アクセス権のあるスクリプト プロジェクトの関数をリモートで実行できます。お客様の アプリは特定の Apps Script 関数を呼び出せます。その際、入力パラメータを渡すと、 返されたレスポンスを受け取ります。
このページの例は、一般的な実行オペレーションが、 API で実現できますP-MAX などの 承認要件、 関数の実行ガイドをご覧ください。
以下の例では、scriptId というプレースホルダを使用して、スクリプト プロジェクト ID をどこで指定するかを示しています。詳しくは、 スクリプト ID を確認する手順は次のとおりです。
- Apps Script プロジェクトの左上にある [プロジェクトの設定] をクリックします。 。
- [スクリプト ID]の横の[コピー] をクリックします。
関数を実行
次の scripts.run
リクエストが listFolderContent
という名前の Apps Script 関数を呼び出し、
ドライブの folderId と整数の MAX_SIZE
を引数として返します。「
関数は開発モードで実行されるため、最後に実行した
実行されているバージョンにかかわらず、関数の保存バージョンが実行されます。
実行可能なファイルとしてデプロイされます
リクエスト プロトコルを以下に示します。「 関数の実行ガイド を使用して、Google Cloud SDK を使用してさまざまな言語で実行リクエストを実装する方法を API クライアント ライブラリ。
POST https://script.googleapis.com/v1/scripts/scriptId:run
{ "function": "listFolderContent", "parameters": [ folderId, MAX_SIZE ], "devMode": true }
レスポンス 呼び出された Apps Script 関数が完了すると、 実行結果またはエラー レスポンスが含まれます。この例では、関数はファイル名の配列を正常に返します。
{ "response": { "result": [ "fileTitle1", "fileTitle2", "fileTitle3" ] }, }
Apps Script の実行中に関数でエラーが発生した場合、 次のようになります。
{ "response": { "error": { "code": 3, "message": "ScriptError", "details": [{ "@type": "type.googleapis.com/google.apps.script.v1.ExecutionError", "errorMessage": "The script enountered an exeception it could not resolve.", "errorType": "ScriptError", "scriptStackTraceElements": [{ "function": "listFolderContent", "lineNumber": 14 }] }] } } }