ExecutionRequest

import type { ExecutionRequest } from "https://googleapis.deno.dev/v1/script:v1.ts";

A request to run the function in a script. The script is identified by the specified script_id. Executing a function on a script returns results based on the implementation of the script.

interface ExecutionRequest {

devMode?: boolean;

function?: string;

parameters?: any[];

sessionState?: string;

}

§Properties

devMode?: boolean

[src]

If true and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Apps Script API. Optional; default is false.

function?: string

[src]

The name of the function to execute in the given script. The name does not include parentheses or parameters. It can reference a function in an included library such as Library.libFunction1.

parameters?: any[]

[src]

The parameters to be passed to the function being executed. The object type for each parameter should match the expected type in Apps Script. Parameters cannot be Apps Script-specific object types (such as a Document or a Calendar); they can only be primitive types such as string, number, array, object, or boolean. Optional.

sessionState?: string

[src]

Deprecated. For use with Android add-ons only. An ID that represents the user's current session in the Android app for Google Docs or Sheets, included as extra data in the Intent that launches the add-on. When an Android add-on is run with a session state, it gains the privileges of a bound script—that is, it can access information like the user's current cursor position (in Docs) or selected cell (in Sheets). To retrieve the state, call Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState"). Optional.