Document versions
Introduction
Google Workspace is an enterprise work environment solution offering multiple interconnected office applications ranging from email to video conferencing (Gmail, Google Drive, Google Meet, etc.). In order to establish the environmental impact of using each of these services, Sopht needs access to certain data from the company's Google Workspace usage reports.
This document serves as a user manual, providing Sopht's customers with the necessary information to set up the collector.
Quick Overview
Purpose: Collects usage metrics from Google Workspace services (Gmail, Google Drive, Google Meet) to establish environmental impact of digital workplace usage.
Key Information:
- Data Collected:
- Gmail: Number of emails sent/received, mailbox storage (MB)
- Google Drive: Storage quota used (MB)
- Google Meet: Call duration, meeting statistics
- Collection Frequency: Weekly (Saturdays at noon), with 2-3 day API delay
Setup Requirements:
- Service Account with appropriate roles
- Google Admin permissions for Reports API access
- API scopes for usage reports (read-only)
Important Notes:
- Only usage data collected, no content
- Customer Usage Reports level (organization-wide)
- Deployed Sopht-side by default
- Alternative: No collector mode where customer pushes data to Backbone API directly
<aside>
⚠️
Google Workspace data retrieval can be divided into 2 setup types, each described below:
- Setup — Default Collector: The collector is deployed by Sopht on its own infrastructure and sends data to the Sopht Backbone API.
- Setup — No Collector: The customer does not use any collector and instead sends data directly to the Sopht Backbone API in the required format.
</aside>