Tổng quan về API cài đặt quản trị viên

API Cài đặt quản trị cho phép quản trị viên của các miền Google Workspace truy xuất và thay đổi chế độ cài đặt của các miền đó dưới dạng nguồn cấp dữ liệu API Dữ liệu của Google.

Các chế độ cài đặt miền này bao gồm nhiều tính năng có trong Bảng điều khiển dành cho quản trị viên Google Workspace. Ví dụ về cách sử dụng API này bao gồm việc tạo bảng điều khiển tuỳ chỉnh hoặc tích hợp các miền Google Workspace vào môi trường cũ hiện có.

API Cài đặt quản trị triển khai giao thức Google Data API. Google Data API tuân thủ mô hình phát hành và chỉnh sửa theo Giao thức phát hành Atom (AtomPub). Các yêu cầu HTTP AtomPub sử dụng phương pháp thiết kế Chuyển tập hợp đại diện (RESTful) cho các dịch vụ web. Để biết thêm thông tin, hãy xem Hướng dẫn dành cho nhà phát triển về dữ liệu của Google.

Đối tượng

Tài liệu này dành cho các nhà phát triển muốn viết ứng dụng khách có thể sửa đổi và truy xuất thông tin về các miền Google Workspace. Tài liệu này cung cấp các ví dụ về các hoạt động tương tác cơ bản của API Cài đặt quản trị bằng XML thô và HTTP.

Tài liệu này giả định rằng bạn hiểu các ý tưởng chung đằng sau giao thức API Dữ liệu của Google và bạn đã quen thuộc với Bảng điều khiển dành cho quản trị viên của Google Workspace. Để biết thêm thông tin về Bảng điều khiển dành cho quản trị viên, hãy xem bài viết Sử dụng Bảng điều khiển dành cho quản trị viên.

Bắt đầu

Tạo tài khoản

API Cài đặt quản trị được bật cho tài khoản Google Workspace. Đăng ký tài khoản Google Workspace cho mục đích thử nghiệm. Dịch vụ Cài đặt quản trị sử dụng Tài khoản Google, vì vậy, nếu đã có tài khoản trên miền Google Workspace, bạn đã sẵn sàng sử dụng.

Giới thiệu về các loại nguồn cấp dữ liệu API Cài đặt quản trị

API Cài đặt quản trị cho phép bạn quản lý các danh mục chế độ cài đặt miền sau:

Chế độ cài đặt tính năng Đăng nhập một lần

Tính năng Đăng nhập một lần (SSO) dựa trên SAML cho phép người dùng sử dụng cùng một thông tin đăng nhập và mật khẩu cho cả các dịch vụ do Google Workspace lưu trữ cũng như các dịch vụ khác mà bạn có thể lưu trữ trong tổ chức của mình. Cụ thể, khi sử dụng tính năng SSO, một ứng dụng web được lưu trữ (chẳng hạn như Google Workspace) sẽ chuyển hướng người dùng đến nhà cung cấp danh tính của tổ chức để xác thực người dùng khi họ đăng nhập. Để biết thông tin chi tiết, hãy xem bài viết Tìm hiểu về tính năng SSO dựa trên SAML cho Google Workspace.

Khi định cấu hình SSO, bạn cần nhập thông tin cần thiết để dịch vụ Google Workspace giao tiếp với nhà cung cấp danh tính lưu trữ thông tin đăng nhập của người dùng, cũng như thiết lập các đường liên kết mà người dùng sẽ được chuyển đến để đăng nhập, đăng xuất và thay đổi mật khẩu. API Cài đặt quản trị cho phép bạn cập nhật và truy xuất các chế độ cài đặt này theo phương thức có lập trình. Google sử dụng khoá công khai đã tạo để xác minh yêu cầu SSO này với nhà cung cấp danh tính và đảm bảo rằng phản hồi SAML khoá riêng tư không bị sửa đổi trong quá trình truyền mạng.

Để biết thông tin tóm tắt ngắn gọn về cách sử dụng chế độ cài đặt SSO theo API, hãy lấy chứng chỉ khoá công khai từ nhà cung cấp danh tính, đăng ký khoá công khai với Google và thiết lập chế độ cài đặt truy vấn SSO dựa trên SAML. Đối với thông báo lỗi, hãy xem phần Khắc phục sự cố về SSO:

  • Tạo khoá – Với nhà cung cấp danh tính, hãy tạo một tập hợp khoá công khai và khoá riêng tư bằng thuật toán DSA hoặc RSA. Khoá công khai nằm trong một chứng chỉ có định dạng X.509. Để biết thêm thông tin về khoá ký Đăng nhập một lần dựa trên SAML, hãy xem bài viết Tạo khoá và chứng chỉ cho Dịch vụ đăng nhập một lần của Google Workspace.
  • Đăng ký với Google – Sử dụng chế độ cài đặt Đăng nhập một lần của API Cài đặt quản trị để đăng ký chứng chỉ khoá công khai của bạn với Google.
  • Thiết lập chế độ cài đặt SSO – Sử dụng chế độ cài đặt Đăng nhập một lần của API Cài đặt quản trị để định cấu hình chế độ cài đặt dùng để giao tiếp với máy chủ của nhà cung cấp danh tính của miền.

Chế độ cài đặt cổng và định tuyến

Nguồn cấp dữ liệu này cho phép quản trị viên miền kiểm soát việc định tuyến email cho miền của họ.

Các thao tác định tuyến email cho phép quản trị viên chỉ định chế độ cài đặt định tuyến email ở cấp miền. Chức năng này tương tự như chức năng định tuyến email trong phần cài đặt Gmail của Bảng điều khiển dành cho quản trị viên. Để biết thêm thông tin, hãy xem phần Định tuyến email và cấu hình phân phối kép của tính năng định tuyến email.

Mẫu yêu cầu và phản hồi XML của API Cài đặt quản trị

Tài liệu này cung cấp các ví dụ về mã của các yêu cầu và phản hồi cơ bản của API Cài đặt quản trị bằng XML thô và HTTP. Ví dụ về ngôn ngữ mặc định của miền này cho thấy cú pháp XML và HTTP đầy đủ cho phần nội dung của mục yêu cầu và phản hồi, đây là phần nội dung chung cho mỗi thao tác:

Để thay đổi chế độ cài đặt cổng email gửi đi của miền, hãy gửi PUT HTTP đến URL nguồn cấp dữ liệu cổng:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

XML AtomPub entry yêu cầu PUT ngôn ngữ mặc định của miền là:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
  xmlns:apps='http://schemas.google.com/apps/2006'>
  <apps:property name='smartHost' value='smtp.out.domain.com' />
  <apps:property name='smtpMode' value='SMTP' />
</atom:entry>

Ngoại trừ các thuộc tính và giá trị dành riêng cho thao tác, các phần tử atom:property đại diện cho một cặp khoá-giá trị duy nhất chứa thông tin về một thuộc tính mà bạn muốn truy xuất hoặc cập nhật. Đây là những thông tin chung cho tất cả nội dung yêu cầu API Cài đặt quản trị.

Phần tử entry phản hồi ngôn ngữ mặc định của miền trả về các thuộc tính smartHost và smtpMode cùng với cú pháp XML phổ biến cho tất cả nội dung phản hồi của API Cài đặt quản trị:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/domain/2.0/domainName/email/gateway</id>
<updated>2008-12-17T23:59:23.887Z</updated>
<link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</entry>

Quản lý chế độ cài đặt Đăng nhập một lần

Tính năng Đăng nhập một lần (SSO) của Google Workspace cho phép người dùng đăng nhập vào nhiều dịch vụ mà chỉ cần nhập tên người dùng và mật khẩu một lần. Mật khẩu này do nhà cung cấp danh tính của miền lưu trữ, chứ không phải Google Workspace. Để biết thêm thông tin, hãy xem trang về SSO trên Trung tâm trợ giúp. Các phần sau đây minh hoạ định dạng XML dùng cho chế độ cài đặt Đăng nhập một lần.

Truy xuất chế độ cài đặt Đăng nhập một lần

Để truy xuất chế độ cài đặt Đăng nhập một lần, hãy gửi GET HTTP đến URL nguồn cấp dữ liệu chung của SSO và thêm tiêu đề Authorization như mô tả trong phần Xác thực với dịch vụ Cài đặt quản trị. Đối với thông báo lỗi, hãy xem bài viết Khắc phục sự cố về SSO:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

Thao tác này không có thông số nào trong phần nội dung yêu cầu.

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200 OK, cùng với nguồn cấp dữ liệu AtomPub có chế độ cài đặt SSO của miền.

Tệp XML phản hồi GET trả về các thuộc tính samlSignonUri, samlLogoutUri, changePasswordUri, enableSSO, ssoWhitelist và useDomainSpecificIssuer:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
...
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='true'/>
<apps:property name='ssoWhitelist' value='CIDR formatted IP address'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

Các thuộc tính bao gồm:

samlSignonUri
URL của nhà cung cấp danh tính mà Google Workspace gửi yêu cầu SAML để xác thực người dùng.
samlLogoutUri
Địa chỉ mà người dùng sẽ được chuyển đến khi họ đăng xuất khỏi ứng dụng web.
changePasswordUri
Địa chỉ mà người dùng sẽ được chuyển đến khi họ muốn thay đổi mật khẩu SSO cho ứng dụng web.
enableSSO
Bật dịch vụ SSO dựa trên SAML cho miền này. Nếu trước đây bạn đã định cấu hình chế độ cài đặt SSO và sau đó đặt enableSSO thành enableSSO=false, thì chế độ cài đặt bạn đã nhập trước đó vẫn được lưu.
ssoWhitelist
ssoWhitelist là một địa chỉ IP mặt nạ mạng ở định dạng Định tuyến liên miền không phân lớp (CIDR). ssoWhitelist xác định những người dùng đăng nhập bằng SSO và những người dùng đăng nhập bằng trang xác thực tài khoản Google Workspace. Nếu không chỉ định mặt nạ nào, tất cả người dùng sẽ đăng nhập bằng SSO. Để biết thêm thông tin, hãy xem phần Cách hoạt động của mặt nạ mạng.
useDomainSpecificIssuer
Bạn có thể sử dụng một nhà cung cấp miền cụ thể trong yêu cầu SAML cho nhà cung cấp danh tính. Mặc dù không cần thiết cho hầu hết các trường hợp triển khai SSO, nhưng tính năng này rất hữu ích trong các công ty lớn sử dụng một nhà cung cấp danh tính để xác thực toàn bộ tổ chức có nhiều miền con. Việc cung cấp nhà cung cấp miền cụ thể sẽ xác định miền con nào sẽ được liên kết với yêu cầu. Để biết thêm thông tin, hãy xem phần Thành phần phát hành trong yêu cầu SAML hoạt động như thế nào?

Nếu yêu cầu của bạn không thành công vì lý do nào đó, hệ thống sẽ trả về một mã trạng thái khác. Để biết thêm thông tin về mã trạng thái của Google Data API, hãy xem phần Mã trạng thái HTTP.

Cập nhật chế độ cài đặt tính năng Đăng nhập một lần

Để cập nhật chế độ cài đặt SSO của một miền, trước tiên, hãy truy xuất chế độ cài đặt SSO bằng thao tác Truy xuất chế độ cài đặt Đăng nhập một lần, sửa đổi chế độ cài đặt đó rồi gửi yêu cầu PUT đến URL nguồn cấp dữ liệu SSO. Hãy đảm bảo giá trị <id> trong mục cập nhật khớp chính xác với <id> của mục hiện có. Thêm tiêu đề Authorization như mô tả trong phần Xác thực với dịch vụ API Cài đặt quản trị. Còn đối với thông báo lỗi, hãy xem bài viết Khắc phục sự cố về SSO.

Khi cập nhật chế độ cài đặt Đăng nhập một lần, hãy gửi một HTTP PUT đến URL nguồn cấp dữ liệu chung của SSO:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

Nội dung XML của yêu cầu PUT là:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='enableSSO' value='false' />
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon' />
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout' />
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword' />
<apps:property name='ssoWhitelist' value='127.0.0.1/32' />
<apps:property name='useDomainSpecificIssuer' value='false'/>
</atom:entry>

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200 OK, cùng với nguồn cấp dữ liệu AtomPub có chế độ cài đặt SSO.

XML phản hồi PUT là:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='false'/>
<apps:property name='ssoWhitelist' value='127.0.0.1/32'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

Nếu yêu cầu của bạn không thành công vì lý do nào đó, hệ thống sẽ trả về một mã trạng thái khác. Để biết thêm thông tin về mã trạng thái của Google Data API, hãy xem phần Mã trạng thái HTTP.

Bạn không được phép thay đổi chế độ cài đặt Đăng nhập một lần khi khách hàng mục tiêu đã bật chế độ Phê duyệt nhiều bên cho các hành động nhạy cảm. Yêu cầu sẽ không thành công với errorCode="1811" và reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval".

Truy xuất khoá ký Đăng nhập một lần

Để truy xuất khoá ký Đăng nhập một lần, hãy gửi GET HTTP đến URL nguồn cấp dữ liệu khoá ký SSO và thêm tiêu đề Authorization như mô tả trong phần Xác thực với dịch vụ Cài đặt quản trị. Đối với thông báo lỗi, hãy xem bài viết Khắc phục sự cố về SSO:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

Thao tác này không có thông số nào trong phần nội dung yêu cầu.

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200 OK, cùng với nguồn cấp dữ liệu AtomPub có khoá ký.

Tệp XML phản hồi GET trả về thuộc tính signingKey:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</entry>

Nếu yêu cầu của bạn không thành công vì lý do nào đó, hệ thống sẽ trả về một mã trạng thái khác. Để biết thêm thông tin về mã trạng thái của Google Data API, hãy xem phần Mã trạng thái HTTP.

Cập nhật khoá ký Đăng nhập một lần

Để cập nhật khoá ký SSO của một miền, trước tiên, hãy truy xuất khoá ký bằng thao tác Truy xuất khoá ký Đăng nhập một lần, sửa đổi khoá đó rồi gửi yêu cầu PUT đến URL nguồn cấp dữ liệu khoá ký SSO. Hãy đảm bảo giá trị <id> trong mục cập nhật khớp chính xác với <id> của mục hiện có. Để biết thêm thông tin về khoá ký Đăng nhập một lần dựa trên SAML, hãy xem bài viết Tạo khoá và chứng chỉ cho Dịch vụ đăng nhập một lần của Google Workspace.

Khi cập nhật khoá ký Đăng nhập một lần, hãy gửi PUT HTTP đến URL nguồn cấp dữ liệu khoá ký SSO:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

XML yêu cầu PUT là:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</atom:entry>

Bạn không được phép thay đổi chế độ cài đặt Đăng nhập một lần khi khách hàng mục tiêu đã bật chế độ Phê duyệt nhiều bên cho các hành động nhạy cảm. Yêu cầu sẽ không thành công với errorCode="1811" và reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval".

Quản lý cổng và định tuyến email

Phần cổng email đi cho biết cách API Cài đặt quản trị hỗ trợ định tuyến email đi của người dùng trong miền của bạn. Phần định tuyến email cho biết cách định tuyến thư đến một máy chủ thư khác.

Truy xuất chế độ cài đặt cổng thư đi

Để truy xuất chế độ cài đặt cổng email gửi đi, hãy gửi GET HTTP đến URL nguồn cấp dữ liệu cổng và thêm tiêu đề Authorization như mô tả trong phần Xác thực với dịch vụ Cài đặt quản trị:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

Thao tác này không có thông số nào trong phần nội dung yêu cầu.

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200 OK, cùng với nguồn cấp dữ liệu AtomPub có thông tin trạng thái của cổng email.

Phản hồi GET trả về các thuộc tính smartHost và smtpMode. Để biết thêm thông tin về các thuộc tính này, hãy xem bài viết Cập nhật chế độ cài đặt cổng email gửi đi.

Sau đây là ví dụ về một phản hồi có thể xảy ra:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='smartHost' value='smtpout.domain.com'/>
<apps:property name='smtpMode' value='SMTP'/>
</entry>

Nếu yêu cầu của bạn không thành công vì lý do nào đó, hệ thống sẽ trả về một mã trạng thái khác. Để biết thêm thông tin về mã trạng thái của Google Data API, hãy xem phần Mã trạng thái HTTP.

Cập nhật chế độ cài đặt cổng gửi email

Để cập nhật chế độ cài đặt cổng email gửi đi của một miền, hãy gửi yêu cầu PUT HTTP đến URL nguồn cấp dữ liệu cổng:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

XML yêu cầu PUT là:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</atom:entry>

Các thuộc tính yêu cầu là:

smartHost
Địa chỉ IP hoặc tên máy chủ của máy chủ SMTP. Google Workspace sẽ chuyển thư đi đến máy chủ này.
smtpMode
Giá trị mặc định là SMTP. Một giá trị khác, SMTP_TLS, bảo mật kết nối bằng TLS khi phân phối thư.

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200 OK, cùng với nguồn cấp dữ liệu AtomPub có trạng thái cài đặt cổng email.

Nếu yêu cầu của bạn không thành công vì lý do nào đó, hệ thống sẽ trả về một mã trạng thái khác. Để biết thêm thông tin về mã trạng thái của Google Data API, hãy xem phần Mã trạng thái HTTP.

Quản lý chế độ cài đặt định tuyến email

Trước tiên, hãy tạo một yêu cầu XML:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='routeDestination' value='route-smtp.domain.com'/>
<apps:property name='routeRewriteTo' value='true'/>
<apps:property name='routeEnabled' value='true'/>
<apps:property name='bounceNotifications' value='true'/>
<apps:property name='accountHandling' value='can be either allAccounts | provisionedAccounts | unknownAccounts'/>
</atom:entry>

Các thuộc tính yêu cầu là:

routeDestination
Đích đến này là tên máy chủ hoặc địa chỉ IP của máy chủ thư SMTP-In nơi email đang được định tuyến. Tên máy chủ hoặc địa chỉ IP phải phân giải được cho Google. Để biết thêm thông tin chi tiết về cách phân giải tên máy chủ lưu trữ thư, hãy xem bài viết Thử nghiệm Google Workspace với tính năng định tuyến email.
routeRewriteTo
Nếu đúng, trường to: của phong bì SMTP của thư sẽ được thay đổi thành tên máy chủ đích (tên máy chủ của user@destination) và thư sẽ được gửi đến địa chỉ người dùng này trên máy chủ thư đích. Nếu là false, email sẽ được gửi đến địa chỉ email to: của thư gốc (user@original hostname) trên máy chủ thư đích. Điều này tương tự như chế độ cài đặt "Thay đổi phong bì SMTP" trong Bảng điều khiển dành cho quản trị viên. Để biết thêm thông tin, hãy xem bài viết Cài đặt miền để định tuyến email.
routeEnabled
Nếu true, chức năng định tuyến email sẽ được bật. Nếu là false, chức năng này sẽ bị tắt.
bounceNotifications
Nếu true, Google Workspace sẽ được bật để gửi thông báo về thư bị trả về cho người gửi khi không gửi được thư.
accountHandling

Chế độ cài đặt này xác định mức độ ảnh hưởng của việc định tuyến email đối với các loại người dùng trong miền:

  • allAccounts – Phân phối tất cả email đến đích đến này.
  • provisionedAccounts – Phân phối thư đến đích này nếu người dùng tồn tại trong Google Workspace.
  • unknownAccounts – Phân phối thư đến đích đến này nếu người dùng không tồn tại trong Google Workspace. Điều này tương tự như chế độ cài đặt "Email gửi cho" trong Bảng điều khiển dành cho quản trị viên. Để biết thêm thông tin về các điều kiện tiên quyết và cách sử dụng tính năng định tuyến thư, hãy xem bài viết Cài đặt miền để định tuyến thư. ~ Để phát hành yêu cầu này, hãy gửi POST HTTP đến URL nguồn cấp dữ liệu định tuyến email và thêm tiêu đề Authorization như mô tả trong phần Xác thực với dịch vụ Cài đặt quản trị:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/emailrouting

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200 OK, cùng với nguồn cấp dữ liệu AtomPub có thông tin lưu trữ.

Nếu yêu cầu của bạn không thành công vì lý do nào đó, hệ thống sẽ trả về một mã trạng thái khác. Để biết thêm thông tin về mã trạng thái của Google Data API, hãy xem phần Mã trạng thái HTTP.

Điểm cuối ngừng hoạt động vào ngày 31 tháng 10 năm 2018

Chúng tôi đã ngừng sử dụng các điểm cuối sau đây theo thông báo này. Các tính năng này đã ngừng hoạt động vào ngày 31 tháng 10 năm 2018 và không còn được cung cấp nữa.

  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/defaultLanguage
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/organizationName
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/currentNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/maximumNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/supportPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/customerPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/adminSecondaryEmail
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/edition
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/creationTime
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/countryCode
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/appearance/customLogo
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/verification/mx