本文档详细介绍了 Google 协作平台 Data API 的原始协议(XML 和 HTTP)的参考文档。
本文档不包含有关编程语言客户端库的信息。如需了解客户端库参考信息,请参阅开发者指南中特定于编程语言的部分中的链接。
受众群体
本文档适用于想要编写可与 Google 协作平台 互动的客户端应用的程序员。
本文档是一份参考文档,假定您了解协议指南中介绍的概念,以及 Google Data API 协议背后的总体思路。
Google 协作平台 Feed 类型
Google 协作平台 Data API 提供以下类型的 Feed:
活动动态
活动 Feed 是一种包含网站内所有活动说明的 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 查询参数之外,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 是“网站”或 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 网域中用户至少可以查看的所有网站。 | 布尔值 | 此参数仅在列出 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 是“网站”或 G Suite 网域。
对相应 Feed 发出的所有请求都必须经过身份验证。
支持的请求类型:GET、POST、PUT、DELETE
Google 协作平台查询参数参考
Google Data API 协议中支持的查询参数:
max-resultspublished-max(仅限内容 Feed)published-min(仅限内容 Feed)start-indexupdated-maxupdated-minq(全文查询)
如需查看特定于相应 Feed 的参数列表,请参阅上文中的各个 Feed。