Справочное руководство

В этом документе приведена подробная справочная документация по протоколу (XML и HTTP) для Google Sites Data API.

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

Аудитория

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

Это справочный документ, предполагающий, что вы понимаете концепции, представленные в руководстве по протоколу, и общие принципы работы протокола Google Data API.

Типы фидов Google Сайтов

Google Sites Data API предоставляет следующие типы фидов:

Фид действий

Фид действий – это фид, содержащий описания всех действий на сайте.

URI GET для сайта в определенном домене:

https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]

domainName – это либо "сайт", либо домен G Suite.

siteName – название сайта, которое указано в URL целевой страницы сайта: http://sites.google.com/a/domainName/siteName/.

Все запросы к этому фиду должны быть аутентифицированы.

Поддерживаемые типы запросов: GET.

Фид контента

Фид контента содержит текущий контент сайта, который можно редактировать.

URI GET для сайта в определенном домене:

https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]

domainName – это либо "сайт", либо домен G Suite.

siteName – название сайта, которое указано в URL целевой страницы сайта: http://sites.google.com/a/domainName/siteName.

Для запросов к этому фиду может требоваться аутентификация. Это зависит от настроек сайта.

Поддерживаемые типы запросов: GET, POST, PUT, DELETE.

Помимо стандартных параметров запроса Data API, Sites Data API позволяет использовать следующие необязательные параметры при отправке запроса GET с помощью фида контента:

Параметр Описание Тип Примечания
ancestor Запрашивает только записи с указанным предком. string Укажите идентификатор нужной записи-предка. Пример: 0123456789. Возвращает все записи, у которых указанный предок является родительским элементом, родительским элементом родительского элемента и т. д.
include-deleted Указывает, нужно ли включать удаленные записи. Логическое значение Допустимые значения: true и false. Значение по умолчанию – false.
include-draft Указывает, нужно ли включать черновики. Логическое значение Допустимые значения: true и false. Значение по умолчанию – false. Просматривать черновик может только его владелец или автор.
kind Указывает, какие типы записей контента нужно вернуть. Они соответствуют типам страниц в Google Сайтах. список строк, разделенных запятыми Возможные значения: announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment, template.
parent Запрашивает только записи с указанным родительским элементом. string Укажите идентификатор родительской записи. Пример: 0123456789.
path Запрашивает контент в определенной иерархии страниц. string Путь к подстранице на сайте, с которой нужно получить контент. Пример: path=/path/to/page.

Фид версий

Фид изменений содержит историю изменений контента сайта.

URI GET для сайта в определенном домене:

https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]

domainName – это либо "сайт", либо домен G Suite.

siteName – название сайта, которое указано в URL целевой страницы сайта: http://sites.google.com/a/domainName/siteName.

Все запросы к этому фиду должны быть аутентифицированы.

Поддерживаемые типы запросов: GET.

Фид сайта

Фид сайтов можно использовать для создания списка сайтов Google, которыми владеет пользователь или которые ему разрешено просматривать. Также с его помощью можно создавать новые сайты, копировать существующие и изменять их названия.

URI фида для списка сайтов:

https://sites.google.com/feeds/site/domainName/[siteName]

domainName – это либо "сайт", либо домен G Suite.

Все запросы к этому фиду должны быть аутентифицированы.

Поддерживаемые типы запросов: GET, POST, PUT.

При отправке запроса GET для получения списка сайтов фид сайтов поддерживает следующие необязательные параметры:

Параметр Описание Тип Примечания
include-all-sites Перечислите все сайты, которые пользователь может хотя бы просматривать в домене G Suite. Логическое значение Этот параметр применяется только при перечислении сайтов для домена G Suite. Допустимые значения: true или false. Значение по умолчанию – false.
with-mappings Включает сопоставления веб-адресов в запись сайта. Логическое значение Допустимые значения: true и false. Значение по умолчанию – false.

Фид ACL

Фид ACL можно использовать для просмотра и/или изменения разрешений на доступ (ACL) к сайту Google.

URI фида для списка сайтов:

https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]

domainName – это либо "сайт", либо домен G Suite.

Все запросы к этому фиду должны быть аутентифицированы.

Поддерживаемые типы запросов: GET, POST, PUT, DELETE.

Справочник параметров запроса Google Сайтов

Поддерживаемые параметры запроса из протокола Google Data API:

  • max-results
  • published-max (только фид контента)
  • published-min (только фид контента)
  • start-index
  • updated-max
  • updated-min
  • q (полнотекстовые запросы)

Список параметров для каждого фида приведен в соответствующем разделе выше.

К началу