Skip to main content
Version: 7.3

How to configure and publish the Google Workspace Marketplace Add-on

Introduction​

The Google Workspace Marketplace Add-on is a private Google Workspace application that lets users open migrated contentACCESS HTML shortcuts directly in Gmail. It is designed for contentACCESS HTML shortcuts and supports quick review and restore of archived email content without leaving the Google Workspace environment.

This page describes the end-to-end setup that a Google Workspace administrator must complete to create and publish the add-on. It covers:

  • creating the required Google Cloud project,
  • configuring OAuth consent,
  • preparing the Apps Script project,
  • enabling the Marketplace SDK,
  • creating the deployment,
  • configuring the Marketplace app and store listing,
  • and installing the app for the target users or groups.

Prerequisites​

Before you configure the add-on, make sure you have the following:

  • A Google Workspace organization or domain where the add-on will be used.
  • A customer account with sufficient permissions to create and manage the Cloud project and Marketplace configuration.
  • The contentACCESS backend URL.
  • A Google Workspace administrator for the final installation and approval if the organization restricts Marketplace installations.

Please note that private Marketplace apps are available only within the organization in which they are published.

How to configure and publish the add-on​

The following steps describe the complete setup process for the Google Workspace Marketplace Add-on. First, you create the required Google Cloud project and connect it to the Apps Script project. Then you configure the OAuth consent and required scopes, enable the Marketplace SDK, and create the deployment that will be used by the app. After that, you define the Marketplace app settings, prepare the store listing, and publish the add-on. Finally, you install it in the customer’s Google Workspace environment and make it available to the selected users or groups.

Create a Google Cloud project​

To create the required Google Cloud project, follow these steps:

  1. Sign in to Google Cloud with an account that has sufficient permissions for the Google Workspace environment.
  2. Open Google Cloud Console: https://console.cloud.google.com/
  3. At the top, click the project selector (the current project name or dropdown menu).
  4. Click New Project.
  5. Enter a project name.
  6. If the Organization/Location option appears, select your organization and the appropriate location.
  7. Click Create.
  8. Open the project selector again and select the newly created project.

Create a new project in Google Cloud Console

Copy the Cloud project number​

After you create the Cloud project, copy the Project number from the project dashboard. You will need this number when linking the Apps Script project to the Cloud project.

Created project in Google Cloud Console

This step is required so the add-on can access the required data from Gmail and read the related information from archived shortcuts. For the app to work correctly, it needs the appropriate Google permissions and an OAuth consent configuration for the customer’s Google Workspace environment.

  1. Open Google Cloud Console, then go to Google Auth Platform > Branding. (From the hamburger menu in the top-left corner, select APIs and Services, and then choose OAuth consent screen. On the Google Auth Platform / Overview page, open the left-side menu and select Branding.)
  2. Configure the OAuth consent details for the new customer Cloud project:
    • App name: contentACCESS
    • User support email: customer/admin email

Google Workspace app information

  • Audience: Internal (for a private app used only within the customer’s Google Workspace organization)

Google Workspace audience settings

  • Developer contact information: developer/admin email (for example, support@tech-arrow.com or the customer’s administrator email)

Google Workspace contact information

  1. Complete the required fields and save the configuration.

Google Workspace OAuth configuration complete

  1. After the OAuth configuration is complete, return to Apps Script > Project Settings > Google Cloud Project > Change project, and enter the Cloud project number.
note

This step must be completed before assigning the Cloud project to the Apps Script project. If the OAuth consent screen is not configured, Apps Script may display the message: “In order to change your project, you will need to configure the OAuth consent screen.”

This configuration allows the add-on to request and use the required Google Workspace permissions to read email data and shortcut metadata in the customer environment.

Create the Apps Script project​

  1. Open Apps Script: https://script.google.com/
  2. Click New project.

Create a new Apps Script project

  1. Rename the project.
  2. Open Project Settings.
  3. Under Google Cloud Platform (GCP) Project, click Change project.

Google Cloud Project settings in Apps Script

  1. Enter the Google Cloud project number.
  2. Click Set project.

Set the Google Cloud project for the Apps Script project

Copy the source code​

  1. Open the working developer Apps Script project (where you previously configured the project ID).
  2. Enable the Show "appsscript.json" manifest file option in the editor. After this, the appsscript.json manifest file appears in the Editor side menu.

Show the appsscript.json manifest file in Apps Script

  1. Copy the developer source code into the customer project. Copy the required .gs Apps Script files into the customer project and keep the project structure consistent.

Edit the appsscript.json manifest in Apps Script

Edit the Code.gs file in Apps Script

  1. Copy the complete appsscript.json manifest.
note

If the archive content is converted to PDF for preview or rendering, make sure the required Ghostscript (GS) tool is installed and configured in the environment that performs the conversion.

  1. Save the project.

Before finalizing the customer deployment, replace the backend URL with the customer’s production backend URL, update the URL allowlist to the customer’s HTTPS URL prefix, remove any test endpoints if the deployment is for production, review customer-specific IDs and configuration, and keep the OAuth scopes aligned with the tested application.

Configure Google Auth Platform​

  1. Open Google Cloud Console with the customer project selected.
  2. Go to Navigation menu > Google Auth Platform.
  3. Open Data Access and add the OAuth scopes used by the copied manifest. Copy the following values into the table text box:

These URLs are required so the add-on can view and read email and shortcut data and access the information stored in them.

Google Auth Platform OAuth scopes

  1. Click Add to table, then save the configuration.

Google Auth Platform save scope

Enable the Google Workspace Marketplace SDK​

  1. With the customer Cloud project selected, open Google Cloud Console.
  2. Go to Navigation menu > APIs & Services > Library.
  3. Search for Google Workspace Marketplace SDK.

Search for the Google Workspace Marketplace SDK

  1. Select Google Workspace Marketplace SDK and click Enable.

Google Workspace Marketplace SDK enabled

  1. Review the enabled Workspace Marketplace SDK overview:

Google Workspace Marketplace SDK overview

Create a customer Apps Script deployment​

  1. Open the customer Apps Script project.
  2. Click Deploy > New deployment.
  3. For Select type, choose Google Workspace Add-on.

Create a new Google Workspace Add-on deployment

  1. Enter a release description.
  2. Click Deploy.
  3. Click Copy to copy the Deployment ID. We highly recommend saving this ID in a secure location, because it is required for the Marketplace app configuration.

Deployment ID in Google Workspace Add-on deployment

Configure the Marketplace app​

  1. Open Google Cloud Console with the customer project selected.
  2. Go to Navigation menu > APIs & Services > Enable APIs and Services > select the Google Workspace Marketplace SDK option.

Google Workspace Marketplace SDK API page

  1. Once it opens, go to the App configuration tab. Under App visibility, select Private, then choose the installation setting: Individual + Admin Install, or Admin Only Install if the customer wants administrator-controlled installation. We recommend the Admin Only Install option.

App visibility and installation settings

  1. Scroll down to the App integrations section, select Google Workspace add-on, and then select App Script. Enter or select the Apps Script Deployment ID.

App integrations and Apps Script deployment configuration

  1. Enter the OAuth scopes used by the add-on further down on the same tab. These scopes are the same as those configured in Google Auth Platform. It may also happen that the scopes are already pre-filled from the previous configuration steps in this section. If not, copy the following values into the table text box:
  2. Complete the developer information (this is TECH-ARROW, and all necessary information can be found on our website).
  3. Click Save Draft.

Developer information in the Google Workspace Marketplace app configuration

Create the store listing and publish the add-on​

  1. In Google Cloud Console, go to Navigation menu > APIs & Services > Enable APIs and Services > Google Workspace Marketplace SDK > Store Listing tab.
  2. Complete App Details based on your preferences. Click the dropdown arrow in the language column to open the list, and then enter the application name, a short description, and a detailed description.

App details in the Google Workspace Marketplace Store Listing

  1. Upload the required application icons and banner in the Graphic Assets section. The required sizes are 32x32 and 128x128 for the application icons, and 220x140 for the application card banner. Also add at least one screenshot showing the add-on integrated with Google Workspace.

Graphic assets for the Google Workspace Marketplace listing

  1. Complete Support Links and other required fields. The Distribution region is also required. All necessary information can be found on our website.

Support links in the Google Workspace Marketplace listing

  1. Save the listing. Once the draft is saved, the Publish button appears. Click it to publish the add-on to the Google Workspace Marketplace. The add-on will then be available for installation in the customer’s Google Workspace environment.

Publish the Google Workspace Marketplace Store Listing

Install the application​

  1. Sign in as the customer’s Google Workspace administrator if administrator installation is being used.
  2. Open Google Workspace Marketplace: https://workspace.google.com/marketplace/
  3. Open the customer’s private contentACCESS listing by selecting Internal apps in the left-side menu.

Find the contentACCESS app in Google Workspace Marketplace

  1. Click Admin install or Install, depending on the configured installation setting.

Install the Google Workspace Marketplace add-on

  1. Complete the authorization and installation flow:
    • Step 1: Allow data access — install the application for certain groups or organizational units and agree to the policy. Then click Next.

Allow data access for the Google Workspace Marketplace add-on

  • Step 2: Select users (optional) — select the required group(s) or organizational unit(s), or skip this step. Then click Finish.

Select users for the Google Workspace Marketplace add-on

note

If the organization uses an app allowlist, the administrator may need to allow the app first.

  1. After installation, the add-on appears in Gmail for the selected users.

contentACCESS add-on installed in Gmail

The add-on can be accessed from the right-side menu in Gmail.

Change app access for another group or organization unit​

If you need to make the app available to another Google Workspace group or organizational unit, you can update the existing installation without repeating the full installation flow.

  1. Sign in to admin.google.com.
  2. In the left-side menu, go to Apps > Google Workspace Marketplace apps > Apps list.
  3. Select the contentACCESS app.
  4. Open the User access section.
  5. Click View organizational units and groups.

Manage app access for Google Workspace organizational units and groups

  1. In the Search for... field, find the required group or organization unit and set the app distribution to On or Off as needed.

Google Workspace app distribution On/Off settings for a group or organization unit

This allows the administrator to manage app availability for additional groups or organization units without repeating the full installation process.