Admin SDK 보고서 서비스

Admin SDK Reports 서비스를 사용하면 Apps Script에서 Admin SDK의 Reports API를 사용할 수 있습니다. 이 API를 사용하면 Google Workspace 도메인 (리셀러 포함)의 관리자가 도메인에 대한 맞춤 사용 보고서를 만들 수 있습니다.

참조

이 서비스에 관한 자세한 내용은 Admin SDK Reports API의 참고 문서를 참고하세요. Apps Script의 모든 고급 서비스와 마찬가지로 Admin SDK Reports 서비스는 공개 API와 동일한 객체, 메서드, 매개변수를 사용합니다. 자세한 내용은 메서드 서명이 결정되는 방식을 참고하세요.

문제를 신고하고 기타 지원을 받으려면 Admin SDK 보고서 지원 가이드를 참고하세요.

샘플 코드

아래 샘플 코드는 API의 버전 1을 사용합니다.

로그인 활동 보고서 생성

이 샘플은 지난주의 로그인 활동 보고서를 스프레드시트로 생성합니다. 보고서에는 시간, 사용자, 로그인 결과가 포함됩니다.

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()); }

사용자 사용량 보고서 생성

이 샘플은 지난주 오늘 사용자 사용 보고서를 스프레드시트로 생성합니다. 보고서에는 날짜, 사용자, 마지막 로그인 시간, 수신된 이메일 수, 소유한 문서 수가 포함됩니다.

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;   }, {}); }