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