Google Workspace

Download 224
Last updated Nov 12, 2026

Install Guide

Overview

Caution
This guide is based on Google Workspace app 1.9.2610.0 or later. Before installing, make sure you are using the latest version. If you are using an earlier version, upgrade to the latest version. Gmail log collection and the google-workspace-gmail-logs query command are available in 1.10.2611.0 or later.
Note
This guide is based on screens as of October 2026. Menu names and screens in the Google Workspace Admin console and the Google Cloud console may change. Screenshots are taken in Korean, and English menu names are given in the text.

The Google Workspace app collects Google Workspace audit logs (admin activity, login, Drive, Gmail, Meet, Chat, OAuth token) and Alert Center alerts, and provides query commands to look up domains, users, groups, and Drive connected apps, and to read and write Google Sheets.

Setup Flow

First, decide which loggers and query commands you will use in 1. Required Permissions, and prepare only the permissions they need. Choose an authentication method in 3. Choosing an Authentication Method.

The steps depend on the authentication method. In the table below, follow in order only the steps marked Required for the method you chose. Click a task name to go to its setup page.

TaskWhereService accountUser account OAuth
2. Prepare a dedicated integration account and admin roleAdmin consoleRequiredRequired (not needed if you use only the Drive apps and spreadsheet commands)
2. Create a project and enable APIsGoogle Cloud consoleRequiredRequired
3-1. Create a service account and keyGoogle Cloud consoleRequired-
3-1. Register domain-wide delegationAdmin consoleRequired-
3-2. Configure the OAuth consent screen and clientGoogle Cloud console-Required
3-2. Issue a refresh tokenOAuth 2.0 Playground-Required
4. Install the app, add a connect profile and loggersLogpresso SonarRequiredRequired

Gmail Log Limitations

Gmail logs have the following limitations due to what Google provides.

  • Gmail logs may not be available depending on your Google Workspace edition.
  • Google keeps Gmail logs for 180 days, so the logger's Scan Days is up to 180 days.
  • The google-workspace-gmail-logs query command requires the from or duration option, and queries up to 30 days at a time within the last 180 days.
  • The sender address, attachment names and URLs of clicked links are not provided.
  • Recipients do not distinguish To, Cc and Bcc.
  • Bounces are recorded with mail event type UNKNOWN and action type BOUNCED, and forwarding as FIRST_REPLIED on the original mail.
  • Marking as read, downloading a mail, and blocking the sender when reporting spam are not recorded.
  • Delivery stage events (UNKNOWN) make up about half of all events.

Network Requirements

Sonar must be allowed outbound HTTPS (443) access to the addresses for the features you use.

AddressUsed by
oauth2.googleapis.comAll features (token issuance)
admin.googleapis.comAdmin Activity, Login, Drive, Gmail, Meet, and Chat loggers, *-logs query commands, google-workspace-domains, users, groups
alertcenter.googleapis.comAlert Center logger, google-workspace-alerts
www.googleapis.comDrive Activity logger, google-workspace-drive-logs, drive-apps, drive-app
sheets.googleapis.comgoogle-workspace-sheets-values, sheets-write-values