एडमिन SDK रिपोर्ट सेवा

'एडमिन SDK की रिपोर्ट' सेवा की मदद से, Apps Script में, एडमिन SDK के रिपोर्ट एपीआई का इस्तेमाल किया जा सकता है. यह एपीआई, Google Workspace डोमेन (इसमें रीसेलर भी शामिल हैं) के एडमिन को अपने डोमेन के लिए, इस्तेमाल की कस्टम रिपोर्ट बनाने की सुविधा देता है.

ध्यान दें: यह एक बेहतर सेवा है, जिसे इस्तेमाल करने से पहले चालू करना ज़रूरी है.

रेफ़रंस

इस सेवा के बारे में ज़्यादा जानकारी के लिए, 'एडमिन SDK रिपोर्ट एपीआई' के लिए रेफ़रंस दस्तावेज़ देखें. Apps Script की सभी बेहतर सेवाओं की तरह, एडमिन SDK रिपोर्ट सेवा भी उन ऑब्जेक्ट, तरीकों, और पैरामीटर का इस्तेमाल करती है जो सार्वजनिक एपीआई के लिए किए जाते हैं. ज़्यादा जानकारी के लिए, हस्ताक्षर तय करने का तरीका लेख पढ़ें.

समस्याओं की रिपोर्ट करने और अन्य मदद पाने के लिए, एडमिन SDK रिपोर्ट के लिए सहायता गाइड देखें.

नमूना कोड

नीचे दिए गए सैंपल कोड में, एपीआई के वर्शन 1 का इस्तेमाल किया गया है.

लॉगिन गतिविधि की रिपोर्ट जनरेट करें

यह नमूना पिछले हफ़्ते की लॉगिन गतिविधि की रिपोर्ट, स्प्रेडशीट के तौर पर जनरेट करता है. रिपोर्ट में समय, उपयोगकर्ता, और लॉगिन के नतीजे शामिल होते हैं.

advanced/adminSDK.gs

GitHub पर देखें

/**
 * 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

GitHub पर देखें

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