Project Management

AI-generated Key Takeaways

The Apps Script API enables programmatic creation and management of Apps Script projects, including tasks like creating new projects, retrieving project metadata, and updating project files.
Before using the Apps Script API, ensure it's enabled in your Google Account settings.
You can retrieve a script project's unique ID from the Project Settings in the Apps Script editor.
The API provides methods for accessing and modifying the content of script projects, such as source code and metadata for individual files within the project.
Updating project files through the API sets the updated content as the HEAD version, which is used for API execution.

The Apps Script API allows you to create and modify Apps Script projects from your app. The examples on this page illustrate how some common project management operations can be achieved with the API.

NOTE: The Apps Script API must be enabled before usage.

In these examples, the placeholders scriptId is used to indicate where you would provide the script project ID. Follow the steps below to find the script ID:

In the Apps Script project, at the top left, click Project Settings .
Next to "Script ID," click Copy.

Create a new Apps Script project

The following projects.create request creates a new standalone script.

POST https://scriptmanagement.googleapis.com/v1/projects/

{
  "title": "My Script"
}

Retrieve project metadata

The following projects.get request gets the script project's metadata.

GET https://scriptmanagement.googleapis.com/v1/projects/scriptId

The response consists of an object such as this one:

{
  "scriptId": "scriptId",
  "title": "My Title",
  "parentId": "parentId",
  "createTime": "2017-10-02T15:01:23.045123456Z",
  "updateTime": "2017-10-02T15:01:23.045123456Z",
  "creator": { "name": "Grant" },
  "lastModifyUser": { "name": "Grant" },
}

Retrieve project files

The following projects.getContent request gets the content of the script project, including the code source and metadata for each script file.

GET https://scriptmanagement.googleapis.com/v1/projects/scriptId/content

The response consists of a Content object such as this one:

{
  "scriptId": "scriptId",
  "files": [{
    "name": "My Script",
    "type": "SERVER_JS",
    "source": "function hello(){\nconsole.log('Hello world');}",
    "lastModifyUser": {
      "name": "Grant",
      "email": "grant@example.com",
    },
    "createTime": "2017-10-02T15:01:23.045123456Z",
    "updateTime": "2017-10-02T15:01:23.045123456Z",
    "functionSet": {
      "values": [
        "name": "helloWorld"
      ]
    }
  }, {
    "name": "appsscript",
    "type": "JSON",
    "source": "{\"timeZone\":\"America/New_York\",\"exceptionLogging\":\"CLOUD\"}",
    "lastModifyUser": {
      "name": "Grant",
      "email": "grant@example.com",
    },
    "createTime": "2017-10-02T15:01:23.045123456Z",
    "updateTime": "2017-10-02T15:01:23.045123456Z"
  }]
}

Update project files

The following projects.updateContent request 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 an API executable project.

PUT https://scriptmanagement.googleapis.com/v1/projects/scriptID/content

{
  "files": [{
    "name": "index",
    "type": "HTML",
    "source": "<html> <header><title>HTML Page</title></header> <body> My HTML </body> </html>"
  }, {
    "name": "My Script",
    "type": "SERVER_JS",
    "source": "function hello(){\nconsole.log('Hello world');}",
  }, {
    "name": "appsscript",
    "type": "JSON",
    "source": "{\"timeZone\":\"America/New_York\",\"exceptionLogging\":\"CLOUD\"}",
    "lastModifyUser": {
      "name": "Grant",
      "email": "grant@example.com",
    },
    "createTime": "2017-10-02T15:01:23.045123456Z",
    "updateTime": "2017-10-02T15:01:23.045123456Z"
  }]
}