參考指南

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

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

適用對象

本文件的適用對象為想要編寫能夠與 Google 協作平台互動用戶端應用程式的程式設計師。

這只是參考文件,假設您已瞭解通訊協定指南中的概念,以及 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

依網站 (已發布) 設定而定,對這個動態饋給發出的要求不一定需要驗證。

支援的要求類型:GETPOSTPUTDELETE

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

參數 說明 類型 附註
ancestor 僅要求包含指定祖系的項目。 字串 提供所需祖系項目的 ID。例如:0123456789。傳回含有指定祖系為父項、父項的父項等的所有項目,以此類推。
include-deleted 指定是否要納入已刪除的項目。 boolean 可能的值為 truefalse。預設值為 false
include-draft 指定是否要包含草稿項目。 boolean 可能的值為 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 網域中使用者至少可查看的所有網站。 boolean 這個參數只有在列出 G Suite 網域的網站時才能使用。可能的值為 truefalse。預設值為 false
with-mappings 在網站項目中加入網址對應。 boolean 可能的值為 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 (完整文字查詢)

請查看上方的每個動態饋給,查看該動態饋給專屬的參數清單。

返回頁首