Google Chat App Setup

Integrating Digital Agent into Google Chat elevates collaboration and efficiency within your workspace. Seamlessly combine the power of Google Chat's real-time communication with the intelligence of Digital Agent to streamline tasks, provide instant information, and enhance user experiences. 

Start using Digital Agent in Google Chat channel by setting up the Google Chat App.

Setup Google Chat App through the Google Console Developer Portal 

Login to the Google console portal to setup your Google Chat app. 

To setup Google Chat app for Digital Agent, perform the following steps: 

Step 1: Create a new project on Google Console 

Begin setting up Google Chat App for Digital Agent by creating a new project on Google Console. 

To create a new project on Google Console, perform the following steps: 

1. Login to your Google account.  
2. Go to the Google Console Developer portal. 
3. Click Go to Create a Project. (Refer the following screenshot)
   
   Figure: Google Console – Create a project 
4. Enter the Project name, Organization, and Location, as shown in the below screenshot. Click Create to create a project. (Refer the following screenshot)
   
   Figure: Google Console - Project Details 
5. Once you click Create, a project is successfully created on Google Console. The following screenshot displays the details of the create project on Google Console.
    
   Figure: Google Console - Project Creation Successful

Step 2: Enable Service Account and Generate Keys 

After creating a new project on Google Console, you have to enable the Service account and generate the keys. Enabling the Service account allows Digital Agent to securely interact with Google Cloud services. And generating keys provides secure authentication for Digital Agent to access APIs and resources associated with the Google Chat integration. 

To enable Service account and generate keys, perform the following steps: 

1. From the left navigation panel, navigate to IAM & Admin > Service Accounts. (Refer the following screenshot)
   
   Figure: Google Console – Service Accounts
2. Click + CREATE SERVICE ACCOUNT to create Service account for Digital Agent. (Refer the following screenshot)
   
   Figure: Google Console - Create Service Account 
3. In the next screen fill in Service Account details in Step 1 such as Service account name, Service account ID, and Service account description.
4. Click CREATE AND CONTINUE to create Service account.
   
   Figure: Create Service Account - details 
5. Steps 2 and 3 are optional and can be skipped.
6. The details of the Service Account for your project are added successfully. Click the email link once the Service Account is created. (Refer the following screenshot)
   
   Figure: Service Account - Click email link 
7. Navigate to the KEYS tab. Click ADD KEY and select Create new key from the dropdown menu.
   
   Figure: Generate Key - Add New Key 

8. A pop-up window will appear. Select the Key type as JSON. Click Create.
   

   Note

   Save this file carefully, as it cannot be recovered once it is lost.

   
   
   Figure: Generate Key - Select Key Type 

9. A new pop-up window displays a confirmation message "Private key saved to your computer."
   
   Figure: Generate Key - Private Key Saved
   

   Note

   Retrieve the Client Email and Private Key from the downloaded JSON file, then pass them along to the SymphonyAI team for configuration in the Bot setting.

Step 3: Enable Google Chat API 

Enabling the Google Chat API is a crucial step in integrating Digital Agent with Google Chat. The Google Chat API allows developers to build applications that can interact programmatically with Google Chat spaces. 

To enable Google Chat API, perform the following steps:

1. From the left navigation panel, click APIs & Services > Enabled APIs and services.
   
   Figure: Enable Google Chat API 
2. Click + Enable APIs and services to enable the APIs for Digital Agent.
   
   Figure: Enable API and Services 
3. Navigate to the search bar and search for Google Chat API and select it.
   
   Figure: Search Google Chat API
4. Click Enable to enable the Google Chat API.
   
   Figure: Enable Google Chat API
5. Configure your Google Chat bot once the Google Chat API is enabled.

Step 4: Configure your Google Chat bot 

Configuring your Google Chat bot is a vital step in the process of integrating Digital Agent with Google Chat. This configuration involves setting up the necessary parameters, permissions, and behavior of Digital Agent within the Google Chat environment. 

To configure your Google Chat bot, perform the following steps: 

1. Navigate to CONFIGURATION tab.
   
   Figure: Configuration tab
2. Click Save to save all the configuration details. Mention the below details in the following screen to configure your Google Chat bot:
   
   Figure: Google Chat bot - configuration details
   
   
   1. Enter the name for your app.
   2. Add the avatar URL.
   3. Enter the description relevant to your app.
   4. Toggle the switch next to Interactive features to enable it.
   5. Click on both the check boxes under the Functionality section.

   6. Under Connection settings, select App URL and add the app URL in the App URL field.
      

      Note

      The app URL will be provided by the SymphonyAI team.

   7. Scroll down to the Visibility section and enter the email addresses to add individuals and groups to your domain. 
   8. Click Save to save all the configuration details.

Step 5: Configure Digital Agent app in the Google Workspace Marketplace SDK

Using the Google Workspace Marketplace SDK is necessary for managing Digital Agent app on the Marketplace, regardless of whether you are publishing it privately or publicly.

Configure and manage Digital Agent app on the Google Workspace Marketplace using the Google Workspace Marketplace SDK. SDK is a toolkit for creating and managing apps on the Marketplace. To make Digital Agent app available in Google Chat, you need to set it up in the SDK. SDK allows you to do the following activities:

• Select whether you want Digital Agent app to be publicly accessible to all Marketplace users or privately accessible to certain Google Workspace organizations.
• Define the types of users who can install Digital Agent app from the Marketplace.
• Mention the Google Workspace apps that Digital Agent app is compatible with.
• Set the OAuth scopes required by Digital Agent app.
• Provide details about people who have created Digital Agent and maintain them.

Enable the Google Workspace Marketplace SDK

Click here to enable Google Workspace Marketplace SDK in your Google Cloud project.

To enable Google Workspace Marketplace SDK in your Google Cloud project, perform the following steps:

1. Open the Google Cloud Console.
2. Click Select a project from the top. Click the name of the project to switch between Google Cloud projects which are already open.
3. Select Digital Agent app's Cloud project.
4. Click Open.
5. Type and search Google Workspace Marketplace SDK in the search bar at the top.
   
   Figure: Search Marketplace SDK

6. Open Google Workspace Marketplace SDK page.

   Important

   Make sure you enable the Google Workspace Marketplace SDK, not the API. The Google Workspace Marketplace API is a different tool used to integrate with Google's licensing and billing services.

7. Click Enable to enable the Google Workspace Marketplace SDK, if it is not already enabled.
   
   Figure: Enable Marketplace SDK

Enter app settings in the Google Workspace Marketplace SDK

After enabling the Google Workspace Marketplace SDK in your Google Cloud project, configure the app settings in the Google Workspace Marketplace SDK.

To enter the app settings in the Google Workspace Marketplace SDK, perform the following steps:

1. Open Google Workspace Marketplace SDK.
2. Navigate to the App Configuration tab.
3. Fill in all the fields with the details about your app. Refer to App configuration settings to know more about each setting.
4. Click Save to save the details.
   
   Figure: App settings fields

App Configuration Settings

There are several settings in the App Configuration section of the Google Workspace Marketplace SDK.

App Visibility

If you are utilizing a Google Workspace account, which is typically set up by your work organization, you will see the App Visibility option. However, if you're using a consumer account, identifiable by its "@gmail.com" domain, your publishing capabilities are restricted to public settings only.

• Public: People from outside your domain can find and install the app. Opting for public visibility means that Google will review and approve your app listing before publishing it.
• Private: The app is exclusively discoverable and installable by individuals within your domain.

If you opt to publish as Unlisted, the app listing will not be displayed in browse or search results. Users will only be able to access the app's store page via the direct URL.

When creating the store listing, you can limit the countries and regions where your app will be available by configuring this in the Distribution section.

Installation Settings

The installation settings determine whether users or Workspace administrators can install your app directly from its store listing page on the Google Workspace Marketplace.

Publish an app

After enabling the Google Workspace Marketplace SDK and entering the app settings in Google Workspace Marketplace SDK, you need to publish the app.

To publish the app, perform the following steps:

1. Login to Google Cloud console.
2. Click Menu > APIs & Services > Google Workspace Marketplace SDK > Store Listing.
3. Fill in the details in the sections for App Details, Graphic Assets, and Support Links. If your app uses or references any Google trademarks, ensure compliance with the Google Workspace Marketplace branding guidelines.
   
4. This step is optional. In the Distribution section, deselect All Regions and choose only the specific regions where you wish to publish your app. For users located outside of the selected regions based on their IP address, the following occurs:
   1. Your app listing does not appear when users search for apps in the Google Workspace Marketplace.
   2. When attempting to access the listing through a direct link, they get the error message: "Sorry, this app is not available in your country or region".
      Make sure to include the language specific to each region in the App Details section.
5. Click Publish to save the details and publish.
6. The app is published right away if your app listing is marked as private.
7. The app undergoes a review process before getting published, if the app listing is marked as public. For more information, refer to App review process and requirements.

Create a store listing

The details you provide on the Store Listing page serve as promotional material for your app, reaching out to potential users browsing through the Google Workspace Marketplace. While certain fields are not mandatory, completing them can significantly enhance the descriptive quality of your app listing.

Ensure that you have information about the following assets before filling out the Store Listing page:

App Details

App details section contains general details about the app such as application name, description.

The Store Listing page in the Google Workspace Marketplace displays the App Details section with the following fields:

Graphic Assets

Graphics are used in the Google Workspace Marketplace to visually depict and advertise apps.

Refer the below table for the fields present in the Graphic Assets section:

Support Links

Support links help users to seek assistance with your app and review your terms and policies.

Refer the below table for the fields present in the Support Links section:

Check you app listing's publication status

During the review process for public app listings, you will receive email notifications regarding the publication status. These notifications will be sent to the Developer email that you supplied for your app listing.

Follow the below steps to check whether your app listing is published or not:

1. Go to Google Cloud console.

2. Open your app's Google Cloud project.
3. From the left panel, click Menu > APIs & Services.
4. Click Google Workspace Marketplace SDK > Store Listing tab.
5. On the top of the Store Listing tab, status of app listing publication is displayed. (Refer below screenshot)
   
   Figure: App listing publication status

Below table describes the possible publication statuses of app listings along with their definitions: