В этом документе представлена подробная справочная информация по исходному протоколу (XML и HTTP) для API данных Google Sites.
Данный документ не содержит информации о клиентских библиотеках для языков программирования. Справочную информацию о клиентских библиотеках можно найти по ссылкам в разделах руководства разработчика, посвященных конкретным языкам программирования.
Аудитория
Этот документ предназначен для программистов, которые хотят писать клиентские приложения, способные взаимодействовать с Google Sites.
Это справочный документ; предполагается, что вы понимаете концепции, представленные в руководстве по протоколу , и общие принципы, лежащие в основе протокола Google Data API .
Типы фидов Google Sites
API данных Google Sites предоставляет следующие типы каналов:
Лента активности
Лента активности — это лента, содержащая описания всех действий, происходящих на сайте.
GET URI для этого канала, относящегося к сайту в определенном домене, выглядит следующим образом:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName — это либо "site", либо домен G Suite.
siteName — это имя сайта siteName как оно отображается в URL-адресе главной страницы сайта: domainName .
Все запросы к этому каналу должны быть авторизованы.
Поддерживаемые типы запросов: GET
Лента контента
Лента контента — это лента, содержащая текущий редактируемый контент сайта.
GET URI для этого канала, относящегося к сайту в определенном домене, выглядит следующим образом:
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName — это либо "site", либо домен G Suite.
siteName — это имя сайта, как оно отображается в URL-адресе главной страницы сайта: domainName siteName
Запросы к этой ленте могут требовать или не требовать аутентификации в зависимости от настроек сайта (опубликованных данных).
Поддерживаемые типы запросов: GET , POST , PUT , DELETE
В дополнение к стандартным параметрам запроса Data 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 — это либо "site", либо домен G Suite.
siteName — это имя сайта, как оно отображается в URL-адресе главной страницы сайта: domainName siteName
Все запросы к этому каналу должны быть авторизованы.
Поддерживаемые типы запросов: GET
Лента новостей сайта
Лента сайтов может использоваться для отображения сайтов Google, которыми владеет пользователь или на которые у него есть права просмотра. Она также может использоваться для создания новых сайтов, копирования сайта или изменения названия существующего сайта.
URI ленты для списка сайтов:
https://sites.google.com/feeds/site/domainName/[siteName]
domainName — это либо "site", либо домен 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 — это либо "site", либо домен G Suite.
Все запросы к этому каналу должны быть авторизованы.
Поддерживаемые типы запросов: GET , POST , PUT , DELETE
Справочник параметров запроса Google Sites
Поддерживаемые параметры запроса из протокола Google Data API :
-
max-results -
published-max(только контент-лента) -
published-min(только контент-лента) -
start-index -
updated-max -
updated-min -
q(полные текстовые запросы)
Список параметров, специфичных для каждого из каналов , см. выше.