本文档提供了 Google Sites Data API 的原始协议(XML 和 HTTP)的详细参考文档。
本文档不包含有关编程语言客户端库的信息。如需了解客户端库参考信息,请参阅开发者指南中特定于编程语言的部分中的链接。
受众群体
本文面向的是特定程序员,他们希望编写可与 Google 协作平台进行交互的客户端应用程序。
这是一个参考文档;本文假定您已了解协议指南中的概念以及 Google 数据 API 协议背后的一般概念。
Google 协作平台 Feed 类型
Google 协作平台数据 API 提供以下类型的供稿:
活动动态
活动 Feed 是一个 Feed,其中包含网站中所有活动的说明。
此 Feed 中特定网域中网站的 GET URI 如下所示:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName 可以是“site”或 G Suite 网域。
siteName 是网站的着陆页网址 (http://sites.google.com/a/domainName/siteName/) 中显示的网站名称。
对此 Feed 发出的所有请求都必须经过身份验证。
支持的请求类型:GET
内容 Feed
内容 Feed 包含当前可编辑的网站内容。
此 Feed 中特定网域中的网站的 GET URI 为:
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName 是“site”或 G Suite 网域。
siteName 是网站着陆页网址中显示的网站名称:http://sites.google.com/a/domainName/siteName。
对此 Feed 的请求可能需要进行身份验证,也可能不需要,具体取决于网站的(已发布)设置。
支持的请求类型:GET、POST、PUT、DELETE
除了标准 Data API 查询参数之外,Sites Data API 还允许使用内容 Feed 发出 GET 请求的以下可选参数:
| 参数 | 说明 | 类型 | 备注 |
|---|---|---|---|
ancestor |
仅请求具有指定祖先的条目。 | 字符串 | 提供所需祖先条目的 ID。例如 0123456789。返回将指定祖先作为父级、父级的父级等的所有条目。 |
include-deleted |
指定是否包含已删除的条目。 | 布尔值 | 可能的值是 true 或 false。默认值为 false。 |
include-draft |
指定是否包含草稿条目。 | 布尔值 | 可能的值为 true 或 false。默认值为 false。 您必须是草稿的所有者或作者,才能查看草稿。 |
kind |
指定要返回的内容条目的类型。系统会根据 Google 协作平台中的页面类型显示这些设置。 | 以英文逗号分隔的字符串列表 | 可能的值包括 announcement、announcementspage、attachment、comment、filecabinet、listitem、listpage、webpage、webattachment、template。 |
parent |
仅请求具有指定父级的条目。 | 字符串 | 提供父条目的 ID。例如:0123456789。 |
path |
请求特定网页层次结构下的内容 | 字符串 | 要提取内容的网站中子页面的路径。例如:path=/path/to/page。 |
修订 Feed
修订 Feed 是包含网站内容历史修订版本的 Feed。
此 Feed 中特定网域中网站的 GET URI 如下所示:
https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]
domainName 是“site”或 G Suite 网域。
siteName 是网站着陆页网址中显示的网站名称:http://sites.google.com/a/domainName/siteName。
对此 Feed 的所有请求都必须经过身份验证。
支持的请求类型:GET
站点 Feed
网站 Feed 可用于列出用户拥有或有权查看的 Google 协作平台。还可用于创建新网站、复制网站或修改现有网站的名称。
Google 协作平台商家信息的 Feed URI 为:
https://sites.google.com/feeds/site/domainName/[siteName]
domainName 是“site”或 G Suite 网域。
对此 Feed 发出的所有请求都必须经过身份验证。
支持的请求类型:GET、POST、PUT
在针对酒店信息网站发出 GET 请求时,网站 Feed 支持以下(可选)参数:
| 参数 | 说明 | 类型 | 备注 |
|---|---|---|---|
include-all-sites |
列出 G Suite 网域中的用户至少可以查看的所有网站。 | 布尔值 | 只有在为 G Suite 网域列出网站时,此参数才适用。可能的值为 true 或 false。默认值为 false。 |
with-mappings |
在网站条目中包含网址映射。 | 布尔值 | 可能的值为 true 或 false。默认值为 false。 |
ACL Feed
ACL Feed 可用于列出和/或修改 Google 网站的共享权限 (ACL)。
网站商家信息的 Feed URI 为:
https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]
domainName 是“site”或 G Suite 网域。
对此 Feed 发出的所有请求都必须经过身份验证。
支持的请求类型:GET、POST、PUT、DELETE
Google 协作平台查询参数参考
Google Data API 协议支持的查询参数:
max-resultspublished-max(仅限内容 Feed)published-min(仅限内容 Feed)start-indexupdated-maxupdated-minq(全文查询)
如需查看特定于相应 Feed 的参数列表,请参阅上文中的每个 Feed。