Domain Shared Contacts API cho phép các ứng dụng của bạn 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 một miền Google Workspace. Tất cả người dùng của một miền Google Workspace và tất cả dịch vụ của Google đều có thể xem danh bạ dùng chung.
Ứng dụng của bạn có thể sử dụng Domain Shared Contacts API để 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ể.
Chỉ tài khoản Google Workspace mới có thể sử dụng API Danh bạ dùng chung của miền. Để sử dụng API này, hãy bật Domain Shared Contacts API 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ệ dùng chung có thể mất đến 24 giờ mới được thể hiện trong tính năng tự động điền đị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ạ dùng chung của miền, tài liệu này còn đưa ra các ví dụ về cách quản lý danh bạ bằ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
Tài liệu này dành cho những nhà phát triển muốn viết ứng dụng khách có thể thao tác với danh sách liên hệ 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 rõ các nguyên tắc cơ bản đằng sau giao thức API Dữ liệu của Google.
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 các 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 API Danh bạ dùng chung của miền tuân theo các nguyên tắc của API Dữ liệu của Google. API Dữ liệu của Google dựa trên cả định dạng phân phối Atom 1.0 và RSS 2.0, ngoài Giao thức phát hành Atom.
Chỉ định phiên bản
Mọi yêu cầu mà bạn gửi bằng Domain Shared Contacts API đều 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.