एडमिन SDK की डायरेक्ट्री की सेवा

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

रेफ़रंस

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

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

नमूना कोड

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

सभी उपयोगकर्ताओं की सूची बनाना

इस सैंपल में, डोमेन के सभी उपयोगकर्ताओं की सूची दी गई है. उपयोगकर्ताओं की सूची, उनके नाम के हिसाब से लगाई गई है.

advanced/adminSDK.gs
/**
 * Lists all the users in a domain sorted by first name.
 * @see https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list
 */
function listAllUsers() {
  let pageToken;
  let page;
  do {
    page = AdminDirectory.Users.list({
      domain: 'example.com',
      orderBy: 'givenName',
      maxResults: 100,
      pageToken: pageToken
    });
    const users = page.users;
    if (!users) {
      console.log('No users found.');
      return;
    }
    // Print the user's full name and email.
    for (const user of users) {
      console.log('%s (%s)', user.name.fullName, user.primaryEmail);
    }
    pageToken = page.nextPageToken;
  } while (pageToken);
}

उपयोगकर्ता की जानकारी पाना

इस सैंपल में, उपयोगकर्ता को उसके ईमेल पते से ढूंढा जाता है और उसका सारा डेटा, JSON स्ट्रिंग के तौर पर लॉग किया जाता है.

advanced/adminSDK.gs
/**
 * Get a user by their email address and logs all of their data as a JSON string.
 * @see https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/get
 */
function getUser() {
  // TODO (developer) - Replace userEmail value with yours
  const userEmail = 'liz@example.com';
  try {
    const user = AdminDirectory.Users.get(userEmail);
    console.log('User data:\n %s', JSON.stringify(user, null, 2));
  } catch (err) {
    // TODO (developer)- Handle exception from the API
    console.log('Failed with error %s', err.message);
  }
}

उपयोगकर्ता जोड़ें

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

advanced/adminSDK.gs
/**
 * Adds a new user to the domain, including only the required information. For
 * the full list of user fields, see the API's reference documentation:
 * @see https://developers.google.com/admin-sdk/directory/v1/reference/users/insert
 */
function addUser() {
  let user = {
    // TODO (developer) - Replace primaryEmail value with yours
    primaryEmail: 'liz@example.com',
    name: {
      givenName: 'Elizabeth',
      familyName: 'Smith'
    },
    // Generate a random password string.
    password: Math.random().toString(36)
  };
  try {
    user = AdminDirectory.Users.insert(user);
    console.log('User %s created with ID %s.', user.primaryEmail, user.id);
  } catch (err) {
    // TODO (developer)- Handle exception from the API
    console.log('Failed with error %s', err.message);
  }
}

उपनाम बनाना

इस सैंपल में, किसी उपयोगकर्ता के लिए कोई दूसरा नाम (उपनाम) बनाया गया है.

advanced/adminSDK.gs
/**
 * Creates an alias (nickname) for a user.
 * @see https://developers.google.com/admin-sdk/directory/reference/rest/v1/users.aliases/insert
 */
function createAlias() {
  // TODO (developer) - Replace userEmail value with yours
  const userEmail = 'liz@example.com';
  let alias = {
    alias: 'chica@example.com'
  };
  try {
    alias = AdminDirectory.Users.Aliases.insert(alias, userEmail);
    console.log('Created alias %s for user %s.', alias.alias, userEmail);
  } catch (err) {
    // TODO (developer)- Handle exception from the API
    console.log('Failed with error %s', err.message);
  }
}

सभी ग्रुप की सूची बनाना

इस सैंपल में, डोमेन के सभी ग्रुप की सूची दी गई है.

advanced/adminSDK.gs
/**
 * Lists all the groups in the domain.
 * @see https://developers.google.com/admin-sdk/directory/reference/rest/v1/groups/list
 */
function listAllGroups() {
  let pageToken;
  let page;
  do {
    page = AdminDirectory.Groups.list({
      domain: 'example.com',
      maxResults: 100,
      pageToken: pageToken
    });
    const groups = page.groups;
    if (!groups) {
      console.log('No groups found.');
      return;
    }
    // Print group name and email.
    for (const group of groups) {
      console.log('%s (%s)', group.name, group.email);
    }
    pageToken = page.nextPageToken;
  } while (pageToken);
}

ग्रुप में सदस्य जोड़ना

इस सैंपल में, डोमेन के किसी मौजूदा ग्रुप में उपयोगकर्ता को जोड़ा गया है.

advanced/adminSDK.gs
/**
 * Adds a user to an existing group in the domain.
 * @see https://developers.google.com/admin-sdk/directory/reference/rest/v1/members/insert
 */
function addGroupMember() {
  // TODO (developer) - Replace userEmail value with yours
  const userEmail = 'liz@example.com';
  // TODO (developer) - Replace groupEmail value with yours
  const groupEmail = 'bookclub@example.com';
  const member = {
    email: userEmail,
    role: 'MEMBER'
  };
  try {
    AdminDirectory.Members.insert(member, groupEmail);
    console.log('User %s added as a member of group %s.', userEmail, groupEmail);
  } catch (err) {
    // TODO (developer)- Handle exception from the API
    console.log('Failed with error %s', err.message);
  }
}