Google Apps Script Chat app

Stay organized with collections Save and categorize content based on your preferences.

Create a Google Chat app that you can directly message and that responds by echoing your messages.

Objectives

  • Set up your environment.
  • Create the script.
  • Publish the app.
  • Run the sample.

Prerequisites

Set up your environment

To complete this quickstart, set up your environment.

Enable the API

Before using Google APIs, you need to enable them in a Google Cloud project. You can enable one or more APIs in a single Google Cloud project.
  • In the Google Cloud console, enable the Google Chat API.

    Enable the API

All apps using OAuth 2.0 require a consent screen configuration. Configuring your app's OAuth consent screen defines what is displayed to users and app reviewers, and registers your app so you can publish it later.

  1. In the Google Cloud console, go to the OAuth consent screen.

    Go to OAuth consent screen

  2. Select the user type for your app, then click Create.
  3. Complete the app registration form, then click Save and Continue.
  4. If you're creating an app for use outside of your Google Workspace organization, click Add or Remove Scopes. Add and verify the authorization scopes required by your app, then click Save and Continue.

    Some scopes require additional reviews by Google. For apps used only internally by your Google Workspace organization, scopes aren't listed on the consent screen and use of restricted or sensitive scopes does not require further review by Google. For more details, see How to choose scopes for your app.

  5. Under Test users, click Add users.
  6. Enter your email address and any other authorized test users, then click Save and Continue.
  7. Review your app registration summary. To make changes, click Edit. If the app registration looks OK, click Back to Dashboard.

Create the script

To create the script, you use a template and then set your Cloud project in Apps Script.

Create the script from the template

  1. Go to the Apps Script Getting Started page.
  2. Click the Chat App template. You might have to scroll down to see this template.
  3. Click Untitled project, type Quickstart app, and click Rename.

Copy the Cloud project number

  1. Go to the Google Cloud console.
  2. If necessary, open the Cloud project that you intend to use for this quickstart:
    1. Next to Google Cloud, click the Down arrow . A dialog listing current projects appears.
    2. Select your project and click Open. The console opens your project.
  3. Click Settings and Utilities > Project settings.
  4. Copy the Project number.

Set the Apps Script project's Cloud project

  1. In the Chat app Apps Script project, click Project Settings .
  2. Under Google Cloud Platform (GCP) Project, click Change project.
  3. In GCP project number, paste the Google Cloud project number.
  4. Click Set project.

You now have working app code that you can try out (as described in the following steps) and then customize to meet your requirements.

Make sure that you're signed in to the correct Google Account when you open the Apps Script template. The current account can sometimes switch to your default account without you noticing.

Get the Deployment ID

You need the Deployment ID for this Apps Script project, so that you can use it in the next step.

To get the Deployment ID, do the following:

  1. In the Chat app Apps Script project, click Deploy > New deployment.
  2. Under Select type, click Add-on.
  3. Fill out the options and click Deploy.
  4. Under Deployment ID, click Copy.

Publish the Chat app

Publish the Chat app from the Google Cloud console.

  1. In the Google Cloud console, search for Google Chat API, and click Google Chat API.
  2. Click Manage.
  3. Click Configuration and set up the Chat app:

    1. In the App name field, enter Quickstart app.
    2. In the Avatar URL field, enter https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. In the Description field, enter Quickstart app.
    4. Under Functionality, select Receive 1:1 messages and Join spaces and group conversations.
    5. Under Connection settings, select Apps Script project and paste the Deployment ID into the field.
    6. Under Permissions, select Specific people and groups in your domain, and enter your email.
  4. Click Save.

The Chat app is ready to respond to messages.

Run the sample

  1. Open Chat.
  2. Send a new direct message to the app by clicking Start a chat > Find apps.
  3. On the Find apps page, search for "Quickstart App".
  4. Next to Quickstart App, click Chat.
  5. In the new direct message with the app, type Hello and press enter.

The app thanks you for adding it and echoes your message.

Next steps

  • Create interactive cards. Card messages support a defined layout, interactive UI elements like buttons, and rich media like images. Use card messages to present detailed information, gather information from users, and guide users to take a next step.
  • Support slash commands. Slash commands let you register and advertise specific commands that users can give your app by typing a command that begins with a forward slash (/), like /help.
  • Launch dialogs. Dialogs are windowed, card-based interfaces that your app can open to interact with a user. Multiple cards can be strung together sequentially, which helps users complete multi-step processes, like filling in form data.