Script

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

Manages and executes Google Apps Script projects.

class Script {

constructor(client?: CredentialsClient, baseUrl?: string);

async processesList(opts?: ProcessesListOptions): Promise<ListUserProcessesResponse>;

async processesListScriptProcesses(opts?: ProcessesListScriptProcessesOptions): Promise<ListScriptProcessesResponse>;

async projectsCreate(req: CreateProjectRequest): Promise<Project>;

async projectsDeploymentsCreate(scriptId: string, req: DeploymentConfig): Promise<Deployment>;

async projectsDeploymentsDelete(deploymentId: string, scriptId: string): Promise<Empty>;

async projectsDeploymentsGet(deploymentId: string, scriptId: string): Promise<Deployment>;

async projectsDeploymentsList(scriptId: string, opts?: ProjectsDeploymentsListOptions): Promise<ListDeploymentsResponse>;

async projectsDeploymentsUpdate(

deploymentId: string,

scriptId: string,

req: UpdateDeploymentRequest,

): Promise<Deployment>;

async projectsGet(scriptId: string): Promise<Project>;

async projectsGetContent(scriptId: string, opts?: ProjectsGetContentOptions): Promise<Content>;

async projectsGetMetrics(scriptId: string, opts?: ProjectsGetMetricsOptions): Promise<Metrics>;

async projectsUpdateContent(scriptId: string, req: Content): Promise<Content>;

async projectsVersionsCreate(scriptId: string, req: Version): Promise<Version>;

async projectsVersionsGet(scriptId: string, versionNumber: number): Promise<Version>;

async projectsVersionsList(scriptId: string, opts?: ProjectsVersionsListOptions): Promise<ListVersionsResponse>;

async scriptsRun(scriptId: string, req: ExecutionRequest): Promise<Operation>;

}

§Constructors

new Script(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

processesList(opts?: ProcessesListOptions): Promise<ListUserProcessesResponse>

[src]

List information about processes made by or on behalf of a user, such as process type and current status.

processesListScriptProcesses(opts?: ProcessesListScriptProcessesOptions): Promise<ListScriptProcessesResponse>

[src]

List information about a script's executed processes, such as process type and current status.

projectsCreate(req: CreateProjectRequest): Promise<Project>

[src]

Creates a new, empty script project with no script files and a base manifest file.

projectsDeploymentsCreate(scriptId: string, req: DeploymentConfig): Promise<Deployment>

[src]

Creates a deployment of an Apps Script project.

@param scriptId

The script project's Drive ID.

projectsDeploymentsDelete(deploymentId: string, scriptId: string): Promise<Empty>

[src]

Deletes a deployment of an Apps Script project.

@param deploymentId

The deployment ID to be undeployed.

@param scriptId

The script project's Drive ID.

projectsDeploymentsGet(deploymentId: string, scriptId: string): Promise<Deployment>

[src]

Gets a deployment of an Apps Script project.

@param deploymentId

The deployment ID.

@param scriptId

The script project's Drive ID.

projectsDeploymentsList(scriptId: string, opts?: ProjectsDeploymentsListOptions): Promise<ListDeploymentsResponse>

[src]

Lists the deployments of an Apps Script project.

@param scriptId

The script project's Drive ID.

projectsDeploymentsUpdate(deploymentId: string, scriptId: string, req: UpdateDeploymentRequest): Promise<Deployment>

[src]

Updates a deployment of an Apps Script project.

@param deploymentId

The deployment ID for this deployment.

@param scriptId

The script project's Drive ID.

projectsGet(scriptId: string): Promise<Project>

[src]

Gets a script project's metadata.

@param scriptId

The script project's Drive ID.

projectsGetContent(scriptId: string, opts?: ProjectsGetContentOptions): Promise<Content>

[src]

Gets the content of the script project, including the code source and metadata for each script file.

@param scriptId

The script project's Drive ID.

projectsGetMetrics(scriptId: string, opts?: ProjectsGetMetricsOptions): Promise<Metrics>

[src]

Get metrics data for scripts, such as number of executions and active users.

@param scriptId

Required field indicating the script to get metrics for.

projectsUpdateContent(scriptId: string, req: Content): Promise<Content>

[src]

Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project.

@param scriptId

The script project's Drive ID.

projectsVersionsCreate(scriptId: string, req: Version): Promise<Version>

[src]

Creates a new immutable version using the current code, with a unique version number.

@param scriptId

The script project's Drive ID.

projectsVersionsGet(scriptId: string, versionNumber: number): Promise<Version>

[src]

Gets a version of a script project.

@param scriptId

The script project's Drive ID.