Google Chat

Google Chat Channel Setup Help Doc#


This document will help you understand features and limitations of Google Chat channel, and guide you in setting up your own Google Chat chatbot on Yellow AI platform.


Before setting up a chatbot:

Screenshot 2021-12-09 at 4.13.52 PM.png

  • Enable Service Account and Generate Keys:
    • In the navigation panel go to IAM & Admin → Service Accounts

Screenshot 2021-12-09 at 4.21.32 PM.png

  • On the next screen click on + CREATE SERVICE ACCOUNT

Screenshot 2021-12-09 at 4.21.46 PM.png

  • Add the Service Account Details in Step 1. Skip Step 2 & 3.

Screenshot 2021-12-09 at 4.22.15 PM.png

Screenshot 2021-12-09 at 4.22.28 PM.png

  • Once the service account is created, open it.
  • Go to KEYS tab and click on ADD KEY → Create new key and select JSON. Please save this file carefully as this can not be recovered.

Screenshot 2021-12-09 at 4.37.47 PM.png

Screenshot 2021-12-09 at 4.38.05 PM.png

Screenshot 2021-12-09 at 4.38.19 PM.png

  • Enable Google Chat API:
    • In navigation go click on APIs & Services

Screenshot 2021-12-09 at 4.18.05 PM.png


Screenshot 2021-12-09 at 4.18.20 PM.png

  • Search for Google Chat API

Screenshot 2021-12-09 at 4.18.38 PM.png

  • Enable on Google Chat API:
    • Once enabled, go to Configuration.

Screenshot 2021-12-09 at 4.18.47 PM.png

Screenshot 2021-12-09 at 4.42.26 PM.png

  • Fill in all the details to configure your Google Chat Bot:
    • Please check both the options for Functionality
    • For Connection setting select “Bot URL” and add the following:
      • For cloud.yellow.ai[BOT ID]
      • For app.yellowmessenger.com[BOT ID]

Screenshot 2021-12-09 at 4.43.47 PM.png

Channel setup on platform#

1) To connect your Google Chat account, go to Channels → Communication → Google Chat → Connect.

Screenshot 2021-12-10 at 1.09.18 PM.png

2) Enter the Client Email and Private Key. You will find this in the JSON file you had downloaded earlier.




3) Your Google Chat Channel should now be configured successfully!!


Supported Features#

  • Following variables are passed to the profile object and can be accessed using {{{profile.Variable}}}:
    • spaceId → This refers to the Google Chat space in which the user has messaged
    • displayName → This refers to the name of the Google Chat user
    • email → This refers to the email of the Google Chat user
    • thread → This refers to the thread in which the User has messaged
  • Events: Upon successful configuration, the following events are auto-added to the Event Hub in platform:
    • google_chat_added_to_space → Received when your Bot is added to a Space.
    • google_chat_removed_from_space → Received when your Bot is removed from a Space.
  • Text Messages: Synchronous messages supported only.
  • Card Messages: This is not supported right now.