API Danh bạ dùng chung trong miền cho phép các ứng dụng nhận 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. Danh bạ dùng chung sẽ hiển thị cho tất cả người dùng trong miền Google Workspace và mọi dịch vụ của Google đều có quyền truy cập vào danh bạ đó.
Ứng dụng của bạn có thể dùng API Danh bạ được chia sẻ trong miền để tạo danh bạ được chia sẻ, chỉnh sửa hoặc xoá danh bạ được chia sẻ hiện có và truy vấn danh bạ được chia sẻ khớp với một tiêu chí cụ thể.
API Danh bạ được chia sẻ trong 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ạ được chia sẻ của miền trong Bảng điều khiển dành cho quản trị viên. Các thay đổi đối với người liên hệ được chia sẻ có thể mất tới 24 giờ mới được thể hiện trong tính năng tự động hoàn thành địa chỉ email và trình quản lý liên hệ.
Ngoài việc cung cấp thông tin cơ bản về các chức năng của API Danh bạ được chia sẻ trên miền, tài liệu này còn cung cấp các ví dụ về cách quản lý danh bạ bằng cách sử dụng XML và HTTP. Sau khi đọc tài liệu này, bạn có thể tìm hiểu thêm về cách tương tác với API bằng cách sử dụng thư viện ứng dụng của chúng tôi.
Đối tượng người xem
Tài liệu này dành cho những nhà phát triển muốn viết những ứng dụng có thể thao tác danh bạ của Google bằng cách sử dụng HTTP và XML. Tài liệu này giả định rằng bạn đã hiểu những kiến thức cơ bản về giao thức Google Data API.
Nếu bạn đang sử dụng hệ điều hành UNIX và muốn thử các ví dụ trong tài liệu này mà không cần viết mã, hãy sử dụng tiện ích dòng lệnh UNIX curl hoặc wget. Tìm hiểu cách sử dụng cURL với Dịch vụ dữ liệu của Google.
Nguyên tắc
Phiên bản này của Domain Shared Contacts API tuân theo các nguyên tắc của Google Data API. Google Data API dựa trên cả định dạng phân phối Atom 1.0 và RSS 2.0, bên cạnh Giao thức xuất bản Atom.
Chỉ định một phiên bản
Mọi yêu cầu bạn gửi bằng API Danh bạ được chia sẻ trên miền phải chỉ định phiên bản 3.0 của API:
GData-Version: 3.0
Nếu không thể đặt tiêu đề HTTP, bạn có thể chỉ định v=3.0 làm tham số truy vấn trong URL, nhưng bạn nên sử dụng phương thức tiêu đề HTTP.