Yönetici SDK'sı Dizin Hizmeti

Yönetici SDK'sı Dizini hizmeti, Yönetici SDK'sının Apps Komut Dosyası'ndaki Directory API. Bu API, alan adlarının Google Workspace yöneticilerini ( (bayiler) önce alanlarındaki cihazları, grupları, kullanıcıları ve diğer varlıkları yönetme.

Referans

Bu hizmetle ilgili ayrıntılı bilgi için bkz. Admin SDK referans belgeleri Directory API'ye gidin. Apps Komut Dosyası'ndaki tüm gelişmiş hizmetler gibi Yönetici SDK'si de Dizin hizmeti, herkese açık alanlarla aynı nesneleri, yöntemleri ve parametreleri kullanır API'ye gidin. Daha fazla bilgi için Yöntem imzaları nasıl belirlenir? bölümüne bakın.

Sorun bildirmek ve daha fazla destek almak için şuraya bakın: Yönetici SDK'sı Dizini destek kılavuzu.

Örnek kod

Aşağıdaki örnek kod şunun sürüm 1'ini kullanır: API.

Tüm kullanıcıları listele

Bu örnekte, bir alandaki tüm kullanıcılar ada göre sıralanır.

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

Kullanıcıyı alma

Bu örnek, kullanıcıyı e-posta adresiyle alır ve tüm verilerini JSON dizesi.

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

Kullanıcı ekle

Bu örnek, yalnızca gerekli olanlar da dahil olmak üzere, alana yeni bir kullanıcı ekler ekleyebilirsiniz. Kullanıcı alanlarının tam listesi için API'nin referans belgeleri.

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

Takma ad oluştur

Bu örnek, bir kullanıcı için takma ad (takma ad) oluşturur.

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

Tüm grupları listele

Bu örnekte, alandaki tüm gruplar listelenmektedir.

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

Grup üyesi ekleyin

Bu örnek, bir kullanıcıyı alandaki mevcut bir gruba ekler.

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