API Danh bạ dùng chung của miền cho phép các ứng dụng lấy và cập nhật danh bạ bên ngoài được chia sẻ với tất cả người dùng trong miền Google Workspace. Tất cả người dùng trong miền Google Workspace đều có thể xem danh bạ được chia sẻ và tất cả các dịch vụ của Google đều có quyền truy cập vào danh sách liên hệ.
Sử dụng API Danh bạ dùng chung của miền để tạo, chỉnh sửa hoặc xoá danh bạ được chia sẻ, cũng như truy vấn danh bạ phù hợp với các tiêu chí cụ thể.
API Danh bạ dùng chung của miền chỉ dành cho tài khoản Google Workspace. Để sử dụng API này, hãy bật API Danh bạ dùng chung của miền trong Bảng điều khiển dành cho quản trị viên. Các thay đổi có thể mất đến 24 giờ mới xuất hiện trong tính năng tự động hoàn thành và trình quản lý danh bạ.
Tài liệu này cung cấp thông tin cơ bản về API Danh bạ dùng chung của miền và các ví dụ về cách quản lý danh bạ bằng XML và HTTP. Để tìm hiểu thêm, hãy xem thư viện ứng dụng.
Đối tượng
Tài liệu này dành cho nhà phát triển viết các ứng dụng có chức năng thao tác với danh sách liên hệ trên Google bằng HTTP và XML. Tài liệu này giả định rằng bạn đã biết về giao thức Google Data APIs.
Người dùng Linux và macOS có thể dùng thử các ví dụ trong tài liệu này bằng curl hoặc wget. Hãy xem bài viết Sử dụng curl với Google Data APIs.
Nguyên tắc
API Danh bạ dùng chung của miền tuân theo các nguyên tắc của Google Data APIs. Google Data APIs dựa trên Atom 1.0, RSS 2.0 và Giao thức phát hành Atom.
Chỉ định phiên bản
Tất cả các yêu cầu được gửi bằng API Danh bạ dùng chung của miền đều phải chỉ định phiên bản 3.0:
GData-Version: 3.0
Nếu bạn không thể đặt tiêu đề HTTP, hãy chỉ định v=3.0 làm tham số truy vấn.
Bạn nên sử dụng phương thức tiêu đề HTTP.