本文件提供 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。
視網站 (已發布) 的設定而定,傳送至此動態饋給的要求不一定需要驗證。
支援的要求類型: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
(完整文字查詢)
請參閱上述的每個動態饋給,瞭解該動態饋給專屬的參數清單。