Admin Console Settings/API Requirements for Gopher for Gmail

API Scopes

Because it offers such tremendous power, Gopher for Gmail is restricted to use by Google Workspace domain super-administrators only.

The Google Workspace domain must have API Access enabled, and the Gopher for Gmail spreadsheet tool must be separately installed by each end-user with an Add-on for Sheets available in the Chrome Web Store.

The API scopes requested by the Sheets Add-on are as follows:

Scope	Reason
View and manage your spreadsheets in Google Drive.	Used to spawn, format, and import data within the current Sheet running Gopher for Gmail.  No spreadsheet other than the currently active Sheet is ever accessed.
Display and run third-party web content in prompts and sidebars inside Google applications.	Used to render the custom sidebar and modal dialogs within Sheets.
Connect to an external service.	Used to make calls to Google Analytics, with anonymous reporting info, and Google Cloud-hosted infrastructure as well as a database that backs the tool.  Data retained in CDW Amplified for Education's custody includes the email identity of users who performed actions within the tool, and aggregate information about their actions.
View users on your domain	Used to confirm that the currently logged-in user is a super-administrator, a requirement for use.

Client Name and Scopes Installation 

Gopher for Gmail also requires one-time installation via a Client Name and a list of API scopes within the Admin console's Domain-Wide Delegation section as shown below. The values needed for the scopes below are provided within the Gopher for Gmail sidebar interface. 

1. 1. Navigate to Domain-wide Delegation in the Admin console.
      Security >  Access and data control > API controls > Domain wide delegation > Manage Domain Wide Delegation
   2. Click Add new.
   3. Enter this Client ID, 113149838232119368247.
   4. Enter these OAuth scopes:
      • https://www.googleapis.com/auth/userinfo.email
      • https://www.googleapis.com/auth/userinfo.profile
      • https://www.googleapis.com/auth/spreadsheets
      • https://mail.google.com/
        
   5. Click Authorize.

Performing this action grants domain-wide authority to Gopher for Gmail to use the following API scopes, for the following reasons.

Scope	Reason
Read, send, delete, and manage your email.	Gopher for Gmail needs full access to user inboxes to perform its mass message search/delete functions.  In other words, it performs its message deletions on behalf of users.
View your installed application's licensing information.	Used to ensure the correct installation state of the app.
View and manage your spreadsheets in Google Drive.	Used to write status messages and logs back to Google Sheets when performing bulk operations.
View your email address.	Used to identify the currently logged-in user.
View your basic profile info.	Used to identify the currently logged-in user.

Performing this action grants domain-wide authority to Gopher for Gmail to use the following API scopes, for the following reasons.

Document Version	Date	Description of Change
1.0	3/12/2024	Changed link to open in new tab and italicized navigation path
1.1	7/23/2024	Reverify