API Danh bạ đã ngừng hoạt động vào ngày 19 tháng 1 năm 2022. Hãy sử dụng hướng dẫn này để tìm hiểu về các thay đổi đối với trường, điểm cuối và phạm vi uỷ quyền khi bạn di chuyển sang API Người.
Tổng quan
API Người dùng có chức năng giống như API Danh bạ cũ cho tất cả các tính năng, trừ trường hợp ngoại lệ sau đây cho Danh bạ khác:
Quản trị viên có quyền chỉ có thể đọc đối với "Người liên hệ khác" thông qua phạm vi mới. Vì việc gửi tín hiệu thay đổi/ghi trở lại "Danh bạ khác" không được hỗ trợ, nên người dùng của bạn sẽ phải thêm Người liên hệ khác làm Người liên hệ của tôi nếu họ muốn cập nhật các trường dữ liệu.
API chỉ có thể đọc thông tin liên hệ cơ bản của "Danh bạ khác". Ví dụ: họ tên đầy đủ, địa chỉ email và số điện thoại.
Ngoài ra, phạm vi cũ của Danh bạ (https://www.google.com/m8/feeds), cung cấp quyền truy cập vào cả danh bạ cá nhân và thông tin trong thư mục, được thay thế bằng các phạm vi sau:
- Cách truy cập danh bạ cá nhân:
https://www.googleapis.com/auth/contacts - Để truy cập thông tin trong thư mục:
https://www.googleapis.com/auth/directory.readonly
Danh bạ
Liên kết trường
| Trường liên hệ | Cánh đồng người |
|---|---|
| atom:content | tiểu sử |
| atom:link rel='http://schemas.google.com/contacts/2008/rel#photo' | ảnh |
| atom:title | names |
| gContact:Thông tin thanh toán | từ khoá khác (type=OUTtrang_BILLING_INFORMATION) |
| gContact:sinh nhật | sinh nhật |
| gContact:calendarLink | calendarUrls |
| gContact:directoryServer | hơi từ khoá (type=OUTNVDA_DIRECTORY_SERVER) |
| gContact:sự kiện | sự kiện |
| gContact:broadProperty | clientData |
| gContact:externalId | externalIds |
| gContact:fileAs | fileAses |
| gContact:giới tính | giới tính |
| gContact:groupmembershipsInfo | memberships.contactGroupMembership |
| gContact:hobby | mối quan tâm |
| gContact:tên viết tắt | KHÔNG DÙNG NỮA biệt hiệu (type=BAN ĐẦU) |
| gContact:jot type='home' | từ khoá khác (type=HOME) |
| gContact:jot type='Từ khoá' | từ khoá khác (type=OUTNH_TỪ KHOÁ) |
| gContact:jot type='other' | từ khoá khác (type=OTHER) |
| gContact:jot type='user' | từ khoá khác (type=OUT gần_USER) |
| gContact:jot type='work' | từ khoá khác (type=WORK) |
| gContact:ngôn ngữ | languages (ngôn ngữ) |
| gContact:maidenName | Biệt hiệu (type=MAIDEN_NAME) KHÔNG DÙNG NỮA |
| gContact:số dặm đã đi | sai từ khoá (type=OUTlook_MILEAGE) |
| gContact:biệt hiệu | biệt hiệu (type=DEFAULT) |
| gContact:nghề nghiệp | nghề nghiệp |
| gLiên hệ:ưu tiên | từ khoá khác (type=OUTxem_PRIORITY) |
| gContact:quan hệ | mối quan hệ |
| gContact:độ nhạy | từ khoá khác (type=OUTxem_SENSITIVITY) |
| gContact:shortName | biệt hiệu (loại=SHORT_NAME) KHÔNG DÙNG NỮA |
| gContact:chủ đề | từ khoá khác (type=OUTxem_SUBJECT) |
| gContact:userDefinedField | userDefined |
| gContact:trang web | urls |
| gContact:yomiName | names.phonetic_full_name |
| gd:đã xoá | metadata.deleted |
| gd:email | emailAddresses |
| gd:im | imClients |
| gd:tổ chức | organizations |
| gd:phoneNumber | phoneNumbers |
| gd:postalAddress | addresses.formattedValue |
| gd:ở đâu | nơi cư trú |
| gd:structuredPostalAddress | địa chỉ |
Điểm cuối Danh bạ cá nhân
Đã đọc
Yêu cầu phạm vi https://www.googleapis.com/auth/contacts hoặc https://www.googleapis.com/auth/contacts.readonly.
- Đọc một địa chỉ liên hệ cụ thể
people.get - Đọc một số người liên hệ cụ thể
people.getBatchGet - Đọc danh bạ bằng
people.connections.list
Thay đổi
Cần có phạm vi https://www.googleapis.com/auth/contacts. Thay đổi tất cả các trường liên hệ, ngoại trừ ảnh.
- Tạo một người liên hệ bằng
people.createContact - Cập nhật một người liên hệ hiện có bằng
people.updateContact - Xoá người liên hệ bằng
people.deleteContact.
Thay đổi ảnh
Cần có phạm vi https://www.googleapis.com/auth/contacts.
- Cập nhật ảnh của người liên hệ bằng
people.updateContactPhoto. - Xoá ảnh của người liên hệ bằng
people.deleteContactPhoto.
Điểm cuối Danh bạ khác
Đã đọc
Các liên hệ khác ở chế độ chỉ đọc và chỉ có các trường names, emailAddresses và phoneNumbers được trả về.
Cần có phạm vi https://www.googleapis.com/auth/contacts.other.readonly.
- Đọc danh bạ khác bằng
otherContacts.list.
Sao chép
Cần có phạm vi https://www.googleapis.com/auth/contacts.other.readonly và https://www.googleapis.com/auth/contacts.
- Sao chép danh bạ khác bằng
otherContacts.copyOtherContactToMyContactsGroup.
Điểm cuối danh sách địa chỉ chung
Cần có phạm vi https://www.googleapis.com/auth/directory.readonly.
- Liệt kê tất cả người liên hệ và hồ sơ trong thư mục
people.listDirectoryPeople. - Tìm kiếm người liên hệ trong thư mục và hồ sơ
people.searchDirectoryPeople.
Nhóm liên hệ
Liên kết trường
| Trường nhóm liên hệ API Danh bạ | Trường nhóm liên hệ API người liên hệ |
|---|---|
| atom:cập nhật | metadata.updateTime |
| atom:title | name |
| atom:content | name |
| gd:đã xoá | metadata.deleted |
| systemGroup | groupType=SYSTEM_CONTACT_GROUP |
Điểm cuối
Đã đọc
Yêu cầu phạm vi https://www.googleapis.com/auth/contacts hoặc https://www.googleapis.com/auth/contacts.readonly.
- Tạo một nhóm người liên hệ cụ thể bằng cách sử dụng
people.contactGroups.get - Liệt kê nhóm liên hệ bằng cách sử dụng
people.contactGroups.list
Thay đổi
Cần có phạm vi https://www.googleapis.com/auth/contacts.
- Tạo nhóm người liên hệ bằng
people.contactGroups.create - Cập nhật nhóm người liên hệ bằng
people.contactGroups.update - Xoá nhóm người liên hệ bằng
people.contactGroups.delete Thêm hoặc xoá người liên hệ khỏi nhóm người liên hệ bằng cách sử dụng
people.contactGroups.members.modify
Phạm vi uỷ quyền
Phạm vi cũ https://www.google.com/m8/feeds là bí danh của phạm vi https://www.googleapis.com/auth/contacts. Tức là các lượt cấp quyền truy cập OAuth hiện có ở phạm vi cũ sẽ hoạt động cho mọi điểm cuối trong API Mọi người yêu cầu phạm vi https://www.googleapis.com/auth/contacts. Thao tác đọc và ghi danh bạ cũng như nhóm liên hệ sẽ hoạt động với phạm vi cũ.
API Người yêu cầu phạm vi mới để truy cập vào dữ liệu "Danh bạ khác" hoặc Thư mục. Vui lòng xem thông tin chi tiết ở trên để biết các phạm vi cần thiết.
Để biết thêm thông tin chi tiết, hãy xem phần Uỷ quyền cho yêu cầu.
Thư viện ứng dụng
- Đối với Apps Script, hãy xem phần Dịch vụ người dùng nâng cao.
- Đối với các ngôn ngữ được hỗ trợ khác, hãy xem phần Cài đặt thư viện ứng dụng.