How to Deploy the Add-in in Google Workspace

Deployment Steps

Create Script

To deploy the Phishing Reporter add-in to users in Google Workspace, follow these steps:
  • Go to script.google.com and click on the New Project button.
  • Click Use Legacy Editor.
  • The new script file that is opened is saved with a project name.
  • In the Code.gs, paste the script code provided by the platform and save it.
  • Go to View > Show manifest file and create the appscript.json file. Copy and save the manifest code provided by the platform.

Create Project

  • Go to console.cloud.google.com and create a new project.
  • Name your project and select the location. Then click on Create to start your project.
  • Go to the API & Services page. Open the OAuth content screen page from the left menu. Please make sure the User type option selected is Internal.

OAuth Content Screen Configuration

  • On the OAuth content screen, fill in the required fields, and then click Save and Continue. After that, click the Save and Continue button again on the Scope screen without making any changes. Then click Back to Dashboard.
  • Go to API & Services and open the Library page to search Gmail API and then enable it.
  • Go to Project Settings and copy the Project Number.

Change the Project Number of Script

  • Go to Resources > Cloud Platform project on script.google.com.
  • On the Cloud Platform project page, paste the Project Number in the designated field and click Set Project.
  • Confirm the project change.
The change is enabled once the project change is confirmed.

Enable Google Workspace Marketplace SDK

  • From the Library page, search for the Google Workspace Marketplace SDK and click on it.
  • Click the Enable button and activate Google Workspace Marketplace SDK.
  • Go back to script.google.com and click Publish > Deploy from the manifest file and then Click Get ID and copy the Deployment ID.
  • Go back to the Console Cloud. Go to the API & Services page, find “Google Workspace Marketplace SDK” and click on it.
  • Go to the App Configuration tab and enable the Google Workspace add-on option and check Deploy using Apps Script deployment ID.
  • Then paste the Deployment ID, upload the logos provided by the platform and fill in the required fields.
  • Before saving, do not forget to select the Private option and then click Save.
  • Go to the Google Workspace Marketplace SDK page and click the Manage button to see the Store Listing menu, upload the logos provided here, fill in the required fields, and click Publish.

Deploy Add-in

To deploy the add-in, go to the application marketplace. Find the add-in in the Approved listing, and click the Domain Install button to start the deployment process. Click Continue to start distribution of the extension.
Accept the required permissions to complete the deployment.
It may take up to 24 hours for this app to be installed for your entire Google Workspace domain or organizational unit.

Uninstall the Add-in

  • Go to Google Admin > Apps > Google Workspace Marketplace apps > App list on the left menu.
  • Click on the Phishing Reporter add-in you want to uninstall.
  • Click Delete App to complete the process.
It may take up to 24 hours for this app to be uninstalled for your entire Google Workspace domain or organizational unit.
Copy link
On this page
Deployment Steps
Create Script
Create Project
OAuth Content Screen Configuration
Change the Project Number of Script
Enable Google Workspace Marketplace SDK
Deploy Add-in
Uninstall the Add-in