Test interactive features for Google Chat apps

This page explains how to configure and install a test version of your Google Chat app so that you can try out interactive features—such as slash commands, direct messaging, and link previews—before releasing them to end users.

By testing your Chat app, you can ensure that it offers a high-quality user experience and functions as expected. If you're publishing your Chat app publicly, testing also helps you make sure that your Chat app meets the requirements for being listed in the Google Workspace Marketplace.

To safely test at each phase of your Chat app's lifecycle, we recommend that you set up separate environments for development, staging, and production. In each environment, you should create and deploy a different Chat app. To learn how to set up environments, see Create and manage deployments for your Google Chat app.

Prerequisites

  • You must enable interactive features for your Chat app, and the Chat app must be able to receive 1:1 messages, or join spaces or group conversations. You can modify these settings in the Chat API Configurations page in the Google Cloud console. For steps, see Receive and respond to interactions with your Google Chat app.
  • To grant access to your Chat app for testing:

Add trusted testers

For interactive Chat apps, the Chat API lets you share your Chat app with specific people in your Google Workspace organization. The people that you specify can add the Chat app to a space and test its features before you publish it to the Marketplace.

To test your own Chat app, you must add yourself as a trusted tester. To learn about visibility settings, see Visibility and publishing settings for your Chat app.

To make your test Chat app available to you and others in your organization, do the following:

  1. In the Google Cloud console, open the Google Chat API page:

    Go to Google Chat API page

  2. Click the Configuration tab.
  3. Go to Interactive features > Visibility, and then select the Make this Chat app available to specific people and groups in GOOGLE_WORKSPACE_ORGANIZATION, where GOOGLE_WORKSPACE_ORGANIZATION is the name of your organization.
  4. In the field that appears after selecting the checkbox, enter the email addresses of the people or Google Groups that you want to access your Chat app, separated by commas. To test your own Chat app, enter the email address that you use to access Google Chat.
  5. Click Save.

Add your Chat app to spaces

To start testing interactive features, you must add your Chat app to one or more spaces, such as a direct message, group message, or named space. If you haven't added all the members in the space as trusted testers, they might be able to see the Chat app in the space but can't interact directly with it.

Chat apps that haven't been published don't appear in the listing results from the Google Workspace Marketplace. To find unpublished Chat apps in Google Chat, you can search for the Chat app, find it under Google Workspace tools while composing a message, or @mention the Chat app in a message.

To add your Chat app to a space, do the following:

  1. Open Google Chat using the Google Workspace account that you provided when you added yourself as a trusted tester.

    Go to Google Chat

  2. To start a direct message with the Chat app, do the following:
    1. Click New chat.
    2. In the Add 1 or more people field, type the name of your Chat app.
    3. Select your Chat app from the results. A direct message opens.
  3. To add the Chat app to an existing space, do to the following:
    1. Under Spaces, click the name of the space.
    2. In the Chat space's new message field, enter @ and the name of the Chat app. Select your Chat app from the results
    3. Press Enter or click Send.
    4. If the Add to space name window appears, click Add to space. Your message with the @mention is posted to the Chat space. A text also appears that explains that you added the Chat app to the space.

You can now test the Chat app in the space.

Review and test your Chat app for the Google Workspace Marketplace

When you test your Chat app, you should review all features and then log and fix any errors that you encounter. To understand and address any error messages, see Troubleshoot and fix Google Chat errors.

If you want to publish your Chat app publicly on the Google Workspace Marketplace, you must submit your Chat app for a review. Google reviews your Chat app to make sure that it meets all Marketplace requirements. To learn about the process and requirements, see App review process and requirements for the Google Workspace Marketplace.