Method: scripts.run

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

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

エラー 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 固有のオブジェクト タイプ（Document、Calendar など）にすることはできません。string、number、array、object、boolean などのプリミティブ タイプのみを指定できます。省略可。
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 の場合、error も response も設定されません。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 オブジェクトを 1 つ含む配列。

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