參考指南

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

本文件不包含程式設計語言用戶端程式庫的相關資訊。如需用戶端程式庫參考資訊，請參閱開發人員指南中的程式設計語言相關章節。

目標對象

本文件適用於想要編寫可與 Google Sites 互動的用戶端應用程式的程式設計師。

這是一份參考文件，假設您已瞭解通訊協定指南中介紹的概念，以及 Google Data API 通訊協定背後的一般概念。

Google 協作平台動態饋給類型

Google Sites 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。

系統會根據網站的 (發布) 設定，決定是否需要驗證動態饋給的要求。

支援的要求類型：GET、POST、PUT、DELETE

除了標準 Data API 查詢參數之外，Sites Data API 也允許使用內容動態饋給發出 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。

修訂動態饋給

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

此動態饋給在特定網域內網站適用的 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 網域。

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

支援的要求類型：GET、POST、PUT

針對清單網站提出 GET 要求時，網站動態饋給支援下列 (選用) 參數：

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

ACL 動態饋給

ACL 資訊提供可用於列出和/或修改 Google 網站的共用權限 (ACL)。

網站資訊資源的動態饋給 URI 如下所示：

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

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

所有向這個動態饋給發出的要求都必須驗證。

支援的要求類型：GET、POST、PUT、DELETE

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

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

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

如要查看特定動態饋給的參數清單，請參閱上方的每個動態饋給。

返回頁首