Layanan Direktori Admin SDK

Layanan Direktori Admin SDK memungkinkan Anda menggunakan Directory API Admin SDK di Apps Script. API ini memberi administrator domain Google Workspace (termasuk reseller) kemampuan untuk mengelola perangkat, grup, pengguna, dan entitas lain di domain mereka.

Referensi

Untuk mengetahui informasi mendetail tentang layanan ini, lihat dokumentasi referensi untuk Admin SDK Directory API. Seperti semua layanan lanjutan di Apps Script, layanan Direktori Admin SDK menggunakan objek, metode, dan parameter yang sama dengan API publik. Untuk mengetahui informasi selengkapnya, lihat Cara menentukan tanda tangan metode.

Untuk melaporkan masalah dan menemukan dukungan lainnya, lihat panduan dukungan Direktori Admin SDK.

Kode contoh

Contoh kode di bawah menggunakan versi 1 dari API.

Menampilkan daftar semua pengguna

Contoh ini mencantumkan semua pengguna dalam domain yang diurutkan berdasarkan nama depan.

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

Mendapatkan pengguna

Contoh ini mendapatkan pengguna berdasarkan alamat emailnya dan mencatat semua datanya sebagai string 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 = '[email protected]';   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);   } }

Tambahkan pengguna

Contoh ini menambahkan pengguna baru ke domain, termasuk hanya informasi yang diperlukan. Untuk mengetahui daftar lengkap kolom pengguna, lihat dokumentasi referensi API.

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: '[email protected]',     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);   } }

Buat alias

Contoh ini membuat alias (nama panggilan) untuk pengguna.

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 = '[email protected]';   let alias = {     alias: '[email protected]'   };   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);   } }

Mencantumkan semua grup

Contoh ini mencantumkan semua grup di domain.

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

Menambahkan anggota grup

Contoh ini menambahkan pengguna ke grup yang sudah ada di domain.

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 = '[email protected]';   // TODO (developer) - Replace groupEmail value with yours   const groupEmail = '[email protected]';   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);   } }