新版 Google 协作平台已于 2016 年 11 月 22 日发布。协作平台 API 无法访问或修改使用此版本创建的网站,但仍可以访问传统版协作平台

参考指南

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

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

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

受众

本文档适用于想要编写可与 Google 协作平台进行交互的客户端应用程序的程序员。

这是一个参考文档;本文假设您已理解协议指南中的概念,以及 Google Data API 协议背后的一般概念。

Google 协作平台 Feed 类型

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

活动 Feed

活动 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。

对于特定网域中的网站,此 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 查询参数外,Sites Data API 还允许下列可选参数使用 Content 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 的 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 Feed

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 的参数列表。

返回页首