Usługa raportów pakietu Admin SDK

Usługa Admin SDK Reports umożliwia korzystanie z interfejsu Reports API pakietu Admin SDK w Apps Script. Ten interfejs API umożliwia administratorom domen (w tym sprzedawcom) tworzenie niestandardowych raportów o wykorzystaniu w ich domenie. Google Workspace

Dokumentacja

Szczegółowe informacje o tej usłudze znajdziesz w dokumentacji referencyjnej interfejsu Reports API pakietu Admin SDK. Podobnie jak wszystkie usługi zaawansowane w Apps Script, usługa Reports z pakietu Admin SDK korzysta z tych samych obiektów, metod i parametrów co publiczny interfejs API. Więcej informacji znajdziesz w artykule Jak określane są podpisy metod.

Aby zgłosić problemy i uzyskać dodatkową pomoc, zapoznaj się z przewodnikiem pomocy dotyczącym raportów pakietu Admin SDK.

Przykładowy kod

Poniższy przykładowy kod korzysta z wersji 1 interfejsu API.

Generowanie raportu o aktywności dotyczącej logowania się

Ten przykładowy skrypt generuje raport aktywności logowania z ostatniego tygodnia w formie arkusza kalkulacyjnego. Raport zawiera czas, użytkownika i wynik logowania.

advanced/adminSDK.gs
/**  * Generates a login activity report for the last week as a spreadsheet. The  * report includes the time, user, and login result.  * @see https://developers.google.com/admin-sdk/reports/reference/rest/v1/activities/list  */ function generateLoginActivityReport() {   const now = new Date();   const oneWeekAgo = new Date(now.getTime() - 7 * 24 * 60 * 60 * 1000);   const startTime = oneWeekAgo.toISOString();   const endTime = now.toISOString();    const rows = [];   let pageToken;   let page;   do {     page = AdminReports.Activities.list('all', 'login', {       startTime: startTime,       endTime: endTime,       maxResults: 500,       pageToken: pageToken     });     const items = page.items;     if (items) {       for (const item of items) {         const row = [           new Date(item.id.time),           item.actor.email,           item.events[0].name         ];         rows.push(row);       }     }     pageToken = page.nextPageToken;   } while (pageToken);    if (rows.length === 0) {     console.log('No results returned.');     return;   }   const spreadsheet = SpreadsheetApp.create('Google Workspace Login Report');   const sheet = spreadsheet.getActiveSheet();    // Append the headers.   const headers = ['Time', 'User', 'Login Result'];   sheet.appendRow(headers);    // Append the results.   sheet.getRange(2, 1, rows.length, headers.length).setValues(rows);    console.log('Report spreadsheet created: %s', spreadsheet.getUrl()); }

Generowanie raportu o korzystaniu przez użytkowników

Ten przykład generuje raport o korzystaniu z usługi przez użytkowników z zeszłego tygodnia w formie arkusza kalkulacyjnego. Raport zawiera datę, użytkownika, czas ostatniego logowania, liczbę otrzymanych e-maili i liczbę dokumentów, których jest właścicielem.

advanced/adminSDK.gs
/**  * Generates a user usage report for this day last week as a spreadsheet. The  * report includes the date, user, last login time, number of emails received,  * and number of drive files created.  * @see https://developers.google.com/admin-sdk/reports/reference/rest/v1/userUsageReport/get  */ function generateUserUsageReport() {   const today = new Date();   const oneWeekAgo = new Date(today.getTime() - 7 * 24 * 60 * 60 * 1000);   const timezone = Session.getScriptTimeZone();   const date = Utilities.formatDate(oneWeekAgo, timezone, 'yyyy-MM-dd');    const parameters = [     'accounts:last_login_time',     'gmail:num_emails_received',     'drive:num_items_created'   ];   const rows = [];   let pageToken;   let page;   do {     page = AdminReports.UserUsageReport.get('all', date, {       parameters: parameters.join(','),       maxResults: 500,       pageToken: pageToken     });     if (page.warnings) {       for (const warning of page.warnings) {         console.log(warning.message);       }     }     const reports = page.usageReports;     if (reports) {       for (const report of reports) {         const parameterValues = getParameterValues(report.parameters);         const row = [           report.date,           report.entity.userEmail,           parameterValues['accounts:last_login_time'],           parameterValues['gmail:num_emails_received'],           parameterValues['drive:num_items_created']         ];         rows.push(row);       }     }     pageToken = page.nextPageToken;   } while (pageToken);    if (rows.length === 0) {     console.log('No results returned.');     return;   }   const spreadsheet = SpreadsheetApp.create('Google Workspace User Usage Report');   const sheet = spreadsheet.getActiveSheet();    // Append the headers.   const headers = ['Date', 'User', 'Last Login', 'Num Emails Received',     'Num Drive Files Created'];   sheet.appendRow(headers);    // Append the results.   sheet.getRange(2, 1, rows.length, headers.length).setValues(rows);    console.log('Report spreadsheet created: %s', spreadsheet.getUrl()); }  /**  * Gets a map of parameter names to values from an array of parameter objects.  * @param {Array} parameters An array of parameter objects.  * @return {Object} A map from parameter names to their values.  */ function getParameterValues(parameters) {   return parameters.reduce((result, parameter) => {     const name = parameter.name;     let value;     if (parameter.intValue !== undefined) {       value = parameter.intValue;     } else if (parameter.stringValue !== undefined) {       value = parameter.stringValue;     } else if (parameter.datetimeValue !== undefined) {       value = new Date(parameter.datetimeValue);     } else if (parameter.boolValue !== undefined) {       value = parameter.boolValue;     }     result[name] = value;     return result;   }, {}); }