Tổng quan về API Danh bạ được chia sẻ của miền

Domains Shared Contacts API cho phép ứng dụng của bạn tải và cập nhật thông tin bên ngoài những địa chỉ liên hệ được chia sẻ với tất cả người dùng trong một miền Google Workspace. Đã chia sẻ danh bạ đều hiển thị với tất cả người dùng của một miền Google Workspace và tất cả người dùng các dịch vụ khác có quyền truy cập vào danh bạ.

Cảnh báo: API Danh bạ được chia sẻ trong miền chỉ dành cho người liên hệ bên ngoài. Sử dụng API này để tạo thông tin liên hệ cho người dùng (nội bộ) trong miền hoặc có thể dẫn đến thông tin liên hệ trùng lặp cho những người dùng và nhóm đó, từ đó có thể dẫn đến hành vi không mong muốn. Để tải và cập nhật Người dùng trong miền Google Workspace (nội bộ) thông tin liên hệ, hãy sử dụng API Thư mục .

Ứng dụng của bạn có thể sử dụng Domain Shared Contacts API để tạo danh bạ dùng chung, chỉnh sửa hoặc xoá địa chỉ liên hệ được chia sẻ hiện có và truy vấn các địa chỉ liên hệ được chia sẻ khớp với tiêu chí cụ thể.

API Danh bạ được chia sẻ trong miền chỉ được cung cấp cho tài khoản Google Workspace. Để sử dụng API, bật API Danh bạ được chia sẻ trong 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 phản ánh trong email tự động hoàn thành địa chỉ và trình quản lý liên hệ.

Ngoài việc cung cấp thông tin cơ bản về khả năng của API Danh bạ được chia sẻ của miền, tài liệu này cung cấp các ví dụ về cách quản lý địa chỉ liên hệ 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 tương tác với API bằng cách sử dụng thư viện ứng dụng.

Đố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 có thể thao túng 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 Kiến thức cơ bản về 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à bạn muốn thử các ví dụ trong tài liệu mà không cần viết bất kỳ mã nào, hãy sử dụng các tiện ích dòng lệnh UNIX cuộn người 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 thủ các nguyên tắc của API Dữ liệu của Google. Google Data API dựa trên cả định dạng phân phối Atom 1.0 và RSS 2.0 ngoài Giao thức xuất bản Atom.

Chỉ định một phiên bản

Mọi yêu cầu mà bạn gửi bằng API Danh bạ được chia sẻ trong 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 pháp tiêu đề HTTP.

Lưu ý: Thư viện ứng dụng tự động cung cấp tiêu đề phiên bản thích hợp, vì vậy, đừng sử dụng tham số truy vấn v=3.0 khi bạn đang dùng thư viện ứng dụng.