ドメイン サービスから Admin SDK Advanced Services への移行

G Suite ドメイン管理者がユーザーとグループを管理できるドメイン サービスは、2014 年 5 月 15 日をもって非推奨となり、2014 年 11 月 20 日に無効になります。このサービスは、最近追加された Admin SDK ディレクトリAdmin SDK レポートの高度なサービスに置き換えられています。このページでは、ドメイン サービスから新しい代替である Admin SDK への移行パスの概要について説明します。

メソッドの比較

次の表に、ドメイン サービスで使用されるメソッドの概要と、Admin SDK 内の同等のメソッド(存在する場合)を示します。

ドメイン サービスによる方法 Admin SDK のメソッド
DomainGroup.addMember(memberId) AdminDirectory.Members.insert(resource, groupKey)
Admin SDK では、 role を使用してグループ内のメンバーのロールを指定できます。
DomainGroup.addOwner(ownerId)
DomainGroup.deleteGroup() AdminDirectory.Groups.remove(groupKey)
DomainGroup.getAllMembers() AdminDirectory.Members.list(groupKey, optionalArgs)
Admin SDK では、オプションの roles パラメータを使用してオーナーを一覧表示できます。
DomainGroup.getAllOwners()
DomainGroup.getDescription() AdminDirectory.Groups.get(groupKey)
プロパティ: description
プロパティ: id
プロパティ: name
DomainGroup.getId()
DomainGroup.getName()
DomainGroup.getPermissionLevel() なし
DomainGroup.removeMember(memberId) AdminDirectory.Members.remove(groupKey, memberKey)
DomainGroup.removeOwner(ownerId)
DomainGroup.setDescription(description) AdminDirectory.Groups.patch(resource, groupKey)
プロパティ: description
プロパティ: name
DomainGroup.setName(name)
DomainGroup.setPermissionLevel(level) なし
DomainNickname.deleteNickname() AdminDirectory.Users.Aliases.remove(userKey, alias)
DomainNickname.getNickname() AdminDirectory.Users.Aliases.list(userKey, optionalArgs)
プロパティ: aliases
プロパティ: primaryEmail
DomainNickname.getUsername()
DomainUser.deleteUser() AdminDirectory.Users.remove(userKey)
DomainUser.getAgreedToTerms() AdminDirectory.Users.get(userKey)
プロパティ: agreedToTerms
プロパティ: changePasswordAtNextLogin
プロパティ: primaryEmail
プロパティ: name.familyName
プロパティ: name.givenName
プロパティ: isAdmin
プロパティ: suspended
DomainUser.getChangePasswordAtNextLogin()
DomainUser.getEmail()
DomainUser.getFamilyName()
DomainUser.getGivenName()
DomainUser.getIsAdmin()
DomainUser.getIsSuspended()
DomainUser.getStorageQuota() AdminReports.UserUsageReport.get(userKey, date, optionalArgs)
アカウント: total_quota_in_mb
DomainUser.setChangePasswordAtNext Login(changePassword) AdminDirectory.Users.patch(resource, userKey)
プロパティ: changePasswordAtNextLogin
プロパティ: name.familyName
プロパティ: name.givenName
DomainUser.setFamilyName(name)
DomainUser.setGivenName(name)
DomainUser.setIsAdmin(admin) AdminDirectory.Users.makeAdmin(resource, userKey)
プロパティ: isAdmin
DomainUser.setIsSuspended(suspended) AdminDirectory.Users.patch(resource, userKey)
プロパティ: suspended
プロパティ: password
プロパティ: primaryEmail
DomainUser.setPassword(password)
DomainUser.setUsername(username)
GroupsManager.createGroup(groupId, name, description, permissionLevel) GroupsManager.createGroup(groupId, name) AdminDirectory.Groups.insert(resource)
権限レベルの設定は、Admin SDK ではサポートされていません。
GroupsManager.getAllGroups()
GroupsManager.getAllGroups(memberId)
AdminDirectory.Groups.list(optionalArgs)
パラメータ: userKey
GroupsManager.getDomain()
NicknameManager.getDomain()
UserManager.getDomain()
該当なし
回避策として、1 人のユーザーのメールアドレスを取得して、ドメインを抽出してください。
GroupsManager.getGroup(groupId) AdminDirectory.Groups.get(groupKey)
NicknameManager.createNickname(username, nickname) AdminDirectory.Users.Aliases.insert(resource, userKey)
NicknameManager.getAllNicknames() なし
NicknameManager.getAllNicknames(username) AdminDirectory.Users.Aliases.list(userKey, optionalArgs)
結果をループしてニックネームを見つける必要があります。
NicknameManager.getNickname(nickname)
UserManager.createUser(username, givenName, familyName, password) UserManager.createUser(username, givenName, familyName, password, passwordHashFunction) AdminDirectory.Users.insert(resource)
プロパティ: hashFunction
UserManager.getAllUsers() AdminDirectory.Users.list(optionalArgs)
customer パラメータまたは domain パラメータのいずれかを指定する必要があります。アカウント管理者は、my_customer エイリアスを使用してアカウントの customerId を表すこともできます。
UserManager.getUser(user)
UserManager.getUser(username)
AdminDirectory.Users.get(userKey)

Admin SDK の新機能

上記のサポート対象方法に加えて、Admin SDK Advanced サービスには、次の新機能が用意されています。

機能 Admin SDK のクラスまたはメソッド
管理通知 AdminDirectory.Notifications
アプリケーション固有のパスワード AdminDirectory.Asps
デバイス管理 AdminDirectory.Chromeosdevices
AdminDirectory.Mobiledevices
グループ エイリアス AdminDirectory.Groups.Aliases
OAuth トークン AdminDirectory.Tokens
組織部門 AdminDirectory.Orgunits
レポート AdminReports
ユーザーの検索 AdminDirectory.Users.list(optionalArgs)
パラメータ: query
ユーザーの削除を取り消す AdminDirectory.Users.undelete()
ユーザーデータ AdminDirectory.Users.get(userKey)
ユーザーの写真 AdminDirectory.Users.Photos.get(userKey)
確認コード(2 要素) AdminDirectory.VerificationCodes