API общих контактов домена использует стандартные элементы API данных Google и элементы, специфичные для общих контактов.
Запись контакта принимает форму расширенного вида Контакта , представляющего человека, место проведения (например, клуб или ресторан) или организацию. Тип контакта отображается в XML как элемент <atom:entry>
, который содержит различные элементы расширения из пространства имен данных Google.
Элемент category
, указывающий, что запись является контактом, выглядит следующим образом:
<atom:category scheme="http://schemas.google.com/g/2005#kind"
term="http://schemas.google.com/contact/2008#contact"/>
В API общих контактов домена некоторые элементы имеют несколько более строгие ограничения, чем тип контакта. Для следующих элементов вы указываете либо атрибут rel
, либо атрибут label
, но не оба:
-
gd:email
-
gd:im
-
gd:organization
-
gd:phoneNumber
-
gd:structuredPostalAddress
Когда вы создаете или обновляете общий контакт, если для любого из этих элементов вы указываете rel
и label
или ни одного из них, сервер отклоняет запись.
Фотографии поддержка
Вместе со значениями стандартных свойств, таких как self или edit, вы можете использовать значения rel
для atom:link
. При использовании ссылок на фотографии необходимо указывать авторизационный токен в HTTP-заголовке. Дополнительные сведения см. в разделе Подробнее об аутентификации и авторизации .
- С помощью команды
GET
rel="http://schemas.google.com/contacts/2008/rel#photo"
добавляет возможность чтения фотографии, связанной с контактом. Вы можете использовать URL-адрес, указанный вhref
, чтобы прочитать последнюю версию фотографии, связанной с контактом. Ссылка не отображается, если для контакта нет изображения.
Пример:
<atom:link rel="http://schemas.google.com/contacts/2008/rel#photo"
href="https://www.google.com/m8/feeds/photos/media/jo%40example.com/1234" type="image/*" />
- С помощью команды
PUT
илиDELETE
rel="http://schemas.google.com/contacts/2008/rel#edit-photo"
добавляет возможность обновления или удаления локальной фотографии, связанной с контактом.
Пример:
<atom:link rel="http://schemas.google.com/contacts/2008/rel#edit-photo"
href="https://www.google.com/m8/feeds/photos/media/jo%40example.com/1234/photo4524" />
пространство имен gContact
URL-адрес пространства имен XML для gContact
— http://schemas.google.com/contact/2008
.
В этом пространстве имен определяется элемент, представляющий группу, к которой принадлежит контакт.
Свойства gContact:groupMembershipInfo
Свойство | Описание |
---|---|
href | Определяет группу, к которой принадлежит или принадлежал контакт. На группу ссылается ее идентификатор. |
deleted="true" | Означает, что для контакта удалено членство в группе. Этот атрибут включается только в том случае, если в качестве параметра запроса указано showdeleted , в противном случае groupMembershipInfo для групп, к которым контакт больше не принадлежит, не возвращается. |