Google Workspace 如何通过 API 实现 Gmail 激活的 Ruby 方案咨询

前置准备 #

• 首先在Google Cloud Console启用Admin SDK API，创建服务账号并开通全域委派权限，需授予OAuth授权域https://www.googleapis.com/auth/admin.directory.user
• 确保你操作的管理员账号拥有Google Workspace超级管理员权限，目标用户归属当前管理域，且域名已配置符合要求的MX记录
• 安装Ruby版Google API客户端：gem install google-apis-admin_directory_v1，也可将gem 'google-apis-admin_directory_v1'加入Gemfile后执行bundle install

核心逻辑说明 #

手动点击「Activate Gmail」按钮的操作，对应调用Admin SDK Directory API的用户更新接口，将用户的isMailboxSetup属性设置为true，调用时Google服务端会自动完成MX记录核验，核验通过即自动激活Gmail服务。

示例代码 #

require 'google/apis/admin_directory_v1'
require 'googleauth'

# 配置项替换为你自己的实际参数
SERVICE_ACCOUNT_KEY_PATH = "./your-service-account-key.json"
ADMIN_IMPERSONATE_EMAIL = "admin@your-workspace-domain.com"
TARGET_USER_EMAIL = "user-to-activate@your-workspace-domain.com"
OAUTH_SCOPE = ["https://www.googleapis.com/auth/admin.directory.user"]

# 初始化服务账号授权
auth = Google::Auth::ServiceAccountCredentials.make_creds(
  json_key_io: File.open(SERVICE_ACCOUNT_KEY_PATH),
  scope: OAUTH_SCOPE
)
# 模拟超级管理员操作，必须配置否则无域用户管理权限
auth.sub = ADMIN_IMPERSONATE_EMAIL
auth.fetch_access_token!

# 初始化API客户端
directory_service = Google::Apis::AdminDirectoryV1::DirectoryService.new
directory_service.authorization = auth

# 激活目标用户的Gmail服务
user = directory_service.get_user(TARGET_USER_EMAIL)
user.is_mailbox_setup = true
result = directory_service.update_user(TARGET_USER_EMAIL, user)

# 输出激活结果
puts "用户#{TARGET_USER_EMAIL}的Gmail激活状态：#{result.is_mailbox_setup}"

常见问题说明 #

• 若域名MX记录不符合要求，调用接口会返回明确的校验失败错误，需先完成MX配置再重新调用
• 服务账号全域委派配置错误、权限scope缺失、模拟的管理员账号无对应权限，都会返回403权限不足报错
• 激活操作完成后可能存在1-5分钟的生效延迟，可间隔一段时间后调用get_user接口校验状态

内容的提问来源于stack exchange，提问作者Vibol