"description":"Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast one of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the project in the script editor, then select\n**File \u003e Project properties** and click the **Scopes** tab.",
"description":"The script ID of the script to be executed. To find the script ID, open\nthe project in the script editor and select **File \u003e Project properties**.",
"description":"Gets a deployment of an Apps Script project."
},
"list":{
"response":{
"$ref":"ListDeploymentsResponse"
},
"parameterOrder":[
"scriptId"
],
"httpMethod":"GET",
"parameters":{
"pageToken":{
"location":"query",
"description":"The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
"type":"string"
},
"pageSize":{
"location":"query",
"description":"The maximum number of deployments on each returned page. Defaults to 50.",
"format":"int32",
"type":"integer"
},
"scriptId":{
"description":"The script project's Drive ID.",
"required":true,
"type":"string",
"location":"path"
}
},
"flatPath":"v1/projects/{scriptId}/deployments",
"path":"v1/projects/{scriptId}/deployments",
"id":"script.projects.deployments.list",
"description":"Lists the deployments of an Apps Script project."
"description":"The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
"type":"string"
},
"pageSize":{
"location":"query",
"description":"The maximum number of versions on each returned page. Defaults to 50.",
"format":"int32",
"type":"integer"
},
"scriptId":{
"location":"path",
"description":"The script project's Drive ID.",
"required":true,
"type":"string"
}
},
"flatPath":"v1/projects/{scriptId}/versions",
"id":"script.projects.versions.list",
"path":"v1/projects/{scriptId}/versions",
"description":"List the versions of a script project.",
"httpMethod":"GET",
"response":{
"$ref":"ListVersionsResponse"
},
"parameterOrder":[
"scriptId"
]
},
"create":{
"request":{
"$ref":"Version"
},
"description":"Creates a new immutable version using the current code, with a unique\nversion number.",
"description":"Updates the content of the specified script project.\nThis content is stored as the HEAD version, and is used when the script is\nexecuted as a trigger, in the script editor, in add-on preview mode, or as\na web app or Apps Script API in development mode. This clears all the\nexisting files in the project.",
"description":"Creates a new, empty script project with no script files and a base\nmanifest file.",
"response":{
"$ref":"Project"
},
"parameterOrder":[],
"httpMethod":"POST",
"parameters":{},
"flatPath":"v1/projects"
},
"getContent":{
"parameters":{
"versionNumber":{
"location":"query",
"description":"The version number of the project to retrieve. If not provided, the\nproject's HEAD version is returned.",
"format":"int32",
"type":"integer"
},
"scriptId":{
"description":"The script project's Drive ID.",
"required":true,
"type":"string",
"location":"path"
}
},
"flatPath":"v1/projects/{scriptId}/content",
"id":"script.projects.getContent",
"path":"v1/projects/{scriptId}/content",
"description":"Gets the content of the script project, including the code source and\nmetadata for each script file.",
"httpMethod":"GET",
"response":{
"$ref":"Content"
},
"parameterOrder":[
"scriptId"
]
},
"getMetrics":{
"response":{
"$ref":"Metrics"
},
"parameterOrder":[
"scriptId"
],
"httpMethod":"GET",
"parameters":{
"metricsFilter.deploymentId":{
"description":"Optional field indicating a specific deployment to retrieve metrics from.",
"type":"string",
"location":"query"
},
"scriptId":{
"location":"path",
"description":"Required field indicating the script to get metrics for.",
"required":true,
"type":"string"
},
"metricsGranularity":{
"location":"query",
"enum":[
"UNSPECIFIED_GRANULARITY",
"WEEKLY",
"DAILY"
],
"description":"Required field indicating what granularity of metrics are returned.",
"type":"string"
}
},
"flatPath":"v1/projects/{scriptId}/metrics",
"path":"v1/projects/{scriptId}/metrics",
"id":"script.projects.getMetrics",
"description":"Get metrics data for scripts, such as number of executions and\nactive users."
}
}
},
"processes":{
"methods":{
"listScriptProcesses":{
"description":"List information about a script's executed processes, such as process type\nand current status.",
"httpMethod":"GET",
"parameterOrder":[],
"response":{
"$ref":"ListScriptProcessesResponse"
},
"parameters":{
"pageSize":{
"location":"query",
"description":"The maximum number of returned processes per page of results. Defaults to\n50.",
"format":"int32",
"type":"integer"
},
"scriptProcessFilter.endTime":{
"description":"Optional field used to limit returned processes to those that completed\non or before the given timestamp.",
"format":"google-datetime",
"type":"string",
"location":"query"
},
"scriptProcessFilter.userAccessLevels":{
"repeated":true,
"location":"query",
"enum":[
"USER_ACCESS_LEVEL_UNSPECIFIED",
"NONE",
"READ",
"WRITE",
"OWNER"
],
"description":"Optional field used to limit returned processes to those having one of\nthe specified user access levels.",
"type":"string"
},
"scriptProcessFilter.statuses":{
"location":"query",
"enum":[
"PROCESS_STATUS_UNSPECIFIED",
"RUNNING",
"PAUSED",
"COMPLETED",
"CANCELED",
"FAILED",
"TIMED_OUT"
],
"description":"Optional field used to limit returned processes to those having one of\nthe specified process statuses.",
"type":"string",
"repeated":true
},
"scriptProcessFilter.functionName":{
"location":"query",
"description":"Optional field used to limit returned processes to those originating from\na script function with the given function name.",
"type":"string"
},
"scriptProcessFilter.startTime":{
"location":"query",
"description":"Optional field used to limit returned processes to those that were\nstarted on or after the given timestamp.",
"format":"google-datetime",
"type":"string"
},
"scriptProcessFilter.deploymentId":{
"location":"query",
"description":"Optional field used to limit returned processes to those originating from\nprojects with a specific deployment ID.",
"type":"string"
},
"scriptId":{
"description":"The script ID of the project whose processes are listed.",
"type":"string",
"location":"query"
},
"scriptProcessFilter.types":{
"location":"query",
"enum":[
"PROCESS_TYPE_UNSPECIFIED",
"ADD_ON",
"EXECUTION_API",
"TIME_DRIVEN",
"TRIGGER",
"WEBAPP",
"EDITOR"
],
"description":"Optional field used to limit returned processes to those having one of\nthe specified process types.",
"type":"string",
"repeated":true
},
"pageToken":{
"location":"query",
"description":"The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
"type":"string"
}
},
"flatPath":"v1/processes:listScriptProcesses",
"id":"script.processes.listScriptProcesses",
"path":"v1/processes:listScriptProcesses"
},
"list":{
"path":"v1/processes",
"id":"script.processes.list",
"description":"List information about processes made by or on behalf of a user,\nsuch as process type and current status.",
"response":{
"$ref":"ListUserProcessesResponse"
},
"parameterOrder":[],
"httpMethod":"GET",
"parameters":{
"userProcessFilter.functionName":{
"description":"Optional field used to limit returned processes to those originating from\na script function with the given function name.",
"type":"string",
"location":"query"
},
"userProcessFilter.scriptId":{
"description":"Optional field used to limit returned processes to those originating from\nprojects with a specific script ID.",
"type":"string",
"location":"query"
},
"userProcessFilter.types":{
"repeated":true,
"location":"query",
"enum":[
"PROCESS_TYPE_UNSPECIFIED",
"ADD_ON",
"EXECUTION_API",
"TIME_DRIVEN",
"TRIGGER",
"WEBAPP",
"EDITOR"
],
"description":"Optional field used to limit returned processes to those having one of\nthe specified process types.",
"type":"string"
},
"userProcessFilter.statuses":{
"repeated":true,
"location":"query",
"enum":[
"PROCESS_STATUS_UNSPECIFIED",
"RUNNING",
"PAUSED",
"COMPLETED",
"CANCELED",
"FAILED",
"TIMED_OUT"
],
"description":"Optional field used to limit returned processes to those having one of\nthe specified process statuses.",
"type":"string"
},
"userProcessFilter.deploymentId":{
"location":"query",
"description":"Optional field used to limit returned processes to those originating from\nprojects with a specific deployment ID.",
"type":"string"
},
"userProcessFilter.endTime":{
"location":"query",
"description":"Optional field used to limit returned processes to those that completed\non or before the given timestamp.",
"format":"google-datetime",
"type":"string"
},
"pageToken":{
"description":"The token for continuing a previous list request on the next page. This\nshould be set to the value of `nextPageToken` from a previous response.",
"type":"string",
"location":"query"
},
"pageSize":{
"description":"The maximum number of returned processes per page of results. Defaults to\n50.",
"format":"int32",
"type":"integer",
"location":"query"
},
"userProcessFilter.startTime":{
"description":"Optional field used to limit returned processes to those that were\nstarted on or after the given timestamp.",
"format":"google-datetime",
"type":"string",
"location":"query"
},
"userProcessFilter.userAccessLevels":{
"description":"Optional field used to limit returned processes to those having one of\nthe specified user access levels.",
"type":"string",
"repeated":true,
"location":"query",
"enum":[
"USER_ACCESS_LEVEL_UNSPECIFIED",
"NONE",
"READ",
"WRITE",
"OWNER"
]
},
"userProcessFilter.projectName":{
"description":"Optional field used to limit returned processes to those originating from\nprojects with a specific project name.",
"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"The script runs as the user accessing the web app.",
"The script runs as the user who deployed the web app. Note that this is\nnot necessarily the owner of the script project."
]
}
},
"id":"GoogleAppsScriptTypeWebAppConfig"
},
"Project":{
"properties":{
"parentId":{
"type":"string",
"description":"The parent's Drive ID that the script will be attached to. This is usually\nthe ID of a Google Document or Google Sheet. This filed is optional, and\nif not set, a stand-alone script will be created."
},
"createTime":{
"description":"When the script was created.",
"format":"google-datetime",
"type":"string"
},
"updateTime":{
"description":"When the script was last updated.",
"format":"google-datetime",
"type":"string"
},
"creator":{
"$ref":"GoogleAppsScriptTypeUser",
"description":"User who originally created the script."
},
"scriptId":{
"description":"The script project's Drive ID.",
"type":"string"
},
"title":{
"description":"The title for the project.",
"type":"string"
},
"lastModifyUser":{
"description":"User who last modified the script.",
"$ref":"GoogleAppsScriptTypeUser"
}
},
"id":"Project",
"description":"The script project resource.",
"type":"object"
},
"ListDeploymentsResponse":{
"description":"Response with the list of deployments for the specified Apps Script project.",
"description":"The token that can be used in the next call to get the next page of\nresults.",
"type":"string"
}
},
"id":"ListDeploymentsResponse"
},
"File":{
"description":"An individual file within a script project.\nA file is a third-party source code created by one or more\ndevelopers. It can be a server-side JS code, HTML, or a\nconfiguration file. Each script project can contain multiple files.",
"type":"object",
"properties":{
"type":{
"description":"The type of the file.",
"type":"string",
"enumDescriptions":[
"Undetermined file type; never actually used.",
"An Apps Script server-side code file.",
"A file containing client-side HTML.",
"A file in JSON format. This type is only used for the script\nproject's manifest. The manifest file content must match the\nstructure of a valid\n[ScriptManifest](/apps-script/concepts/manifests)"
],
"enum":[
"ENUM_TYPE_UNSPECIFIED",
"SERVER_JS",
"HTML",
"JSON"
]
},
"source":{
"description":"The file content.",
"type":"string"
},
"lastModifyUser":{
"$ref":"GoogleAppsScriptTypeUser",
"description":"The user who modified the file most recently.\nThis read-only field is only visible to users who have WRITER\npermission for the script project."
},
"createTime":{
"description":"Creation date timestamp.\nThis read-only field is only visible to users who have WRITER\npermission for the script project.",
"format":"google-datetime",
"type":"string"
},
"functionSet":{
"$ref":"GoogleAppsScriptTypeFunctionSet",
"description":"The defined set of functions in the script file, if any."
},
"updateTime":{
"description":"Last modified date timestamp.\nThis read-only field is only visible to users who have WRITER\npermission for the script project.",
"format":"google-datetime",
"type":"string"
},
"name":{
"description":"The name of the file. The file extension is not part of the file\nname, which can be identified from the type field.",
"type":"string"
}
},
"id":"File"
},
"ExecutionResponse":{
"description":"An object that provides the return value of a function executed using the\nApps Script API. If the script function returns successfully, the response\nbody's response field contains this\n`ExecutionResponse` object.",
"type":"object",
"properties":{
"result":{
"description":"The return value of the script function. The type matches the object type\nreturned in Apps Script. Functions called using the Apps Script API cannot\nreturn Apps Script-specific objects (such as a `Document` or a `Calendar`);\nthey can only return primitive types such as a `string`, `number`, `array`,\n`object`, or `boolean`.",
"type":"any"
}
},
"id":"ExecutionResponse"
},
"GoogleAppsScriptTypeScopeSet":{
"description":"A set of scopes. No duplicates are permitted.",
"type":"object",
"properties":{
"values":{
"description":"List of scope values in the set.",
"type":"array",
"items":{
"$ref":"GoogleAppsScriptTypeScope"
}
}
},
"id":"GoogleAppsScriptTypeScopeSet"
},
"GoogleAppsScriptTypeScope":{
"description":"Represents an authorization scope.",
"type":"object",
"properties":{
"name":{
"description":"The scope's identifying string.",
"type":"string"
},
"authorizer":{
"enum":[
"SCOPE_AUTHORIZER_UNSPECIFIED",
"AUTHORIZED_BY_DEVELOPER",
"AUTHORIZED_BY_END_USER"
],
"description":"Who authorized the scope.",
"type":"string",
"enumDescriptions":[
"Authorizer unspecified.",
"Developer authorized scope.",
"End user authorized scope."
]
}
},
"id":"GoogleAppsScriptTypeScope"
},
"ListVersionsResponse":{
"description":"Response with the list of the versions for the specified script project.",
"type":"object",
"properties":{
"versions":{
"description":"The list of versions.",
"type":"array",
"items":{
"$ref":"Version"
}
},
"nextPageToken":{
"description":"The token use to fetch the next page of records. if not exist in the\nresponse, that means no more versions to list.",
"type":"string"
}
},
"id":"ListVersionsResponse"
},
"Metrics":{
"description":"Resource containing usage stats for a given script, based on the supplied\nfilter and mask present in the request.",
"description":"A list of functions composing the set.",
"type":"array",
"items":{
"$ref":"GoogleAppsScriptTypeFunction"
}
}
},
"id":"GoogleAppsScriptTypeFunctionSet"
},
"Empty":{
"description":"A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"description":"The list of script project files.\nOne of the files is a script manifest; it must be named \"appsscript\",\nmust have type of JSON, and include the manifest configurations for the\nproject.",
"description":"An object that provides information about the nature of an error resulting\nfrom an attempted execution of a script function using the Apps Script API.\nIf a run call\nsucceeds but the script function (or Apps Script itself) throws an exception,\nthe response body's error field\ncontains a\nStatus object. The `Status` object's `details` field\ncontains an array with a single one of these `ExecutionError` objects.",
"type":"object",
"properties":{
"errorType":{
"description":"The error type, for example `TypeError` or `ReferenceError`. If the error\ntype is unavailable, this field is not included.",
"type":"string"
},
"errorMessage":{
"description":"The error message thrown by Apps Script, usually localized into the user's\nlanguage.",
"type":"string"
},
"scriptStackTraceElements":{
"description":"An array of objects that provide a stack trace through the script to show\nwhere the execution failed, with the deepest call first.",
"type":"array",
"items":{
"$ref":"ScriptStackTraceElement"
}
}
}
},
"ListUserProcessesResponse":{
"properties":{
"processes":{
"description":"List of processes matching request parameters.",
"type":"array",
"items":{
"$ref":"GoogleAppsScriptTypeProcess"
}
},
"nextPageToken":{
"description":"Token for the next page of results. If empty, there are no more pages\nremaining.",
"type":"string"
}
},
"id":"ListUserProcessesResponse",
"description":"Response with the list of\nProcess resources.",
"description":"A request to run the function in a script. The script is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script.",
"description":"For Android add-ons only. An ID that represents the user's current session\nin the Android app for Google Docs or Sheets, included as extra data in the\n[Intent](https://developer.android.com/guide/components/intents-filters.html)\nthat launches the add-on. When an Android add-on is run with a session\nstate, it gains the privileges of a\n[bound](https://developers.google.com/apps-script/guides/bound)\nscript—that is, it can access information like the user's current\ncursor position (in Docs) or selected cell (in Sheets). To retrieve the\nstate, call\n`Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`.\nOptional."
},
"function":{
"type":"string",
"description":"The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters."
},
"devMode":{
"description":"If `true` and the user is an owner of the script, the script runs at the\nmost recently saved version rather than the version deployed for use with\nthe Apps Script API. Optional; default is `false`.",
"description":"The parameters to be passed to the function being executed. The object type\nfor each parameter should match the expected type in Apps Script.\nParameters cannot be Apps Script-specific object types (such as a\n`Document` or a `Calendar`); they can only be primitive types such as\n`string`, `number`, `array`, `object`, or `boolean`. Optional.",
"description":"An entry point specification for web apps.",
"$ref":"GoogleAppsScriptTypeWebAppEntryPoint"
}
},
"id":"EntryPoint"
},
"Version":{
"description":"A resource representing a script project version. A version is a \"snapshot\"\nof a script project and is similar to a read-only branched release. When\ncreating deployments, the version to use must be specified.",
"type":"object",
"properties":{
"createTime":{
"type":"string",
"description":"When the version was created.",
"format":"google-datetime"
},
"description":{
"description":"The description for this version.",
"description":"The incremental ID that is created by Apps Script when a version is\ncreated. This is system assigned number and is immutable once created.",
"description":"Representation of a single script process execution that was started from\nthe script editor, a trigger, an application, or using the Apps Script API.\nThis is distinct from the `Operation`\nresource, which only represents exeuctions started via the Apps Script API.",
"type":"object",
"properties":{
"projectName":{
"description":"Name of the script being executed.",
"description":"Request to create a script project.",
"type":"object",
"properties":{
"parentId":{
"description":"The Drive ID of a parent file that the created script project is bound to.\nThis is usually the ID of a Google Doc, Google Sheet, Google Form, or\nGoogle Slides file. If not set, a standalone script project is created.",
"type":"string"
},
"title":{
"description":"The title for the project.",
"type":"string"
}
},
"id":"CreateProjectRequest"
},
"Operation":{
"description":"A representation of a execution of an Apps Script function that is started using run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the [Apps Script quotas guide](/apps-script/guides/services/quotas#current_limitations). \u003cp\u003eAfter the execution is started, it can have one of four outcomes:\u003c/p\u003e \u003cul\u003e \u003cli\u003e If the script function returns successfully, the\n response field contains an\n ExecutionResponse object\n with the function's return value in the object's `result` field.\u003c/li\u003e\n\u003cli\u003e If the script function (or Apps Script itself) throws an exception, the\n error field contains a\n Status object. The `Status` object's `details`\n field contains an array with a single\n ExecutionError object that\n provides information about the nature of the error.\u003c/li\u003e\n\u003cli\u003e If the execution has not yet completed,\n the done field is `false` and\n the neither the `response` nor `error` fields are present.\u003c/li\u003e\n\u003cli\u003e If the `run` call itself fails (for example, because of a\n malformed request or an authorization error), the method returns an HTTP\n response code in the 4XX range with a different format for the response\n body. Client libraries automatically convert a 4XX response into an\n exception class.\u003c/li\u003e\n\u003c/ul\u003e",
"type":"object",
"properties":{
"error":{
"$ref":"Status",
"description":"If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error."
},
"done":{
"description":"This field indicates whether the script execution has completed. A completed execution has a populated `response` field containing the ExecutionResponse from function that was executed.",
"type":"boolean"
},
"response":{
"additionalProperties":{
"description":"Properties of the object. Contains field @type with type URL.",
"type":"any"
},
"description":"If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.",
"type":"object"
}
},
"id":"Operation"
},
"Status":{
"description":"If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains this `Status` object.",
"type":"object",
"properties":{
"code":{
"description":"The status code. For this API, this value either: \u003cul\u003e \u003cli\u003e 3, indicating an `INVALID_ARGUMENT` error, or\u003c/li\u003e \u003cli\u003e 1, indicating a `CANCELLED` execution.\u003c/li\u003e \u003c/ul\u003e",
"format":"int32",
"type":"integer"
},
"message":{
"type":"string",
"description":"A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [google.rpc.Status.details](google.rpc.Status.details) field, or localized by the client."
},
"details":{
"description":"An array that contains a single ExecutionError object that provides information about the nature of the error.",
"type":"array",
"items":{
"additionalProperties":{
"description":"Properties of the object. Contains field @type with type URL.",
"type":"any"
},
"type":"object"
}
}
},
"id":"Status"
},
"GoogleAppsScriptTypeFunction":{
"description":"Represents a function in a script project.",
"type":"object",
"properties":{
"name":{
"description":"The function name in the script project.",
"type":"string"
}
},
"id":"GoogleAppsScriptTypeFunction"
},
"MetricsValue":{
"description":"Metrics value that holds number of executions counted.",
"type":"object",
"properties":{
"startTime":{
"description":"Required field indicating the start time of the interval.",
"format":"google-datetime",
"type":"string"
},
"value":{
"description":"Indicates the number of executions counted.",
"format":"uint64",
"type":"string"
},
"endTime":{
"description":"Required field indicating the end time of the interval.",
