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

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

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

Аудитория

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

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

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

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

Лента активности

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

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

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

domainName — это либо «сайт», либо домен G Suite.

siteName — это имя сайта siteName которое отображается в URL-адресе domainName страницы сайта: http://sites.google.com/a/domainName/siteName/.

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

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

Лента контента

Фид контента – это канал, содержащий текущий редактируемый контент сайта.

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

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

domainName — это либо «сайт», либо домен G Suite.

siteName — это имя сайта siteName domainName

Запросы к этому каналу могут требовать или не требовать аутентификации, в зависимости от (опубликованных) настроек Сайта.

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

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

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

Фид изменений

Фид редакций – это канал, содержащий исторические версии контента сайта.

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

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

domainName — это либо «сайт», либо домен G Suite.

siteName — это имя сайта siteName domainName

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

Поддерживаемые типы запросов: 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 (полнотекстовые запросы)

См. список параметров, специфичных для каждого канала выше.

Вернуться наверх