API контактов был отключен 19 января 2022 г. Используйте это руководство, чтобы узнать об изменениях в полях, конечных точках и областях авторизации при переходе на API People.
Обзор
API People имеет ту же функциональность, что и устаревший API Contacts, для всех функций, за следующими исключениями для Other Contacts :
Администраторы имеют разрешения только на чтение для «Других контактов» в новой области. Поскольку отправка сигналов изменения/записи обратно в «Другие контакты» не поддерживается, вашим пользователям придется добавить Другой контакт в качестве «Моего контакта», если они хотят обновить его поля данных.
Через API можно прочитать только основную контактную информацию для «Других контактов». Например, полное имя, адрес электронной почты и номер телефона.
Кроме того, старая область «Контакты» ( https://www.google.com/m8/feeds ), которая предоставляла доступ как к личным контактам, так и к информации каталога, заменяется следующими областями:
- Для доступа к личным контактам:
https://www.googleapis.com/auth/contacts - Чтобы получить доступ к информации каталога:
https://www.googleapis.com/auth/directory.readonly.
Контакты
Сопоставление полей
| Контактное поле | Поле человека |
|---|---|
| атом: содержание | биографии |
| атом: ссылка rel='http://schemas.google.com/contacts/2008/rel#photo' | фото |
| атом: название | имена |
| gContact:billingInformation | miscKeywords (тип = OUTLOOK_BILLING_INFORMATION) |
| gКонтакт: день рождения | дни рождения |
| gContact:calendarLink | календарные URL-адреса |
| gContact:directoryServer | miscKeywords (тип = OUTLOOK_DIRECTORY_SERVER) |
| gContact: событие | события |
| gContact:extendedProperty | данные клиента |
| gContact:externalId | внешние идентификаторы |
| gContact:fileAs | файлазы |
| gКонтакт:пол | полы |
| gContact:groupMembershipInfo | членство.contactGroupMembership |
| gКонтакт:хобби | интересы |
| gКонтакт: инициалы | УСТАРЕВШИЕ псевдонимы (type=INITIALS) |
| gContact:jot type='home' | miscKeywords (тип=HOME) |
| gContact:jot type='ключевые слова' | miscKeywords (тип = OUTLOOK_KEYWORD) |
| gContact:jot type='другое' | miscKeywords (тип=OTHER) |
| gContact:jot type='пользователь' | miscKeywords (тип = OUTLOOK_USER) |
| gContact:jot type='работа' | miscKeywords (тип = РАБОТА) |
| gКонтакт:язык | языки |
| gКонтакт: девичье имя | УСТАРЕВШИЕ псевдонимы (type=MAIDEN_NAME) |
| gКонтакт:пробег | miscKeywords (тип=OUTLOOK_MILEAGE) |
| gContact:никнейм | псевдонимы (тип=DEFAULT) |
| gКонтакт:профессия | занятия |
| gКонтакт:приоритет | miscKeywords (тип = OUTLOOK_PRIORITY) |
| gContact:отношение | связи |
| gКонтакт:чувствительность | miscKeywords (тип = OUTLOOK_SENSITIVITY) |
| gContact:shortName | УСТАРЕВШИЕ псевдонимы (type=SHORT_NAME) |
| gКонтакт:тема | miscKeywords (тип = OUTLOOK_SUBJECT) |
| gContact:userDefinedField | определяемые пользователем |
| gКонтакт: сайт | URL-адреса |
| gContact:yomiName | имена.phonetic_full_name |
| гд: удалено | метаданные.удалены |
| гд: электронная почта | адрес электронной почты |
| боже: я | imClients |
| гд:организация | организации |
| гд: номер телефона | телефонные номера |
| гд: почтовый адрес | адреса.formattedValue |
| боже: где | резиденции |
| гд:структурированныйПочтовыйАдрес | адреса |
Конечные точки личных контактов
Читать
Требуется область https://www.googleapis.com/auth/contacts или https://www.googleapis.com/auth/contacts.readonly .
- Прочтите один конкретный контакт
people.get - Прочитайте несколько конкретных
people.getBatchGet - Чтение контактов с помощью
people.connections.list
Мутировать
Требуется область https://www.googleapis.com/auth/contacts . Изменяет все поля контактов, кроме фотографий.
- Создайте контакт с помощью
people.createContact - Обновите существующий контакт с помощью
people.updateContact - Удалите контакт с помощью
people.deleteContact.
Изменение фото
Требуется область https://www.googleapis.com/auth/contacts .
- Обновите фотографию контакта с помощью
people.updateContactPhoto. - Удалите фотографию контакта с помощью
people.deleteContactPhoto.
Другие конечные точки контактов
Читать
Другие контакты доступны только для чтения, и возвращаются только names , emailAddresses и phoneNumbers .
Требуется область https://www.googleapis.com/auth/contacts.other.readonly .
- Прочтите другие контакты,
otherContacts.list.
Копировать
Требуются области https://www.googleapis.com/auth/contacts.other.readonly и https://www.googleapis.com/auth/contacts .
- Скопируйте другие контакты
otherContacts.copyOtherContactToMyContactsGroupиспользуяotherContacts.copyOtherContactToMyContactsGroup.
Конечные точки глобального списка адресов
Требуется область https://www.googleapis.com/auth/directory.readonly .
- Перечислите все контакты и профили
people.listDirectoryPeople. - Поиск в каталоге контактов и
people.searchDirectoryPeople.
Контактные группы
Сопоставление полей
| Поле группы контактов API контактов | Поле контактной группы API People |
|---|---|
| атом: обновлено | метаданные.updateTime |
| атом: название | имя |
| атом: содержание | имя |
| гд: удалено | метаданные.удалены |
| системная группа | groupType=SYSTEM_CONTACT_GROUP |
Конечные точки
Читать
Требуется область https://www.googleapis.com/auth/contacts или https://www.googleapis.com/auth/contacts.readonly .
- Получите конкретную группу контактов, используя
people.contactGroups.get - Перечислите группы контактов, используя
people.contactGroups.list
Мутировать
Требуется область https://www.googleapis.com/auth/contacts .
- Создайте группу контактов с помощью
people.contactGroups.create. - Обновите группу контактов с помощью
people.contactGroups.update. - Удалите группу контактов с помощью
people.contactGroups.delete Добавьте или удалите контакты из группы контактов с помощью
people.contactGroups.members.modify.
Области авторизации
Устаревшая область https://www.google.com/m8/feeds является псевдонимом области https://www.googleapis.com/auth/contacts . Это означает, что существующие разрешения oauth с устаревшей областью действия будут работать для любых конечных точек в People API, которым требуется область https://www.googleapis.com/auth/contacts . Чтение и запись контактов и контактных групп будет работать с устаревшей областью.
People API требует новых областей для доступа к «Другим контактам» или данным каталога. Подробную информацию о необходимых объемах см. выше.
Дополнительные сведения см. в разделе Авторизация запросов .
Клиентские библиотеки
- Сведения о сценарии приложений см. в разделе Advanced People Service .
- Информацию о других поддерживаемых языках см. в разделе «Установка клиентских библиотек» .