Общие элементы: «Виды»

Предупреждение . Эта страница посвящена старым API Google, API данных Google; это относится только к API, которые перечислены в каталоге API данных Google , многие из которых были заменены более новыми API. Для получения информации о конкретном новом API см. документацию по новому API. Информацию об авторизации запросов с помощью более нового API см. в разделе Аутентификация и авторизация учетных записей Google .

Введение

Часто полезно, чтобы службы, использующие API данных Google, могли предоставлять согласованный набор информации об элементе определенного типа.

Например, различные службы Google Data API (или «GData») могут предоставлять контактную информацию для человека или организации; для всех таких служб имеет смысл использовать один и тот же набор элементов контактной информации.

Набор элементов, которые вместе описывают контакт, называется «типом» контакта. Некоторые элементы вида Contact являются обычными элементами Atom или RSS; другие определяются Google в пространстве имен, которое называется «пространство имен данных Google». По соглашению, пространство имен данных Google обычно упоминается в коде XML с помощью псевдонима gd: например, элемент, содержащий номер телефона или факса, называется <gd:phoneNumber> . URL-адрес схемы для пространства имен данных Google: http://schemas.google.com/g/2005.

Google также определяет другие типы: событие (набор стандартизированных элементов, которые вместе представляют событие календаря) и сообщение (набор элементов, представляющих сообщение электронной почты, публикацию в группе обсуждения или другое сообщение).

Некоторые элементы из пространства имен Google Data используются несколькими типами. Например, элемент <gd:who> связывает человека (описанного в <gd:who> ) с записью, содержащей элемент <gd:who> . Этот элемент используется в типе Event для указания организаторов, участников и т. д. Он также используется в типе Message для указания отправителей и получателей.

Когда запись в фиде Google Data API использует заданный тип, она содержит элемент <atom:category> с атрибутом scheme , установленным на "http://schemas.google.com/g/2005#kind" , и атрибутом term . установите имя URL-адреса схемы, за которым следует имя вида. Например, запись «Контакт» включает следующий элемент:

<atom:category scheme="http://schemas.google.com/g/2005#kind"
  term="http://schemas.google.com/g/2005#contact"/>

Это позволяет клиентам быстро и легко определить, какие данные содержит запись, то есть определить семантику записи. (Вы можете использовать RSS вместо Atom, если хотите; см. справочный документ по протоколу для элементов RSS, соответствующих элементам Atom.)

Этот документ является справочником по некоторым распространенным видам и элементам, которые они содержат.

Недокументированные элементы

Мы не включаем информацию о стандартных элементах <atom:entry> в виды, где эти элементы имеют свои стандартные значения. Например, <atom:id> , <atom:published> и <atom:updated> имеют свои стандартные значения, когда они появляются в типах.

Мы также не включаем информацию о стандартных элементах Atom, которая была бы бессмысленной в данном контексте; например, <atom:summary> не используется в виде Contact, и хотя <atom:author> является обязательным элементом в записи (если только он не указан в родительской ленте), он не имеет полезного значения в Контактный вид.

Создание видов

Может быть трудно определить, какую именно информацию вам нужно включить при создании записи определенного типа, особенно потому, что некоторые элементы в типах содержат другие типы.

Один из подходов, который может помочь, заключается в использовании предоставляемых нами клиентских библиотек, а не в попытках создавать виды вручную. Клиентские библиотеки предоставляют различные методы добавления и изменения данных в записи заданного типа; подробности см. в документации по клиентской библиотеке.

Расширяемость

Информация в этом документе не охватывает все возможные свойства и значения атрибутов для видов. Службы могут расширять виды, поэтому конкретная служба может использовать свойства и значения, не включенные в этот документ.

Типографские соглашения

В таблицах в этом документе мы используем следующие соглашения для обязательных и необязательных элементов:

имя элемента Обязательный элемент
имя элемента? Необязательный элемент
имя_элемента* Необязательный элемент, допускается несколько экземпляров

Элементы и атрибуты представлены в стандартной нотации XPath.

Тип контакта

Представляет контакт: лицо, место, такое как клуб или ресторан, или организацию.

Элемент категории: <atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#contact"/>

Примечание . Если вы используете вид контакта в контексте API контактов , помните, что вид контакта версии 2.0 (описанный в этом документе) используется API контактов, начиная с версии 3.0 API.

Характеристики

Свойство Описание
atom:category * Категории. Экземпляры с атрибутом @label рассматриваются как теги. Сведения об использовании атрибута @scheme см. в примечании в начале этого раздела.
atom:content Заметки о контакте.
atom:link * Ссылки на соответствующую информацию. В частности, atom:link[@rel='alternate'] ссылается на HTML-страницу с описанием контакта.
atom:title Имя контакта. Это поле доступно только для чтения. Чтобы изменить имя контакта, см. gd:name .
gd: email * Адрес электронной почты.
gd: extendedProperty * Расширенное свойство.
gd: deleted ? Наличие этого элемента указывает на то, что эта запись контакта была удалена.
gd: im * IM-адреса.
gd: name ? Имя контакта в структурированной форме.
gd: organization * Организация.
gd: phoneNumber * Номера телефона и факса.
gd: structuredPostalAddress * Почтовый адрес контакта в структурированном виде.
gd: where ? Место, связанное с контактом.

Примеры

<entry xmlns='http://www.w3.org/2005/Atom' xmlns:gd='http://schemas.google.com/g/2005'>
  <category scheme='http://schemas.google.com/g/2005#kind' 
      term='http://schemas.google.com/contact/2008#contact'/>
  <title>Elizabeth Bennet</title>
  <content>My good friend, Liz.  A little quick to judge sometimes, but nice girl.</content>
  <gd:email rel='http://schemas.google.com/g/2005#work' primary='true' address='liz@gmail.com'/>
  <gd:email rel='http://schemas.google.com/g/2005#home' address='liz@example.org'/>
  <gd:phoneNumber rel='http://schemas.google.com/g/2005#work' primary='true'>
    (206)555-1212
  </gd:phoneNumber>
  <gd:phoneNumber rel='http://schemas.google.com/g/2005#home'>
    (206)555-1213
  </gd:phoneNumber>
  <gd:phoneNumber rel='http://schemas.google.com/g/2005#mobile'>
    (206) 555-1212
  </gd:phoneNumber>
  <gd:im rel='http://schemas.google.com/g/2005#home' 
      protocol='http://schemas.google.com/g/2005#GOOGLE_TALK' 
      address='liz@gmail.com'/>
  <gd:postalAddress rel='http://schemas.google.com/g/2005#work' primary='true'>
    1600 Amphitheatre Pkwy 
    Mountain View, CA 94043
  </gd:postalAddress>
  <gd:postalAddress rel='http://schemas.google.com/g/2005#home'>
    800 Main Street
    Mountain View, CA 94041
  </gd:postalAddress>
  <gd:organization>
    <gd:orgName>Google, Inc.</gd:orgName>
    <gd:orgTitle>Tech Writer</gd:orgTitle>
  </gd:organization>
</entry>

Тип профиля

Представляет профиль, связанный с пользователем Google или другим объектом. Вид Profile имеет много общего с видом Contact . Однако он имеет некоторые отличия: например, он не может содержать расширенные свойства или быть помечен как удаленный.

Элемент категории: <atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#profile"/>

Тип профиля был представлен в версии 3.0 API контактов.

Характеристики

Свойство Описание
atom:category * Категории. Экземпляры с атрибутом @label рассматриваются как теги. Сведения об использовании атрибута @scheme см. в примечании «Элемент категории» в начале этого раздела.
atom:content Примечания к профилю.
atom:link * Ссылки на соответствующую информацию. В частности, atom:link[@rel='alternate'] ссылается на HTML-страницу с описанием профиля.
atom:title Имя профиля. Это поле доступно только для чтения.
gd: email * Адрес электронной почты.
gd: im * IM-адреса.
gd: name ? Имя в структурированной форме.
gd: organization * Организация.
gd: phoneNumber * Номера телефона и факса.
gd: structuredPostalAddress * Почтовый адрес в структурированной форме.
gd: where ? Место, связанное с профилем.

Примеры

<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:gContact='http://schemas.google.com/contact/2008'
xmlns:batch='http://schemas.google.com/gdata/batch'
xmlns:gd='http://schemas.google.com/g/2005'
  <category scheme='http://schemas.google.com/g/2005#kind'
  term='http://schemas.google.com/contact/2008#profile' />
  <title>Elizabeth Bennett</title>
  <gd:name>
    <gd:givenName>Elizabeth</gd:givenName>
    <gd:familyName>Bennett</gd:familyName>
  </gd:name>
  <gd:structuredPostalAddress rel='http://schemas.google.com/g/2005#work'>
    <gd:formattedAddress>Longbourne, Nr. Meryton, Hertfordshire, England</gd:formattedAddress>
  </gd:structuredPostalAddress>
</entry>

Тип события

Представляет событие календаря. Место события представлено типом Contact, встроенным в элемент <gd:where> (или связанный с ним); планировщики событий и участники представлены в виде типов контактов, встроенных в элементы <gd:who> (или связанные с ними).

Элемент категории: <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/>

Характеристики

Свойство Описание
atom:author Человек, который создал это событие.
atom:category * Категории. Экземпляры с атрибутом @label рассматриваются как теги. Сведения об использовании атрибута @scheme см. в примечании в начале этого раздела.
atom:content Подробное описание события.
atom:link * Ссылки. В частности, atom:link[@rel='alternate'] предоставляет ссылку на HTML-страницу с описанием события.
atom:title Краткое название мероприятия.
gd: comments ? Лента комментариев.
gd: eventStatus ? Расширяемое перечисление задокументировано ниже.
gd: extendedProperty * Расширенное свойство.
gd: originalEvent ? Исходный идентификатор события для повторяющихся событий.
gd: recurrence ? Правило повторения.
gd: transparency ? Расширяемое перечисление, задокументированное ниже, соответствует свойству TRANSP, определенному в RFC 2445.
gd: visibility ? Расширяемое перечисление задокументировано ниже.
gd: when * Время события. Атрибуты startTime и endTime должны быть установлены оба, хотя для событий на весь день эти атрибуты являются только датами, без времени.
gd: when /gd:reminder * Напоминания о мероприятии.
gd: where * Место проведения мероприятия или близлежащие предметы первой необходимости, такие как парковка. Если элемент <gd:where> указан на уровне канала, но на уровне входа нет элемента <gd:where> , то записи наследуют значение <gd:where> уровне канала.
gd: who * Люди, связанные с мероприятием: организатор, участники, спикеры, исполнители и т. д.
gd: who /gd:attendeeStatus ? Статус приема.
gd: who /gd:attendeeType ? Тип участника: required или optional .

относительные значения для gd:где

относительное значение Описание
http://schemas.google.com/g/2005#event или не указано. Место, где происходит событие.
http://schemas.google.com/g/2005#event.alternate Второстепенное место. Например, удаленный сайт со ссылкой на видеоконференцию на основной сайт.
http://schemas.google.com/g/2005#event.parking Рядом стоянка.

gd:значения состояния события

Ценить Описание
http://schemas.google.com/g/2005#event.canceled Мероприятие отменено.
http://schemas.google.com/g/2005#event.confirmed Мероприятие планируется.
http://schemas.google.com/g/2005#event.tentative Мероприятие запланировано только предварительно.

gd: значения видимости

Ценить Описание
http://schemas.google.com/g/2005#event.confidential Разрешить некоторым читателям увидеть событие.
http://schemas.google.com/g/2005#event.default Наследовать поведение от предпочтений владельца календаря, в котором отображается событие.
http://schemas.google.com/g/2005#event.private Разрешить наименьшему количеству читателей увидеть событие.
http://schemas.google.com/g/2005#event.public Разрешить большинству читателей увидеть событие.

gd:значения прозрачности

Ценить Описание
http://schemas.google.com/g/2005#event.opaque Указывает, что событие занимает время в календаре; время события будет помечено как занятое при поиске занятости.
http://schemas.google.com/g/2005#event.transparent Указывает, что событие не занимает время в календаре; время события не будет помечено как занятое при поиске занятости.

Примеры

Встреча:

<entry xmlns:gd="http://schemas.google.com/g/2005">
  <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/>
  <id>http://mycal.example.com/feeds/jo/home/full/e1a2af06df8a563edf9d32ec9fd61e03f7f3b67b</id>
  <published>2005-01-18T21:00:00Z</published>
  <updated>2006-01-01T00:00:00Z</updated>
  <title>Discuss BazMat API</title>
  <content>We will discuss integrating GData with BazMat.</content>
  <author>
    <name>Jo March</name>
    <email>jo@example.com</email>
  </author>
  <gd:when startTime='2005-01-18T21:00:00Z' endTime='2005-01-18T22:00:00Z'>
    <gd:reminder minutes='15'/>
  </gd:when>
  <gd:where valueString='Building 41, Room X'/>
  <gd:eventStatus value="http://schemas.google.com/g/2005#event.confirmed"/>
  <gd:visibility value="http://schemas.google.com/g/2005#event.public"/>
  <gd:transparency value="http://schemas.google.com/g/2005#event.transparent"/>
</entry>

Онлайн-мероприятие:

<entry xmlns:gd="http://schemas.google.com/g/2005">
  <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#event"/>
  <id>http://mycal.example.com/feeds/jo/home/full/982307e797979879a</id>
  <published>2005-01-18T21:00:00Z</published>
  <updated>2006-01-01T00:00:00Z</updated>
  <title>Online Chess Tournament</title>
  <content/>
  <author>
    <name>Jo March</name>
    <email>jo@example.com</email>
  </author>
  <gd:when startTime='2006-01-24T19:00:00-08:00' endTime='2006-01-24T20:00:00-08:00'>
    <gd:reminder minutes='15'/>
  </gd:when>
  <gd:where>
    <gd:entryLink>
      <entry>
        <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#contact"/>
        <id>http://contacts.example.com/jo/GamePhannz</id>
        <published>2005-01-18T21:00:00Z</published>
        <updated>2006-01-01T00:00:00Z</updated>
        <title>GamePhannz Online Game Server</title>
        <link rel="http://schemas.google.com/g/2005#onlineLocation" type="text/html" href="http://gamephannz.example.com/chess/138fd87e"/>
        <content/>
      </entry>
    </gd:entryLink>
  </gd:where>
  <gd:eventStatus value="http://schemas.google.com/g/2005#event.confirmed"/>
  <gd:visibility value="http://schemas.google.com/g/2005#event.public"/>
  <gd:transparency value="http://schemas.google.com/g/2005#event.transparent"/>
</entry>

Тип сообщения

Представляет сообщение, например электронное письмо, публикацию в группе обсуждения или комментарий.

Элемент категории: <atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#message"/>

Характеристики

Свойство Описание
atom:category * Категории. Экземпляры с атрибутом @label рассматриваются как теги. Сведения об использовании атрибута @scheme см. в примечании в начале этого раздела. Информацию об использовании атрибута @term см. в таблице ниже.
atom:content Тело сообщения.
atom:link * Вложения сообщения. В частности, чтобы загрузить вложение, используйте <link rel="enclosure"> и поместите содержимое вложения в медиаколлекцию Atom.
atom:title Тема сообщения.
gd: geoPt ? Географическое местоположение, из которого было отправлено сообщение.
gd: rating ? Оценка качества (как определено приложением).
gd: who * Люди, связанные с этим сообщением. Точная семантика зависит от значения @rel . См. таблицу ниже.

Категория @term значения

Все перечисленные ниже категории относятся к схеме http://schemas.google.com/g/2005 .

Срок Описание
http://schemas.google.com/g/2005#message.chat Сообщение представляет собой расшифровку сеанса чата.
http://schemas.google.com/g/2005#message.inbox Сообщение помечается как принадлежащее папке «Входящие».
http://schemas.google.com/g/2005#message.sent Сообщение помечается как отправленное.
http://schemas.google.com/g/2005#message.spam Сообщение считается спамом.
http://schemas.google.com/g/2005#message.starred Сообщение помечено как помеченное.
http://schemas.google.com/g/2005#message.unread Сообщение не прочитано.

значения rel для gd:who

Свойство Описание
http://schemas.google.com/g/2005#message.bcc Получатель скрытой копии сообщения.
http://schemas.google.com/g/2005#message.cc Получатель копии сообщения.
http://schemas.google.com/g/2005#message.from Отправитель сообщения (электронной почты или мгновенного сообщения).
http://schemas.google.com/g/2005#message.reply-to Предполагаемый получатель ответного сообщения.
http://schemas.google.com/g/2005#message.to Основной получатель сообщения.

Пример

Сообщение электронной почты:

<entry xmlns:gd="http://schemas.google.com/g/2005">
  <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#message"/>
  <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#message.sent"/>
  <author>
    <name>Jo March</name>
    <email>jo@example.com</email>
  </author>
  <id>http://mymail.example.com/feeds/jo/home/full/e1a2af06df8a563edf9d32ec9fd61e03f7f3b67b</id>
  <published>2006-01-18T21:00:00Z</published>
  <updated>2006-01-18T21:00:00Z</updated>
  <title>Re: Info?</title>
  <content>Hi, Fritz -- The information you're looking for is on p. 47.</content>
  <gd:who rel="http://schemas.google.com/g/2005#message.from">
    <gd:entryLink href="http://contacts.example.com/jo/Jo"/>
  </gd:who>
  <gd:who rel="http://schemas.google.com/g/2005#message.to">
    <gd:entryLink href="http://contacts.example.com/fritzb/FritzB"/>
  </gd:who>
</entry>

Ссылка на элемент пространства имен данных Google

Остальная часть этого документа состоит из справочного материала для элементов, используемых видами.

перечисления

Некоторым элементам расширения необходимо указывать свойства, значения которых поступают из перечисляемого набора. Общий вид таких свойств:

<gd:propertyName value="propertyValue">

Если значение свойства поступает из пространства имен данных Google, оно принимает форму http://schemas.google.com/g/2005# {kind} . {ценить}. Например: http://schemas.google.com/g/2005#event.tentative . Если пространство значений является расширяемым, значения также могут быть в форме URI. Рекомендуемая форма для URI расширенного значения: {URI схемы} # {value}. Например: http://www.example.com/attendeeStatus#AudioConference .

gEnumConstruct =
   attribute value { text },
   anyAttribute*

gdCommonProperties

Общие свойства, используемые для всех типов Google. Обратите внимание, что наличие в схеме anyAttribute и anyElement позволяет расширять все элементы пространства имен данных Google, использующие общие свойства, в любом пространстве имен. В частности, разрешено вкладывать любой элемент gd или любой элемент Atom/RSS в любой другой элемент gd. Это должно быть сделано разумно, и в большинстве случаев такое использование должно быть задокументировано как явное свойство содержащего типа элемента gd.

Характеристики

Свойство Тип Описание
@xml:base uri Стандартная конструкция XML для описания базы вложенных относительных URI.
@xml:lang text Язык вложенных строк.

Схема

namespace gd = "http://schemas.google.com/g/2005"

gdCommonProperties = {
   atomCommonAttributes,
   anyAttribute*,
   (anyElement*)
}

gd: дополнительное имя

Указывает дополнительное (например, отчество) имя человека, например. "Сьюзен".

Характеристики

Свойство Тип Описание
@yomi ? xs:string Фонетическое представление.
text() xs:string Фамилия человека.

Пример

<gd:additionalName yomi="'suz@n">Susan<gd:additionalName>

Схема

start = additionalName

additionalName =
   element gd:additionalName {
      attribute yomi { xs:string }?,
      (xs:string)
   }

гд:комментарии

Содержит ленту комментариев для прилагаемой записи (например, события календаря).

Характеристики

Свойство Тип Описание
@rel ? xs:string Тип комментариев, содержащихся внутри. В настоящее время существует различие между обычными комментариями и отзывами.
gd: feedLink ? feedLink Лента комментариев. Этот фид должен реализовывать тип Message .

относительные значения

Ценить Описание
http://schemas.google.com/g/2005#regular или не указано Регулярные комментарии (от пользователей).
http://schemas.google.com/g/2005#reviews Профессиональные обзоры.

Примеры

Лента комментариев:

<gd:comments>
  <gd:feedLink href="http://example.com/Jo/posts/MyFirstPost/comments" countHint="10">
    <feed>
      <id>http://example.com/Jo/posts/MyFirstPost/comments</id>
      <title>My first post: comments</title>
      ...
      <entry>
         ...
         <content>Good post.</content>
      </entry>
      <entry>
         ...
      </entry>
      ...
    </feed>
  </gd:feedLink>
</gd:comments>

Лента отзывов:

<gd:comments rel="http://schemas.google.com/g/2005#reviews">
  <gd:feedLink href="http://example.com/restaurants/SanFrancisco/432432/reviews" countHint="25">
    <feed>
      <id>http://example.com/restaurants/SanFrancisco/432432/reviews</id>
      <title>La Folie reviews</title>
      ...
      <entry>
         ...
         <content>Good food.</content>
         <gd:rating value="5" min="1" max="5"/>
      </entry>
      <entry>
         ...
      </entry>
      ...
    </feed>
  </gd:feedLink>
</gd:comments>

Схема

start = comments

comments =
   element gd:comments {
      gdCommonProperties,
      attribute rel { xs:string }?,
      (feedLink?)
   }

гд: удалено

Элемент маркера, который, если присутствует, указывает, что содержащая запись удалена.

Характеристики

Никто.

Схема

start = deleted

deleted =
   element gd:deleted

gd:страна

Название страны вместе с необязательным кодом страны. Последний приведен в соответствии с ISO 3166-1 alpha-2 .

Характеристики

Свойство Тип Описание
@code ? xs:string Код страны как в ISO 3166-1 alpha-2 .
text() xs:string Имя страны.

Примеры

<gd:country code='PL'>Poland</gd:country>
<gd:country>Gabon</gd:country>

Схема

start = country

country =
   element gd:country {
      attribute code { xs:string }?,
      xs:string?
   }

gd: электронная почта

Адрес электронной почты, связанный с содержащим объектом (обычно это объект, представляющий человека или местоположение).

Характеристики

Свойство Тип Описание
@address xs:string Адрес электронной почты.
@displayName ? xs:string Отображаемое имя объекта (например, лица), которому принадлежит адрес электронной почты.
@label ? xs:string Простое строковое значение, используемое для названия этого адреса электронной почты. Это позволяет пользовательскому интерфейсу отображать метки, такие как «Работа», «Личное», «Предпочитаемый» и т. д.
@rel ? xs:string Программное значение, определяющее тип электронной почты; подробности см. ниже.
@primary ? xs:boolean Когда несколько расширений электронной почты отображаются в виде контакта, указывает, какой из них является основным. Максимум одно электронное письмо может быть основным. Значение по умолчанию — "false" .

относительные значения

Ценить Описание
http://schemas.google.com/g/2005#home
http://schemas.google.com/g/2005#other Адрес электронной почты, который не является ни домашним, ни рабочим. label может использоваться для обозначения фактического типа.
http://schemas.google.com/g/2005#work

Примеры

<gd:email address="foo@bar.example.com" displayName="Foo Bar" />
<gd:email label="Personal" rel="http://schemas.google.com/g/2005#home" address="fubar@gmail.com" primary="true"/>

Схема

start = email

email =
   element gd:email {
      attribute address { xs:string },
      attribute displayName { xs:string }?,
      attribute label { xs:string }?,
      attribute rel { xs:string }?,
      attribute primary { xs:boolean }?
   }

gd: записьСсылка

Представляет логически вложенную запись. Например, элемент <gd:who> , представляющий контакт, может иметь вложенную запись из ленты контактов.

Характеристики

Свойство Тип Описание
@href ? xs:string Задает URI записи. Если вложенная запись встроена и не связана, этот атрибут можно опустить.
@readOnly ? xs:boolean Указывает, доступна ли содержащаяся запись только для чтения. Значение по умолчанию — "false" .
@rel ? xs:string Определяет отношение ссылки; позволяет службе предоставлять несколько типов входных ссылок для одного объекта. Имеет ту же семантику и допустимые значения, что и атрибут rel элемента <atom:link> .
atom:entry ? atomEntry Содержание записи.

Ограничения

  • Один или оба из @href или <atom:entry> должны присутствовать.
  • Если atom:entry отсутствует, клиент может получить содержимое из URI записи в @href . Если присутствует atom:entry , содержимое должно быть таким же, как и то, что было получено из @href во время создания записи.
  • Когда PUT или POST содержит <gd:entryLink> и указан атрибут @href , значение атрибута используется для создания ссылки; если элемент atom:entry также присутствует, он игнорируется. Если атрибут @href не указан, то элемент atom:entry либо сохраняется как встроенная запись, либо сохраняется в другой ленте и связан с ней. Обратите внимание, что некоторые службы могут не поддерживать все эти параметры.

Примеры

Контактная информация в пределах <gd:who> :

<gd:who rel="http://schemas.google.com/g/2005#event.attendee" valueString="Jo">
  <gd:entryLink href="http://gmail.com/jo/contacts/Jo">
    <entry>
      <category scheme="http://schemas.google.com/g/2005#kind"
        term="http://schemas.google.com/g/2005#contact"/>
      <id>http://gmail.com/jo/contacts/Jo</id>
      <category term="user-tag" label="Google"/>
      <title>Jo March</title>
      <gd:email address="jo@example.com"/>
      <gd:phoneNumber label="work">(650) 555-1212</gd:phoneNumber>
    </entry>
  </gd:entryLink>
</gd:who>

Только внешняя ссылка (запись только для чтения):

<gd:who rel="http://schemas.google.com/g/2005#event.attendee" valueString="Jo">
  <gd:entryLink href="http://gmail.com/jo/contacts/Jo" readOnly="true"/>
</gd:who>

Схема

start = entryLink

entryLink =
   element gd:entryLink {
      attribute href { xs:string }?,
      attribute readOnly { xs:boolean }?,
      (atomEntry?)
   }

gd: расширенное свойство

Позволяет хранить ограниченный объем пользовательских данных в качестве вспомогательного свойства объемлющей сущности.

Обратите внимание, что наличие anyForeignElement позволяет фиду опционально встраивать любой действительный XML в элемент gd:extendedProperty (взаимоисключающее с атрибутом value ).

Характеристики

Свойство Тип Описание
@name xs:string Задает имя свойства, выраженное в виде URI. URI расширенных свойств обычно следуют соглашению {schema}#{local-name}.
@value ? xs:string Стоимость имущества.
@realm ? xs:string Используется некоторыми API для указания, где применяется расширенное свойство.

Пример

Внешний идентификатор события календаря:

<gd:extendedProperty name="http://www.example.com/schemas/2007#mycal.id"
  value="1234"></gd:extendedProperty> 

Дополнительный xml для записи контакта

<gd:extendedProperty name="com.google">
  <some_xml>value</some_xml>
</gd:extendedProperty>

Схема

start = extendedProperty

extendedProperty =
   element gd:extendedProperty {
      attribute name { xs:string },
      attribute value { xs:string } ?,
      (anyForeignElement*),
      attribute realm { xs:string } ?
   }

gd: имя семьи

Указывает фамилию человека, например. "Смит".

Характеристики

Свойство Тип Описание
@yomi ? xs:string Фонетическое представление.
text() xs:string Фамилия человека.

Пример

<gd:familyName yomi="smɪð">Smith<gd:familyName>

Схема

start = familyName

familyName =
   element gd:familyName {
      attribute yomi { xs:string }?,
      (xs:string)
   }

gd: каналСсылка

Представляет логически вложенный канал. Например, лента календаря может иметь вложенную ленту, представляющую все комментарии к записям.

Характеристики

Свойство Тип Описание
@countHint ? xs:unsignedInt Подсказки по количеству записей в ленте. В зависимости от реализации может быть неточное количество.
@href ? xs:string Указывает URI фида. Если вложенный фид встроен и не связан, этот атрибут можно не указывать.
@readOnly ? xs:boolean Указывает, доступен ли содержащийся канал только для чтения.
@rel ? xs:string Определяет отношение ссылки; позволяет службе предоставлять несколько типов ссылок на каналы для одного объекта. Имеет ту же семантику и допустимые значения, что и атрибут rel элемента <atom:link> .
atom:feed ? atomFeed Содержание фида.

Ограничения

  • Должен присутствовать один или оба из @href или <atom:feed> .
  • Если atom:feed отсутствует, клиент может получить содержимое из URI в @href . Если он присутствует, содержимое должно совпадать с тем, что было бы получено из @href во время создания канала.
  • Когда PUT или POST содержит <gd:feedLink> и указан атрибут @href , значение атрибута используется для создания ссылки; если элемент <atom:feed> также присутствует, он игнорируется. Если атрибут @href не указан, элемент <atom:feed> сохраняется как встроенный канал. Обратите внимание, что некоторые службы могут не поддерживать все эти параметры.

Примеры

Ведение блога:

<gd:feedLink href="http://example.com/Jo/posts/MyFirstPost/comments" countHint="10">
    <feed>
      <id>http://example.com/Jo/posts/MyFirstPost/comments</id>
      <title>My first post: comments</title>
      ...
      <entry>
         ...
         <content>Good post.</content>
      </entry>
      <entry>
         ...
      </entry>
      ...
    </feed>
  </gd:feedLink>

Только внешняя ссылка:

<gd:feedLink href="http://example.com/Jo/posts/MyFirstPost/comments"
            countHint="10"/>

Встроенный канал в записи Atom, представляющей список:

<gd:feedLink>
  <feed>
    <id>cid:1</id>
    <entry>
       <id>cid:1.1</id>
       <content>list item 1</content>
    </entry>
    <entry>
       <id>cid:1.2</id>
       <content>list item 2</content>
    </entry>
  </feed>
</gd:feedLink>

Схема

start = feedLink

feedLink =
   element gd:feedLink {
      attribute href { xs:string }?,
      attribute readOnly { xs:boolean }?,
      attribute countHint { xs:unsignedInt }?,
      (atomFeed?)
   }

gd:geoPt

Географическое положение (широта, долгота, высота над уровнем моря).

Устарело. Этот элемент устарел. Вместо этого для данных геотегов используйте GeoRSS .

Характеристики

Свойство Тип Описание
@elev ? xs:float Высота в метрах. Отрицательные значения указывают глубины ниже среднего уровня моря.
@label ? xs:string Простое строковое значение, используемое для названия этого местоположения. Это позволяет пользовательскому интерфейсу отображать метку, такую ​​​​как «Текущее положение».
@lat xs:float Широта в градусах. Положительные значения означают север, отрицательные значения означают юг. Диапазон: [-90,0, 90,0].
@lon xs:float Долгота в градусах. Положительные значения означают восток, отрицательные значения означают запад. Диапазон: [-180,0, 180,0].
@time ? xs:dateTime Отметка времени.

Примеры

<gd:geoPt lat="40.75" lon="-74.0"/>
<gd:geoPt lat="27.98778" lon="86.94444" elev="8850.0"/>

Схема

start = geoPt

geoPt =
   element gd:geoPt {
      attribute label { xs:string }?,
      attribute lat { xs:float },
      attribute lon { xs:float },
      attribute elev { xs:float }?,
      attribute time { xs:dateTime }?
   }

гд: я

Адрес для обмена мгновенными сообщениями, связанный с содержащим объектом.

Характеристики

Свойство Тип Описание
@address xs:string адрес ИМ.
@label ? xs:string Простое строковое значение, используемое для названия этого адреса для обмена мгновенными сообщениями. Это позволяет пользовательскому интерфейсу отображать метки, такие как «Работа», «Личное», «Предпочитаемый» и т. д.
@rel ? xs:string Программное значение, определяющее тип IM; подробности см. ниже.
@protocol ? xs:string Идентифицирует сеть обмена мгновенными сообщениями. Значение может быть либо одним из стандартных значений (показанных ниже), либо URI, идентифицирующим собственную сеть обмена мгновенными сообщениями.
@primary ? xs:boolean Когда несколько добавочных номеров для обмена мгновенными сообщениями отображаются в виде контакта, указывает, какой из них является основным. Максимум один IM может быть основным. Значение по умолчанию — "false" .

относительные значения

Ценить Описание
http://schemas.google.com/g/2005#home
http://schemas.google.com/g/2005#netmeeting
http://schemas.google.com/g/2005#other Адрес для обмена мгновенными сообщениями, который не является ни домашним, ни рабочим. label может использоваться для обозначения фактического типа.
http://schemas.google.com/g/2005#work

значения атрибутов протокола

В следующей таблице показаны некоторые вероятные возможные значения атрибута @protocol.

Ценить Описание
http://schemas.google.com/g/2005#AIM Протокол обмена мгновенными сообщениями AOL
http://schemas.google.com/g/2005#MSN Протокол обмена сообщениями MSN
http://schemas.google.com/g/2005#YAHOO Протокол Yahoo Messenger
http://schemas.google.com/g/2005#SKYPE Скайп-протокол
http://schemas.google.com/g/2005#QQ QQ-протокол
http://schemas.google.com/g/2005#GOOGLE_TALK Протокол Google Talk
http://schemas.google.com/g/2005#ICQ ICQ-протокол
http://schemas.google.com/g/2005#JABBER Джаббер-протокол

Примеры

Адрес для обмена мгновенными сообщениями для MSN Messenger:

<gd:im protocol="http://schemas.google.com/g/2005#MSN" address="foo@bar.msn.com" rel="http://schemas.google.com/g/2005#home" primary="true"/>

Предоставляемый пользователем адрес для обмена мгновенными сообщениями с неопределенным протоколом. Такой адрес полезен для целей отображения, но с ним трудно работать программно.

<gd:im label="Other" address="foo@baz.example.com"/>

Схема

start = im

im =
   element gd:im {
      attribute address { xs:string },
      attribute label { xs:string }?,
      attribute rel { xs:string }?,
      attribute protocol { xs:string }?,
      attribute primary { xs:boolean }?
   }

gd: данное имя

Указывает имя человека, например. "Джон".

Характеристики

Свойство Тип Описание
@yomi ? xs:string Фонетическое представление.
text() xs:string Имя человека.

Пример

<gd:givenName yomi="dʒon">John<gd:givenName>

Схема

start = givenName

givenName =
   element gd:givenName {
      attribute yomi { xs:string }?,
      (xs:string)
   }

гд: деньги

Определяет сумму денег в определенной валюте.

Характеристики

Свойство Тип Описание
@amount xsd:float Количество денег.
@currencyCode xsd:string Код валюты ISO4217 .

Пример

<gd:money amount='650.0' currencyCode='EUR'/>

Схема

element gd:money {
  attribute amount { xsd:float },
  attribute currencyCode { xsd:string }
}

гд:имя

Позволяет хранить имя человека в структурированном виде. Состоит из имени, дополнительного имени, фамилии, префикса, суффикса и полного имени .

Характеристики

Свойство Тип Описание
gd:givenName ? givenName Имя человека.
gd:additionalName ? additionalName Дополнительное имя человека, например. второе имя.
gd:familyName ? familyName Фамилия человека.
gd:namePrefix ? namePrefix Почетный префикс, например. «мистер» или «миссис».
gd:nameSuffix ? nameSuffix Почетный суффикс, напр. «сан» или «III».
gd:fullName ? fullName Неструктурированное представление имени.

Пример

Структурированное представление сэра Уинстона Леонарда Спенсера-Черчилля, KG

<gd:name>
  <gd:givenName>Winston</gd:givenName>
  <gd:additionalName>Leonard</gd:additionalName>
  <gd:familyName>Spencer-Churchill</gd:familyName>
  <gd:namePrefix>Sir</gd:namePrefix>
  <gd:nameSuffix>OG</gd:nameSuffix>
</gd:name>

Схема

start = name

name =
   element gd:name {
      givenName?
      & additionalName?
      & familyName?
      & namePrefix?
      & nameSuffix?
   }

Ограничения

  • Неструктурированный компонент имени должен соответствовать его структурированному представлению.

gd:организация

Организация, обычно связанная с контактом.

Характеристики

Свойство Тип Описание
@label ? xs:string Простое строковое значение, используемое для названия этой организации. Это позволяет пользовательскому интерфейсу отображать такие ярлыки, как «Работа», «Волонтер», «Профессиональное общество» и т. Д.
gd:orgDepartment ? orgDepartment Указывает отдел внутри организации.
gd:orgJobDescription ? orgJobDescription Описание работы в организации.
gd:orgName ? orgName Название организации.
gd:orgSymbol ? orgSymbol Символ организации.
gd:orgTitle ? orgTitle Должность человека в организации.
@primary ? xs:boolean Когда несколько расширений организаций появляются в виде контакта, указывает, какой из них является основным. Не более одной организации может быть первичной. Значение по умолчанию — "false" .
@rel ? xs:string Программное значение, определяющее тип организации; подробности см. ниже.
gd:where ? where Место, связанное с организацией, например, местонахождение офиса.

относительные значения

Ценить Описание
http://schemas.google.com/g/2005#other Организация, которая не работает. label может использоваться для обозначения фактического типа.
http://schemas.google.com/g/2005#work

Примеры

<gd:organization rel="http://schemas.google.com/g/2005#work" label="Work" primary="true">
  <gd:orgName>Google, Inc.</gd:orgName>
  <gd:orgTitle>Tech Writer</gd:orgTitle>
  <gd:orgJobDescription>Writes documentation</gd:orgJobDescription>
  <gd:orgDepartment>Software Development</gd:orgDepartment>
  <gd:orgSymbol>GOOG</gd:orgSymbol>
</gd:organization>

Схема

start = organization

organization =
   element gd:organization {
      attribute label { xs:string }?,
      attribute rel { xs:string }?,
      attribute primary { xs:boolean }?,
      ( orgDepartment? &
      orgJobDescription? &
      orgName? &
      orgSymbol? &
      orgTitle? &
      where? )
   }

gd:orgОтдел

Описывает отдел внутри организации. Должен появиться в элементе gd:organization .

Пример

<gd:orgDepartment>Research and Development</gd:orgDepartment>

Схема

start = orgDepartment

orgDepartment = element gd:orgDepartment { xs:string }

gd:orgJobDescription

Описывает работу в организации. Должен появиться в элементе gd:organization .

Пример

<gd:orgJobDescription>Documenting public APIs</gd:orgJobDescription>

Схема

start = orgJobDescription

orgJobDescription = element gd:orgJobDescription { xs:string }

gd: имя_организации

Название организации. Должен появиться в элементе gd:organization .

Характеристики

Свойство Описание
@yomi ? Йомигана (японское вспомогательное средство для чтения) для названия организации.

Пример

<gd:orgName>Google, Inc.</gd:orgName>

Схема

start = orgName

orgName =
   element gd:orgName {
     attribute yomi {xs:string},
     xs:string
   }

gd: orgSymbol

Предоставляет символ организации. Должен появиться в элементе gd:organization .

Пример

<gd:orgSymbol>GOOG</gd:orgSymbol>

Схема

start = orgSymbol

orgSymbol = element gd:orgSymbol { xs:string }

gd: orgTitle

Должность человека в организации. Должен появиться в элементе gd:organization .

Пример

<gd:orgTitle>President and CEO</gd:orgTitle>

Схема

start = orgTitle

orgTitle =
   element gd:orgTitle { xs:string }

gd: исходное событие

Эквивалентно свойству Recurrence ID, указанному в разделе 4.8.4.4 RFC 2445 . Появляется в каждом экземпляре повторяющегося события, чтобы идентифицировать исходное событие.

Содержит элемент <gd:when> , указывающий исходное время запуска экземпляра, ставшего исключением.

Характеристики

Свойство Тип Описание
@id xs:string Идентификатор исходного события.
@href xs:string URL-адрес ленты событий для исходного события.

Пример

Указание исходного события:

<gd:originalEvent id="i8fl1nrv2bl57c1qgr3f0onmgg"

href="http://www.google.com/calendar/feeds/userID/private-magicCookie/full/eventID">
  <gd:when startTime="2006-03-17T22:00:00.000Z"/>
</gd:originalEvent>

Схема

start = originalEvent

originalEvent =
   element gd:originalEvent {
      attribute id { xs:string },
      attribute href { xs:string },
      when
   }

gd: номер телефона

Номер телефона, связанный с содержащим объектом (обычно это объект, представляющий человека или местоположение).

Характеристики

Свойство Тип Описание
@label ? xs:string Простое строковое значение, используемое для названия этого номера телефона. В большинстве случаев @label не требуется, так как @rel однозначно идентифицирует номер и позволяет пользовательскому интерфейсу отображать соответствующую метку, такую ​​как «Мобильный», «Дом», «Работа» и т. д. Однако в случае, когда один человек имеет ( например) несколько мобильных телефонов, это свойство можно использовать для их устранения.
@rel ? xs:string Программное значение, определяющее тип номера телефона; подробности см. ниже.
@uri ? xs:string Необязательный «tel URI», используемый для формального представления номера, полезный для программного доступа, такого как мост VoIP/PSTN. См. RFC 3966 для получения дополнительной информации об URI tel.
@primary ? xs:boolean Если в виде контакта отображается несколько расширений телефонных номеров, указывается, какой из них является основным. Максимум один номер телефона может быть основным. Значение по умолчанию — "false" .
text() xs:string человекочитаемый номер телефона; может быть в любом формате телефонного номера. Начальные и конечные пробелы не имеют значения. Новые строки в строке также несущественны и могут быть удалены или сведены к одному пробелу.

относительные значения

Ценить Описание
http://schemas.google.com/g/2005#assistant
http://schemas.google.com/g/2005#callback
http://schemas.google.com/g/2005#car
http://schemas.google.com/g/2005#company_main
http://schemas.google.com/g/2005#fax
http://schemas.google.com/g/2005#home
http://schemas.google.com/g/2005#home_fax
http://schemas.google.com/g/2005#isdn
http://schemas.google.com/g/2005#main
http://schemas.google.com/g/2005#mobile
http://schemas.google.com/g/2005#other Специальный тип числа, для которого никакое другое значение rel не имеет смысла. label может использоваться для обозначения фактического типа.
http://schemas.google.com/g/2005#other_fax
http://schemas.google.com/g/2005#pager
http://schemas.google.com/g/2005#radio
http://schemas.google.com/g/2005#telex
http://schemas.google.com/g/2005#tty_tdd
http://schemas.google.com/g/2005#work
http://schemas.google.com/g/2005#work_fax
http://schemas.google.com/g/2005#work_mobile
http://schemas.google.com/g/2005#work_pager

Примеры

Простой номер телефона, введенный пользователем:

<gd:phoneNumber>(425) 555-8080 ext. 72585</gd:phoneNumber>

Тот же номер телефона, взятый из справочника:

<gd:phoneNumber rel="http://schemas.google.com/g/2005#work" uri="tel:+1-425-555-8080;ext=52585">
  (425) 555-8080 ext. 52585
</gd:phoneNumber>

Номер с этикеткой:

<gd:phoneNumber rel="http://schemas.google.com/g/2005#mobile" label="Personal calls only" uri="tel:+12065551212">
  +1 206 555 1212
</gd:phoneNumber>

Схема

start = phoneNumber

phoneNumber =
   element gd:phoneNumber {
      attribute rel { xs:string }?,
      attribute label { xs:string }?,
      attribute uri { xs:string }?,
      attribute primary { xs:boolean }?,
      (xs:string)
   }

gd: почтовый адрес

Почтовый адрес.

Характеристики

Свойство Тип Описание
@label ? xs:string Простое строковое значение, используемое для обозначения этого адреса.
@rel ? xs:string Программное значение, определяющее тип почтового адреса; подробности см. ниже.
@primary ? xs:boolean Когда несколько расширений почтовых адресов появляются в виде контакта, указывает, какой из них является основным. Максимум один почтовый адрес может быть основным. Значение по умолчанию — "false" .
text() xs:string Адрес в виде текста. Начальные и конечные пробелы не имеют значения. Новые строки в строке имеют большое значение.

относительные значения

Ценить Описание
http://schemas.google.com/g/2005#home
http://schemas.google.com/g/2005#other Адрес, который не является ни домашним, ни рабочим. label может использоваться для обозначения фактического типа.
http://schemas.google.com/g/2005#work

Примеры

<gd:postalAddress>
  500 West 45th Street
  New York, NY 10036
</gd:postalAddress>

Схема

start = postalAddress

postalAddress =
   element gd:postalAddress {
      attribute label { xs:string }?,
      attribute rel { xs:string }?,
      attribute primary { xs:boolean }?,
      (xs:string)
   }

gd: рейтинг

Представляет числовой рейтинг включающего объекта, например комментария. Каждый рейтинг имеет собственную шкалу, хотя служба может нормализовать ее; например, некоторые сервисы могут преобразовывать все оценки по шкале от 1 до 5.

Характеристики

Свойство Тип Описание
@average ? xs:float Средний рейтинг.
@max xs:int Максимальное значение рейтинговой шкалы.
@min xs:int Минимальное значение рейтинговой шкалы.
@numRaters ? xs:int Количество оценок, учитываемых при расчете среднего значения.
@rel ? xs:string Определяет оцениваемый аспект. Если не указано иное, рейтинг является общим рейтингом.
@value ? xs:int Рейтинговое значение.

относительные значения

Ценить Описание
http://schemas.google.com/g/2005#overall или не указано Общая оценка. Более высокие значения означают лучшие оценки.
http://schemas.google.com/g/2005#price Ценовой рейтинг. Более высокие значения означают более высокие цены.
http://schemas.google.com/g/2005#quality Рейтинг качества. Более высокие значения означают лучшее качество.

Примеры

4/5 общий рейтинг:

<gd:rating value="4" min="1" max="5"/>

Рейтинг самого дорогого ценового диапазона:

<gd:rating rel="http://schemas.google.com/g/2005#price" value="5" min="1" max="5"/>

Оценено 200 пользователями со средней оценкой 4,65 из 5:

<gd:rating average="4.65" min="1" max="5" numRaters="200"/>

Схема

start = rating

rating =
   element gd:rating {
      gdCommonProperties,
      attribute rel { xs:string }?,
      attribute value { xs:int }?,
      attribute average { xs:float }?,
      attribute min { xs:int },
      attribute max { xs:int },
      attribute numRaters { xs:int }?
   }

gd: повторение

Представляет даты и время, когда происходит повторяющееся событие.

Строка, определяющая повторение, состоит из набора свойств, каждое из которых определено в стандарте iCalendar (RFC 2445).

В частности, строка обычно начинается со свойства DTSTART, указывающего время начала первого экземпляра события, и часто свойства DTEND или свойства DURATION, указывающего, когда заканчивается первый экземпляр. Далее идут свойства RRULE, RDATE, EXRULE и/или EXDATE, которые вместе определяют повторяющееся событие и его исключения (но см. ниже). (Дополнительную информацию об этих свойствах компонента повторения см. в разделе 4.8.5 RFC 2445.) Последним идет компонент VTIMEZONE, предоставляющий подробные правила часового пояса для любого идентификатора часового пояса, упомянутого в предыдущих свойствах.

Такие службы Google, как Календарь Google, обычно не генерируют свойства EXRULE и EXDATE для представления исключений из повторяющихся событий; вместо этого они генерируют элементы <gd:recurrenceException> . Однако службы Google могут в любом случае включать свойства EXRULE и/или EXDATE; например, пользователи могут импортировать события и исключения в Календарь, и если эти импортированные события содержат свойства EXRULE или EXDATE, то Календарь предоставит эти свойства при отправке элемента <gd:recurrence> .

Обратите внимание, что использование <gd:recurrenceException> означает, что вы не можете быть уверены, просто изучив элемент <gd:recurrence> , есть ли какие-либо исключения в описании повторения. Чтобы убедиться, что вы нашли все исключения, найдите элементы <gd:recurrenceException> в ленте и используйте их элементы <gd:originalEvent> , чтобы сопоставить их с элементами <gd:recurrence> .

Характеристики

Свойство Тип Описание
text() xs:string Описание повторения.

Пример

Повторяющееся событие, происходящее каждое утро с 6:00 до 7:00 по тихоокеанскому времени с 14 по 21 марта 2006 г.:

<gd:recurrence>
  DTSTART;TZID=America/Los_Angeles:20060314T060000
  DURATION:PT3600S
  RRULE:FREQ=DAILY;UNTIL=20060321T220000Z
  BEGIN:VTIMEZONE
  TZID:America/Los_Angeles
  X-LIC-LOCATION:America/Los_Angeles
  BEGIN:STANDARD
  TZOFFSETFROM:-0700
  TZOFFSETTO:-0800
  TZNAME:PST
  DTSTART:19671029T020000
  RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU
  END:STANDARD
  BEGIN:DAYLIGHT
  TZOFFSETFROM:-0800
  TZOFFSETTO:-0700
  TZNAME:PDT
  DTSTART:19870405T020000
  RRULE:FREQ=YEARLY;BYMONTH=4;BYDAY=1SU
  END:DAYLIGHT
  END:VTIMEZONE
</gd:recurrence>

Схема

start = recurrence

recurrence =
   element gd:recurrence {
      (xs:string)
   }

gd: recurrenceException

Представляет событие, которое является исключением из повторяющегося события, то есть экземпляр повторяющегося события, в котором один или несколько аспектов повторяющегося события (например, список посещаемости, время или место) были изменены.

Содержит элемент <gd:originalEvent> , указывающий исходное повторяющееся событие, для которого данное событие является исключением.

Когда вы меняете экземпляр повторяющегося события, этот экземпляр становится исключением. В зависимости от того, какое изменение вы в него внесли, исключение ведет себя одним из двух способов при изменении исходного повторяющегося события:

  • Если вы добавляете, изменяете или удаляете комментарии, участников или ответы посетителей, то исключение остается привязанным к исходному событию, и изменения в исходном событии также изменяют исключение.
  • Если вы вносите какие-либо другие изменения в исключение (например, меняете время или местоположение), то экземпляр становится «специализированным», что означает, что он больше не так сильно привязан к исходному событию. Если вы измените исходное событие, специализированные исключения не изменятся. Но см. ниже.

Например, скажем, у вас есть собрание каждый вторник и четверг в 14:00. Если вы измените список посещаемости для собрания в этот четверг (но не для обычного запланированного собрания), то оно станет исключением. Если вы измените время для встречи в этот четверг (но не для обычной запланированной встречи), то она станет специализированной.

Независимо от того, является ли исключение специализированным или нет, если вы делаете что-то, что удаляет экземпляр, из которого было получено исключение, то исключение удаляется. Обратите внимание, что изменение дня или времени повторяющегося события удаляет все экземпляры и создает новые.

Например, после того, как вы специализировали собрание в этот четверг, скажите, что вы изменили повторяющееся собрание, чтобы оно проводилось в понедельник, среду и пятницу. Это изменение удаляет все повторяющиеся экземпляры собрания вторника/четверга, включая специализированное.

Если конкретный экземпляр повторяющегося события удаляется, то этот экземпляр отображается как <gd:recurrenceException> , содержащий <gd:entryLink> , у которого для <gd:eventStatus> установлено значение "http://schemas.google.com/g/2005#event.canceled" . "http://schemas.google.com/g/2005#event.canceled" . (Дополнительную информацию об отмененных событиях см. в RFC 2445.)

Характеристики

Свойство Тип Описание
@specialized xs:boolean Указывает, является ли исключение специализированным или нет.
gd:entryLink entryLink Запись о событии, содержащая сведения об исключении.
gd:originalEvent originalEvent Исходное повторяющееся событие, для которого это исключение.

Пример

Исключение из повторяющегося события (некоторые части заменены краткими курсивными идентификаторами для ясности):

<gd:recurrenceException specialized="true">
  <gd:entryLink>
    <entry>
      <id>i8fl1nrv2bl57c1qgr3f0onmgg_20060317T220000Z</id>
      <published>2006-03-17T23:00:00.000Z</published>
      <updated>2006-03-14T21:33:12.000Z</updated>
      <category scheme="http://schemas.google.com/g/2005#kind"
        term="http://schemas.google.com/g/2005#event"/>
      <title type="text">recurrence</title>
      <content type="text"/>
      <link rel="alternate" type="text/html"
        href="http://www.google.com/calendar/event?eid=idString"
        title="alternate"/>
      <author>
        <name>exception</name>
      </author>
      <gd:eventStatus
        value="http://schemas.google.com/g/2005#event.confirmed"/>
      <gd:comments>
        <gd:feedLink
            href="http://www.google.com/calendar/feeds/userID/private-magicCookie/full/eventID/comments/">
          <feed>
            <updated>2006-03-14T21:36:23.250Z</updated>
            <title type="text">Comments for: recurrence</title>
            <link rel="alternate" type="text/html"
              href="http://www.google.com/calendar/feeds/userID/private-magicCookie/full/eventID/comments/"
              title="alternate"/>
          </feed>
        </gd:feedLink>
      </gd:comments>
      <gd:transparency
        value="http://schemas.google.com/g/2005#event.opaque "/>
      <gd:originalEvent id="i8fl1nrv2bl57c1qgr3f0onmgg"
          href="http://www.google.com/calendar/feeds/userID/private-magicCookie/composite/eventID">
        <gd:when startTime="2006-03-17T22:00:00.000Z"/>
      </gd:originalEvent>
      <gd:where valueString="Home"/>
      <gd:when startTime="2006-03-17T23:00:00.000Z"
        endTime="2006-03-18T00:00:00.000Z"/>
    </entry>
  </gd:entryLink>
</gd:recurrenceException>

Схема

start = recurrenceException

recurrenceException =
   element gd:recurrenceException {
      attribute specialized { xs:boolean },
      (entryLink
       & originalEvent)
   }

gd: напоминание

Чаще всего используется в: <gd:when>

Интервал времени, указывающий, за какое время до атрибута @startTime или @dueTime содержащей сущности должно быть выдано напоминание. В качестве альтернативы может указываться абсолютное время, в которое должно быть выдано напоминание. Также указывает метод уведомления, указывающий, какой носитель система должна использовать для напоминания пользователю.

Характеристики

Свойство Тип Описание
@absoluteTime ? xs:dateTime Абсолютное время, в которое должно быть выдано напоминание. Обычно это используется, когда пользователь использует функцию «отложить», чтобы отложить предыдущее напоминание. Если часовой пояс не указан, предполагается местное время наблюдателя.
@method ? xs:string Метод уведомления, который должно использовать напоминание. Может иметь любое из следующих значений: alert (вызывает появление оповещения, когда пользователь просматривает календарь в браузере), email (отправляет пользователю сообщение электронной почты) или sms (отправляет пользователю текстовое SMS-сообщение).
@days ? xs:unsignedInt Период времени до gd:when/@startTime когда должно быть выдано напоминание. Если целевым временем родительского объекта является дата, а не конкретное время, то эти атрибуты относятся к полуночи (00:00) этой даты.
@hours ? xs:unsignedInt
@minutes ? xs:unsignedInt

Когда вы создаете или редактируете запись <gd:when> , используйте следующие соглашения для достижения определенных результатов:

  • Чтобы служба использовала напоминания пользователя по умолчанию, включите элемент <gd:reminder> без атрибутов. Если вы укажете продолжительность, но не атрибут method , то служба использует методы уведомления пользователя по умолчанию с указанной вами продолжительностью.
  • To tell the service to not issue any reminders for the event (or to remove existing reminders when updating an event), don't include any <gd:reminder> elements.

Restrictions

  • At most one of @days , @hours , @minutes , or @absoluteTime may be specified. To specify a mixed duration, convert to the most precise unit. For example, to specify 1 hour 30 minutes, use @minutes="90" .
  • You can't use negative values for the attributes (so if you want a reminder to occur after the start time, you must use @absoluteTime ).
  • A given event can't have more than five reminders associated with it.
  • When you're adding a reminder to an event, if you specify the alert , email , or sms methods, you must also specify a duration.

Examples

A 15-minute reminder for a meeting:

<gd:when startTime="2005-06-06T17:00:00-08:00" endTime="2005-06-06T18:00:00-08:00">
  <gd:reminder minutes="15"/>
</gd:when>

Same meeting as above, but snoozed for 10 minutes after the reminder at 16:45:

<gd:when startTime="2005-06-06T17:00:00-08:00" endTime="2005-06-06T18:00:00-08:00">
  <gd:reminder minutes="15"/>
  <gd:reminder absoluteTime="2005-06-06T16:55:00-08:00"/>
</gd:when>

Schema

start = reminder

reminder =
   element gd:reminder {
      gdCommonProperties,
      attribute absoluteTime { xs:dateTime }?,
      attribute method { xs:string }?,
      attribute days { xs:unsignedInt }?,
      attribute hours { xs:unsignedInt }?,
      attribute minutes { xs:unsignedInt }?
   }

gd:resourceId

An opaque resource identifier, distinct from atom:id as it need not be a valid URI. Some services provide a separate identifier to be used when constructing subsequent requests. Exact usage is service specific.

Example

<gd:resourceId>9749638</gd:resourceId>

Schema

start = resourceId

resourceId =
   element gd:resourceId { xs:string }

gd:structuredPostalAddress

Postal address split into components. It allows to store the address in locale independent format. The fields can be interpreted and used to generate formatted, locale dependent address. The following elements reperesent parts of the address: agent, house name, street, PO box, neighborhood, city, subregion, region, postal code, country . The subregion element is not used for postal addresses, it is provided for extended uses of addresses only. In order to store postal address in an unstructured form formatted address field is provided.

Properties

Свойство Тип Описание
@rel ? xs:string Type of the address. Unless specified work type is assumed.
@mailClass ? xs:string Classes of mail accepted at the address. Unless specified both is assumed.
@usage ? xs:string The context in which this addess can be used. Local addresses may differ in layout from general addresses, and frequently use local script (as opposed to Latin script) as well, though local script is allowed in general addresses. Unless specified general usage is assumed.
@label ? xs:string A general label for the address.
@primary ? xs:boolean Specifies the address as primary. Default value is false .
gd:agent ? agent The agent who actually receives the mail. Used in work addresses. Also for 'in care of' or 'c/o'.
gd:housename ? housename Used in places where houses or buildings have names (and not necessarily numbers), eg. "The Pillars".
gd:street ? street Can be street, avenue, road, etc. This element also includes the house number and room/apartment/flat/floor number.
gd:pobox ? pobox Covers actual PO boxes, drawers, locked bags, etc. This is usually but not always mutually exclusive with street.
gd:neighborhood ? neighborhood This is used to disambiguate a street address when a city contains more than one street with the same name, or to specify a small place whose mail is routed through a larger postal town. In China it could be a county or a minor city.
gd:city ? city Can be city, village, town, borough, etc. This is the postal town and not necessarily the place of residence or place of business.
gd:subregion ? subregion Handles administrative districts such as US or UK counties that are not used for mail addressing purposes. Subregion is not intended for delivery addresses.
gd:region ? region A state, province, county (in Ireland), Land (in Germany), departement (in France), etc.
gd:postcode ? postcode Postal code. Usually country-wide, but sometimes specific to the city (eg "2" in "Dublin 2, Ireland" addresses).
gd: country ? country The name or code of the country.
gd:formattedAddress ? formattedAddress The full, unstructured postal address.

rel values

Value Описание
http://schemas.google.com/g/2005#work Work address. Unless other provided this is the default value.
http://schemas.google.com/g/2005#home Home address.
http://schemas.google.com/g/2005#other Any other type of address.

mailClass values

Value Описание
http://schemas.google.com/g/2005#both Parcels and letters can be sent to the address. Unless other provided this is the default value.
http://schemas.google.com/g/2005#letters Only letters can be sent to the address.
http://schemas.google.com/g/2005#parcels Only parcels can be sent to the address.
http://schemas.google.com/g/2005#neither Address is purely locational and cannot be used for mail.

usage values

Value Описание
http://schemas.google.com/g/2005#general This address is for general usage. Unless other provided this is the default value.
http://schemas.google.com/g/2005#local This address is for local usage.

Examples

Corporate address:

mr. John Doe
Google Inc.
1600 Amphitheatre Parkway
Mountain View, CA 94043
<gd:structuredPostalAddress mailClass='http://schemas.google.com/g/2005#letters' label='John at Google'>
  <gd:street>1600 Amphitheatre Parkway</gd:street>
  <gd:city>Mountain View</gd:city>
  <gd:region>CA</gd:region>
  <gd:postcode>94043</gd:postcode>
</gd:structuredPostalAddress>

Private address:

Madame Duval
27, rue Pasteur
14390 CABOURG
FRANCE
<gd:structuredPostalAddress mailClass='http://schemas.google.com/g/2005#both' label='Madame Duval'>
  <gd:street>27, rue Pasteur</gd:street>
  <gd:city>CABOURG</gd:city>
  <gd:postcode>14390</gd:postcode>
  <gd:country>FRANCE</gd:country>
</gd:structuredPostalAddress>

Schema

start = structuredPostalAddress

structuredPostalAddress =
   element gd:structuredPostalAddress {
      attribute label { xs:string }?,
      attribute mailClass { xs:string }?,
      attribute primary { xs:boolean }?,
      attribute rel { xs:string }?,
      attribute usage { xs:string }?,
      (agent?
       & housename?
       & street?
       & poBox?
       & neighborhood?
       & city?
       & subregion?
       & region?
       & postcode?
       & country?
       & formattedAddress? )
}

Restrictions

  • It is forbidden to have both 'gd:postalAddress' and 'gd:structuredPostalAddress' in one entity.
  • Only one structured address can be specified as primary.
  • The unstructured postal address must be consistent with the structured data.

gd:when

Represents a period of time or an instant.

Properties

Свойство Тип Описание
@endTime ? xs:dateTime or xs:date Describes when the event ends. If the timezone is not specified, the observer's local timezone is assumed.
@startTime xs:dateTime or xs:date Describes when the event starts or (for zero-duration events) when it occurs. If the timezone is not specified, the observer's local timezone is assumed.
@valueString ? xs:string A simple string value that can be used as a representation of this time period.

Restrictions

  • It's not possible to mix xs:dateTime with xs:date in startTime / endTime .
  • If endTime is not specified, then the event is considered to be an instant in time (if @startTime includes a time) or a one-day event (if @startTime is only a date).

Examples

A one-day event:

<gd:when startTime="2005-06-06"/>

Alternative representation of a one-day event:

<gd:when startTime="2005-06-06" endTime="2005-06-07"/>

A two-day event (on June 6 and June 7) with a string description:

<gd:when startTime="2005-06-06" endTime="2005-06-08" valueString="This weekend"/>

A one-hour meeting:

<gd:when startTime="2005-06-06T17:00:00-08:00" endTime="2005-06-06T18:00:00-08:00"/>

A zero-duration event:

<gd:when startTime="2005-06-06T17:00:00-08:00"/>

Schema

start = when

when =
   element gd:when {
      gdCommonProperties,
      attribute startTime { (xs:date | xs:dateTime) },
      attribute endTime { (xs:date | xs:dateTime) }?,
      attribute valueString { xs:string }?
   }

gd:where

A place (such as an event location) associated with the containing entity. The type of the association is determined by the rel attribute; the details of the location are contained in an embedded or linked-to Contact entry.

A <gd:where> element is more general than a <gd:geoPt> element. The former identifies a place using a text description and/or a Contact entry, while the latter identifies a place using a specific geographic location.

Properties

Свойство Тип Описание
@label ? xs:string Specifies a user-readable label to distinguish this location from other locations.
@rel ? xs:string Specifies the relationship between the containing entity and the contained location. Possible values (see below) are defined by other elements. For example, <gd:when> defines http://schemas.google.com/g/2005#event .
@valueString ? xs:string A simple string value that can be used as a representation of this location.
gd: entryLink ? entryLink Entry representing location details. This entry should implement the Contact kind.

rel values

Value Описание
http://schemas.google.com/g/2005#event or not specified Place where the enclosing event takes place.
http://schemas.google.com/g/2005#event.alternate A secondary location. For example, a remote site with a videoconference link to the main site.
http://schemas.google.com/g/2005#event.parking A nearby parking lot.

Examples

Event location:

<gd:where valueString="Google Cafeteria (Building 40)"/>

More complicated event location:

<gd:where rel="http://schemas.google.com/g/2005#event" valueString="Joe's Pub">
  <gd:entryLink href="http://local.example.com/10018/JoesPub">
    <gd:entry>
      <id>http://local.example.com/10018/JoesPub</id>
      <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/g/2005#contact"/>
      <content>Nice place to listen to jazz music</content>
      <link href="http://www.joespub.com"/>
      <gd:postalAddress>500 West 45th Street, New York, NY 10018</gd:postalAddress>
      <gd:geoPt lat="40.75" lon="-74.0"/>
      <gd:phoneNumber>(212) 555-1212</gd:phoneNumber>
      <gd:email address="info@joespub.com"/>
    </gd:entry>
  </gd:entryLink>
</gd:where>

Event with multiple locations:

<gd:where label="Mountain View Location (main)"
         valueString="Google Cafeteria (Building 40)"/>

<gd:where rel="http://schemas.google.com/g/2005#event.alternate"
         label="New York Location (videoconference)"
         valueString="Metropolis"/>

Schema

start = where

where =
   element gd:where {
      gdCommonProperties,
      attribute rel { xs:string }?,
      attribute label { xs:string }?,
      attribute valueString { xs:string }?,
      (entryLink?)
   }

gd:who

A person associated with the containing entity. The type of the association is determined by the rel attribute; the details about the person are contained in an embedded or linked-to Contact entry.

The <gd:who> element can be used to specify email senders and recipients, calendar event organizers, and so on.

Properties

Свойство Тип Описание
@email ? xs:string Адрес электронной почты. This property is typically used when <gd:entryLink> is not specified. The address must comply with RFC 2822 , section 3.4.1.
@rel ? xs:string Specifies the relationship between the containing entity and the contained person. See below for possible values.
@valueString ? xs:string A simple string value that can be used as a representation of this person.
gd: attendeeStatus ? gEnumConstruct Status of event attendee. Extensible enum documented below.
gd: attendeeType ? gEnumConstruct Type of event attendee. Extensible enum documented below.
gd: entryLink ? entryLink Entry representing person details. This entry should implement the Contact kind. In many cases, this entry will come from a contact feed.

rel values

The valid values for @rel depend on which kind the <gd:who> element appears in.

Value Kind Описание
http://schemas.google.com/g/2005#event.attendee Событие A general meeting/event attendee.
http://schemas.google.com/g/2005#event.organizer Событие Event organizer. An organizer is not necessarily an attendee.
http://schemas.google.com/g/2005#event.performer Событие Performer. Similar to http://schemas.google.com/g/2005#event.speaker , but with more emphasis on art than speech delivery.
http://schemas.google.com/g/2005#event.speaker Событие Speaker.
http://schemas.google.com/g/2005#message.bcc Message Message BCC recipient.
http://schemas.google.com/g/2005#message.cc Message Message CC recipient.
http://schemas.google.com/g/2005#message.from Message Message (email or IM) sender.
http://schemas.google.com/g/2005#message.reply-to Message Intended recipient of a reply message.
http://schemas.google.com/g/2005#message.to Message Message primary recipient.

gd:attendeeType Values

Value Описание
http://schemas.google.com/g/2005#event.optional Optional attendee.
http://schemas.google.com/g/2005#event.required Required attendee.

gd:attendeeStatus Values

Value Описание
http://schemas.google.com/g/2005#event.accepted Attendee has accepted.
http://schemas.google.com/g/2005#event.declined Attendee has declined.
http://schemas.google.com/g/2005#event.invited Invitation has been sent, but the person has not accepted.
http://schemas.google.com/g/2005#event.tentative Attendee has accepted tentatively.

Examples

Email recipients:

<gd:who rel="http://schemas.google.com/g/2005#message.from" email="jo@example.com"/>
<gd:who rel="http://schemas.google.com/g/2005#message.to" valueString="Elizabeth" email="liz@example.com"/>

Meeting attendee:

<gd:who rel="http://schemas.google.com/g/2005#event.attendee" valueString="Jo">
  <gd:attendeeType value="http://schemas.google.com/g/2005#event.required"/>
  <gd:attendeeStatus value="http://schemas.google.com/g/2005#event.tentative"/>
  <gd:entryLink href="http://gmail.com/jo/contacts/Jo">
    <entry>
      <id>http://gmail.com/jo/contacts/Jo</id>
      <category term="user-tag" label="Google"/>
      <title>Jo March</title>
      <gd:email address="jo@example.com"/>
      <gd:phoneNumber label="work">(650) 555-1212</gd:phoneNumber>
    </entry>
  </gd:entryLink>
</gd:who>

Event organizer:

<gd:who rel="http://schemas.google.com/g/2005#event.organizer" valueString="Receptionist 41"/>

Schema

start = who

who =
   element gd:who {
      gdCommonProperties,
      attribute rel { xs:string }?,
      attribute email { xs:string }?,
      attribute valueString { xs:string }?,
      (entryLink?
       & element gd:attendeeType { gEnumConstruct }?
       & element gd:attendeeStatus { gEnumConstruct }?)
   }

Back to top

Changes since 1.0

Changes to the contact kind

The following elements not present in version 1.0 were added in version 2.0 of the contact kind:

The following phone types not present in version 1.0 were added in version 2.0:

  • http://schemas.google.com/g/2005#assistant
  • http://schemas.google.com/g/2005#callback
  • http://schemas.google.com/g/2005#car
  • http://schemas.google.com/g/2005#company_main
  • http://schemas.google.com/g/2005#isdn
  • http://schemas.google.com/g/2005#main
  • http://schemas.google.com/g/2005#other_fax
  • http://schemas.google.com/g/2005#radio
  • http://schemas.google.com/g/2005#telex
  • http://schemas.google.com/g/2005#tty_tdd
  • http://schemas.google.com/g/2005#work_mobile
  • http://schemas.google.com/g/2005#work_pager

The following IM type not present in version 1.0 was added in version 2.0:

  • http://schemas.google.com/g/2005#netmeeting

The following elements of the 1.0 contact kind are no longer supported:

Changes to gd:email

The new attribute @displayName was added in gd:email in 2.0

Changes to gd:organization

The following subelements of gd:organization were introduced in 2.0:

  • gd:orgDepartment
  • gd:orgJobDescription
  • gd:orgSymbol
  • gd:where

Changes to gd:orgName

In version 2.0 the element gd:orgName was enhanced by adding the @yomi attribute to it.

Back to top