Method: scripts.run

Apps Script プロジェクトで関数を実行します。Apps Script API で使用するスクリプト プロジェクトをデプロイして、呼び出し元アプリケーションが同じ Cloud Platform プロジェクトを共有する必要があります。

この方法では、承認セクションに記載されているスコープを少なくとも 1 つ含む OAuth 2.0 トークンによる承認が必要です。承認を必要としないスクリプト プロジェクトはこの API で実行できません。認証トークンに含める正しいスコープを確認するには、スクリプト プロジェクトの [Overview] ページを開き、[Project OAuth Scopes] まで下にスクロールします。

エラー 403, PERMISSION_DENIED: The caller does not have permission は、リクエストの承認に使用された Cloud Platform プロジェクトが、スクリプトで使用されているプロジェクトと同じでないことを示します。

HTTP リクエスト

POST https://script.googleapis.com/v1/scripts/{scriptId}:run

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
scriptId

string

実行されるスクリプトのスクリプト ID。スクリプト ID は、[プロジェクトの設定] ページの [ID] で確認できます。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "function": string,
  "parameters": [
    value
  ],
  "sessionState": string,
  "devMode": boolean
}
フィールド
function

string

指定されたスクリプトで実行する関数の名前。名前にかっこやパラメータは含まれません。Library.libFunction1 などのインクルード ライブラリの関数を参照できます。

parameters[]

value (Value format)

実行される関数に渡されるパラメータ。各パラメータのオブジェクト タイプは、Apps Script で想定されるタイプと一致している必要があります。パラメータは、Apps Script 固有のオブジェクト型(DocumentCalendar など)にはできません。stringnumberarrayobjectboolean などのプリミティブ型のみを指定できます。省略可。

sessionState

string

この権限のサポートは終了しており、Android アドオンでのみ使用します。Google ドキュメントまたはスプレッドシートの Android アプリでのユーザーの現在のセッションを表す ID。アドオンを起動する Intent に追加データとして含まれます。Android アドオンをセッション状態で実行すると、バインドされたスクリプトの権限が付与されます。つまり、ユーザーの現在のカーソル位置(ドキュメント内)や選択したセル(スプレッドシート内)などの情報にアクセスできます。状態を取得するには、Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState") を呼び出します。省略可。

devMode

boolean

true の場合、ユーザーがスクリプトのオーナーであれば、Apps Script API で使用するためにデプロイされたバージョンではなく、最後に保存したバージョンでスクリプトが実行されます。省略可。デフォルトは false です。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

run で開始された Apps Script 関数の実行を示しています。関数の実行が完了するまで、実行レスポンスは届きません。最大実行ランタイムについては、Apps Script の割り当てガイドをご覧ください。

実行が開始されると、結果は次の 4 つのいずれかになります。

  • スクリプト関数が正常に返された場合、response フィールドには、関数の戻り値がオブジェクトの result フィールドに格納された ExecutionResponse オブジェクトが含まれます。
  • スクリプト関数(または Apps Script 自体)が例外をスローした場合、error フィールドに Status オブジェクトが含まれます。Status オブジェクトの details フィールドには、エラーの性質に関する情報を提供する単一の ExecutionError オブジェクトを含む配列が含まれます。
  • 実行がまだ完了していない場合、done フィールドは false になり、response フィールドも error フィールドも存在しません。
  • run 呼び出し自体が失敗した場合(リクエストの形式が正しくない場合や認証エラーなどが原因で)、メソッドはレスポンス本文の形式が異なる 4XX 範囲の HTTP レスポンス コードを返します。クライアント ライブラリは、4XX レスポンスを自動的に例外クラスに変換します。

JSON 表現
{
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
フィールド
done

boolean

このフィールドは、スクリプトの実行が完了したかどうかを示します。完了した実行には、実行された関数の ExecutionResponse を含む response フィールドにデータが入力されます。

共用体フィールド result。オペレーションの結果。error または有効な response になります。done == false の場合、errorresponse も設定されません。done == true の場合、error または response のいずれか 1 つのみを設定できます。一部のサービスでは結果が提供されないことがあります。result は次のいずれかになります。
error

object (Status)

run の呼び出しが成功したものの、スクリプト関数(または Apps Script 自体)が例外をスローした場合、このフィールドには Status オブジェクトが格納されます。Status オブジェクトの details フィールドには、エラーの性質に関する情報を提供する単一の ExecutionError オブジェクトを含む配列が含まれます。

response

object

スクリプト関数が正常に返された場合、このフィールドには関数の戻り値を含む ExecutionResponse オブジェクトが含まれます。

任意のデータ型のフィールドを含むオブジェクト。タイプを識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://apps-apis.google.com/a/feeds
  • https://apps-apis.google.com/a/feeds/alias/
  • https://apps-apis.google.com/a/feeds/groups/
  • https://mail.google.com/
  • https://sites.google.com/feeds
  • https://www.google.com/calendar/feeds
  • https://www.google.com/m8/feeds
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/dynamiccreatives
  • https://www.googleapis.com/auth/forms
  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/groups
  • https://www.googleapis.com/auth/script.cpanel
  • https://www.googleapis.com/auth/script.external_request
  • https://www.googleapis.com/auth/script.scriptapp
  • https://www.googleapis.com/auth/script.send_mail
  • https://www.googleapis.com/auth/script.storage
  • https://www.googleapis.com/auth/script.webapp.deploy
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/sqlservice
  • https://www.googleapis.com/auth/userinfo.email

詳細については、OAuth 2.0 の概要をご覧ください。

ステータス

run の呼び出しが成功したものの、スクリプト関数(または Apps Script 自体)が例外をスローした場合、レスポンス本文の error フィールドにこの Status オブジェクトが含まれます。

JSON 表現
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
フィールド
code

integer

ステータス コード。この API の場合、この値は次のいずれかになります。

  • 10、SCRIPT_TIMEOUT エラーを示している。
  • 3: INVALID_ARGUMENT エラーを示しています。
  • 1。CANCELLED の実行を示します。

message

string

デベロッパー向けのエラー メッセージ(英語)。ユーザー向けのエラー メッセージは、ローカライズされて details フィールドで送信されるか、クライアントによってローカライズされます。

details[]

object

エラーの性質に関する情報を提供する単一の ExecutionError オブジェクトを含む配列。

任意のデータ型のフィールドを含むオブジェクト。タイプを識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }