参考指南

本文提供了详细的参考文档,介绍 Google 协作平台数据 API 的原始协议(XML 和 HTTP)。

本文档不包含有关编程语言客户端库的信息。有关客户端库参考信息,请参阅开发者指南中针对编程语言的部分中的链接。

受众群体

本文面向的是特定程序员,他们希望编写可与 Google 协作平台进行交互的客户端应用程序。

本文档是参考文档;本文档假定您已了解协议指南中所述的概念,以及 Google 数据 API 协议背后的一般概念。

Google 协作平台 Feed 类型

Google 协作平台数据 API 提供以下类型的供稿:

活动动态

活动供稿是包含网站中所有活动的说明的供稿。

此 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。

此 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 的请求可能要求进行身份验证,也可能不需要进行身份验证,具体取决于网站的(已发布)设置。

支持的请求类型:GETPOSTPUTDELETE

除了标准 Data API 查询参数之外,协作平台数据 API 还支持以下可选参数 使用内容 Feed 发出 GET 请求:

参数 说明 类型 备注
ancestor 仅请求具有指定祖先的条目。 字符串 提供所需祖先条目的 ID。例如 0123456789。返回将指定的祖先实体作为父级、其父级以依此类推的所有条目。
include-deleted 指定是否包含已删除的条目。 布尔值 可能的值是 truefalse。默认值为 false
include-draft 指定是否包含草稿条目。 布尔值 可能的值是 truefalse。默认值为 false。 您必须是所有者或作者 进行查看。
kind 指定要返回的内容条目的类型。系统会根据 Google 协作平台中的页面类型显示这些设置。 以英文逗号分隔的字符串列表 可能的值包括 announcementannouncementspageattachmentcommentfilecabinetlistitemlistpagewebpagewebattachmenttemplate
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 的所有请求都必须经过身份验证。

支持的请求类型:GETPOSTPUT

发出列出网站的 GET 请求时,网站 Feed 支持以下(可选)参数:

参数 说明 类型 备注
include-all-sites 列出 G Suite 网域中的用户至少可以查看的所有网站。 布尔值 只有在为 G Suite 网域列出网站时,此参数才适用。可能的值包括 truefalse。默认值为 false
with-mappings 在网站条目中包含网址映射。 布尔值 可能的值是 truefalse。默认值为 false

ACL 供稿

ACL Feed 可用于列出和/或修改 Google 网站的共享权限 (ACL)。

Google 协作平台商家信息的 Feed URI 为:

https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]

domainName 可以是“site”或 G Suite 网域。

对此 Feed 的所有请求都必须经过身份验证。

支持的请求类型:GETPOSTPUTDELETE

Google 协作平台查询参数参考

Google Data API 协议支持的查询参数:

  • max-results
  • published-max(仅限内容 Feed)
  • published-min(仅限内容 Feed)
  • start-index
  • updated-max
  • updated-min
  • q(全文查询)

请参阅上文中的每个 Feed,查看该 Feed 特有的参数列表。

返回页首