Skip to main content
  1. CloudM
  2. Migrate
  3. Perform a Migration
  4. Configure your Connections
  5. Connection Setup
  6. Environment Configuration Guides

Enable and Configure the Google Chat API

Updated

Configuration of the Google Chat API within the Google Cloud Platform (GCP) is required to allow CloudM to interact with your Google Chat environment for message migration and space management.

Prerequisites

  • Access to the Google Cloud Console with a valid project selected.
  • Administrator privileges for the Google Workspace domain.
  • The HTTP Endpoint URL provided in your CloudM project setup.

Step 1: Enable the API

  1. Navigate to the Google Cloud Console.
  2. Go to APIs & Services Library.
  3. Search for Google Chat API.
  4. Click Enable.

Step 2: Configure the Chat App

Once the API is enabled, click the Configuration tab (or click Manage Configuration) to set up the application details.

1. Workspace Add-on Setting

Critical Configuration:

Ensure the checkbox "Build this Chat app as a Workspace add-on" is DESELECTED (unticked).

Warning: This setting cannot be disabled once saved. If you enable and save this setting, you must create a new Google Cloud Project to configure the Chat API correctly for CloudM.

2. Application Info

Configure the visual identity of the migration app as it appears to end-users within Google Chat.

  • App name
    • Definition: The display name users see when the app migrates a message or joins a space.
    • Requirements: Maximum 25 characters recommended to prevent UI truncation.
  • Avatar URL
    • Definition: The source URL for the profile picture (circular icon) in chat threads.
    • Requirements: Must be a publicly accessible HTTPS URL (PNG or JPG) with a 1:1 aspect ratio.
  • Description
    • Definition: A brief summary for administrative identification.
    • Requirements: Maximum 40 characters.

3. Interactive Features

Select the features required for the application to interact with your environment:

  • Enable Interactive Features: Set to Enabled.
  • Join spaces and group conversations: Set to Enabled (required for migrating data into Google Spaces).

4. Connection Settings

  1. Select HTTP endpoint URL as the connection method.
  2. App URL / HTTP Endpoint URL: Enter the specific URL provided by your CloudM setup.
    • For source connections, enter the source domain (e.g., https://source.com).
    • For destination connections, enter the destination domain (e.g., https://destination.com).
  3. Authentication Audience: Select Project number.

5. Visibility

Control application access and installation:

  1. Select "Make this Chat app available to specific people and groups in [Your Domain]".
  2. Email addresses: Enter the email address of a Google Group containing the Super Admin account used for the connection and all migrating users.
Note: You can use a Dynamic Group for automatic membership or a Static Group with Bulk Import via CSV. Access changes may take up to 24 hours to propagate.

6. Logs

  • Log errors to Logging: Enable this to assist in debugging connection issues via the Google Cloud Logs Explorer.

Step 3: Save and Verify Status

  1. Click Save at the bottom of the page.
  2. After the page refreshes, scroll to the top and verify the App Status field.
  3. Ensure the status is LIVE - available to users. If the status is not "LIVE", use the dropdown menu to change it and click Save again.

Step 4: Enable Service Account Scopes

Authorize the Service Account with the specific Google Chat API scopes in the Google Workspace Admin Console.

Refer to the Service Account setup guide for detailed scope instructions.

Was this article helpful?
1 out of 4 found this helpful