Bạn có thể yêu cầu người dùng chia sẻ danh bạ theo nhiều cách:
- Tất cả người liên hệ dùng chung
- Một nhóm người liên hệ khớp với một tiêu chí cụ thể
- Một người liên hệ dùng chung
- Ảnh của một người liên hệ
Theo mặc định, các mục trong nguồn cấp dữ liệu không được sắp xếp.
Nhận tất cả danh bạ dùng chung
Để nhận tất cả danh bạ được chia sẻ, hãy gửi yêu cầu
GET
HTTP đến URL nguồn cấp dữ liệu danh bạ:GET https://www.google.com/m8/feeds/contacts/
DOMAIN /PROJECTION Thay thế nội dung sau:
DOMAIN
: URL của miền, ví dụ: example.com.PROJECTION
: Giá trị chiếu chỉ định các phần tửgd:extendedProperty
. Để biết danh sách các giá trị được hỗ trợ, hãy xem phần Giá trị chiếu.
Nguồn cấp dữ liệu trả về mã trạng thái
HTTP 200 OK
và nguồn cấp dữ liệu Atom 1.0 tiêu chuẩn chứa các thông tin liên hệ. Sau đây là ví dụ về nguồn cấp dữ liệu danh bạ chỉ có một mục:<feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/' xmlns:gd='http://schemas.google.com/g/2005' xmlns:gContact='http://schemas.google.com/contact/2008' xmlns:batch='http://schemas.google.com/gdata/batch'> <id>https://www.google.com/m8/feeds/contacts/example.com/base</id> <updated>2008-03-05T12:36:38.836Z</updated> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/contact/2008#contact' /> <title type='text'>example.com's Contacts</title> <link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full' /> <link rel='http://schemas.google.com/g/2005#post' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full' /> <link rel='http://schemas.google.com/g/2005#batch' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/batch' /> <link rel='self' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full?max-results=25' /> <author> <name>example.com</name> <email>example.com</email> </author> <generator version='1.0' uri='https://www.google.com/m8/feeds/contacts'> Contacts </generator> <openSearch:totalResults>1</openSearch:totalResults> <openSearch:startIndex>1</openSearch:startIndex> <openSearch:itemsPerPage>25</openSearch:itemsPerPage> <entry> <id> https://www.google.com/m8/feeds/contacts/example.com/base/c9012de </id> <updated>2008-03-05T12:36:38.835Z</updated> <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/contact/2008#contact' /> <title type='text'>Fitzgerald</title> <gd:name> <gd:fullName>Fitzgerald</gd:fullName> </gd:name> <link rel="http://schemas.google.com/contacts/2008/rel#photo" type="image/*" href="http://google.com/m8/feeds/photos/media/example.com/c9012de"/> <link rel='self' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/c9012de' /> <link rel='edit' type='application/atom+xml' href='https://www.google.com/m8/feeds/contacts/example.com/full/c9012de/1204720598835000' /> <gd:phoneNumber rel='http://schemas.google.com/g/2005#home' primary='true'> 456 </gd:phoneNumber> <gd:extendedProperty name="pet" value="hamster" /> </entry> </feed>
Nguồn cấp dữ liệu không trả về nhiều hơn 10 MB trong một phản hồi. Để nhận toàn bộ danh sách liên hệ, hãy liên tục nhấp vào đường liên kết Tiếp theo của nguồn cấp dữ liệu trả về cho đến khi bạn không còn thấy đường liên kết đó trong nguồn cấp dữ liệu trả về.
Lấy danh bạ được chia sẻ bằng cách sử dụng tham số truy vấn
Bạn có thể yêu cầu một nhóm người liên hệ khớp với một tiêu chí cụ thể, chẳng hạn như yêu cầu người liên hệ được cập nhật sau một ngày nhất định. Không hỗ trợ truy vấn toàn văn hoặc tìm người liên hệ theo địa chỉ email. Để biết danh sách đầy đủ các tham số truy vấn được hỗ trợ, hãy xem Hướng dẫn tham khảo về API Danh bạ được chia sẻ trên miền.
Gửi yêu cầu
HTTP GET
đến URL của nguồn cấp dữ liệu danh bạ bằng một tham số đã xác định:GET https://www.google.com/m8/feeds/contacts/
DOMAIN /PROJECTION ?PARAMETER Thay thế nội dung sau:
DOMAIN
: URL của miền, ví dụ: example.com.PROJECTION
: Giá trị chiếu chỉ định các phần tửgd:extendedProperty
. Để biết danh sách các giá trị được hỗ trợ, hãy xem phần Giá trị chiếu.PARAMETER
: Một trong các tham số truy vấn được hỗ trợ. Để biết thêm thông tin, hãy xem Hướng dẫn tham khảo về API Danh bạ được chia sẻ trong miền.
Ví dụ: để cập nhật tất cả các mục danh bạ được chia sẻ trên miền sau ngày 16 tháng 3 năm 2022 cho example.com, hãy gửi một yêu cầu HTTP đến URL nguồn cấp dữ liệu danh bạ được chia sẻ trên miền và thêm tham số
updated-min
vào URL yêu cầu:GET https://www.google.com/m8/feeds/contacts/example.com/full?updated-min=2022-03-16T00:00:00
Khi bạn gửi yêu cầu
GET
đó, máy chủ sẽ trả về một mã trạng thái HTTP200 OK
và một nguồn cấp dữ liệu chứa mọi địa chỉ liên hệ dùng chung miền đã được tạo hoặc cập nhật sau ngày được chỉ định.Nguồn cấp dữ liệu không trả về nhiều hơn 10 MB trong một phản hồi. Để nhận toàn bộ danh sách liên hệ theo tiêu chí đã chỉ định, hãy liên tục nhấp vào đường liên kết Tiếp theo của nguồn cấp dữ liệu trả về cho đến khi bạn không còn thấy đường liên kết đó trong nguồn cấp dữ liệu trả về.
Theo dõi các thay đổi gia tăng
Để theo dõi các thay đổi gia tăng đối với danh bạ dùng chung của miền, hãy làm như sau:
1. Khi bạn gửi yêu cầu cho một nguồn cấp dữ liệu, hãy theo dõi giá trị của phần tử <updated>
của nguồn cấp dữ liệu.
1. Bạn chỉ có thể nhận được những người liên hệ dùng chung trong miền đã thay đổi kể từ
yêu cầu trước đó bằng cách đặt tham số truy vấn
updated-min
thành giá trị <updated>
đó và đặt
showdeleted
thành true
.
Nhận một người liên hệ dùng chung
Để nhận một người liên hệ được chia sẻ, bạn phải sử dụng đường liên kết của chính người liên hệ đó. Bạn chỉ có thể lấy đường liên kết tự liên hệ của người liên hệ được chia sẻ bằng cách tìm mục nhập của người liên hệ đó trong nguồn cấp dữ liệu người liên hệ được chia sẻ. Nếu bạn không chắc nên sử dụng giá trị nào cho đường liên kết tự tham chiếu, hãy xem phần Tải tất cả danh bạ và Tải danh bạ bằng cách sử dụng tham số truy vấn.
- Để lấy một người liên hệ dùng chung miền cụ thể, hãy gửi yêu cầu
GET
HTTP đến đường liên kết tự liên kết của một người liên hệ: Thay thế nội dung sau:GET https://www.google.com/m8/feeds/contacts/
DOMAIN /PROJECTION /:SELF_LINK >
DOMAIN
: URL của miền, ví dụ: example.com.PROJECTION
: Giá trị chiếu chỉ định các phần tửgd:extendedProperty
. Để biết danh sách các giá trị được hỗ trợ, hãy xem phần Giá trị chiếu.SELF_LINK
: Một giá trị số duy nhất đại diện cho một người liên hệ dùng chung, ví dụ: 12345.
Sau đó, máy chủ sẽ trả về mã trạng thái HTTP 200 OK
và một mục nhập chứa thông tin liên hệ.
Ví dụ: để lấy thông tin liên hệ dùng chung miền có đường liên kết tự thân được đặt thành https://www.google.com/m8/feeds/contacts/example.com/full/12345
, hãy gửi yêu cầu HTTP sau:
GET https://www.google.com/m8/feeds/contacts/example.com/full/12345