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

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

रेफ़रंस

इस सेवा के बारे में विस्तृत जानकारी के लिए, देखें एडमिन SDK के लिए रेफ़रंस दस्तावेज़ डायरेक्ट्री एपीआई. Apps Script की सभी बेहतर सेवाओं की तरह, एडमिन 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);
  }
}