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

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

यह एक अडवांस सेवा है. इसका इस्तेमाल करने से पहले, इसे चालू करना ज़रूरी है.

संदर्भ

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

समस्याओं की शिकायत करने और अन्य सहायता पाने के लिए, Admin 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;
  }, {});
}