新版協作平台已於 2016 年 11 月 22 日推出。Site API 無法存取或修改透過這個版本建立的協作平台,但仍可存取傳統版協作平台

參考指南

本文件提供 Google Site Data API 原始通訊協定 (XML 和 HTTP) 的詳細參考說明文件。

這份文件並未提供程式設計語言用戶端程式庫的資訊。如需用戶端程式庫的參考資訊,請參閱《開發人員指南》中程式設計語言部分章節的連結。

觀眾

這份文件的適用對像是想編寫可與 Google 協作平台互動的用戶端應用程式程式。

它是一份參考說明文件,可讓您瞭解通訊協定指南中的概念,以及 Google Data API 通訊協定的一般概念。

Google 協作平台動態饋給類型

Google Sheets Data API 提供下列類型的動態饋給:

活動動態消息

活動動態消息是一個動態饋給,內含網站中所有活動的說明。

這個動態饋給為特定網域中網站的GET URI:

https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]

domainName 是「網站」或 G Suite 網域。

siteName 是網站網站網址中顯示的網站名稱,例如:http://sites.google.com/a/domainName/siteName/。

所有傳送至這個動態饋給的要求都必須通過驗證。

支援的要求類型:GET

內容動態饋給

「內容動態饋給」是包含目前可編輯網站內容的動態饋給。

這個動態饋給為特定網域中網站的GET URI:

https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]

domainName 是「網站」或 G Suite 網域。

siteName 是網站網站網址中顯示的網站名稱,例如 http://sites.google.com/a/domainName/siteName

視這個網站 (已發布) 設定而定,傳送至這個動態饋給的要求可能會/不需要驗證。

支援的要求類型:GETPOSTPUTDELETE

除了標準 Data API 查詢參數外,Site Data Data API 還允許下列選用參數,使用內容動態饋給發出 GET 要求:

參數 說明 類型 附註
ancestor 僅要求具有指定祖系的項目。 字串 請提供所需祖系項目的 ID。例如:0123456789。傳回具有指定祖系、所有父項、父項和父項等項目的所有項目。
include-deleted 指定是否要納入已刪除的項目。 布林值 可能的值為 truefalse。預設值為 false
include-draft 指定是否要包含草稿項目。 布林值 可能的值為 truefalse。預設為 false。只有草稿的擁有者或作者才能查看。
kind 指定要傳回的內容項目種類。這些類型適用於 Google 協作平台中的頁面類型。 以半形逗號分隔的字串清單 可能的值包括 announcementannouncementspageattachmentcommentfilecabinetlistitemlistpagewebpagewebattachmenttemplate
parent 僅要求具有指定父項的項目。 字串 請提供父項項目的 ID。例如 0123456789
path 要求存取特定網頁階層的內容 字串 網站中要擷取內容子頁面的路徑。例如 path=/path/to/page

修訂版本動態饋給

「修訂版本動態饋給」動態饋給是包含網站內容的修訂版本修訂版本。

這個動態饋給為特定網域中網站的GET URI:

https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]

domainName 是「網站」或 G Suite 網域。

siteName 是網站網站網址中顯示的網站名稱,例如 http://sites.google.com/a/domainName/siteName

所有傳送至這個動態饋給的要求都必須通過驗證。

支援的要求類型:GET

網站動態饋給

網站動態消息可用於列出使用者擁有或具備檢視權限的 Google 協作平台網站。也可以用來建立新網站、複製網站或修改現有網站的名稱。

網站清單的動態饋給 URI 如下:

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

domainName 是「網站」或 G Suite 網域。

所有傳送至這個動態饋給的要求都必須通過驗證。

支援的要求類型:GETPOSTPUT

針對動態饋給網站發出 GET 要求時,網站動態饋給支援下列 (選用) 參數:

參數 說明 類型 附註
include-all-sites 列出使用者必須至少在 G Suite 網域中瀏覽的所有網站。 布林值 這個參數僅適用於列出 G Suite 網域的網站。可能的值為 truefalse。預設值為 false
with-mappings 包含項目條中的所有網址對應。 布林值 可能的值為 truefalse。預設值為 false

ACL 動態饋給

ACL 動態饋給可用於列出和/或修改 Google 網站的共用權限 (ACL)。

網站清單的動態饋給 URI 如下:

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

domainName 是「網站」或 G Suite 網域。

所有傳送至這個動態饋給的要求都必須通過驗證。

支援的要求類型:GETPOSTPUTDELETE

Google 協作平台查詢參數參考資料

Google Data API 通訊協定支援的查詢參數:

  • max-results
  • published-max (僅限內容動態饋給)
  • published-min (僅限內容動態饋給)
  • start-index
  • updated-max
  • updated-min
  • q (全文查詢)

如需該動態饋給專屬的參數清單,請參閱上方的每個動態饋給

返回頁首