"description":"An API for managing and executing Google Apps Script projects. \u003caside class=\"note\"\u003e\u003cb\u003eNote\u003c/b\u003e: In order to use this API in your apps, you must \u003ca href=\"/apps-script/api/how-tos/enable#using_the_apps_script_api_in_your_app\"\u003e enable it for use\u003c/a\u003e. To allow other apps to manage your scripts, you must \u003ca href=\"/apps-script/api/how-tos/enable#granting_third-party_applications_access_to_your_script_projects\"\u003e grant them access\u003c/a\u003e.\u003c/aside\u003e\n",
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location":"query",
"type":"string"
},
"bearer_token":{
"description":"OAuth bearer token.",
"location":"query",
"type":"string"
},
"callback":{
"description":"JSONP",
"location":"query",
"type":"string"
},
"fields":{
"description":"Selector specifying which fields to include in a partial response.",
"location":"query",
"type":"string"
},
"key":{
"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.",
"location":"query",
"type":"string"
},
"oauth_token":{
"description":"OAuth 2.0 token for the current user.",
"location":"query",
"type":"string"
},
"pp":{
"default":"true",
"description":"Pretty-print response.",
"location":"query",
"type":"boolean"
},
"prettyPrint":{
"default":"true",
"description":"Returns response with indentations and line breaks.",
"location":"query",
"type":"boolean"
},
"quotaUser":{
"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.",
"location":"query",
"type":"string"
},
"uploadType":{
"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location":"query",
"type":"string"
},
"upload_protocol":{
"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").",
"description":"The maximum number of returned processes per page of results. Defaults to\n50.",
"format":"int32",
"location":"query",
"type":"integer"
},
"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.",
"description":"The maximum number of returned processes per page of results. Defaults to\n50.",
"format":"int32",
"location":"query",
"type":"integer"
},
"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.",
"description":"Creates a new, empty script project with no script files and a base\nmanifest file.",
"flatPath":"v1/projects",
"httpMethod":"POST",
"id":"script.projects.create",
"parameterOrder":[],
"parameters":{},
"path":"v1/projects",
"request":{
"$ref":"CreateProjectRequest"
},
"response":{
"$ref":"Project"
}
},
"get":{
"description":"Gets a script project's metadata.",
"flatPath":"v1/projects/{scriptId}",
"httpMethod":"GET",
"id":"script.projects.get",
"parameterOrder":[
"scriptId"
],
"parameters":{
"scriptId":{
"description":"The script project's Drive ID.",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"v1/projects/{scriptId}",
"response":{
"$ref":"Project"
}
},
"getContent":{
"description":"Gets the content of the script project, including the code source and\nmetadata for each script file.",
"flatPath":"v1/projects/{scriptId}/content",
"httpMethod":"GET",
"id":"script.projects.getContent",
"parameterOrder":[
"scriptId"
],
"parameters":{
"scriptId":{
"description":"The script project's Drive ID.",
"location":"path",
"required":true,
"type":"string"
},
"versionNumber":{
"description":"The version number of the project to retrieve. If not provided, the\nproject's HEAD version is returned.",
"format":"int32",
"location":"query",
"type":"integer"
}
},
"path":"v1/projects/{scriptId}/content",
"response":{
"$ref":"Content"
}
},
"getMetrics":{
"description":"Get metrics data for scripts, such as number of executions and\nactive users.",
"flatPath":"v1/projects/{scriptId}/metrics",
"httpMethod":"GET",
"id":"script.projects.getMetrics",
"parameterOrder":[
"scriptId"
],
"parameters":{
"metricsFilter.deploymentId":{
"description":"Optional field indicating a specific deployment to retrieve metrics from.",
"location":"query",
"type":"string"
},
"metricsGranularity":{
"description":"Required field indicating what granularity of metrics are returned.",
"enum":[
"UNSPECIFIED_GRANULARITY",
"WEEKLY",
"DAILY"
],
"location":"query",
"type":"string"
},
"scriptId":{
"description":"Required field indicating the script to get metrics for.",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"v1/projects/{scriptId}/metrics",
"response":{
"$ref":"Metrics"
}
},
"updateContent":{
"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.",
"flatPath":"v1/projects/{scriptId}/content",
"httpMethod":"PUT",
"id":"script.projects.updateContent",
"parameterOrder":[
"scriptId"
],
"parameters":{
"scriptId":{
"description":"The script project's Drive ID.",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"v1/projects/{scriptId}/content",
"request":{
"$ref":"Content"
},
"response":{
"$ref":"Content"
}
}
},
"resources":{
"deployments":{
"methods":{
"create":{
"description":"Creates a deployment of an Apps Script project.",
"flatPath":"v1/projects/{scriptId}/deployments",
"httpMethod":"POST",
"id":"script.projects.deployments.create",
"parameterOrder":[
"scriptId"
],
"parameters":{
"scriptId":{
"description":"The script project's Drive ID.",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"v1/projects/{scriptId}/deployments",
"request":{
"$ref":"DeploymentConfig"
},
"response":{
"$ref":"Deployment"
}
},
"delete":{
"description":"Deletes a deployment of an Apps Script project.",
"description":"Lists the deployments of an Apps Script project.",
"flatPath":"v1/projects/{scriptId}/deployments",
"httpMethod":"GET",
"id":"script.projects.deployments.list",
"parameterOrder":[
"scriptId"
],
"parameters":{
"pageSize":{
"description":"The maximum number of deployments on each returned page. Defaults to 50.",
"format":"int32",
"location":"query",
"type":"integer"
},
"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.",
"location":"query",
"type":"string"
},
"scriptId":{
"description":"The script project's Drive ID.",
"location":"path",
"required":true,
"type":"string"
}
},
"path":"v1/projects/{scriptId}/deployments",
"response":{
"$ref":"ListDeploymentsResponse"
}
},
"update":{
"description":"Updates a deployment of an Apps Script project.",
"description":"List the versions of a script project.",
"flatPath":"v1/projects/{scriptId}/versions",
"httpMethod":"GET",
"id":"script.projects.versions.list",
"parameterOrder":[
"scriptId"
],
"parameters":{
"pageSize":{
"description":"The maximum number of versions on each returned page. Defaults to 50.",
"format":"int32",
"location":"query",
"type":"integer"
},
"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.",
"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.",
"flatPath":"v1/scripts/{scriptId}:run",
"httpMethod":"POST",
"id":"script.scripts.run",
"parameterOrder":[
"scriptId"
],
"parameters":{
"scriptId":{
"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":"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":"Request to create a script project.",
"id":"CreateProjectRequest",
"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.",
"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":"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.",
"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":"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 name of the function to execute in the given script. The name does not\ninclude parentheses or parameters.",
"type":"string"
},
"parameters":{
"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.",
"items":{
"type":"any"
},
"type":"array"
},
"sessionState":{
"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\u0026mdash;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.",
"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.",
"id":"ExecutionResponse",
"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`.",
"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.",
"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."
},
"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."
},
"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.",
"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)"
],
"type":"string"
},
"updateTime":{
"description":"Last modified date timestamp.\nThis read-only field is only visible to users who have WRITER\npermission for the script project.",
"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.",
"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",
"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.",
"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."
"description":"User who originally created the script."
},
"lastModifyUser":{
"$ref":"GoogleAppsScriptTypeUser",
"description":"User who last modified the script."
},
"parentId":{
"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.",
"type":"string"
},
"scriptId":{
"description":"The script project's Drive ID.",
"type":"string"
},
"title":{
"description":"The title for the project.",
"type":"string"
},
"updateTime":{
"description":"When the script was last updated.",
"format":"google-datetime",
"type":"string"
}
},
"type":"object"
},
"ScriptStackTraceElement":{
"description":"A stack trace through the script that shows where the execution failed.",
"id":"ScriptStackTraceElement",
"properties":{
"function":{
"description":"The name of the function that failed.",
"type":"string"
},
"lineNumber":{
"description":"The line number where the script failed.",
"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.",
"description":"The status code. For this API, this value either: \u003cul\u003e \u003cli\u003e 10, indicating a `SCRIPT_TIMEOUT` error,\u003c/li\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",
"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.",
"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.",
"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.",
