Call Apps Script from an automation

• Overview
• Get started calling Apps Script from an automation
• Create an Apps Script project
• Add and configure the "Call a script" task in a bot
• Share an Apps Script project
• Manage Apps Script projects in your account
• Quotas and limitations

Overview

Apps Script is a cloud-based JavaScript platform that lets you integrate with and automate tasks across Google products. With Apps Script, you write code in modern JavaScript and have access to built-in libraries for Google Workspace applications.

You can use custom logic from within your AppSheet app by calling Apps Script from an AppSheet automation bot.

Examples of custom logic that you can implement include:

• Create a calendar appointment when a button is clicked
• Add a slide to a presentation when a new row is added
• Save photos to Drive and share with specific individuals when uploaded using a form
• Create an audit log by generating a Google Docs file with data from a table
• Call an external service for machine learning prediction using data from a newly added row and write back model prediction

New to Apps Script? See Google Apps Script overview.
New to AppSheet Automation? See AppSheet Automation: The Essentials.

Get started calling Apps Script from an automation

Get started calling Apps Script from an automation.

• Watch an introductory video on calling Apps Script from an automation.

  Note: The concepts in this video are still valid, though the AppSheet app editor UI has changed since it was recorded.

  Calling Apps Script from AppSheet Automations

• Walk through the quick start to call a simple "hello world" script from an AppSheet automation and confirm its execution.
• Use Apps Script samples
  • Use the AppSheet Apps Script Examples Project 
  • Use Apps Script to create a calendar event
  • Use Apps Script to send an interactive chat message

Create an Apps Script project

First, you must create an Apps Script project for your script files and related resources. An Apps Script project includes:

• One or more script files (.gs) to define your custom integrations
• Optionally, HTML files, that might include JavaScript and CSS, to create custom templates and layouts

To create an Apps Script project:

1. From the Apps Script home page you can:

   • Create a new Apps Script project, as described in Create and delete projects.

   • Copy an existing Apps Script project:

     1. Open the Apps Script project editor.

     2. Click Overview in the left sidebar and click Make a copy (copy icon) in the right side of the page.

        

2. Add one or more scripts to the project or modify the existing scripts. For examples, see Use the AppSheet Apps Script Examples project.

Add and configure the "Call a script" task in a bot

Add and configure the Call a script task in a bot by performing the following steps.

For more information about adding and configuring tasks in an automation bot, see Tasks: The Essentials.

1. Add the Call a script task to a bot, as described in Add a task to a bot.
2. Configure the "Call a script" task.
3. Click Authorize to authorize the Apps Script project to run.
   Note: You'll need to authorize the first time you access the project and anytime authentication scopes are added. As indicated, the script will always run as the app owner regardless of the account used to authorize the project.
4. Select the Apps Script function that you want to call in the Function Name drop-down.
   
   The list is populated using the functions defined by the Apps Script project selected in the previous step. After you select the function, the list of associated arguments is displayed. 
5. Enter an expression that defines each argument that will be passed to the function in the Function Parameters field. For example:
   
6. Optionally, enable the Return Value option to use the return value from the Apps Script function. See Use return values from Apps Script tasks for more information.
7. Optionally, enable the Run asynchronously? option to run the Apps Script task asynchronously as a background task. Enabling this option can improve client response time.
   
   Before setting this option, consider whether your application requires the Apps Script to complete synchronously to execute correctly. For example, if your Apps Script is changing data and your application relies on that data being updated before the sync completes, then using an asynchronous call may yield incorrect results.
8. When you are done, save the task by selecting one of the following:
   • Save - Save the app.
   • Save & verify data - Save the app and verify that it is runnable based on external dependencies.

Configure the "Call a script" task

Configure the Call a script task by using the settings in the following table.

Setting	Description
Linking	Enable or disable reuse of this component by expanding the Linking panel and toggling the Linking setting. See Reuse automation components.
Task name	Name of the task that appears in the automation process flow. It must be unique within your app.
Table name	Table referenced by the task. Select an existing table in the list. Click  to show the selected table in a dialog. See Tables: The Essentials for more information about adding tables.
Apps Script Project	Apps Script project that contains the function you want to call. To populate the field: Click Browse (File icon). Click Files on Google Drive. Navigate to the Apps Script project in your Drive. See Create an Apps Script project. Click Select. Click Open Project to open the project, if desired.

 Expand and customize the Advanced settings, as described below.

Share an Apps Script project

Share your Apps Script project by sharing it directly or using a shared drive. For details, see Collaborating with other developers.

Manage Apps Script projects in your AppSheet account

The following sections describe how to manage Apps Script projects in your AppSheet account:

• View Apps Script projects in your AppSheet account
• Add an Apps Script project to your AppSheet account
• Remove an Apps Script project from your AppSheet account

View Apps Script projects in your AppSheet account

To view Apps Script projects in your AppSheet account:

1. Sign in to AppSheet.
2. Go to the My account page.
3. Select Integrations > Apps Scripts.

The Apps Script projects are displayed, as follows:

Add an Apps Script project to your AppSheet account

When you add and configure a Call a script task, the Apps Script project is added to your account automatically.

Remove an Apps Script project from your AppSheet account

Remove access to an Apps Script project from your AppSheet user or team account so that it is no longer available for use by other apps.

Note: Before removing an Apps Script project from your AppSheet account, you should delete all references to the Apps Script project in your apps to avoid errors. If you removed a project from the My Account page, and want to add the project back to your account, select the script again from within the “Call a script” flow.

To remove an App Script to your user or team account:

1. Sign in to AppSheet.
2. Go to the My account page.
3. Select Integrations > Apps Scripts.
4. Click Delete (Trash icon) to delete access to a particular script.

Quotas and limitations

• Apps Script executions are subject to standard Google Workspace quotas and limitations as stated in Quotas for Google Services.
• Apps Script tasks will be available for users in the AppSheet Core plan and above. See AppSheet pricing plans.